Package Classes (0.11.11)

Service for Auto-Completion.

Service for Auto-Completion.

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.

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 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 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 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.

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.

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.

Values: ENCODING_UNSPECIFIED (0): The encoding is unspecified. TEXT (1): Text encoding. BINARY (2): Binary encoding.

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.

Values: TYPE_UNSPECIFIED (0): The type is unspecified. STRING (1): String type. NUMBER (2): Numerical type. INTEGER (3): Integer type. VAR_INTEGER (4): Variable length integer type. BIG_NUMERIC (5): BigDecimal type. BOOLEAN (6): Boolean type. JSON (7): JSON type.

The Cloud Bigtable source for importing data.

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.

External conversation proto definition.

Enumeration of the state of the conversation.

Values: STATE_UNSPECIFIED (0): Unknown. IN_PROGRESS (1): Conversation is currently open. COMPLETED (2): Conversation has been completed.

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 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.

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.

DataStore captures global settings and configs at the DataStore level.

Content config of the data store.

Values: CONTENT_CONFIG_UNSPECIFIED (0): Default value. NO_CONTENT (1): Only contains documents without any Document.content. CONTENT_REQUIRED (2): Only contains documents with Document.content. PUBLIC_WEBSITE (3): The data store is used for public website search.

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.

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

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

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.

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.

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 message for SiteSearchEngineService.GetSiteSearchEngine method.

Request message for SiteSearchEngineService.GetTargetSite method.

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.

Values: RECONCILIATION_MODE_UNSPECIFIED (0): Defaults to INCREMENTAL. INCREMENTAL (1): Inserts new documents or updates existing documents. FULL (2): Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location.

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.

Values: INDUSTRY_VERTICAL_UNSPECIFIED (0): Value used when unset. GENERIC (1): The generic vertical for documents that are not specific to any industry vertical. MEDIA (2): The media industry vertical. HEALTHCARE_FHIR (7): The healthcare FHIR vertical.

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 ListConversations method.

Response for ListConversations 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 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 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.

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.

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.

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.

Values: CORPUS_TYPE_UNSPECIFIED (0): Default value. DESKTOP (1): Denotes a crawling attempt for the desktop version of a page. MOBILE (2): Denotes a crawling attempt for the mobile version of a page.

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.

Values: SEARCH_ADD_ON_UNSPECIFIED (0): Default value when the enum is unspecified. This is invalid to use. SEARCH_ADD_ON_LLM (1): Large language model add-on.

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.

A specification for configuring the behavior of content search.

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

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.

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.

Values: CONDITION_UNSPECIFIED (0): Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED. DISABLED (1): Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero. AUTO (2): Automatic query expansion built by the Search API.

The specification for query spell correction.

Enum describing under which mode spell correction should occur.

Values: MODE_UNSPECIFIED (0): Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO. SUGGESTION_ONLY (1): Search API will try to find a spell suggestion if there is any and put in the SearchResponse.corrected_query. The spell suggestion will not be used as the search query. AUTO (2): Automatic spell correction built by the Search API. Search will be based on the corrected query if found.

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.

Summary of the top N search result 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.

Values: SUMMARY_SKIPPED_REASON_UNSPECIFIED (0): Default value. The summary skipped reason is not specified. ADVERSARIAL_QUERY_IGNORED (1): The adversarial query ignored case.

    Only populated 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.

    Only populated 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.

Summary with metadata information.

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

Values: SEARCH_TIER_UNSPECIFIED (0): Default value when the enum is unspecified. This is invalid to use. SEARCH_TIER_STANDARD (1): Standard tier. SEARCH_TIER_ENTERPRISE (2): Enterprise tier.

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.

Values: SITE_VERIFICATION_STATE_UNSPECIFIED (0): Defaults to VERIFIED. VERIFIED (1): Site ownership verified. UNVERIFIED (2): Site ownership pending verification or verification failed. EXEMPTED (3): Site exempt from verification, e.g., a public website that opens to all.

The type of solution.

Values: SOLUTION_TYPE_UNSPECIFIED (0): Default value. SOLUTION_TYPE_RECOMMENDATION (1): Used for Recommendations AI. SOLUTION_TYPE_SEARCH (2): Used for Discovery Search. SOLUTION_TYPE_CHAT (3): Used for use cases related to the Generative AI agent. SOLUTION_TYPE_GENERATIVE_CHAT (4): Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with SOLUTION_TYPE_CHAT 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.

Values: MATCH_OPERATOR_UNSPECIFIED (0): Default value. Should not be used EXACT_MATCH (1): If the suggestion is an exact match to the block_phrase, then block it. CONTAINS (2): If the suggestion contains the block_phrase, then block it.

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.

Values: INDEXING_STATUS_UNSPECIFIED (0): Defaults to SUCCEEDED. PENDING (1): The target site is in the update queue and will be picked up by indexing pipeline. FAILED (2): The target site fails to be indexed. SUCCEEDED (3): The target site has been indexed. DELETING (4): The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either:

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

Possible target site types.

Values: TYPE_UNSPECIFIED (0): This value is unused. In this case, server behavior defaults to Type.INCLUDE. INCLUDE (1): Include the target site. EXCLUDE (2): Exclude the target site.

Defines text input.

A transaction represents the entire purchase transaction.

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

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.

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 customers' website.

The abstract base class for a message.

Information of an end user.

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 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 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 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.

Defines an answer.

An enum for answer skipped reasons.

Values: ANSWER_SKIPPED_REASON_UNSPECIFIED (0): Default value. The answer skipped reason is not specified. ADVERSARIAL_QUERY_IGNORED (1): The adversarial query ignored case. NON_ANSWER_SEEKING_QUERY_IGNORED (2): The non-answer seeking query ignored case. 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.

Citation info for a segment.

Citation source.

Query understanding information.

Query classification information.

Query classification types.

Values: TYPE_UNSPECIFIED (0): Unspecified query classification type. ADVERSARIAL_QUERY (1): Adversarial query classification type. NON_ANSWER_SEEKING_QUERY (2): Non-answer-seeking query classification type.

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.

Unstructured document information.

Chunk content.

Enumeration of the state of the answer generation.

Values: STATE_UNSPECIFIED (0): Unknown. IN_PROGRESS (1): Answer generation is currently in progress. FAILED (2): Answer generation currently failed. SUCCEEDED (3): Answer generation has succeeded.

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.

Values: STATE_UNSPECIFIED (0): Unknown. IN_PROGRESS (1): Step is currently in progress. FAILED (2): Step currently failed. SUCCEEDED (3): Step has succeeded.

Request message for ConversationalSearchService.AnswerQuery method.

Answer generation specification.

Answer Generation Model specification.

Answer generation prompt specification.

Query understanding specification.

Query classification specification.

Query classification types.

Values: TYPE_UNSPECIFIED (0): Unspecified query classification type. ADVERSARIAL_QUERY (1): Adversarial query classification type. NON_ANSWER_SEEKING_QUERY (2): Non-answer-seeking query classification type.

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>__

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.

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.

Values: ENCODING_UNSPECIFIED (0): The encoding is unspecified. TEXT (1): Text encoding. BINARY (2): Binary encoding.

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.

Values: TYPE_UNSPECIFIED (0): The type is unspecified. STRING (1): String type. NUMBER (2): Numerical type. INTEGER (3): Integer type. VAR_INTEGER (4): Variable length integer type. BIG_NUMERIC (5): BigDecimal type. BOOLEAN (6): Boolean type. JSON (7): JSON type.

The Cloud Bigtable source for importing data.

Request message for GroundedGenerationService.CheckGrounding method.

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.

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.

External conversation proto definition.

Enumeration of the state of the conversation.

Values: STATE_UNSPECIFIED (0): Unknown. IN_PROGRESS (1): Conversation is currently open. COMPLETED (2): Conversation has been completed.

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 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.

Defines custom fine tuning spec.

DataStore captures global settings and configs at the DataStore level.

Content config of the data store.

Values: CONTENT_CONFIG_UNSPECIFIED (0): Default value. NO_CONTENT (1): Only contains documents without any Document.content. CONTENT_REQUIRED (2): Only contains documents with Document.content. PUBLIC_WEBSITE (3): The data store is used for public website search.

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

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

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.

Values: TRAINING_STATE_UNSPECIFIED (0): Unspecified training state. PAUSED (1): The engine training is paused. TRAINING (2): The engine is training.

Additional information of a recommendation engine.

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

Values: DATA_STATE_UNSPECIFIED (0): Unspecified default value, should never be explicitly set. DATA_OK (1): The engine has sufficient training data. DATA_ERROR (2): The engine does not have sufficient training data. Error messages can be queried via Stackdriver.

The serving state of the recommendation engine.

Values: SERVING_STATE_UNSPECIFIED (0): Unspecified serving state. INACTIVE (1): The engine is not serving. ACTIVE (2): The engine is serving and can be queried. TUNED (3): The engine is trained on tuned hyperparameters and can be queried.

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.

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.

Values: ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED (0): Value used when unset. METATAGS (1): Retrieve value from meta tag. PAGEMAP (2): Retrieve value from page map.

The setting of Completable options in schema.

Values: COMPLETABLE_OPTION_UNSPECIFIED (0): Value used when unset. COMPLETABLE_ENABLED (1): Completable option enabled for a schema field. COMPLETABLE_DISABLED (2): Completable option disabled for a schema field.

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

Values: DYNAMIC_FACETABLE_OPTION_UNSPECIFIED (0): Value used when unset. DYNAMIC_FACETABLE_ENABLED (1): Dynamic facetable option enabled for a schema field. DYNAMIC_FACETABLE_DISABLED (2): Dynamic facetable option disabled for a schema field.

Field value type in the Schema.

Values: FIELD_TYPE_UNSPECIFIED (0): Field type is unspecified. OBJECT (1): Field value type is Object. STRING (2): Field value type is String. NUMBER (3): Field value type is Number. INTEGER (4): Field value type is Integer. BOOLEAN (5): Field value type is Boolean. GEOLOCATION (6): Field value type is Geolocation. DATETIME (7): Field value type is Datetime.

Sets the filterable option for schema fields.

Values: FILTERABLE_OPTION_UNSPECIFIED (0): Value used when unset. FILTERABLE_ENABLED (1): Filterable option enabled for a schema field. FILTERABLE_DISABLED (2): Filterable option disabled for a schema field.

The setting of Indexable options in schema.

Values: INDEXABLE_OPTION_UNSPECIFIED (0): Value used when unset. INDEXABLE_ENABLED (1): Indexable option enabled for a schema field. INDEXABLE_DISABLED (2): Indexable option disabled for a schema field.

The setting of Retrievable options in schema.

Values: RETRIEVABLE_OPTION_UNSPECIFIED (0): Value used when unset. RETRIEVABLE_ENABLED (1): Retrievable option enabled for a schema field. RETRIEVABLE_DISABLED (2): Retrievable option disabled for a schema field.

The setting of Searchable options in schema.

Values: SEARCHABLE_OPTION_UNSPECIFIED (0): Value used when unset. SEARCHABLE_ENABLED (1): Searchable option enabled for a schema field. SEARCHABLE_DISABLED (2): Searchable option disabled for a schema field.

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 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 DocumentService.GetDocument method.

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

Values: PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED (0): Default value. JSON (1): output format will be a JSON string representation of processed document.

The type of processing to return in the response.

Values: PROCESSED_DOCUMENT_TYPE_UNSPECIFIED (0): Default value. PARSED_DOCUMENT (1): Available for all data store parsing configs. CHUNKED_DOCUMENT (2): Only available if ChunkingConfig is enabeld on the data store.

Request message for ProjectService.GetProject 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.

Grounding Fact.

The abstract base class for a message.

Defines guided search spec.

Identity Provider Config.

Third party IDP Config.

Identity Provider Type.

Values: IDP_TYPE_UNSPECIFIED (0): Default value. ACL search not enabled. GSUITE (1): Google 1P provider. THIRD_PARTY (2): Third party provider.

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.

Values: RECONCILIATION_MODE_UNSPECIFIED (0): Defaults to INCREMENTAL. INCREMENTAL (1): Inserts new documents or updates existing documents. FULL (2): Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location.

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.

Values: INDUSTRY_VERTICAL_UNSPECIFIED (0): Value used when unset. GENERIC (1): The generic vertical for documents that are not specific to any industry vertical. MEDIA (2): The media industry vertical. HEALTHCARE_FHIR (7): The healthcare FHIR vertical.

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 message for ChunkService.ListChunks method.

Response message for ChunkService.ListChunks method.

Request for ListConversations method.

Response for ListConversations 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 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.

Values: STATE_UNSPECIFIED (0): The default value of the enum. This value is not actually used. TERMS_ACCEPTED (1): The project has given consent to the terms of service. TERMS_PENDING (2): The project is pending to review and accept the terms of service. TERMS_DECLINED (3): The project has declined or revoked the agreement to 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 PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for DocumentService.PurgeDocuments method.

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

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.

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.

Values: CORPUS_TYPE_UNSPECIFIED (0): Default value. DESKTOP (1): Denotes a crawling attempt for the desktop version of a page. MOBILE (2): Denotes a crawling attempt for the mobile version of a page.

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.

Values: CONSENT_CHANGE_ACTION_UNSPECIFIED (0): Invalid action, user must specify accept/decline ACCEPT (1): User accepts service terms.

Request for resuming training of an engine.

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.

Values: SEARCH_ADD_ON_UNSPECIFIED (0): Default value when the enum is unspecified. This is invalid to use. SEARCH_ADD_ON_LLM (1): Large language model add-on.

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.

Values: ATTRIBUTE_TYPE_UNSPECIFIED (0): Unspecified AttributeType. NUMERICAL (1): The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified. FRESHNESS (2): For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD dayTimeDuration value (a restricted subset of an ISO 8601 duration value). The pattern for this is: [nD][TnH][nM][nS]]. E.g. 5D, 3DT12H30M, T24H.

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).

Values: INTERPOLATION_TYPE_UNSPECIFIED (0): Interpolation type is unspecified. In this case, it defaults to Linear. LINEAR (1): Piecewise linear interpolation will be applied.

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 is based on [DataStore.DocumentProcessingConfig.chunking_config][]:

• If [DataStore.DocumentProcessingConfig.chunking_config][] is specified, it defaults to CHUNKS.
• Otherwise, it defaults to DOCUMENTS.

Values: SEARCH_RESULT_MODE_UNSPECIFIED (0): Default value. DOCUMENTS (1): Returns documents in the search result. CHUNKS (2): Returns chunks in the search result. Only available if the [DataStore.DocumentProcessingConfig.chunking_config][] is specified.

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.

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

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.

Values: CONDITION_UNSPECIFIED (0): Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED. DISABLED (1): Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero. AUTO (2): Automatic query expansion built by the Search API.

The specification for query spell correction.

Enum describing under which mode spell correction should occur.

Values: MODE_UNSPECIFIED (0): Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO. SUGGESTION_ONLY (1): Search API will try to find a spell suggestion if there is any and put in the SearchResponse.corrected_query. The spell suggestion will not be used as the search query. AUTO (2): Automatic spell correction built by the Search API. Search will be based on the corrected query if found.

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 query expansion including whether expansion has occurred.

Represents the search results.

The abstract base class for a message.

Summary of the top N search result 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.

Values: SUMMARY_SKIPPED_REASON_UNSPECIFIED (0): Default value. The summary skipped reason is not specified. ADVERSARIAL_QUERY_IGNORED (1): The adversarial query ignored case.

    Only populated 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 populated 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.

Summary with metadata information.

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

Values: SEARCH_TIER_UNSPECIFIED (0): Default value when the enum is unspecified. This is invalid to use. SEARCH_TIER_STANDARD (1): Standard tier. SEARCH_TIER_ENTERPRISE (2): Enterprise tier.

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.

Values: STATE_UNSPECIFIED (0): State is unspecified. IN_PROGRESS (1): The session is currently open.

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.

Values: SITE_VERIFICATION_STATE_UNSPECIFIED (0): Defaults to VERIFIED. VERIFIED (1): Site ownership verified. UNVERIFIED (2): Site ownership pending verification or verification failed. EXEMPTED (3): Site exempt from verification, e.g., a public website that opens to all.

The type of solution.

Values: SOLUTION_TYPE_UNSPECIFIED (0): Default value. SOLUTION_TYPE_RECOMMENDATION (1): Used for Recommendations AI. SOLUTION_TYPE_SEARCH (2): Used for Discovery Search. SOLUTION_TYPE_CHAT (3): Used for use cases related to the Generative AI agent. SOLUTION_TYPE_GENERATIVE_CHAT (4): Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with SOLUTION_TYPE_CHAT 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.

Values: MATCH_OPERATOR_UNSPECIFIED (0): Default value. Should not be used EXACT_MATCH (1): If the suggestion is an exact match to the block_phrase, then block it. CONTAINS (2): If the suggestion contains the block_phrase, then block it.

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.

Values: INDEXING_STATUS_UNSPECIFIED (0): Defaults to SUCCEEDED. PENDING (1): The target site is in the update queue and will be picked up by indexing pipeline. FAILED (2): The target site fails to be indexed. SUCCEEDED (3): The target site has been indexed. DELETING (4): The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either:

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

Possible target site types.

Values: TYPE_UNSPECIFIED (0): This value is unused. In this case, server behavior defaults to Type.INCLUDE. INCLUDE (1): Include the target site. EXCLUDE (2): Exclude the target site.

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 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.

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 customers' website.

The abstract base class for a message.

Information of an end user.

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 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 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 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.

Defines an answer.

An enum for answer skipped reasons.

Values: ANSWER_SKIPPED_REASON_UNSPECIFIED (0): Default value. The answer skipped reason is not specified. ADVERSARIAL_QUERY_IGNORED (1): The adversarial query ignored case. NON_ANSWER_SEEKING_QUERY_IGNORED (2): The non-answer seeking query ignored case. 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.

Citation info for a segment.

Citation source.

Query understanding information.

Query classification information.

Query classification types.

Values: TYPE_UNSPECIFIED (0): Unspecified query classification type. ADVERSARIAL_QUERY (1): Adversarial query classification type. NON_ANSWER_SEEKING_QUERY (2): Non-answer-seeking query classification type.

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.

Unstructured document information.

Chunk content.

Enumeration of the state of the answer generation.

Values: STATE_UNSPECIFIED (0): Unknown. IN_PROGRESS (1): Answer generation is currently in progress. FAILED (2): Answer generation currently failed. SUCCEEDED (3): Answer generation has succeeded.

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.

Values: STATE_UNSPECIFIED (0): Unknown. IN_PROGRESS (1): Step is currently in progress. FAILED (2): Step currently failed. SUCCEEDED (3): Step has succeeded.

Request message for ConversationalSearchService.AnswerQuery method.

Answer generation specification.

Answer Generation Model specification.

Answer generation prompt specification.

Query understanding specification.

Query classification specification.

Query classification types.

Values: TYPE_UNSPECIFIED (0): Unspecified query classification type. ADVERSARIAL_QUERY (1): Adversarial query classification type. NON_ANSWER_SEEKING_QUERY (2): Non-answer-seeking query classification type.

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>__

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.

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.

Values: ENCODING_UNSPECIFIED (0): The encoding is unspecified. TEXT (1): Text encoding. BINARY (2): Binary encoding.

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.

Values: TYPE_UNSPECIFIED (0): The type is unspecified. STRING (1): String type. NUMBER (2): Numerical type. INTEGER (3): Integer type. VAR_INTEGER (4): Variable length integer type. BIG_NUMERIC (5): BigDecimal type. BOOLEAN (6): Boolean type. JSON (7): JSON type.

The Cloud Bigtable source for importing data.

Request message for GroundedGenerationService.CheckGrounding method.

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

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.

External conversation proto definition.

Enumeration of the state of the conversation.

Values: STATE_UNSPECIFIED (0): Unknown. IN_PROGRESS (1): Conversation is currently open. COMPLETED (2): Conversation has been completed.

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 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.

DataStore captures global settings and configs at the DataStore level.

Content config of the data store.

Values: CONTENT_CONFIG_UNSPECIFIED (0): Default value. NO_CONTENT (1): Only contains documents without any Document.content. CONTENT_REQUIRED (2): Only contains documents with Document.content. PUBLIC_WEBSITE (3): The data store is used for public website search.

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

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.

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 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.

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.

Request for GetAnswer 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 GetServingConfig method.

Request for GetSession method.

Request message for SiteSearchEngineService.GetSiteSearchEngine method.

Request message for SiteSearchEngineService.GetTargetSite method.

Grounding Fact.

The abstract base class for a message.

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.

Values: RECONCILIATION_MODE_UNSPECIFIED (0): Defaults to INCREMENTAL. INCREMENTAL (1): Inserts new documents or updates existing documents. FULL (2): Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location.

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.

Values: INDUSTRY_VERTICAL_UNSPECIFIED (0): Value used when unset. GENERIC (1): The generic vertical for documents that are not specific to any industry vertical. MEDIA (2): The media industry vertical. HEALTHCARE_FHIR (7): The healthcare FHIR vertical.

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 ListConversations method.

Response for ListConversations 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 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.

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.

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.

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.

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.

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.

Values: CORPUS_TYPE_UNSPECIFIED (0): Default value. DESKTOP (1): Denotes a crawling attempt for the desktop version of a page. MOBILE (2): Denotes a crawling attempt for the mobile version of a page.

Defines a reply message to user.

Defines reference in reply.

Request for resuming training of an engine.

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.

Values: SEARCH_ADD_ON_UNSPECIFIED (0): Default value when the enum is unspecified. This is invalid to use. SEARCH_ADD_ON_LLM (1): Large language model add-on.

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.

Values: ATTRIBUTE_TYPE_UNSPECIFIED (0): Unspecified AttributeType. NUMERICAL (1): The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified. FRESHNESS (2): For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD dayTimeDuration value (a restricted subset of an ISO 8601 duration value). The pattern for this is: [nD][TnH][nM][nS]]. E.g. 5D, 3DT12H30M, T24H.

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).

Values: INTERPOLATION_TYPE_UNSPECIFIED (0): Interpolation type is unspecified. In this case, it defaults to Linear. LINEAR (1): Piecewise linear interpolation will be applied.

A specification for configuring the behavior of content search.

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

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.

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

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.

Values: CONDITION_UNSPECIFIED (0): Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED. DISABLED (1): Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero. AUTO (2): Automatic query expansion built by the Search API.

The specification for query spell correction.

Enum describing under which mode spell correction should occur.

Values: MODE_UNSPECIFIED (0): Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO. SUGGESTION_ONLY (1): Search API will try to find a spell suggestion if there is any and put in the SearchResponse.corrected_query. The spell suggestion will not be used as the search query. AUTO (2): Automatic spell correction built by the Search API. Search will be based on the corrected query if found.

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 query expansion including whether expansion has occurred.

Represents the search results.

The abstract base class for a message.

Summary of the top N search result 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.

Values: SUMMARY_SKIPPED_REASON_UNSPECIFIED (0): Default value. The summary skipped reason is not specified. ADVERSARIAL_QUERY_IGNORED (1): The adversarial query ignored case.

    Only populated 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.

    Only populated 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.

Summary with metadata information.

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

Values: SEARCH_TIER_UNSPECIFIED (0): Default value when the enum is unspecified. This is invalid to use. SEARCH_TIER_STANDARD (1): Standard tier. SEARCH_TIER_ENTERPRISE (2): Enterprise tier.

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.

Values: STATE_UNSPECIFIED (0): State is unspecified. IN_PROGRESS (1): The session is currently open.

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.

Values: SITE_VERIFICATION_STATE_UNSPECIFIED (0): Defaults to VERIFIED. VERIFIED (1): Site ownership verified. UNVERIFIED (2): Site ownership pending verification or verification failed. EXEMPTED (3): Site exempt from verification, e.g., a public website that opens to all.

The type of solution.

Values: SOLUTION_TYPE_UNSPECIFIED (0): Default value. SOLUTION_TYPE_RECOMMENDATION (1): Used for Recommendations AI. SOLUTION_TYPE_SEARCH (2): Used for Discovery Search. SOLUTION_TYPE_CHAT (3): Used for use cases related to the Generative AI agent. SOLUTION_TYPE_GENERATIVE_CHAT (4): Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with SOLUTION_TYPE_CHAT 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.

Values: MATCH_OPERATOR_UNSPECIFIED (0): Default value. Should not be used EXACT_MATCH (1): If the suggestion is an exact match to the block_phrase, then block it. CONTAINS (2): If the suggestion contains the block_phrase, then block it.

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.

Values: INDEXING_STATUS_UNSPECIFIED (0): Defaults to SUCCEEDED. PENDING (1): The target site is in the update queue and will be picked up by indexing pipeline. FAILED (2): The target site fails to be indexed. SUCCEEDED (3): The target site has been indexed. DELETING (4): The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either:

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

Possible target site types.

Values: TYPE_UNSPECIFIED (0): This value is unused. In this case, server behavior defaults to Type.INCLUDE. INCLUDE (1): Include the target site. EXCLUDE (2): Exclude the target site.

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 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 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 customers' website.

The abstract base class for a message.

Information of an end user.

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.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.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.

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

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

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

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

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

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

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

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

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

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

API documentation for discoveryengine_v1beta.services.serving_config_service.pagers module.

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