API documentation for geminidataanalytics_v1.types package.
Classes
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.
AnalysisQuery
A query for performing an analysis.
BigQueryJob
A BigQuery job executed by the system.
BigQueryPropertyGraphReference
Message representing a reference to a single BigQuery property graph.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BigQueryRoutine
A reference to a BigQuery routine.
BigQueryRoutineReference
A reference to a BigQuery routine.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BigQueryTableReference
Message representing a reference to a single BigQuery table.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BigQueryTableReferences
Message representing references to BigQuery tables and property
graphs. At least one of table_references,
property_graph_references, or search_scope must be
populated.
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
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
Citation
Source attributions for content.
CitationAnchor
The anchor of the citation.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CitationSource
The source of the citation.
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
ClientManagedResourceContext
Context with client managed resources. Some clients may not use GDA managed resources including conversations and agents, instead they create and manage their own conversations and agents resources.
Context
A collection of context to apply to this conversation
Conversation
Message for a conversation.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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
DataAgentContext
Context for the chat request using a data agent.
DataAnalyticsAgent
Message describing a DataAnalyticsAgent object.
DataFilter
A filter on a datasource's underlying data. Filter syntax documentation: https://cloud.google.com/looker/docs/filter-expressions
DataFilterType
The type of filter present on a datasource, such as ALWAYS_FILTER.
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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
DatasourceOptions
Options for datasources configurations.
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
DeleteConversationRequest
Request for deleting a conversation based on parent and conversation id.
DeleteDataAgentRequest
Message for deleting a DataAgent.
ErrorMessage
An error message from a tool call. This message is used to represent an error that occurred while an agent was trying to use a tool. It's important to note that not all errors are terminal. Many are recoverable, and the agent may use the information from this error message to self-correct and retry the tool call or try a different approach.
For example, if a data query fails, the agent might receive an
ErrorMessage, analyze it, and then generate a corrected query.
Clients should be cautious about interpreting this message as a definitive failure. It can be part of the agent's normal, iterative process of completing a task. Surfacing these errors directly to end-users without context (e.g., as a "hard failure") may be misleading.
ExampleQueries
A message containing derived and authored example queries.
ExampleQuery
Example of relevant and commonly used SQL query and its corresponding natural language queries optionally present. Currently only used for BigQuery data sources.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Field
A field in a schema.
GetConversationRequest
Request for getting a conversation based on parent and conversation id.
GetDataAgentRequest
Message for getting a DataAgent.
GlossaryTerm
Definition of a term within a specific domain.
ListAccessibleDataAgentsRequest
Message for requesting list of accessible DataAgents.
ListAccessibleDataAgentsResponse
Message for response to listing accessible DataAgents.
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.
LookerGoldenQuery
A golden query for Looker, including natural language questions and a corresponding Looker Query. Analogous to ExampleQuery.
LookerQuery
Looker Query Object Looker API
documentation <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
MatchedQuery
A matched query message represents the agent having matched one of the example queries supplied in context as being applicable to the current question. It will also contain additional info during the matching process.
Message
A message from an interaction 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
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.
QueryParameter
A query parameter message represents a parameter that can be used to parameterize a SQL query.
QueryParameterValues
A query parameter values message represents the values for the query parameters that were extracted from the user question by LLM, based on the example query.
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 Looker Studio datasource.
StudioDatasourceReferences
Message representing references to Looker Studio 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 multi-turn 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
TextMessage
A multi-part text message.
UpdateDataAgentRequest
Message for updating a DataAgent.
UserFunctions
A collection of user functions to be included in context.
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