Package Classes (0.1.0)

Summary of entries of Classes for google-cloud-geminidataanalytics.

Classes

ContextRetrievalServiceAsyncClient

Service to ask a natural language question with a provided project, returns BigQuery tables that are relevant to the question within the project scope that is accessible to the user, along with contextual data including table schema information as well as sample values.

ContextRetrievalServiceClient

Service to ask a natural language question with a provided project, returns BigQuery tables that are relevant to the question within the project scope that is accessible to the user, along with contextual data including table schema information as well as sample values.

DataAgentServiceAsyncClient

Service describing handlers for resources.

DataAgentServiceClient

Service describing handlers for resources.

ListDataAgentsAsyncPager

A pager for iterating through list_data_agents requests.

This class thinly wraps an initial ListDataAgentsResponse object, and provides an __aiter__ method to iterate through its data_agents field.

If there are more pages, the __aiter__ method will make additional ListDataAgents requests and continue to iterate through the data_agents field on the corresponding responses.

All the usual ListDataAgentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDataAgentsPager

A pager for iterating through list_data_agents requests.

This class thinly wraps an initial ListDataAgentsResponse object, and provides an __iter__ method to iterate through its data_agents field.

If there are more pages, the __iter__ method will make additional ListDataAgents requests and continue to iterate through the data_agents field on the corresponding responses.

All the usual ListDataAgentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

DataChatServiceAsyncClient

Service to ask a natural language question on top of BigQuery and LookerStudio datasources to get back streamed responses of various kinds to help provide a rich conversational answer.

DataChatServiceClient

Service to ask a natural language question on top of BigQuery and LookerStudio datasources to get back streamed responses of various kinds to help provide a rich conversational answer.

ListConversationsAsyncPager

A pager for iterating through list_conversations requests.

This class thinly wraps an initial ListConversationsResponse object, and provides an __aiter__ method to iterate through its conversations field.

If there are more pages, the __aiter__ method will make additional ListConversations requests and continue to iterate through the conversations field on the corresponding responses.

All the usual ListConversationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListConversationsPager

A pager for iterating through list_conversations requests.

This class thinly wraps an initial ListConversationsResponse object, and provides an __iter__ method to iterate through its conversations field.

If there are more pages, the __iter__ method will make additional ListConversations requests and continue to iterate through the conversations field on the corresponding responses.

All the usual ListConversationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListMessagesAsyncPager

A pager for iterating through list_messages requests.

This class thinly wraps an initial ListMessagesResponse object, and provides an __aiter__ method to iterate through its messages field.

If there are more pages, the __aiter__ method will make additional ListMessages requests and continue to iterate through the messages field on the corresponding responses.

All the usual ListMessagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListMessagesPager

A pager for iterating through list_messages requests.

This class thinly wraps an initial ListMessagesResponse object, and provides an __iter__ method to iterate through its messages field.

If there are more pages, the __iter__ method will make additional ListMessages requests and continue to iterate through the messages field on the corresponding responses.

All the usual ListMessagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AnalysisEvent

An event indicating the progress of an analysis.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AnalysisMessage

A message produced during analysis.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AnalysisOptions

Options for analysis.

Python

Options for Python analysis.

AnalysisQuery

A query for performing an analysis.

BigQueryJob

A BigQuery job executed by the system.

BigQueryTableReference

Message representing a reference to a single BigQuery table.

BigQueryTableReferences

Message representing references to BigQuery tables.

Blob

A blob of data with a MIME type.

ChartMessage

A message produced during chart generation.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ChartOptions

Options for chart generation.

ImageOptions

Options for rendering images of generated charts.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NoImage

No image.

SvgOptions

SVG options.

ChartQuery

A query for generating a chart.

ChartResult

The result of a chart generation query.

ChatRequest

Request for Chat.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Context

A collection of context to apply to this conversation

Conversation

Message for a conversation.

LabelsEntry

The abstract base class for a message.

ConversationOptions

Options for the conversation.

ConversationReference

Reference to a persisted conversation and agent context.

CreateConversationRequest

Request for creating a conversation.

CreateDataAgentRequest

Message for creating a DataAgent.

Credentials

Represents different forms of credential specification.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DataAgent

Message describing a DataAgent object.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

LabelsEntry

The abstract base class for a message.

DataAgentContext

Context for the chat request using a data agent.

ContextVersion

List of context versions supported by DCS. There are two versions of context. This is to maintain versioning for the data agent.

DataAnalyticsAgent

Message describing a DataAnalyticsAgent object.

DataMessage

A message produced during data retrieval.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DataQuery

A query for retrieving data.

DataResult

Retrieved data.

Datasource

A datasource that can be used to answer questions.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DatasourceReferences

A collection of references to datasources.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DeleteDataAgentRequest

Message for deleting a DataAgent.

DirectLookup

Direct lookup parameters.

ErrorMessage

An error message.

Field

A field in a schema.

GetConversationRequest

Request for getting a conversation based on parent and conversation id.

GetDataAgentRequest

Message for getting a DataAgent.

ListConversationsRequest

Request for listing conversations based on parent.

ListConversationsResponse

Message for response to listing conversations.

ListDataAgentsRequest

Message for requesting list of DataAgents.

ListDataAgentsResponse

Message for response to listing DataAgents.

ListMessagesRequest

Request for listing chat messages based on parent and conversation_id.

ListMessagesResponse

Response for listing chat messages.

LookerExploreReference

Message representing a reference to a single Looker explore.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

LookerExploreReferences

Message representing references to Looker explores.

LookerQuery

A query for retrieving data from a Looker explore. See https://cloud.google.com/looker/docs/reference/looker-api/latest/methods/Query/run_inline_query

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Filter

A Looker query filter.

Message

A message from an internaction between the user and the system.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

OAuthCredentials

Represents OAuth credentials.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SecretBased

The name of the secret containing the access token. Represents secret-based OAuth credentials.

TokenBased

Read more about Looker access tokens here:

https://developers.looker.com/api/advanced-usage/looker-api-oauth

OperationMetadata

Represents the metadata of the long-running operation.

PrivateLookerInstanceInfo

Message representing a private Looker instance info required if the Looker instance is behind a private network.

RetrieveBigQueryRecentRelevantTablesRequest

Request for retrieving BigQuery table references from recently accessed tables. Response is sorted by semantic similarity to the query.

RetrieveBigQueryRecentRelevantTablesResponse

Response for retrieving BigQuery table references from recently accessed tables. Response is sorted by semantic similarity to the query.

RetrieveBigQueryTableContextRequest

Request for retrieving BigQuery table contextual data via direct lookup.

RetrieveBigQueryTableContextResponse

Response for retrieving BigQuery table contextual data via direct lookup.

Candidate

A retrieved candidate.

RetrieveBigQueryTableContextsFromRecentTablesRequest

Request for retrieving BigQuery table contextual data from recently accessed tables. Response is sorted by semantic similarity to the query.

RetrieveBigQueryTableContextsFromRecentTablesResponse

Response for retrieving BigQuery table contextual data from recently accessed tables. Response is sorted by semantic similarity to the query.

RetrieveBigQueryTableSuggestedDescriptionsRequest

Request for retrieving BigQuery table schema with suggested table and column descriptions. Columns are sorted by default BigQuery table schema order.

RetrieveBigQueryTableSuggestedDescriptionsResponse

Response for retrieving BigQuery table schema with suggested table and column descriptions. Columns are sorted by default BigQuery table schema order.

Schema

The schema of a Datasource or QueryResult instance.

SchemaMessage

A message produced during schema resolution.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SchemaQuery

A query for resolving the schema relevant to the posed question.

SchemaResult

The result of schema resolution.

StorageMessage

A stored message containing user message or system message.

StudioDatasourceReference

Message representing a reference to a single LookerStudio datasource.

StudioDatasourceReferences

Message representing references to LookerStudio datasources.

SystemMessage

A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TableCandidate

A retrieved BigQuery table candidate.

FieldSuggestion

A suggested description for a field.

TextMessage

A multi-part text message.

UpdateDataAgentRequest

Message for updating a DataAgent.

UserMessage

A message from the user that is interacting with the system.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Modules

pagers

API documentation for geminidataanalytics_v1alpha.services.data_agent_service.pagers module.

pagers

API documentation for geminidataanalytics_v1alpha.services.data_chat_service.pagers module.