Package Classes (0.13.5)

Service for Auto-Completion.

Service for Auto-Completion.

Service for performing CRUD operations on Controls. Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request.

Service for performing CRUD operations on Controls. Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request.

A pager for iterating through list_controls requests.

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

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

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

A pager for iterating through list_controls requests.

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

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

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

Service for conversational search.

Service for conversational search.

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.

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.

A pager for iterating through list_sessions requests.

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

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

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

A pager for iterating through list_sessions requests.

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

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

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

Service for managing DataStore configuration.

Service for managing DataStore configuration.

A pager for iterating through list_data_stores requests.

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

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

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

A pager for iterating through list_data_stores requests.

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

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

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

Service for ingesting Document information of the customer's website.

Service for ingesting Document information of the customer's website.

A pager for iterating through list_documents requests.

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

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

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

A pager for iterating through list_documents requests.

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

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

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

Service for managing Engine configuration.

Service for managing Engine configuration.

A pager for iterating through list_engines requests.

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

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

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

A pager for iterating through list_engines requests.

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

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

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

Service for grounded generation.

Service for grounded generation.

Service for operations on the Project.

Service for operations on the Project.

Service for ranking text records.

Service for ranking text records.

Service for making recommendations.

Service for making recommendations.

Service for managing Schemas.

Service for managing Schemas.

A pager for iterating through list_schemas requests.

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

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

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

A pager for iterating through list_schemas requests.

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

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

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

Service for search.

Service for search.

A pager for iterating through search requests.

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

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

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

A pager for iterating through search_lite requests.

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

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

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

A pager for iterating through search_lite requests.

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

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

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

A pager for iterating through search requests.

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

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

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

Service for search tuning.

Service for search tuning.

Service for managing site search related resources.

Service for managing site search related resources.

A pager for iterating through fetch_domain_verification_status requests.

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

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

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

A pager for iterating through fetch_domain_verification_status requests.

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

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

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

A pager for iterating through list_target_sites requests.

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

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

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

A pager for iterating through list_target_sites requests.

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

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

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

Service for ingesting end user actions on a website to Discovery Engine API.

Service for ingesting end user actions on a website to Discovery Engine API.

AlloyDB source import data from.

Defines an answer.

An enum for answer skipped reasons.

    Google skips the answer if the query is chit
    chat.
OUT_OF_DOMAIN_QUERY_IGNORED (3):
    The out-of-domain query ignored case.

    Google skips the answer if there are no
    high-relevance search results.
POTENTIAL_POLICY_VIOLATION (4):
    The potential policy violation case.

    Google skips the answer if there is a potential
    policy violation detected. This includes content
    that may be violent or toxic.
NO_RELEVANT_CONTENT (5):
    The no relevant content case.

    Google skips the answer if there is no relevant
    content in the retrieved search results.
JAIL_BREAKING_QUERY_IGNORED (6):
    The jail-breaking query ignored case.

    For example, "Reply in the tone of a competing
    company's CEO". Google skips the answer if the
    query is classified as a jail-breaking query.
CUSTOMER_POLICY_VIOLATION (7):
    The customer policy violation case.

    Google skips the summary if there is a customer
    policy violation detected. The policy is defined
    by the customer.
NON_ANSWER_SEEKING_QUERY_IGNORED_V2 (8):
    The non-answer seeking query ignored case.

    Google skips the answer if the query doesn't
    have clear intent.
LOW_GROUNDED_ANSWER (9):
    The low-grounded answer case.

    Google skips the answer if a well grounded
    answer was unable to be generated.

Citation info for a segment.

Citation source.

Query understanding information.

Query classification information.

Query classification types.

Reference.

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

Chunk information.

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

Document metadata.

Structured search information.

Unstructured document information.

Chunk content.

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

Enumeration of the state of the answer generation.

Step information.

Action.

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

Observation.

Chunk information.

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

Snippet information.

Search action.

Enumeration of the state of the step.

Request message for ConversationalSearchService.AnswerQuery method.

Answer generation specification.

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

Answer Generation Model specification.

Answer generation prompt specification.

Query understanding specification.

Query classification specification.

Query classification types.

Query rephraser specification.

Related questions specification.

Safety specification.

Search specification.

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

Search parameters.

Search result list.

Search result.

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

Chunk information.

Document metadata contains the information of the document of the current chunk.

Unstructured document information.

Document context.

Extractive answer. Guide <https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers>__

Extractive segment. Guide <https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments>__ Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets.

The abstract base class for a message.

Response message for ConversationalSearchService.AnswerQuery method.

Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.BatchCreateTargetSites method.

Response message for SiteSearchEngineService.BatchCreateTargetSites method.

Request message for DocumentService.BatchGetDocumentsMetadata method.

Matcher for the Documents by FHIR resource names.

Matcher for the Documents. Currently supports matching by exact URIs.

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

Matcher for the Documents by exact uris.

Response message for DocumentService.BatchGetDocumentsMetadata method.

The metadata of a Document.

The value of the matcher that was used to match the Document.

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

The state of the Document.

Metadata related to the progress of the SiteSearchEngineService.BatchVerifyTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.BatchVerifyTargetSites method.

Response message for SiteSearchEngineService.BatchVerifyTargetSites method.

BigQuery source import data from.

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

The Bigtable Options object that contains information to support the import.

The column of the Bigtable.

The column family of the Bigtable.

The encoding mode of a Bigtable column or column family.

The abstract base class for a message.

The type of values in a Bigtable column or column family. The values are expected to be encoded using HBase Bytes.toBytes <https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/util/Bytes.html>__ function when the encoding value is set to BINARY.

The Cloud Bigtable source for importing data.

Request message for GroundedGenerationService.CheckGrounding method.

The abstract base class for a message.

Response message for the GroundedGenerationService.CheckGrounding method.

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

Text and citation info for a claim in the answer candidate.

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

Specification for the grounding check.

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

Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.

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

Metadata of the current chunk. This field is only populated on SearchService.Search API.

Document metadata contains the information of the document of the current chunk.

Page span of the chunk.

Cloud SQL source import data from.

Request message for CollectUserEvent method.

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

Request message for CompletionService.CompleteQuery method.

Response message for CompletionService.CompleteQuery method.

Suggestions as search queries.

Detailed completion information including completion attribution token and clicked completion info.

Autocomplete suggestions that are imported from Customer.

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

Defines circumstances to be checked before allowing a behavior

Matcher for search request query

Used for time-dependent conditions.

Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on SolutionType.

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

Adjusts order of products in returned list.

Specified which products may be included in results. Uses same filter as boost.

Redirects a shopper to the provided URI.

Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy".

External conversation proto definition.

Enumeration of the state of the conversation.

Defines context of the conversation

Defines a conversation message.

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

Request message for ConversationalSearchService.ConverseConversation method.

The abstract base class for a message.

Response message for ConversationalSearchService.ConverseConversation method.

Request for CreateControl method.

Request for CreateConversation method.

Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.

Request for DataStoreService.CreateDataStore method.

Request message for DocumentService.CreateDocument method.

Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.

Request for EngineService.CreateEngine method.

Metadata for Create Schema LRO.

Request message for SchemaService.CreateSchema method.

Request for CreateSession method.

Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.CreateTargetSite method.

A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.

Metadata that describes a custom tuned model.

The abstract base class for a message.

The state of the model.

DataStore captures global settings and configs at the DataStore level.

Estimation of data size per data store.

Content config of the data store.

Request for DeleteControl method.

Request for DeleteConversation method.

Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for DataStoreService.DeleteDataStore method.

Request message for DocumentService.DeleteDocument method.

Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for EngineService.DeleteEngine method.

Metadata for DeleteSchema LRO.

Request message for SchemaService.DeleteSchema method.

Request for DeleteSession method.

Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.DeleteTargetSite method.

Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

Document captures all raw metadata information of items to be recommended or searched.

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

Unstructured data linked to this document.

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

Index status of the document.

Detailed document information associated with a user event.

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

A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser.

Configuration for chunking config.

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

Configuration for the layout based chunking.

Related configurations applied to a specific type of document parser.

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

The digital parsing configurations for documents.

The layout parsing configurations for documents.

The OCR parsing configurations for documents.

The abstract base class for a message.

Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

Metadata that describes the training and serving parameters of an Engine.

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

Configurations for a Chat Engine.

Configurations for generating a Dialogflow agent.

Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.

Additional information of a Chat Engine. Fields in this message are output only.

Common configurations for an Engine.

Configurations for a Search Engine.

Fact Chunk.

The abstract base class for a message.

Request message for SiteSearchEngineService.FetchDomainVerificationStatus method.

Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.

Cloud FhirStore source import data from.

Firestore source import data from.

Cloud Storage location for input content.

Top-level message sent by the client for the GenerateGroundedContent method.

Describes the options to customize dynamic retrieval.

Describes the predictor settings for dynamic retrieval.

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

The version of the predictor to be used in dynamic retrieval.

Content generation specification.

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

Grounding source.

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

Google Search config parameters.

Message to be used for grounding based on inline content.

The abstract base class for a message.

Message to be used for grounding with Vertex AI Search.

Grounding specification.

The abstract base class for a message.

A response candidate generated from the model.

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

Citation for the generated content.

Describes the metadata about dynamic retrieval.

Describes the metadata about the dynamic retrieval predictor.

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

The version of the predictor which was used in dynamic retrieval.

Grounding info for a claim in the candidate and its support.

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

Describes the metadata associated with a retrieval step.

Describes the source to which the metadata is associated to.

Google search entry point.

Request for GetAnswer method.

Request for GetControl method.

Request for GetConversation method.

Request message for DataStoreService.GetDataStore method.

Request message for DocumentService.GetDocument method.

Request message for EngineService.GetEngine method.

Request message for SchemaService.GetSchema method.

Request for GetSession method.

Request message for SiteSearchEngineService.GetSiteSearchEngine method.

Request message for SiteSearchEngineService.GetTargetSite method.

Base structured datatype containing multi-part content of a message.

Single part of content.

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

Grounding Fact.

The abstract base class for a message.

Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.ImportCompletionSuggestions method.

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

The inline source for CompletionSuggestions.

Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.

Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for Import methods.

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

The inline source for the input config for ImportDocuments method.

Indicates how imported documents are reconciled with the existing documents created or imported before.

Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

Configuration of destination for Import related errors.

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

Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.ImportSuggestionDenyListEntries method.

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

The inline source for SuggestionDenyListEntry.

Response message for CompletionService.ImportSuggestionDenyListEntries method.

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for the ImportUserEvents request.

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

The inline source for the input config for ImportUserEvents method.

Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

The industry vertical associated with the DataStore.

A floating point interval.

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

Request for ListControls method.

Response for ListControls method.

Request for ListConversations method.

Response for ListConversations method.

Request message for SearchTuningService.ListCustomModels method.

Response message for SearchTuningService.ListCustomModels method.

Request message for DataStoreService.ListDataStores method.

Response message for DataStoreService.ListDataStores method.

Request message for DocumentService.ListDocuments method.

Response message for DocumentService.ListDocuments method.

Request message for EngineService.ListEngines method.

Response message for EngineService.ListEngines method.

Request message for SchemaService.ListSchemas method.

Response message for SchemaService.ListSchemas method.

Request for ListSessions method.

Response for ListSessions method.

Request message for SiteSearchEngineService.ListTargetSites method.

Response message for SiteSearchEngineService.ListTargetSites method.

Media-specific user event information.

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

Detailed page information.

Detailed panel information associated with a user event.

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

Metadata and configurations for a Google Cloud project in the service.

Metadata about the terms of service.

The agreement states this terms of service.

The abstract base class for a message.

Metadata associated with a project provision operation.

Request for ProjectService.ProvisionProject method.

Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.PurgeCompletionSuggestions method.

Response message for CompletionService.PurgeCompletionSuggestions method.

Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for DocumentService.PurgeDocuments method.

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

The inline source for the input config for DocumentService.PurgeDocuments method.

Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Configuration of destination for Purge related errors.

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

Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.PurgeSuggestionDenyListEntries method.

Response message for CompletionService.PurgeSuggestionDenyListEntries method.

Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for PurgeUserEvents method.

Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Defines a user inputed query.

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

Request message for RankService.Rank method.

The abstract base class for a message.

Response message for RankService.Rank method.

Record message for RankService.Rank method.

Request message for Recommend method.

The abstract base class for a message.

The abstract base class for a message.

Response message for Recommend method.

RecommendationResult represents a generic recommendation result with associated metadata.

The abstract base class for a message.

Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.RecrawlUris method.

Response message for SiteSearchEngineService.RecrawlUris method.

Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.

Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.

CorpusType for the failed crawling operation.

Defines a reply message to user.

Defines the structure and layout of a type of document data.

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

Add-on that provides additional functionality for search.

Detailed search information.

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

Request message for SearchService.Search method.

Boost specification to boost certain documents.

Boost applies to documents which match a condition.

Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.

The attribute(or function) for which the custom ranking is to be applied.

The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).

The interpolation type to be applied. Default will be linear (Piecewise Linear).

A specification for configuring the behavior of content search.

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

A specification for configuring the extractive content in a search response.

Specifies the search result mode. If unspecified, the search result mode defaults to DOCUMENTS.

A specification for configuring snippets in a search response.

A specification for configuring a summary returned in a search response.

Specification of the prompt to use with the model.

Specification of the model.

A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an INVALID_ARGUMENT error is returned.

A facet specification to perform faceted search.

Specifies how a facet is computed.

Specifies the image query input.

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

The abstract base class for a message.

Specification to determine under which conditions query expansion should occur.

Enum describing under which condition query expansion should occur.

Specification for search as you type in search requests.

Enum describing under which condition search as you type should occur.

Session specification.

Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.

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

The specification for query spell correction.

Enum describing under which mode spell correction should occur.

The abstract base class for a message.

Response message for SearchService.Search method.

A facet result.

A facet value which contains value names and their count.

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

Information describing query expansion including whether expansion has occurred.

Represents the search results.

Information about the session.

Summary of the top N search results specified by the summary spec.

Citation info for a segment.

Citation metadata.

Citation source.

Document reference.

Chunk content.

Safety Attribute categories and their associated confidence scores.

An Enum for summary-skipped reasons.

    Only used when
    <xref uid="google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ignore_adversarial_query">SummarySpec.ignore_adversarial_query</xref>
    is set to `true`.
NON_SUMMARY_SEEKING_QUERY_IGNORED (2):
    The non-summary seeking query ignored case.

    Google skips the summary if the query is chit chat. Only
    used when
    <xref uid="google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_summary_seeking_query">SummarySpec.ignore_non_summary_seeking_query</xref>
    is set to `true`.
OUT_OF_DOMAIN_QUERY_IGNORED (3):
    The out-of-domain query ignored case.

    Google skips the summary if there are no
    high-relevance search results. For example, the
    data store contains facts about company A but
    the user query is asking questions about company
    B.
POTENTIAL_POLICY_VIOLATION (4):
    The potential policy violation case.

    Google skips the summary if there is a potential
    policy violation detected. This includes content
    that may be violent or toxic.
LLM_ADDON_NOT_ENABLED (5):
    The LLM addon not enabled case.

    Google skips the summary if the LLM addon is not
    enabled.
NO_RELEVANT_CONTENT (6):
    The no relevant content case.

    Google skips the summary if there is no relevant
    content in the retrieved search results.
JAIL_BREAKING_QUERY_IGNORED (7):
    The jail-breaking query ignored case.

    For example, "Reply in the tone of a competing company's
    CEO". Only used when
    [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
    is set to `true`.
CUSTOMER_POLICY_VIOLATION (8):
    The customer policy violation case.

    Google skips the summary if there is a customer
    policy violation detected. The policy is defined
    by the customer.
NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 (9):
    The non-answer seeking query ignored case.

    Google skips the summary if the query doesn't have clear
    intent. Only used when
    [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
    is set to `true`.

Summary with metadata information.

Tiers of search features. Different tiers might have different pricing. To learn more, check the pricing documentation.

Defines a further subdivision of SolutionType. Specifically applies to SOLUTION_TYPE_SEARCH.

External session proto definition.

Enumeration of the state of the session.

Represents a turn, including a query from the user and a answer from service.

SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.

Verification information for target sites in advanced site search.

Site verification state.

The type of solution.

The Spanner source for importing data

Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.

Operator for matching with the generated suggestions.

A target site for the SiteSearchEngine.

Site search indexing failure reasons.

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

Failed due to insufficient quota.

Target site indexing status enumeration.

    1. target site deleted if unindexing is
        successful;
    2. state reverts to SUCCEEDED if the unindexing
        fails.

Possible target site types.

Defines text input.

Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for SearchTuningService.TrainCustomModel method.

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

Cloud Storage training data input.

Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.

The abstract base class for a message.

A transaction represents the entire purchase transaction.

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

Request for UpdateControl method.

Request for UpdateConversation method.

Request message for DataStoreService.UpdateDataStore method.

Request message for DocumentService.UpdateDocument method.

Request message for EngineService.UpdateEngine method.

Metadata for UpdateSchema LRO.

Request message for SchemaService.UpdateSchema method.

Request for UpdateSession method.

Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.UpdateTargetSite method.

UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.

The abstract base class for a message.

Information of an end user.

Config to store data store type configuration for workspace data

Specifies the type of Workspace App supported by this DataStore

Request message for WriteUserEvent method.

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

Service for managing Acl Configuration.

Service for managing Acl Configuration.

Service for displaying processed Chunk information of the customer's unstructured data.

Service for displaying processed Chunk information of the customer's unstructured data.

A pager for iterating through list_chunks requests.

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

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

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

A pager for iterating through list_chunks requests.

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

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

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

Service for Auto-Completion.

Service for Auto-Completion.

Service for performing CRUD operations on Controls. Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request.

Service for performing CRUD operations on Controls. Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request.

A pager for iterating through list_controls requests.

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

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

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

A pager for iterating through list_controls requests.

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

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

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

Service for conversational search.

Service for conversational search.

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.

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.

A pager for iterating through list_sessions requests.

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

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

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

A pager for iterating through list_sessions requests.

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

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

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

Service for managing DataStore configuration.

Service for managing DataStore configuration.

A pager for iterating through list_data_stores requests.

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

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

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

A pager for iterating through list_data_stores requests.

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

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

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

Service for ingesting Document information of the customer's website.

Service for ingesting Document information of the customer's website.

A pager for iterating through list_documents requests.

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

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

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

A pager for iterating through list_documents requests.

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

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

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

Service for managing Engine configuration.

Service for managing Engine configuration.

A pager for iterating through list_engines requests.

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

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

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

A pager for iterating through list_engines requests.

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

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

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

Service for managing billing estimations resources.

Service for managing billing estimations resources.

Service for managing Evaluations,

Service for managing Evaluations,

A pager for iterating through list_evaluation_results requests.

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

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

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

A pager for iterating through list_evaluation_results requests.

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

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

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

A pager for iterating through list_evaluations requests.

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

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

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

A pager for iterating through list_evaluations requests.

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

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

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

Service for grounded generation.

Service for grounded generation.

Service for operations on the Project.

Service for operations on the Project.

Service for ranking text records.

Service for ranking text records.

Service for making recommendations.

Service for making recommendations.

Service for managing SampleQuerys,

Service for managing SampleQuerys,

A pager for iterating through list_sample_queries requests.

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

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

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

A pager for iterating through list_sample_queries requests.

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

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

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

Service for managing SampleQuerySets,

Service for managing SampleQuerySets,

A pager for iterating through list_sample_query_sets requests.

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

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

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

A pager for iterating through list_sample_query_sets requests.

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

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

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

Service for managing Schemas.

Service for managing Schemas.

A pager for iterating through list_schemas requests.

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

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

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

A pager for iterating through list_schemas requests.

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

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

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

Service for search.

Service for search.

A pager for iterating through search requests.

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

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

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

A pager for iterating through search requests.

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

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

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

Service for search tuning.

Service for search tuning.

Service for operations related to ServingConfig.

Service for operations related to ServingConfig.

A pager for iterating through list_serving_configs requests.

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

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

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

A pager for iterating through list_serving_configs requests.

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

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

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

Service for managing site search related resources.

Service for managing site search related resources.

A pager for iterating through fetch_domain_verification_status requests.

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

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

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

A pager for iterating through fetch_domain_verification_status requests.

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

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

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

A pager for iterating through list_target_sites requests.

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

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

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

A pager for iterating through list_target_sites requests.

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

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

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

Service for ingesting end user actions on a website to Discovery Engine API.

Service for ingesting end user actions on a website to Discovery Engine API.

Access Control Configuration.

AlloyDB source import data from.

Defines an answer.

An enum for answer skipped reasons.

    Google skips the answer if there are no
    high-relevance search results.
POTENTIAL_POLICY_VIOLATION (4):
    The potential policy violation case.

    Google skips the answer if there is a potential
    policy violation detected. This includes content
    that may be violent or toxic.
NO_RELEVANT_CONTENT (5):
    The no relevant content case.

    Google skips the answer if there is no relevant
    content in the retrieved search results.
JAIL_BREAKING_QUERY_IGNORED (6):
    The jail-breaking query ignored case.

    For example, "Reply in the tone of a competing
    company's CEO". Google skips the answer if the
    query is classified as a jail-breaking query.
CUSTOMER_POLICY_VIOLATION (7):
    The customer policy violation case.

    Google skips the summary if there is a customer
    policy violation detected. The policy is defined
    by the customer.

Citation info for a segment.

Citation source.

Query understanding information.

Query classification information.

Query classification types.

Reference.

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

Chunk information.

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

Document metadata.

Structured search information.

Unstructured document information.

Chunk content.

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

Enumeration of the state of the answer generation.

Step information.

Action.

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

Observation.

Chunk information.

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

Snippet information.

Search action.

Enumeration of the state of the step.

Request message for ConversationalSearchService.AnswerQuery method.

Answer generation specification.

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

Answer Generation Model specification.

Answer generation prompt specification.

Query understanding specification.

Query classification specification.

Query classification types.

Query rephraser specification.

Related questions specification.

Safety specification.

Search specification.

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

Search parameters.

Search result list.

Search result.

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

Chunk information.

Unstructured document information.

Document context.

Extractive answer. Guide <https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers>__

Extractive segment. Guide <https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments>__

The abstract base class for a message.

Response message for ConversationalSearchService.AnswerQuery method.

Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.BatchCreateTargetSites method.

Response message for SiteSearchEngineService.BatchCreateTargetSites method.

Request message for DocumentService.BatchGetDocumentsMetadata method.

Matcher for the Documents. Currently supports matching by exact URIs.

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

Matcher for the Documents by exact uris.

Response message for DocumentService.BatchGetDocumentsMetadata method.

The metadata of a Document.

The value of the matcher that was used to match the Document.

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

The state of the Document.

Metadata related to the progress of the SiteSearchEngineService.BatchVerifyTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.BatchVerifyTargetSites method.

Response message for SiteSearchEngineService.BatchVerifyTargetSites method.

BigQuery source import data from.

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

The Bigtable Options object that contains information to support the import.

The column of the Bigtable.

The column family of the Bigtable.

The encoding mode of a Bigtable column or column family.

The abstract base class for a message.

The type of values in a Bigtable column or column family. The values are expected to be encoded using HBase Bytes.toBytes <https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/util/Bytes.html>__ function when the encoding value is set to BINARY.

The Cloud Bigtable source for importing data.

Request message for GroundedGenerationService.CheckGrounding method.

The abstract base class for a message.

Response message for the GroundedGenerationService.CheckGrounding method.

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

Text and citation info for a claim in the answer candidate.

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

Specification for the grounding check.

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

Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.

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

Metadata of the current chunk. This field is only populated on SearchService.Search API.

Document metadata contains the information of the document of the current chunk.

Page span of the chunk.

Cloud SQL source import data from.

Request message for CollectUserEvent method.

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

Request message for CompletionService.CompleteQuery method.

Response message for CompletionService.CompleteQuery method.

Suggestions as search queries.

Detailed completion information including completion attribution token and clicked completion info.

Autocomplete suggestions that are imported from Customer.

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

Defines circumstances to be checked before allowing a behavior

Matcher for search request query

Used for time-dependent conditions.

Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on SolutionType.

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

Adjusts order of products in returned list.

Specified which products may be included in results. Uses same filter as boost.

Redirects a shopper to the provided URI.

Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy".

External conversation proto definition.

Enumeration of the state of the conversation.

Defines context of the conversation

Defines a conversation message.

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

Request message for ConversationalSearchService.ConverseConversation method.

The abstract base class for a message.

Response message for ConversationalSearchService.ConverseConversation method.

Request for CreateControl method.

Request for CreateConversation method.

Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.

Request for DataStoreService.CreateDataStore method.

Request message for DocumentService.CreateDocument method.

Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.

Request for EngineService.CreateEngine method.

Metadata for EvaluationService.CreateEvaluation method.

Request message for EvaluationService.CreateEvaluation method.

Request message for SampleQueryService.CreateSampleQuery method.

Request message for SampleQuerySetService.CreateSampleQuerySet method.

Metadata for Create Schema LRO.

Request message for SchemaService.CreateSchema method.

Request for CreateSession method.

Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.CreateTargetSite method.

A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.

Defines custom fine tuning spec.

Metadata that describes a custom tuned model.

The abstract base class for a message.

The state of the model.

DataStore captures global settings and configs at the DataStore level.

Content config of the data store.

Request for DeleteControl method.

Request for DeleteConversation method.

Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for DataStoreService.DeleteDataStore method.

Request message for DocumentService.DeleteDocument method.

Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for EngineService.DeleteEngine method.

Request message for SampleQueryService.DeleteSampleQuery method.

Request message for SampleQuerySetService.DeleteSampleQuerySet method.

Metadata for DeleteSchema LRO.

Request message for SchemaService.DeleteSchema method.

Request for DeleteSession method.

Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.DeleteTargetSite method.

Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

Document captures all raw metadata information of items to be recommended or searched.

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

ACL Information of the Document.

AclRestriction to model complex inheritance restrictions.

Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document.

Document Hierarchy - Space_S --> Page_P.

Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2

Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } }

Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } }

Unstructured data linked to this document.

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

Index status of the document.

Detailed document information associated with a user event.

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

A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.

Configuration for chunking config.

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

Configuration for the layout based chunking.

Related configurations applied to a specific type of document parser.

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

The digital parsing configurations for documents.

The layout parsing configurations for documents.

The OCR parsing configurations for documents.

The abstract base class for a message.

Double list.

Defines embedding config, used for bring your own embeddings feature.

Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

Metadata that describes the training and serving parameters of an Engine.

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

Configurations for a Chat Engine.

Configurations for generating a Dialogflow agent.

Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.

Additional information of a Chat Engine. Fields in this message are output only.

Common configurations for an Engine.

Additional config specs for a Media Recommendation engine.

Custom threshold for cvr optimization_objective.

The training state of the engine.

Additional information of a recommendation engine.

Describes whether this engine have sufficient training data to be continuously trained.

The serving state of the recommendation engine.

Configurations for a Search Engine.

Additional config specs for a similar-items engine.

Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for EstimateBillingService.EstimateDataSize method

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

Data source contains files either in Cloud Storage or BigQuery.

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

Data source is a set of website patterns that we crawl to get the total number of websites.

URI patterns that we use to crawl.

Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.

Describes the specification of the evaluation.

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

Describes the specification of the query set.

Describes the state of an evaluation.

Fact Chunk.

The abstract base class for a message.

Request message for SiteSearchEngineService.FetchDomainVerificationStatus method.

Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.

Cloud FhirStore source import data from.

Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.

Optional source of the advanced site search field.

The setting of Completable options in schema.

The status of the dynamic facetable option of a schema field.

Field value type in the Schema.

    -  `id`: a string representing the location id
    -  `longitude`: a number representing the longitude
       coordinate of the location
    -  `latitude`: a number repesenting the latitude
       coordinate of the location
    -  `address`: a string representing the full address of
       the location

    `latitude` and `longitude` must always be provided
    together. At least one of a) `address` or b)
    `latitude`-`longitude` pair must be provided.
DATETIME (7):
    Field value type is Datetime. Datetime can be expressed as
    either:

    -  a number representing milliseconds-since-the-epoch
    -  a string representing milliseconds-since-the-epoch. e.g.
       `"1420070400001"`
    -  a string representing the `ISO
       8601 <https://en.wikipedia.org/wiki/ISO_8601>`__ date or
       date and time. e.g. `"2015-01-01"` or
       `"2015-01-01T12:10:30Z"`

Sets the filterable option for schema fields.

The setting of Indexable options in schema.

The setting of Retrievable options in schema.

The setting of Searchable options in schema.

Firestore source import data from.

Cloud Storage location for input content.

Request message for GetAclConfigRequest method.

Request for GetAnswer method.

Request message for ChunkService.GetChunk method.

Request for GetControl method.

Request for GetConversation method.

Request message for DataStoreService.GetDataStore method.

Request for DataStoreService.GetDocumentProcessingConfig method.

Request message for DocumentService.GetDocument method.

Request message for EngineService.GetEngine method.

Request message for EvaluationService.GetEvaluation method.

Request message for DocumentService.GetDocument method.

The format of the returned processed document. If unspecified, defaults to JSON.

The type of processing to return in the response.

Request message for ProjectService.GetProject method.

Request message for SampleQueryService.GetSampleQuery method.

Request message for SampleQuerySetService.GetSampleQuerySet method.

Request message for SchemaService.GetSchema method.

Request for GetServingConfig method.

Request for GetSession method.

Request message for SiteSearchEngineService.GetSiteSearchEngine method.

Request message for SiteSearchEngineService.GetTargetSite method.

Request message for SiteSearchEngineService.GetUriPatternDocumentData method.

Response message for SiteSearchEngineService.GetUriPatternDocumentData method.

The abstract base class for a message.

Grounding Fact.

The abstract base class for a message.

Defines guided search spec.

Identity Provider Config.

Third party IDP Config.

Identity Provider Type.

Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.ImportCompletionSuggestions method.

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

The inline source for CompletionSuggestions.

Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.

Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for Import methods.

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

The inline source for the input config for ImportDocuments method.

Indicates how imported documents are reconciled with the existing documents created or imported before.

Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

Configuration of destination for Import related errors.

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

Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SampleQueryService.ImportSampleQueries method.

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

The inline source for SampleQuerys.

Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.

Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.ImportSuggestionDenyListEntries method.

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

The inline source for SuggestionDenyListEntry.

Response message for CompletionService.ImportSuggestionDenyListEntries method.

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for the ImportUserEvents request.

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

The inline source for the input config for ImportUserEvents method.

Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

The industry vertical associated with the DataStore.

A floating point interval.

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

Language info for DataStore.

Request message for ChunkService.ListChunks method.

Response message for ChunkService.ListChunks method.

Request for ListControls method.

Response for ListControls method.

Request for ListConversations method.

Response for ListConversations method.

Request message for SearchTuningService.ListCustomModels method.

Response message for SearchTuningService.ListCustomModels method.

Request message for DataStoreService.ListDataStores method.

Response message for DataStoreService.ListDataStores method.

Request message for DocumentService.ListDocuments method.

Response message for DocumentService.ListDocuments method.

Request message for EngineService.ListEngines method.

Response message for EngineService.ListEngines method.

Request message for EvaluationService.ListEvaluationResults method.

Response message for EvaluationService.ListEvaluationResults method.

Represents the results of an evaluation for a single SampleQuery.

Request message for EvaluationService.ListEvaluations method.

Response message for EvaluationService.ListEvaluations method.

Request message for SampleQueryService.ListSampleQueries method.

Response message for SampleQueryService.ListSampleQueries method.

Request message for SampleQuerySetService.ListSampleQuerySets method.

Response message for SampleQuerySetService.ListSampleQuerySets method.

Request message for SchemaService.ListSchemas method.

Response message for SchemaService.ListSchemas method.

Request for ListServingConfigs method.

Response for ListServingConfigs method.

Request for ListSessions method.

Response for ListSessions method.

Request message for SiteSearchEngineService.ListTargetSites method.

Response message for SiteSearchEngineService.ListTargetSites method.

Media-specific user event information.

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

Detailed page information.

Detailed panel information associated with a user event.

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

Request for pausing training of an engine.

Principal identifier of a user or a group.

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

Document captures all raw metadata information of items to be recommended or searched.

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

Metadata and configurations for a Google Cloud project in the service.

Metadata about the terms of service.

The agreement states this terms of service.

The abstract base class for a message.

Metadata associated with a project provision operation.

Request for ProjectService.ProvisionProject method.

Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.PurgeCompletionSuggestions method.

Response message for CompletionService.PurgeCompletionSuggestions method.

Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for DocumentService.PurgeDocuments method.

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

The inline source for the input config for DocumentService.PurgeDocuments method.

Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Configuration of destination for Purge related errors.

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

Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.PurgeSuggestionDenyListEntries method.

Response message for CompletionService.PurgeSuggestionDenyListEntries method.

Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for PurgeUserEvents method.

Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Describes the metrics produced by the evaluation.

Stores the metric values at specific top-k levels.

Defines a user inputed query.

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

Request message for RankService.Rank method.

The abstract base class for a message.

Response message for RankService.Rank method.

Record message for RankService.Rank method.

Request message for Recommend method.

The abstract base class for a message.

The abstract base class for a message.

Response message for Recommend method.

RecommendationResult represents a generic recommendation result with associated metadata.

The abstract base class for a message.

Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.RecrawlUris method.

Response message for SiteSearchEngineService.RecrawlUris method.

Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.

Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.

CorpusType for the failed crawling operation.

Defines a reply message to user.

Defines reference in reply.

Request for ReportConsentChange method.

Type of consent acknowledgement (accept / reject).

At this moment, only ACCEPT action is supported.

Request for resuming training of an engine.

Sample Query captures metadata to be used for evaluation.

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

Query Entry captures metadata to be used for search evaluation.

Defines the parameters of the query's expected outcome.

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

A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.

Defines the structure and layout of a type of document data.

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

Add-on that provides additional functionality for search.

Detailed search information.

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

Request message for SearchService.Search method.

Boost specification to boost certain documents.

Boost applies to documents which match a condition.

Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.

The attribute(or function) for which the custom ranking is to be applied.

The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).

The interpolation type to be applied. Default will be linear (Piecewise Linear).

A specification for configuring the behavior of content search.

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

A specification for configuring the extractive content in a search response.

Specifies the search result mode. If unspecified, the search result mode defaults to DOCUMENTS.

A specification for configuring snippets in a search response.

A specification for configuring a summary returned in a search response.

Specification of the prompt to use with the model.

Specification of the model.

A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an INVALID_ARGUMENT error is returned.

The specification that uses customized query embedding vector to do semantic document retrieval.

Embedding vector.

A facet specification to perform faceted search.

Specifies how a facet is computed.

Specifies the image query input.

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

Specification to enable natural language understanding capabilities for search requests.

Enum describing under which condition filter extraction should occur.

The abstract base class for a message.

Specification to determine under which conditions query expansion should occur.

Enum describing under which condition query expansion should occur.

The relevance threshold of the search results. The higher relevance threshold is, the higher relevant results are shown and the less number of results are returned.

Specification for search as you type in search requests.

Enum describing under which condition search as you type should occur.

Session specification.

Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.

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

The specification for query spell correction.

Enum describing under which mode spell correction should occur.

The abstract base class for a message.

Response message for SearchService.Search method.

A facet result.

A facet value which contains value names and their count.

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

Debug information specifically related to forward geocoding issues arising from Geolocation Search.

Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.

Useful attribute for search result refinements.

Information describing what natural language understanding was done on the input query.

The filters that were extracted from the input query represented in a structured form.

Logical And operator.

The expression denoting the filter that was extracted from the input query.

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

Constraint of a geolocation field. Name of the geolocation field as defined in the schema.

Constraint expression of a number field. Example: price < 100.

The comparison operation that was performed.

Logical Or operator.

Constraint expression of a string field.

OneBoxResult is a holder for all results of specific type that we want to display in UI differently.

The type of One Box result.

Information describing query expansion including whether expansion has occurred.

Represents the search results.

The abstract base class for a message.

Information about the session.

Summary of the top N search results specified by the summary spec.

Citation info for a segment.

Citation metadata.

Citation source.

Document reference.

Chunk content.

Safety Attribute categories and their associated confidence scores.

An Enum for summary-skipped reasons.

    Only used when
    <xref uid="google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ignore_adversarial_query">SummarySpec.ignore_adversarial_query</xref>
    is set to `true`.
NON_SUMMARY_SEEKING_QUERY_IGNORED (2):
    The non-summary seeking query ignored case.

    Only used when
    <xref uid="google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_summary_seeking_query">SummarySpec.ignore_non_summary_seeking_query</xref>
    is set to `true`.
OUT_OF_DOMAIN_QUERY_IGNORED (3):
    The out-of-domain query ignored case.

    Google skips the summary if there are no
    high-relevance search results. For example, the
    data store contains facts about company A but
    the user query is asking questions about company
    B.
POTENTIAL_POLICY_VIOLATION (4):
    The potential policy violation case.

    Google skips the summary if there is a potential
    policy violation detected. This includes content
    that may be violent or toxic.
LLM_ADDON_NOT_ENABLED (5):
    The LLM addon not enabled case.

    Google skips the summary if the LLM addon is not
    enabled.
NO_RELEVANT_CONTENT (6):
    The no relevant content case.

    Google skips the summary if there is no relevant
    content in the retrieved search results.
JAIL_BREAKING_QUERY_IGNORED (7):
    The jail-breaking query ignored case.

    For example, "Reply in the tone of a competing company's
    CEO". Only used when
    [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
    is set to `true`.
CUSTOMER_POLICY_VIOLATION (8):
    The customer policy violation case.

    Google skips the summary if there is a customer
    policy violation detected. The policy is defined
    by the customer.
NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 (9):
    The non-answer seeking query ignored case.

    Only used when
    [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
    is set to `true`.

Summary with metadata information.

Tiers of search features. Different tiers might have different pricing. To learn more, check the pricing documentation.

Defines a further subdivision of SolutionType. Specifically applies to SOLUTION_TYPE_SEARCH.

Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.

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

Specifies the configurations needed for Generic Discovery.Currently we support:

• content_search_spec: configuration for generic content search.

Specifies the configurations needed for Media Discovery. Currently we support:

• demote_content_watched: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result.
• promote_fresh_content: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

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

External session proto definition.

Enumeration of the state of the session.

Represents a turn, including a query from the user and a answer from service.

Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.SetUriPatternDocumentData method.

The abstract base class for a message.

Response message for SiteSearchEngineService.SetUriPatternDocumentData method.

SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.

Verification information for target sites in advanced site search.

Site verification state.

The type of solution.

The Spanner source for importing data

Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.

Operator for matching with the generated suggestions.

A target site for the SiteSearchEngine.

Site search indexing failure reasons.

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

Failed due to insufficient quota.

Target site indexing status enumeration.

    1. target site deleted if unindexing is
        successful;
    2. state reverts to SUCCEEDED if the unindexing
        fails.

Possible target site types.

Defines text input.

Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for SearchTuningService.TrainCustomModel method.

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

Cloud Storage training data input.

Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.

The abstract base class for a message.

A transaction represents the entire purchase transaction.

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

Metadata associated with a tune operation.

Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).

Response associated with a tune operation.

Request message for UpdateAclConfig method.

Request for UpdateControl method.

Request for UpdateConversation method.

Request message for DataStoreService.UpdateDataStore method.

Request for DataStoreService.UpdateDocumentProcessingConfig method.

Request message for DocumentService.UpdateDocument method.

Request message for EngineService.UpdateEngine method.

Request message for SampleQueryService.UpdateSampleQuery method.

Request message for SampleQuerySetService.UpdateSampleQuerySet method.

Metadata for UpdateSchema LRO.

Request message for SchemaService.UpdateSchema method.

Request for UpdateServingConfig method.

Request for UpdateSession method.

Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.UpdateTargetSite method.

UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.

The abstract base class for a message.

Information of an end user.

Config to store data store type configuration for workspace data

Specifies the type of Workspace App supported by this DataStore

Request message for WriteUserEvent method.

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

Service for Auto-Completion.

Service for Auto-Completion.

Service for performing CRUD operations on Controls. Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request.

Service for performing CRUD operations on Controls. Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request.

A pager for iterating through list_controls requests.

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

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

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

A pager for iterating through list_controls requests.

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

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

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

Service for conversational search.

Service for conversational search.

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.

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.

A pager for iterating through list_sessions requests.

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

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

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

A pager for iterating through list_sessions requests.

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

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

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

Service for managing DataStore configuration.

Service for managing DataStore configuration.

A pager for iterating through list_data_stores requests.

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

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

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

A pager for iterating through list_data_stores requests.

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

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

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

Service for ingesting Document information of the customer's website.

Service for ingesting Document information of the customer's website.

A pager for iterating through list_documents requests.

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

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

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

A pager for iterating through list_documents requests.

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

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

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

Service for managing Engine configuration.

Service for managing Engine configuration.

A pager for iterating through list_engines requests.

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

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

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

A pager for iterating through list_engines requests.

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

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

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

Service for managing Evaluations,

Service for managing Evaluations,

A pager for iterating through list_evaluation_results requests.

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

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

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

A pager for iterating through list_evaluation_results requests.

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

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

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

A pager for iterating through list_evaluations requests.

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

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

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

A pager for iterating through list_evaluations requests.

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

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

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

Service for grounded generation.

Service for grounded generation.

Service for operations on the Project.

Service for operations on the Project.

Service for ranking text records.

Service for ranking text records.

Service for making recommendations.

Service for making recommendations.

Service for managing SampleQuerys,

Service for managing SampleQuerys,

A pager for iterating through list_sample_queries requests.

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

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

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

A pager for iterating through list_sample_queries requests.

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

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

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

Service for managing SampleQuerySets,

Service for managing SampleQuerySets,

A pager for iterating through list_sample_query_sets requests.

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

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

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

A pager for iterating through list_sample_query_sets requests.

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

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

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

Service for managing Schemas.

Service for managing Schemas.

A pager for iterating through list_schemas requests.

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

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

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

A pager for iterating through list_schemas requests.

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

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

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

Service for search.

Service for search.

A pager for iterating through search requests.

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

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

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

A pager for iterating through search_lite requests.

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

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

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

A pager for iterating through search_lite requests.

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

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

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

A pager for iterating through search requests.

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

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

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

Service for search tuning.

Service for search tuning.

Service for operations related to ServingConfig.

Service for operations related to ServingConfig.

A pager for iterating through list_serving_configs requests.

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

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

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

A pager for iterating through list_serving_configs requests.

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

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

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

Service for managing site search related resources.

Service for managing site search related resources.

A pager for iterating through fetch_domain_verification_status requests.

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

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

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

A pager for iterating through fetch_domain_verification_status requests.

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

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

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

A pager for iterating through list_target_sites requests.

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

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

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

A pager for iterating through list_target_sites requests.

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

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

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

Service for ingesting end user actions on a website to Discovery Engine API.

Service for ingesting end user actions on a website to Discovery Engine API.

Request message for CompletionService.AdvancedCompleteQuery method. .

Specification to boost suggestions based on the condtion of the suggestion.

Boost applies to suggestions which match a condition.

Suggestion type to return.

Response message for CompletionService.AdvancedCompleteQuery method.

Suggestions as content.

The type of the content returned for content suggestions.

Suggestions as people.

The type of the person based on the source.

Suggestions as search queries.

Suggestions from recent search history.

AlloyDB source import data from.

Defines an answer.

An enum for answer skipped reasons.

    Google skips the answer if the query is chit
    chat.
OUT_OF_DOMAIN_QUERY_IGNORED (3):
    The out-of-domain query ignored case.

    Google skips the answer if there are no
    high-relevance search results.
POTENTIAL_POLICY_VIOLATION (4):
    The potential policy violation case.

    Google skips the answer if there is a potential
    policy violation detected. This includes content
    that may be violent or toxic.
NO_RELEVANT_CONTENT (5):
    The no relevant content case.

    Google skips the answer if there is no relevant
    content in the retrieved search results.
JAIL_BREAKING_QUERY_IGNORED (6):
    The jail-breaking query ignored case.

    For example, "Reply in the tone of a competing
    company's CEO". Google skips the answer if the
    query is classified as a jail-breaking query.
CUSTOMER_POLICY_VIOLATION (7):
    The customer policy violation case.

    Google skips the summary if there is a customer
    policy violation detected. The policy is defined
    by the customer.
NON_ANSWER_SEEKING_QUERY_IGNORED_V2 (8):
    The non-answer seeking query ignored case.

    Google skips the answer if the query doesn't
    have clear intent.
LOW_GROUNDED_ANSWER (9):
    The low-grounded answer case.

    Google skips the answer if a well grounded
    answer was unable to be generated.

Citation info for a segment.

Citation source.

Query understanding information.

Query classification information.

Query classification types.

Reference.

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

Chunk information.

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

Document metadata.

Structured search information.

Unstructured document information.

Chunk content.

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

Enumeration of the state of the answer generation.

Step information.

Action.

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

Observation.

Chunk information.

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

Snippet information.

Search action.

Enumeration of the state of the step.

Request message for ConversationalSearchService.AnswerQuery method.

Answer generation specification.

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

Answer Generation Model specification.

Answer generation prompt specification.

Grounding specification.

Level to filter based on answer grounding.

Query understanding specification.

Query classification specification.

Query classification types.

Query rephraser specification.

Related questions specification.

Safety specification.

Search specification.

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

Search parameters.

Search result list.

Search result.

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

Chunk information.

Document metadata contains the information of the document of the current chunk.

Unstructured document information.

Document context.

Extractive answer. Guide <https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers>__

Extractive segment. Guide <https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments>__ Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets.

The abstract base class for a message.

Response message for ConversationalSearchService.AnswerQuery method.

Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.BatchCreateTargetSites method.

Response message for SiteSearchEngineService.BatchCreateTargetSites method.

Request message for DocumentService.BatchGetDocumentsMetadata method.

Matcher for the Documents by FHIR resource names.

Matcher for the Documents. Currently supports matching by exact URIs.

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

Matcher for the Documents by exact uris.

Response message for DocumentService.BatchGetDocumentsMetadata method.

The metadata of a Document.

The value of the matcher that was used to match the Document.

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

The state of the Document.

Metadata related to the progress of the SiteSearchEngineService.BatchVerifyTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.BatchVerifyTargetSites method.

Response message for SiteSearchEngineService.BatchVerifyTargetSites method.

BigQuery source import data from.

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

The Bigtable Options object that contains information to support the import.

The column of the Bigtable.

The column family of the Bigtable.

The encoding mode of a Bigtable column or column family.

The abstract base class for a message.

The type of values in a Bigtable column or column family. The values are expected to be encoded using HBase Bytes.toBytes <https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/util/Bytes.html>__ function when the encoding value is set to BINARY.

The Cloud Bigtable source for importing data.

Request message for GroundedGenerationService.CheckGrounding method.

The abstract base class for a message.

Response message for the GroundedGenerationService.CheckGrounding method.

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

Fact chunk for grounding check.

Text and citation info for a claim in the answer candidate.

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

Specification for the grounding check.

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

Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.

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

Metadata of the current chunk. This field is only populated on SearchService.Search API.

Document metadata contains the information of the document of the current chunk.

Page span of the chunk.

Cloud SQL source import data from.

Request message for CollectUserEvent method.

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

Request message for CompletionService.CompleteQuery method.

Response message for CompletionService.CompleteQuery method.

Suggestions as search queries.

Detailed completion information including completion attribution token and clicked completion info.

Autocomplete suggestions that are imported from Customer.

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

Defines circumstances to be checked before allowing a behavior

Matcher for search request query

Used for time-dependent conditions.

Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on SolutionType.

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

Adjusts order of products in returned list.

Specified which products may be included in results. Uses same filter as boost.

Redirects a shopper to the provided URI.

Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy".

External conversation proto definition.

Enumeration of the state of the conversation.

Defines context of the conversation

Defines a conversation message.

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

Request message for ConversationalSearchService.ConverseConversation method.

The abstract base class for a message.

Response message for ConversationalSearchService.ConverseConversation method.

Request for CreateControl method.

Request for CreateConversation method.

Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.

Request for DataStoreService.CreateDataStore method.

Request message for DocumentService.CreateDocument method.

Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.

Request for EngineService.CreateEngine method.

Metadata for EvaluationService.CreateEvaluation method.

Request message for EvaluationService.CreateEvaluation method.

Request message for SampleQueryService.CreateSampleQuery method.

Request message for SampleQuerySetService.CreateSampleQuerySet method.

Metadata for Create Schema LRO.

Request message for SchemaService.CreateSchema method.

Request for CreateSession method.

Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.CreateSitemap method.

Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.CreateTargetSite method.

A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.

Metadata that describes a custom tuned model.

The abstract base class for a message.

The state of the model.

DataStore captures global settings and configs at the DataStore level.

Estimation of data size per data store.

Content config of the data store.

Stores information regarding the serving configurations at DataStore level.

Request for DeleteControl method.

Request for DeleteConversation method.

Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for DataStoreService.DeleteDataStore method.

Request message for DocumentService.DeleteDocument method.

Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for EngineService.DeleteEngine method.

Request message for SampleQueryService.DeleteSampleQuery method.

Request message for SampleQuerySetService.DeleteSampleQuerySet method.

Metadata for DeleteSchema LRO.

Request message for SchemaService.DeleteSchema method.

Request for DeleteSession method.

Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.DeleteSitemap method.

Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.DeleteTargetSite method.

Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

Document captures all raw metadata information of items to be recommended or searched.

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

Unstructured data linked to this document.

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

Index status of the document.

Detailed document information associated with a user event.

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

A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser.

Configuration for chunking config.

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

Configuration for the layout based chunking.

Related configurations applied to a specific type of document parser.

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

The digital parsing configurations for documents.

The layout parsing configurations for documents.

The OCR parsing configurations for documents.

The abstract base class for a message.

Double list.

Defines embedding config, used for bring your own embeddings feature.

Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

Metadata that describes the training and serving parameters of an Engine.

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

Configurations for a Chat Engine.

Configurations for generating a Dialogflow agent.

Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.

Additional information of a Chat Engine. Fields in this message are output only.

Common configurations for an Engine.

Configurations for a Search Engine.

An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.

Describes the specification of the evaluation.

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

Describes the specification of the query set.

Describes the state of an evaluation.

Fact Chunk.

The abstract base class for a message.

Request message for SiteSearchEngineService.FetchDomainVerificationStatus method.

Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.

Request message for SiteSearchEngineService.FetchSitemaps method.

Matcher for the Sitemaps. Currently only supports uris matcher.

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

Matcher for the Sitemaps by their uris.

Response message for SiteSearchEngineService.FetchSitemaps method.

Contains a Sitemap and its metadata.

Cloud FhirStore source import data from.

Firestore source import data from.

Cloud Storage location for input content.

Top-level message sent by the client for the GenerateGroundedContent method.

Describes the options to customize dynamic retrieval.

Describes the predictor settings for dynamic retrieval.

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

The version of the predictor to be used in dynamic retrieval.

Content generation specification.

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

Grounding source.

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

Google Search config parameters.

Message to be used for grounding based on inline content.

The abstract base class for a message.

Message to be used for grounding with Vertex AI Search.

Grounding specification.

The abstract base class for a message.

Response for the GenerateGroundedContent method.

A response candidate generated from the model.

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

Citation for the generated content.

Describes the metadata about dynamic retrieval.

Describes the metadata about the dynamic retrieval predictor.

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

The version of the predictor which was used in dynamic retrieval.

Grounding info for a claim in the candidate and its support.

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

Describes the metadata associated with a retrieval step.

Describes the source to which the metadata is associated to.

Google search entry point.

Request for GetAnswer method.

Request for GetControl method.

Request for GetConversation method.

Request message for DataStoreService.GetDataStore method.

Request message for DocumentService.GetDocument method.

Request message for EngineService.GetEngine method.

Request message for EvaluationService.GetEvaluation method.

Request message for SampleQueryService.GetSampleQuery method.

Request message for SampleQuerySetService.GetSampleQuerySet method.

Request message for SchemaService.GetSchema method.

Request for GetServingConfig method.

Request for GetSession method.

Request message for SiteSearchEngineService.GetSiteSearchEngine method.

Request message for SiteSearchEngineService.GetTargetSite method.

Base structured datatype containing multi-part content of a message.

Single part of content.

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

Grounding configuration.

Grounding Fact.

The abstract base class for a message.

Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.ImportCompletionSuggestions method.

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

The inline source for CompletionSuggestions.

Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.

Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for Import methods.

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

The inline source for the input config for ImportDocuments method.

Indicates how imported documents are reconciled with the existing documents created or imported before.

Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

Configuration of destination for Import related errors.

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

Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SampleQueryService.ImportSampleQueries method.

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

The inline source for SampleQuerys.

Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.

Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.ImportSuggestionDenyListEntries method.

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

The inline source for SuggestionDenyListEntry.

Response message for CompletionService.ImportSuggestionDenyListEntries method.

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for the ImportUserEvents request.

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

The inline source for the input config for ImportUserEvents method.

Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

The industry vertical associated with the DataStore.

A floating point interval.

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

Language info for DataStore.

Request for ListControls method.

Response for ListControls method.

Request for ListConversations method.

Response for ListConversations method.

Request message for SearchTuningService.ListCustomModels method.

Response message for SearchTuningService.ListCustomModels method.

Request message for DataStoreService.ListDataStores method.

Response message for DataStoreService.ListDataStores method.

Request message for DocumentService.ListDocuments method.

Response message for DocumentService.ListDocuments method.

Request message for EngineService.ListEngines method.

Response message for EngineService.ListEngines method.

Request message for EvaluationService.ListEvaluationResults method.

Response message for EvaluationService.ListEvaluationResults method.

Represents the results of an evaluation for a single SampleQuery.

Request message for EvaluationService.ListEvaluations method.

Response message for EvaluationService.ListEvaluations method.

Request message for SampleQueryService.ListSampleQueries method.

Response message for SampleQueryService.ListSampleQueries method.

Request message for SampleQuerySetService.ListSampleQuerySets method.

Response message for SampleQuerySetService.ListSampleQuerySets method.

Request message for SchemaService.ListSchemas method.

Response message for SchemaService.ListSchemas method.

Request for ListServingConfigs method.

Response for ListServingConfigs method.

Request for ListSessions method.

Response for ListSessions method.

Request message for SiteSearchEngineService.ListTargetSites method.

Response message for SiteSearchEngineService.ListTargetSites method.

Media-specific user event information.

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

Configuration for Natural Language Query Understanding.

Mode of Natural Language Query Understanding. When the NaturalLanguageQueryUnderstandingConfig.Mode is ENABLED, the natural language understanding capabilities will be enabled for a search request if the NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition in the SearchRequest is ENABLED.

Detailed page information.

Detailed panel information associated with a user event.

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

Request for pausing training of an engine.

Metadata and configurations for a Google Cloud project in the service.

Metadata about the terms of service.

The agreement states this terms of service.

The abstract base class for a message.

Metadata associated with a project provision operation.

Request for ProjectService.ProvisionProject method.

Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.PurgeCompletionSuggestions method.

Response message for CompletionService.PurgeCompletionSuggestions method.

Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for DocumentService.PurgeDocuments method.

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

The inline source for the input config for DocumentService.PurgeDocuments method.

Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Configuration of destination for Purge related errors.

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

Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.PurgeSuggestionDenyListEntries method.

Response message for CompletionService.PurgeSuggestionDenyListEntries method.

Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for PurgeUserEvents method.

Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Describes the metrics produced by the evaluation.

Stores the metric values at specific top-k levels.

Defines a user inputed query.

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

Request message for RankService.Rank method.

The abstract base class for a message.

Response message for RankService.Rank method.

Record message for RankService.Rank method.

Request message for Recommend method.

The abstract base class for a message.

The abstract base class for a message.

Response message for Recommend method.

RecommendationResult represents a generic recommendation result with associated metadata.

The abstract base class for a message.

Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.RecrawlUris method.

Response message for SiteSearchEngineService.RecrawlUris method.

Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.

Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.

CorpusType for the failed crawling operation.

Defines a reply message to user.

Defines reference in reply.

Request for resuming training of an engine.

Sample Query captures metadata to be used for evaluation.

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

Query Entry captures metadata to be used for search evaluation.

Defines the parameters of the query's expected outcome.

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

A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.

Defines the structure and layout of a type of document data.

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

Add-on that provides additional functionality for search.

Detailed search information.

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

Request message for SearchService.Search method.

Boost specification to boost certain documents.

Boost applies to documents which match a condition.

Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.

The attribute(or function) for which the custom ranking is to be applied.

The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).

The interpolation type to be applied. Default will be linear (Piecewise Linear).

A specification for configuring the behavior of content search.

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

A specification for configuring the extractive content in a search response.

Specifies the search result mode. If unspecified, the search result mode defaults to DOCUMENTS.

A specification for configuring snippets in a search response.

A specification for configuring a summary returned in a search response.

Specification of the prompt to use with the model.

Specification of the model.

A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an INVALID_ARGUMENT error is returned.

The specification that uses customized query embedding vector to do semantic document retrieval.

Embedding vector.

A facet specification to perform faceted search.

Specifies how a facet is computed.

Specifies the image query input.

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

Specification to enable natural language understanding capabilities for search requests.

Enum describing under which condition filter extraction should occur.

The abstract base class for a message.

The specification for personalization.

The personalization mode of each search request.

Specification to determine under which conditions query expansion should occur.

Enum describing under which condition query expansion should occur.

The relevance threshold of the search results. The higher relevance threshold is, the higher relevant results are shown and the less number of results are returned.

Specification for search as you type in search requests.

Enum describing under which condition search as you type should occur.

Session specification.

Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.

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

The specification for query spell correction.

Enum describing under which mode spell correction should occur.

The abstract base class for a message.

Response message for SearchService.Search method.

A facet result.

A facet value which contains value names and their count.

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

Debug information specifically related to forward geocoding issues arising from Geolocation Search.

Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.

Useful attribute for search result refinements.

Information describing what natural language understanding was done on the input query.

The filters that were extracted from the input query represented in a structured form.

Logical And operator.

The expression denoting the filter that was extracted from the input query.

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

Constraint of a geolocation field. Name of the geolocation field as defined in the schema.

Constraint expression of a number field. Example: price < 100.

The comparison operation that was performed.

Logical Or operator.

Constraint expression of a string field.

OneBoxResult is a holder for all results of specific type that we want to display in UI differently.

The type of One Box result.

Information describing query expansion including whether expansion has occurred.

Represents the search results.

The abstract base class for a message.

Information about the session.

Summary of the top N search results specified by the summary spec.

Citation info for a segment.

Citation metadata.

Citation source.

Document reference.

Chunk content.

Safety Attribute categories and their associated confidence scores.

An Enum for summary-skipped reasons.

    Only used when
    <xref uid="google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ignore_adversarial_query">SummarySpec.ignore_adversarial_query</xref>
    is set to `true`.
NON_SUMMARY_SEEKING_QUERY_IGNORED (2):
    The non-summary seeking query ignored case.

    Google skips the summary if the query is chit chat. Only
    used when
    <xref uid="google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_summary_seeking_query">SummarySpec.ignore_non_summary_seeking_query</xref>
    is set to `true`.
OUT_OF_DOMAIN_QUERY_IGNORED (3):
    The out-of-domain query ignored case.

    Google skips the summary if there are no
    high-relevance search results. For example, the
    data store contains facts about company A but
    the user query is asking questions about company
    B.
POTENTIAL_POLICY_VIOLATION (4):
    The potential policy violation case.

    Google skips the summary if there is a potential
    policy violation detected. This includes content
    that may be violent or toxic.
LLM_ADDON_NOT_ENABLED (5):
    The LLM addon not enabled case.

    Google skips the summary if the LLM addon is not
    enabled.
NO_RELEVANT_CONTENT (6):
    The no relevant content case.

    Google skips the summary if there is no relevant
    content in the retrieved search results.
JAIL_BREAKING_QUERY_IGNORED (7):
    The jail-breaking query ignored case.

    For example, "Reply in the tone of a competing company's
    CEO". Only used when
    [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
    is set to `true`.
CUSTOMER_POLICY_VIOLATION (8):
    The customer policy violation case.

    Google skips the summary if there is a customer
    policy violation detected. The policy is defined
    by the customer.
NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 (9):
    The non-answer seeking query ignored case.

    Google skips the summary if the query doesn't have clear
    intent. Only used when
    [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
    is set to `true`.

Summary with metadata information.

Tiers of search features. Different tiers might have different pricing. To learn more, check the pricing documentation.

Defines a further subdivision of SolutionType. Specifically applies to SOLUTION_TYPE_SEARCH.

Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.

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

Specifies the configurations needed for Generic Discovery.Currently we support:

• content_search_spec: configuration for generic content search.

Specifies the configurations needed for Media Discovery. Currently we support:

• demote_content_watched: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result.
• promote_fresh_content: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

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

External session proto definition.

Enumeration of the state of the session.

Represents a turn, including a query from the user and a answer from service.

SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.

Verification information for target sites in advanced site search.

Site verification state.

A sitemap for the SiteSearchEngine.

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

The type of solution.

The Spanner source for importing data

Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.

Operator for matching with the generated suggestions.

A target site for the SiteSearchEngine.

Site search indexing failure reasons.

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

Failed due to insufficient quota.

Target site indexing status enumeration.

    1. target site deleted if unindexing is
        successful;
    2. state reverts to SUCCEEDED if the unindexing
        fails.

Possible target site types.

Defines text input.

Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for SearchTuningService.TrainCustomModel method.

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

Cloud Storage training data input.

Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.

The abstract base class for a message.

A transaction represents the entire purchase transaction.

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

Metadata associated with a tune operation.

Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).

Response associated with a tune operation.

Request for UpdateControl method.

Request for UpdateConversation method.

Request message for DataStoreService.UpdateDataStore method.

Request message for DocumentService.UpdateDocument method.

Request message for EngineService.UpdateEngine method.

Request message for SampleQueryService.UpdateSampleQuery method.

Request message for SampleQuerySetService.UpdateSampleQuerySet method.

Metadata for UpdateSchema LRO.

Request message for SchemaService.UpdateSchema method.

Request for UpdateServingConfig method.

Request for UpdateSession method.

Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.UpdateTargetSite method.

UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.

The abstract base class for a message.

Information of an end user.

Config to store data store type configuration for workspace data

Specifies the type of Workspace App supported by this DataStore

Request message for WriteUserEvent method.

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

API documentation for discoveryengine_v1.services.control_service.pagers module.

API documentation for discoveryengine_v1.services.conversational_search_service.pagers module.

API documentation for discoveryengine_v1.services.data_store_service.pagers module.

API documentation for discoveryengine_v1.services.document_service.pagers module.

API documentation for discoveryengine_v1.services.engine_service.pagers module.

API documentation for discoveryengine_v1.services.schema_service.pagers module.

API documentation for discoveryengine_v1.services.search_service.pagers module.

API documentation for discoveryengine_v1.services.site_search_engine_service.pagers module.

API documentation for discoveryengine_v1alpha.services.chunk_service.pagers module.

API documentation for discoveryengine_v1alpha.services.control_service.pagers module.

API documentation for discoveryengine_v1alpha.services.conversational_search_service.pagers module.

API documentation for discoveryengine_v1alpha.services.data_store_service.pagers module.

API documentation for discoveryengine_v1alpha.services.document_service.pagers module.

API documentation for discoveryengine_v1alpha.services.engine_service.pagers module.