Package Classes (0.11.11)

Version 0.11.11

• 0.13.4 (latest)
• 0.13.3
• 0.12.3
• 0.11.14
• 0.10.0
• 0.9.1
• 0.8.1
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.1
• 0.2.1
• 0.1.1

Summary of entries of Classes for discoveryengine.

Classes

CompletionServiceAsyncClient

Service for Auto-Completion.

CompletionServiceClient

Service for Auto-Completion.

ConversationalSearchServiceAsyncClient

Service for conversational search.

ConversationalSearchServiceClient

Service for conversational search.

ListConversationsAsyncPager

A pager for iterating through list_conversations requests.

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

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

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

ListConversationsPager

A pager for iterating through list_conversations requests.

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

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

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

DataStoreServiceAsyncClient

Service for managing DataStore configuration.

DataStoreServiceClient

Service for managing DataStore configuration.

ListDataStoresAsyncPager

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.

ListDataStoresPager

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.

DocumentServiceAsyncClient

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

DocumentServiceClient

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

ListDocumentsAsyncPager

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.

ListDocumentsPager

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.

EngineServiceAsyncClient

Service for managing Engine configuration.

EngineServiceClient

Service for managing Engine configuration.

ListEnginesAsyncPager

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.

ListEnginesPager

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.

RecommendationServiceAsyncClient

Service for making recommendations.

RecommendationServiceClient

Service for making recommendations.

SchemaServiceAsyncClient

Service for managing Schemas.

SchemaServiceClient

Service for managing Schemas.

ListSchemasAsyncPager

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.

ListSchemasPager

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.

SearchServiceAsyncClient

Service for search.

SearchServiceClient

Service for search.

SearchAsyncPager

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.

SearchPager

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.

SiteSearchEngineServiceAsyncClient

Service for managing site search related resources.

SiteSearchEngineServiceClient

Service for managing site search related resources.

FetchDomainVerificationStatusAsyncPager

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.

FetchDomainVerificationStatusPager

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.

ListTargetSitesAsyncPager

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.

ListTargetSitesPager

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.

UserEventServiceAsyncClient

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

UserEventServiceClient

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

BatchCreateTargetSiteMetadata

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

BatchCreateTargetSitesRequest

Request message for SiteSearchEngineService.BatchCreateTargetSites method.

BatchCreateTargetSitesResponse

Response message for SiteSearchEngineService.BatchCreateTargetSites method.

BatchVerifyTargetSitesMetadata

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

BatchVerifyTargetSitesRequest

Request message for SiteSearchEngineService.BatchVerifyTargetSites method.

BatchVerifyTargetSitesResponse

Response message for SiteSearchEngineService.BatchVerifyTargetSites method.

BigQuerySource

BigQuery source import data from.

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

BigtableOptions

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

BigtableColumn

The column of the Bigtable.

BigtableColumnFamily

The column family of the Bigtable.

Encoding

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.

FamiliesEntry

The abstract base class for a message.

Type

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.

BigtableSource

The Cloud Bigtable source for importing data.

CloudSqlSource

Cloud SQL source import data from.

CollectUserEventRequest

Request message for CollectUserEvent method.

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

CompleteQueryRequest

Request message for CompletionService.CompleteQuery method.

CompleteQueryResponse

Response message for CompletionService.CompleteQuery method.

QuerySuggestion

Suggestions as search queries.

CompletionInfo

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

Conversation

External conversation proto definition.

State

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.

ConversationContext

Defines context of the conversation

ConversationMessage

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

ConverseConversationRequest

Request message for ConversationalSearchService.ConverseConversation method.

UserLabelsEntry

The abstract base class for a message.

ConverseConversationResponse

Response message for ConversationalSearchService.ConverseConversation method.

CreateConversationRequest

Request for CreateConversation method.

CreateDataStoreMetadata

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

CreateDataStoreRequest

Request for DataStoreService.CreateDataStore method.

CreateDocumentRequest

Request message for DocumentService.CreateDocument method.

CreateEngineMetadata

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

CreateEngineRequest

Request for EngineService.CreateEngine method.

CreateSchemaMetadata

Metadata for Create Schema LRO.

CreateSchemaRequest

Request message for SchemaService.CreateSchema method.

CreateTargetSiteMetadata

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

CreateTargetSiteRequest

Request message for SiteSearchEngineService.CreateTargetSite method.

CustomAttribute

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

DataStore

DataStore captures global settings and configs at the DataStore level.

ContentConfig

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.

DeleteConversationRequest

Request for DeleteConversation method.

DeleteDataStoreMetadata

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

DeleteDataStoreRequest

Request message for DataStoreService.DeleteDataStore method.

DeleteDocumentRequest

Request message for DocumentService.DeleteDocument method.

DeleteEngineMetadata

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

DeleteEngineRequest

Request message for EngineService.DeleteEngine method.

DeleteSchemaMetadata

Metadata for DeleteSchema LRO.

DeleteSchemaRequest

Request message for SchemaService.DeleteSchema method.

DeleteTargetSiteMetadata

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

DeleteTargetSiteRequest

Request message for SiteSearchEngineService.DeleteTargetSite method.

DisableAdvancedSiteSearchMetadata

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

DisableAdvancedSiteSearchRequest

Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

DisableAdvancedSiteSearchResponse

Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

Document

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

Content

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

DocumentInfo

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

EnableAdvancedSiteSearchMetadata

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

EnableAdvancedSiteSearchRequest

Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

EnableAdvancedSiteSearchResponse

Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

Engine

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

ChatEngineConfig

Configurations for a Chat Engine.

AgentCreationConfig

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.

ChatEngineMetadata

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

CommonConfig

Common configurations for an Engine.

SearchEngineConfig

Configurations for a Search Engine.

FetchDomainVerificationStatusRequest

Request message for SiteSearchEngineService.FetchDomainVerificationStatus method.

FetchDomainVerificationStatusResponse

Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.

FhirStoreSource

Cloud FhirStore source import data from.

FirestoreSource

Firestore source import data from.

GcsSource

Cloud Storage location for input content.

GetConversationRequest

Request for GetConversation method.

GetDataStoreRequest

Request message for DataStoreService.GetDataStore method.

GetDocumentRequest

Request message for DocumentService.GetDocument method.

GetEngineRequest

Request message for EngineService.GetEngine method.

GetSchemaRequest

Request message for SchemaService.GetSchema method.

GetSiteSearchEngineRequest

Request message for SiteSearchEngineService.GetSiteSearchEngine method.

GetTargetSiteRequest

Request message for SiteSearchEngineService.GetTargetSite method.

ImportDocumentsMetadata

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

ImportDocumentsRequest

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

InlineSource

The inline source for the input config for ImportDocuments method.

ReconciliationMode

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.

ImportDocumentsResponse

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.

ImportErrorConfig

Configuration of destination for Import related errors.

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

ImportSuggestionDenyListEntriesMetadata

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

ImportSuggestionDenyListEntriesRequest

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

InlineSource

The inline source for SuggestionDenyListEntry.

ImportSuggestionDenyListEntriesResponse

Response message for CompletionService.ImportSuggestionDenyListEntries method.

ImportUserEventsMetadata

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

ImportUserEventsRequest

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

InlineSource

The inline source for the input config for ImportUserEvents method.

ImportUserEventsResponse

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.

IndustryVertical

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.

Interval

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

ListConversationsRequest

Request for ListConversations method.

ListConversationsResponse

Response for ListConversations method.

ListDataStoresRequest

Request message for DataStoreService.ListDataStores method.

ListDataStoresResponse

Response message for DataStoreService.ListDataStores method.

ListDocumentsRequest

Request message for DocumentService.ListDocuments method.

ListDocumentsResponse

Response message for DocumentService.ListDocuments method.

ListEnginesRequest

Request message for EngineService.ListEngines method.

ListEnginesResponse

Response message for EngineService.ListEngines method.

ListSchemasRequest

Request message for SchemaService.ListSchemas method.

ListSchemasResponse

Response message for SchemaService.ListSchemas method.

ListTargetSitesRequest

Request message for SiteSearchEngineService.ListTargetSites method.

ListTargetSitesResponse

Response message for SiteSearchEngineService.ListTargetSites method.

MediaInfo

Media-specific user event information.

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

PageInfo

Detailed page information.

PanelInfo

Detailed panel information associated with a user event.

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

PurgeDocumentsMetadata

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

PurgeDocumentsRequest

Request message for DocumentService.PurgeDocuments method.

PurgeDocumentsResponse

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.

PurgeSuggestionDenyListEntriesMetadata

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

PurgeSuggestionDenyListEntriesRequest

Request message for CompletionService.PurgeSuggestionDenyListEntries method.

PurgeSuggestionDenyListEntriesResponse

Response message for CompletionService.PurgeSuggestionDenyListEntries method.

RecommendRequest

Request message for Recommend method.

ParamsEntry

The abstract base class for a message.

UserLabelsEntry

The abstract base class for a message.

RecommendResponse

Response message for Recommend method.

RecommendationResult

RecommendationResult represents a generic recommendation result with associated metadata.

MetadataEntry

The abstract base class for a message.

RecrawlUrisMetadata

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

RecrawlUrisRequest

Request message for SiteSearchEngineService.RecrawlUris method.

RecrawlUrisResponse

Response message for SiteSearchEngineService.RecrawlUris method.

FailureInfo

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

FailureReason

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

CorpusType

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.

Reply

Defines a reply message to user.

Schema

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

SearchAddOn

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.

SearchInfo

Detailed search information.

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

SearchRequest

Request message for SearchService.Search method.

BoostSpec

Boost specification to boost certain documents.

ConditionBoostSpec

Boost applies to documents which match a condition.

ContentSearchSpec

A specification for configuring the behavior of content search.

ExtractiveContentSpec

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

SnippetSpec

A specification for configuring snippets in a search response.

SummarySpec

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

ModelPromptSpec

Specification of the prompt to use with the model.

ModelSpec

Specification of the model.

DataStoreSpec

A struct to define data stores to filter on in a search call.

FacetSpec

A facet specification to perform faceted search.

FacetKey

Specifies how a facet is computed.

ImageQuery

Specifies the image query input.

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

ParamsEntry

The abstract base class for a message.

QueryExpansionSpec

Specification to determine under which conditions query expansion should occur.

Condition

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.

SpellCorrectionSpec

The specification for query spell correction.

Mode

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.

UserLabelsEntry

The abstract base class for a message.

SearchResponse

Response message for SearchService.Search method.

Facet

A facet result.

FacetValue

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

QueryExpansionInfo

Information describing query expansion including whether expansion has occurred.

SearchResult

Represents the search results.

Summary

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

Citation

Citation info for a segment.

CitationMetadata

Citation metadata.

CitationSource

Citation source.

Reference

Document reference.

ChunkContent

Chunk content.

SafetyAttributes

Safety Attribute categories and their associated confidence scores.

SummarySkippedReason

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.

SummaryWithMetadata

Summary with metadata information.

SearchTier

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

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

SiteVerificationInfo

Verification information for target sites in advanced site search.

SiteVerificationState

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.

SolutionType

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.

SpannerSource

The Spanner source for importing data

SuggestionDenyListEntry

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

MatchOperator

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.

TargetSite

A target site for the SiteSearchEngine.

FailureReason

Site search indexing failure reasons.

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

QuotaFailure

Failed due to insufficient quota.

IndexingStatus

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.

Type

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.

TextInput

Defines text input.

TransactionInfo

A transaction represents the entire purchase transaction.

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

UpdateConversationRequest

Request for UpdateConversation method.

UpdateDataStoreRequest

Request message for DataStoreService.UpdateDataStore method.

UpdateDocumentRequest

Request message for DocumentService.UpdateDocument method.

UpdateEngineRequest

Request message for EngineService.UpdateEngine method.

UpdateSchemaMetadata

Metadata for UpdateSchema LRO.

UpdateSchemaRequest

Request message for SchemaService.UpdateSchema method.

UpdateTargetSiteMetadata

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

UpdateTargetSiteRequest

Request message for SiteSearchEngineService.UpdateTargetSite method.

UserEvent

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

AttributesEntry

The abstract base class for a message.

UserInfo

Information of an end user.

WriteUserEventRequest

Request message for WriteUserEvent method.

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

AclConfigServiceAsyncClient

Service for managing Acl Configuration.

AclConfigServiceClient

Service for managing Acl Configuration.

ChunkServiceAsyncClient

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

ChunkServiceClient

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

ListChunksAsyncPager

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.

ListChunksPager

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.

CompletionServiceAsyncClient

Service for Auto-Completion.

CompletionServiceClient

Service for Auto-Completion.

ConversationalSearchServiceAsyncClient

Service for conversational search.

ConversationalSearchServiceClient

Service for conversational search.

ListConversationsAsyncPager

A pager for iterating through list_conversations requests.

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

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

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

ListConversationsPager

A pager for iterating through list_conversations requests.

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

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

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

ListSessionsAsyncPager

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.

ListSessionsPager

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.

DataStoreServiceAsyncClient

Service for managing DataStore configuration.

DataStoreServiceClient

Service for managing DataStore configuration.

ListDataStoresAsyncPager

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.

ListDataStoresPager

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.

DocumentServiceAsyncClient

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

DocumentServiceClient

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

ListDocumentsAsyncPager

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.

ListDocumentsPager

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.

EngineServiceAsyncClient

Service for managing Engine configuration.

EngineServiceClient

Service for managing Engine configuration.

ListEnginesAsyncPager

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.

ListEnginesPager

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.

EstimateBillingServiceAsyncClient

Service for managing billing estimations resources.

EstimateBillingServiceClient

Service for managing billing estimations resources.

GroundedGenerationServiceAsyncClient

Service for grounded generation.

GroundedGenerationServiceClient

Service for grounded generation.

ProjectServiceAsyncClient

Service for operations on the Project.

ProjectServiceClient

Service for operations on the Project.

RankServiceAsyncClient

Service for ranking text records.

RankServiceClient

Service for ranking text records.

RecommendationServiceAsyncClient

Service for making recommendations.

RecommendationServiceClient

Service for making recommendations.

SchemaServiceAsyncClient

Service for managing Schemas.

SchemaServiceClient

Service for managing Schemas.

ListSchemasAsyncPager

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.

ListSchemasPager

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.

SearchServiceAsyncClient

Service for search.

SearchServiceClient

Service for search.

SearchAsyncPager

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.

SearchPager

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.

SearchTuningServiceAsyncClient

Service for search tuning.

SearchTuningServiceClient

Service for search tuning.

ServingConfigServiceAsyncClient

Service for operations related to ServingConfig.

ServingConfigServiceClient

Service for operations related to ServingConfig.

ListServingConfigsAsyncPager

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.

ListServingConfigsPager

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.

SiteSearchEngineServiceAsyncClient

Service for managing site search related resources.

SiteSearchEngineServiceClient

Service for managing site search related resources.

FetchDomainVerificationStatusAsyncPager

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.

FetchDomainVerificationStatusPager

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.

ListTargetSitesAsyncPager

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.

ListTargetSitesPager

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.

UserEventServiceAsyncClient

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

UserEventServiceClient

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

AclConfig

Access Control Configuration.

Answer

Defines an answer.

AnswerSkippedReason

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

Citation info for a segment.

CitationSource

Citation source.

QueryUnderstandingInfo

Query understanding information.

QueryClassificationInfo

Query classification information.

Type

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

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

ChunkInfo

Chunk information.

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

DocumentMetadata

Document metadata.

UnstructuredDocumentInfo

Unstructured document information.

ChunkContent

Chunk content.

State

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

Step information.

Action

Action.

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

Observation

Observation.

SearchResult

ChunkInfo

Chunk information.

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

SnippetInfo

Snippet information.

SearchAction

Search action.

State

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.

AnswerQueryRequest

Request message for ConversationalSearchService.AnswerQuery method.

AnswerGenerationSpec

Answer generation specification.

ModelSpec

Answer Generation Model specification.

PromptSpec

Answer generation prompt specification.

QueryUnderstandingSpec

Query understanding specification.

QueryClassificationSpec

Query classification specification.

Type

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.

QueryRephraserSpec

Query rephraser specification.

RelatedQuestionsSpec

Related questions specification.

SafetySpec

Safety specification.

SearchSpec

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

SearchParams

Search parameters.

SearchResultList

Search result list.

SearchResult

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

ChunkInfo

Chunk information.

UnstructuredDocumentInfo

Unstructured document information.

DocumentContext

Document context.

ExtractiveAnswer

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

ExtractiveSegment

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

AnswerQueryResponse

Response message for ConversationalSearchService.AnswerQuery method.

BatchCreateTargetSiteMetadata

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

BatchCreateTargetSitesRequest

Request message for SiteSearchEngineService.BatchCreateTargetSites method.

BatchCreateTargetSitesResponse

Response message for SiteSearchEngineService.BatchCreateTargetSites method.

BatchVerifyTargetSitesMetadata

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

BatchVerifyTargetSitesRequest

Request message for SiteSearchEngineService.BatchVerifyTargetSites method.

BatchVerifyTargetSitesResponse

Response message for SiteSearchEngineService.BatchVerifyTargetSites method.

BigQuerySource

BigQuery source import data from.

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

BigtableOptions

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

BigtableColumn

The column of the Bigtable.

BigtableColumnFamily

The column family of the Bigtable.

Encoding

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.

FamiliesEntry

The abstract base class for a message.

Type

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.

BigtableSource

The Cloud Bigtable source for importing data.

CheckGroundingRequest

Request message for GroundedGenerationService.CheckGrounding method.

CheckGroundingResponse

Response message for the GroundedGenerationService.CheckGrounding method.

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

Claim

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

CheckGroundingSpec

Specification for the grounding check.

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

Chunk

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

ChunkMetadata

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

DocumentMetadata

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

PageSpan

Page span of the chunk.

CloudSqlSource

Cloud SQL source import data from.

CollectUserEventRequest

Request message for CollectUserEvent method.

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

CompleteQueryRequest

Request message for CompletionService.CompleteQuery method.

CompleteQueryResponse

Response message for CompletionService.CompleteQuery method.

QuerySuggestion

Suggestions as search queries.

CompletionInfo

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

Conversation

External conversation proto definition.

State

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.

ConversationContext

Defines context of the conversation

ConversationMessage

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

ConverseConversationRequest

Request message for ConversationalSearchService.ConverseConversation method.

UserLabelsEntry

The abstract base class for a message.

ConverseConversationResponse

Response message for ConversationalSearchService.ConverseConversation method.

CreateConversationRequest

Request for CreateConversation method.

CreateDataStoreMetadata

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

CreateDataStoreRequest

Request for DataStoreService.CreateDataStore method.

CreateDocumentRequest

Request message for DocumentService.CreateDocument method.

CreateEngineMetadata

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

CreateEngineRequest

Request for EngineService.CreateEngine method.

CreateSchemaMetadata

Metadata for Create Schema LRO.

CreateSchemaRequest

Request message for SchemaService.CreateSchema method.

CreateSessionRequest

Request for CreateSession method.

CreateTargetSiteMetadata

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

CreateTargetSiteRequest

Request message for SiteSearchEngineService.CreateTargetSite method.

CustomAttribute

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

CustomFineTuningSpec

Defines custom fine tuning spec.

DataStore

DataStore captures global settings and configs at the DataStore level.

ContentConfig

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.

DeleteConversationRequest

Request for DeleteConversation method.

DeleteDataStoreMetadata

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

DeleteDataStoreRequest

Request message for DataStoreService.DeleteDataStore method.

DeleteDocumentRequest

Request message for DocumentService.DeleteDocument method.

DeleteEngineMetadata

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

DeleteEngineRequest

Request message for EngineService.DeleteEngine method.

DeleteSchemaMetadata

Metadata for DeleteSchema LRO.

DeleteSchemaRequest

Request message for SchemaService.DeleteSchema method.

DeleteSessionRequest

Request for DeleteSession method.

DeleteTargetSiteMetadata

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

DeleteTargetSiteRequest

Request message for SiteSearchEngineService.DeleteTargetSite method.

DisableAdvancedSiteSearchMetadata

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

DisableAdvancedSiteSearchRequest

Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

DisableAdvancedSiteSearchResponse

Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

Document

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

AclInfo

ACL Information of the Document.

AccessRestriction

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" } ], } ] } }

Content

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

DocumentInfo

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

DocumentProcessingConfig

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.

ChunkingConfig

Configuration for chunking config.

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

LayoutBasedChunkingConfig

Configuration for the layout based chunking.

ParsingConfig

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

DigitalParsingConfig

The digital parsing configurations for documents.

LayoutParsingConfig

The layout parsing configurations for documents.

OcrParsingConfig

The OCR parsing configurations for documents.

ParsingConfigOverridesEntry

The abstract base class for a message.

DoubleList

Double list.

EmbeddingConfig

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

EnableAdvancedSiteSearchMetadata

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

EnableAdvancedSiteSearchRequest

Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

EnableAdvancedSiteSearchResponse

Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

Engine

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

ChatEngineConfig

Configurations for a Chat Engine.

AgentCreationConfig

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.

ChatEngineMetadata

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

CommonConfig

Common configurations for an Engine.

MediaRecommendationEngineConfig

Additional config specs for a Media Recommendation engine.

OptimizationObjectiveConfig

Custom threshold for cvr optimization_objective.

TrainingState

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.

RecommendationMetadata

Additional information of a recommendation engine.

DataState

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.

ServingState

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.

SearchEngineConfig

Configurations for a Search Engine.

SimilarDocumentsEngineConfig

Additional config specs for a similar-items engine.

EstimateDataSizeMetadata

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

EstimateDataSizeRequest

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

FileDataSource

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

WebsiteDataSource

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

EstimatorUriPattern

URI patterns that we use to crawl.

EstimateDataSizeResponse

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.

FactChunk

Fact Chunk.

SourceMetadataEntry

The abstract base class for a message.

FetchDomainVerificationStatusRequest

Request message for SiteSearchEngineService.FetchDomainVerificationStatus method.

FetchDomainVerificationStatusResponse

Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.

FhirStoreSource

Cloud FhirStore source import data from.

FieldConfig

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

AdvancedSiteSearchDataSource

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.

CompletableOption

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.

DynamicFacetableOption

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.

FieldType

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.

FilterableOption

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.

IndexableOption

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.

RetrievableOption

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.

SearchableOption

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.

FirestoreSource

Firestore source import data from.

GcsSource

Cloud Storage location for input content.

GetAclConfigRequest

Request message for GetAclConfigRequest method.

GetAnswerRequest

Request for GetAnswer method.

GetChunkRequest

Request message for ChunkService.GetChunk method.

GetConversationRequest

Request for GetConversation method.

GetDataStoreRequest

Request message for DataStoreService.GetDataStore method.

GetDocumentProcessingConfigRequest

Request for DataStoreService.GetDocumentProcessingConfig method.

GetDocumentRequest

Request message for DocumentService.GetDocument method.

GetEngineRequest

Request message for EngineService.GetEngine method.

GetProcessedDocumentRequest

Request message for DocumentService.GetDocument method.

ProcessedDocumentFormat

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.

ProcessedDocumentType

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.

GetProjectRequest

Request message for ProjectService.GetProject method.

GetSchemaRequest

Request message for SchemaService.GetSchema method.

GetServingConfigRequest

Request for GetServingConfig method.

GetSessionRequest

Request for GetSession method.

GetSiteSearchEngineRequest

Request message for SiteSearchEngineService.GetSiteSearchEngine method.

GetTargetSiteRequest

Request message for SiteSearchEngineService.GetTargetSite method.

GroundingFact

Grounding Fact.

AttributesEntry

The abstract base class for a message.

GuidedSearchSpec

Defines guided search spec.

IdpConfig

Identity Provider Config.

ExternalIdpConfig

Third party IDP Config.

IdpType

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.

ImportDocumentsMetadata

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

ImportDocumentsRequest

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

InlineSource

The inline source for the input config for ImportDocuments method.

ReconciliationMode

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.

ImportDocumentsResponse

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.

ImportErrorConfig

Configuration of destination for Import related errors.

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

ImportSuggestionDenyListEntriesMetadata

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

ImportSuggestionDenyListEntriesRequest

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

InlineSource

The inline source for SuggestionDenyListEntry.

ImportSuggestionDenyListEntriesResponse

Response message for CompletionService.ImportSuggestionDenyListEntries method.

ImportUserEventsMetadata

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

ImportUserEventsRequest

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

InlineSource

The inline source for the input config for ImportUserEvents method.

ImportUserEventsResponse

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.

IndustryVertical

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.

Interval

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

ListChunksRequest

Request message for ChunkService.ListChunks method.

ListChunksResponse

Response message for ChunkService.ListChunks method.

ListConversationsRequest

Request for ListConversations method.

ListConversationsResponse

Response for ListConversations method.

ListDataStoresRequest

Request message for DataStoreService.ListDataStores method.

ListDataStoresResponse

Response message for DataStoreService.ListDataStores method.

ListDocumentsRequest

Request message for DocumentService.ListDocuments method.

ListDocumentsResponse

Response message for DocumentService.ListDocuments method.

ListEnginesRequest

Request message for EngineService.ListEngines method.

ListEnginesResponse

Response message for EngineService.ListEngines method.

ListSchemasRequest

Request message for SchemaService.ListSchemas method.

ListSchemasResponse

Response message for SchemaService.ListSchemas method.

ListServingConfigsRequest

Request for ListServingConfigs method.

ListServingConfigsResponse

Response for ListServingConfigs method.

ListSessionsRequest

Request for ListSessions method.

ListSessionsResponse

Response for ListSessions method.

ListTargetSitesRequest

Request message for SiteSearchEngineService.ListTargetSites method.

ListTargetSitesResponse

Response message for SiteSearchEngineService.ListTargetSites method.

MediaInfo

Media-specific user event information.

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

PageInfo

Detailed page information.

PanelInfo

Detailed panel information associated with a user event.

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

PauseEngineRequest

Request for pausing training of an engine.

Principal

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

ProcessedDocument

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

Project

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

ServiceTerms

Metadata about the terms of service.

State

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.

ServiceTermsMapEntry

The abstract base class for a message.

ProvisionProjectMetadata

Metadata associated with a project provision operation.

ProvisionProjectRequest

Request for ProjectService.ProvisionProject method.

PurgeDocumentsMetadata

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

PurgeDocumentsRequest

Request message for DocumentService.PurgeDocuments method.

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

PurgeDocumentsResponse

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.

PurgeErrorConfig

Configuration of destination for Purge related errors.

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

PurgeSuggestionDenyListEntriesMetadata

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

PurgeSuggestionDenyListEntriesRequest

Request message for CompletionService.PurgeSuggestionDenyListEntries method.

PurgeSuggestionDenyListEntriesResponse

Response message for CompletionService.PurgeSuggestionDenyListEntries method.

PurgeUserEventsMetadata

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

PurgeUserEventsRequest

Request message for PurgeUserEvents method.

PurgeUserEventsResponse

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

Query

Defines a user inputed query.

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

RankRequest

Request message for RankService.Rank method.

RankResponse

Response message for RankService.Rank method.

RankingRecord

Record message for RankService.Rank method.

RecommendRequest

Request message for Recommend method.

ParamsEntry

The abstract base class for a message.

UserLabelsEntry

The abstract base class for a message.

RecommendResponse

Response message for Recommend method.

RecommendationResult

RecommendationResult represents a generic recommendation result with associated metadata.

MetadataEntry

The abstract base class for a message.

RecrawlUrisMetadata

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

RecrawlUrisRequest

Request message for SiteSearchEngineService.RecrawlUris method.

RecrawlUrisResponse

Response message for SiteSearchEngineService.RecrawlUris method.

FailureInfo

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

FailureReason

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

CorpusType

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.

Reply

Defines a reply message to user.

Reference

Defines reference in reply.

ReportConsentChangeRequest

Request for ReportConsentChange method.

ConsentChangeAction

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.

ResumeEngineRequest

Request for resuming training of an engine.

Schema

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

SearchAddOn

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.

SearchInfo

Detailed search information.

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

SearchRequest

Request message for SearchService.Search method.

BoostSpec

Boost specification to boost certain documents.

ConditionBoostSpec

Boost applies to documents which match a condition.

BoostControlSpec

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

AttributeType

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.

ControlPoint

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

InterpolationType

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.

ContentSearchSpec

A specification for configuring the behavior of content search.

ChunkSpec

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

ExtractiveContentSpec

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

SearchResultMode

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.

SnippetSpec

A specification for configuring snippets in a search response.

SummarySpec

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

ModelPromptSpec

Specification of the prompt to use with the model.

ModelSpec

Specification of the model.

DataStoreSpec

A struct to define data stores to filter on in a search call.

EmbeddingSpec

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

EmbeddingVector

Embedding vector.

FacetSpec

A facet specification to perform faceted search.

FacetKey

Specifies how a facet is computed.

ImageQuery

Specifies the image query input.

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

ParamsEntry

The abstract base class for a message.

QueryExpansionSpec

Specification to determine under which conditions query expansion should occur.

Condition

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.

SpellCorrectionSpec

The specification for query spell correction.

Mode

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.

UserLabelsEntry

The abstract base class for a message.

SearchResponse

Response message for SearchService.Search method.

Facet

A facet result.

FacetValue

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

GeoSearchDebugInfo

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

GuidedSearchResult

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.

RefinementAttribute

Useful attribute for search result refinements.

QueryExpansionInfo

Information describing query expansion including whether expansion has occurred.

SearchResult

Represents the search results.

ModelScoresEntry

The abstract base class for a message.

Summary

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

Citation

Citation info for a segment.

CitationMetadata

Citation metadata.

CitationSource

Citation source.

Reference

Document reference.

ChunkContent

Chunk content.

SafetyAttributes

Safety Attribute categories and their associated confidence scores.

SummarySkippedReason

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.

SummaryWithMetadata

Summary with metadata information.

SearchTier

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.

ServingConfig

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

GenericConfig

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

• content_search_spec: configuration for generic content search.

MediaConfig

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

Session

External session proto definition.

State

Enumeration of the state of the session.

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

Turn

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

SiteSearchEngine

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

SiteVerificationInfo

Verification information for target sites in advanced site search.

SiteVerificationState

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.

SolutionType

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.

SpannerSource

The Spanner source for importing data

SuggestionDenyListEntry

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

MatchOperator

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.

TargetSite

A target site for the SiteSearchEngine.

FailureReason

Site search indexing failure reasons.

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

QuotaFailure

Failed due to insufficient quota.

IndexingStatus

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.

Type

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.

TextInput

Defines text input.

TrainCustomModelMetadata

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

TrainCustomModelRequest

Request message for SearchTuningService.TrainCustomModel method.

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

GcsTrainingInput

Cloud Storage training data input.

TrainCustomModelResponse

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

MetricsEntry

The abstract base class for a message.

TransactionInfo

A transaction represents the entire purchase transaction.

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

TuneEngineMetadata

Metadata associated with a tune operation.

TuneEngineRequest

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

TuneEngineResponse

Response associated with a tune operation.

UpdateAclConfigRequest

Request message for UpdateAclConfig method.

UpdateConversationRequest

Request for UpdateConversation method.

UpdateDataStoreRequest

Request message for DataStoreService.UpdateDataStore method.

UpdateDocumentProcessingConfigRequest

Request for DataStoreService.UpdateDocumentProcessingConfig method.

UpdateDocumentRequest

Request message for DocumentService.UpdateDocument method.

UpdateEngineRequest

Request message for EngineService.UpdateEngine method.

UpdateSchemaMetadata

Metadata for UpdateSchema LRO.

UpdateSchemaRequest

Request message for SchemaService.UpdateSchema method.

UpdateServingConfigRequest

Request for UpdateServingConfig method.

UpdateSessionRequest

Request for UpdateSession method.

UpdateTargetSiteMetadata

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

UpdateTargetSiteRequest

Request message for SiteSearchEngineService.UpdateTargetSite method.

UserEvent

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

AttributesEntry

The abstract base class for a message.

UserInfo

Information of an end user.

WriteUserEventRequest

Request message for WriteUserEvent method.

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

CompletionServiceAsyncClient

Service for Auto-Completion.

CompletionServiceClient

Service for Auto-Completion.

ConversationalSearchServiceAsyncClient

Service for conversational search.

ConversationalSearchServiceClient

Service for conversational search.

ListConversationsAsyncPager

A pager for iterating through list_conversations requests.

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

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

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

ListConversationsPager

A pager for iterating through list_conversations requests.

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

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

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

ListSessionsAsyncPager

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.

ListSessionsPager

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.

DataStoreServiceAsyncClient

Service for managing DataStore configuration.

DataStoreServiceClient

Service for managing DataStore configuration.

ListDataStoresAsyncPager

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.

ListDataStoresPager

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.

DocumentServiceAsyncClient

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

DocumentServiceClient

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

ListDocumentsAsyncPager

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.

ListDocumentsPager

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.

EngineServiceAsyncClient

Service for managing Engine configuration.

EngineServiceClient

Service for managing Engine configuration.

ListEnginesAsyncPager

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.

ListEnginesPager

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.

GroundedGenerationServiceAsyncClient

Service for grounded generation.

GroundedGenerationServiceClient

Service for grounded generation.

RankServiceAsyncClient

Service for ranking text records.

RankServiceClient

Service for ranking text records.

RecommendationServiceAsyncClient

Service for making recommendations.

RecommendationServiceClient

Service for making recommendations.

SchemaServiceAsyncClient

Service for managing Schemas.

SchemaServiceClient

Service for managing Schemas.

ListSchemasAsyncPager

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.

ListSchemasPager

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.

SearchServiceAsyncClient

Service for search.

SearchServiceClient

Service for search.

SearchAsyncPager

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.

SearchPager

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.

SearchTuningServiceAsyncClient

Service for search tuning.

SearchTuningServiceClient

Service for search tuning.

ServingConfigServiceAsyncClient

Service for operations related to ServingConfig.

ServingConfigServiceClient

Service for operations related to ServingConfig.

ListServingConfigsAsyncPager

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.

ListServingConfigsPager

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.

SiteSearchEngineServiceAsyncClient

Service for managing site search related resources.

SiteSearchEngineServiceClient

Service for managing site search related resources.

FetchDomainVerificationStatusAsyncPager

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.

FetchDomainVerificationStatusPager

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.

ListTargetSitesAsyncPager

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.

ListTargetSitesPager

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.

UserEventServiceAsyncClient

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

UserEventServiceClient

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

Answer

Defines an answer.

AnswerSkippedReason

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

Citation info for a segment.

CitationSource

Citation source.

QueryUnderstandingInfo

Query understanding information.

QueryClassificationInfo

Query classification information.

Type

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

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

ChunkInfo

Chunk information.

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

DocumentMetadata

Document metadata.

UnstructuredDocumentInfo

Unstructured document information.

ChunkContent

Chunk content.

State

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

Step information.

Action

Action.

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

Observation

Observation.

SearchResult

ChunkInfo

Chunk information.

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

SnippetInfo

Snippet information.

SearchAction

Search action.

State

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.

AnswerQueryRequest

Request message for ConversationalSearchService.AnswerQuery method.

AnswerGenerationSpec

Answer generation specification.

ModelSpec

Answer Generation Model specification.

PromptSpec

Answer generation prompt specification.

QueryUnderstandingSpec

Query understanding specification.

QueryClassificationSpec

Query classification specification.

Type

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.

QueryRephraserSpec

Query rephraser specification.

RelatedQuestionsSpec

Related questions specification.

SafetySpec

Safety specification.

SearchSpec

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

SearchParams

Search parameters.

SearchResultList

Search result list.

SearchResult

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

ChunkInfo

Chunk information.

UnstructuredDocumentInfo

Unstructured document information.

DocumentContext

Document context.

ExtractiveAnswer

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

ExtractiveSegment

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

AnswerQueryResponse

Response message for ConversationalSearchService.AnswerQuery method.

BatchCreateTargetSiteMetadata

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

BatchCreateTargetSitesRequest

Request message for SiteSearchEngineService.BatchCreateTargetSites method.

BatchCreateTargetSitesResponse

Response message for SiteSearchEngineService.BatchCreateTargetSites method.

BatchVerifyTargetSitesMetadata

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

BatchVerifyTargetSitesRequest

Request message for SiteSearchEngineService.BatchVerifyTargetSites method.

BatchVerifyTargetSitesResponse

Response message for SiteSearchEngineService.BatchVerifyTargetSites method.

BigQuerySource

BigQuery source import data from.

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

BigtableOptions

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

BigtableColumn

The column of the Bigtable.

BigtableColumnFamily

The column family of the Bigtable.

Encoding

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.

FamiliesEntry

The abstract base class for a message.

Type

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.

BigtableSource

The Cloud Bigtable source for importing data.

CheckGroundingRequest

Request message for GroundedGenerationService.CheckGrounding method.

CheckGroundingResponse

Response message for the GroundedGenerationService.CheckGrounding method.

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

Claim

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

CheckGroundingSpec

Specification for the grounding check.

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

CloudSqlSource

Cloud SQL source import data from.

CollectUserEventRequest

Request message for CollectUserEvent method.

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

CompleteQueryRequest

Request message for CompletionService.CompleteQuery method.

CompleteQueryResponse

Response message for CompletionService.CompleteQuery method.

QuerySuggestion

Suggestions as search queries.

CompletionInfo

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

Conversation

External conversation proto definition.

State

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.

ConversationContext

Defines context of the conversation

ConversationMessage

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

ConverseConversationRequest

Request message for ConversationalSearchService.ConverseConversation method.

UserLabelsEntry

The abstract base class for a message.

ConverseConversationResponse

Response message for ConversationalSearchService.ConverseConversation method.

CreateConversationRequest

Request for CreateConversation method.

CreateDataStoreMetadata

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

CreateDataStoreRequest

Request for DataStoreService.CreateDataStore method.

CreateDocumentRequest

Request message for DocumentService.CreateDocument method.

CreateEngineMetadata

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

CreateEngineRequest

Request for EngineService.CreateEngine method.

CreateSchemaMetadata

Metadata for Create Schema LRO.

CreateSchemaRequest

Request message for SchemaService.CreateSchema method.

CreateSessionRequest

Request for CreateSession method.

CreateTargetSiteMetadata

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

CreateTargetSiteRequest

Request message for SiteSearchEngineService.CreateTargetSite method.

CustomAttribute

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

DataStore

DataStore captures global settings and configs at the DataStore level.

ContentConfig

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.

DeleteConversationRequest

Request for DeleteConversation method.

DeleteDataStoreMetadata

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

DeleteDataStoreRequest

Request message for DataStoreService.DeleteDataStore method.

DeleteDocumentRequest

Request message for DocumentService.DeleteDocument method.

DeleteEngineMetadata

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

DeleteEngineRequest

Request message for EngineService.DeleteEngine method.

DeleteSchemaMetadata

Metadata for DeleteSchema LRO.

DeleteSchemaRequest

Request message for SchemaService.DeleteSchema method.

DeleteSessionRequest

Request for DeleteSession method.

DeleteTargetSiteMetadata

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

DeleteTargetSiteRequest

Request message for SiteSearchEngineService.DeleteTargetSite method.

DisableAdvancedSiteSearchMetadata

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

DisableAdvancedSiteSearchRequest

Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

DisableAdvancedSiteSearchResponse

Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

Document

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

Content

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

DocumentInfo

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

DocumentProcessingConfig

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.

ParsingConfig

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

DigitalParsingConfig

The digital parsing configurations for documents.

OcrParsingConfig

The OCR parsing configurations for documents.

ParsingConfigOverridesEntry

The abstract base class for a message.

DoubleList

Double list.

EmbeddingConfig

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

EnableAdvancedSiteSearchMetadata

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

EnableAdvancedSiteSearchRequest

Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

EnableAdvancedSiteSearchResponse

Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

Engine

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

ChatEngineConfig

Configurations for a Chat Engine.

AgentCreationConfig

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.

ChatEngineMetadata

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

CommonConfig

Common configurations for an Engine.

SearchEngineConfig

Configurations for a Search Engine.

FactChunk

Fact Chunk.

SourceMetadataEntry

The abstract base class for a message.

FetchDomainVerificationStatusRequest

Request message for SiteSearchEngineService.FetchDomainVerificationStatus method.

FetchDomainVerificationStatusResponse

Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.

FhirStoreSource

Cloud FhirStore source import data from.

FirestoreSource

Firestore source import data from.

GcsSource

Cloud Storage location for input content.

GetAnswerRequest

Request for GetAnswer method.

GetConversationRequest

Request for GetConversation method.

GetDataStoreRequest

Request message for DataStoreService.GetDataStore method.

GetDocumentRequest

Request message for DocumentService.GetDocument method.

GetEngineRequest

Request message for EngineService.GetEngine method.

GetSchemaRequest

Request message for SchemaService.GetSchema method.

GetServingConfigRequest

Request for GetServingConfig method.

GetSessionRequest

Request for GetSession method.

GetSiteSearchEngineRequest

Request message for SiteSearchEngineService.GetSiteSearchEngine method.

GetTargetSiteRequest

Request message for SiteSearchEngineService.GetTargetSite method.

GroundingFact

Grounding Fact.

AttributesEntry

The abstract base class for a message.

ImportDocumentsMetadata

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

ImportDocumentsRequest

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

InlineSource

The inline source for the input config for ImportDocuments method.

ReconciliationMode

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.

ImportDocumentsResponse

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.

ImportErrorConfig

Configuration of destination for Import related errors.

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

ImportSuggestionDenyListEntriesMetadata

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

ImportSuggestionDenyListEntriesRequest

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

InlineSource

The inline source for SuggestionDenyListEntry.

ImportSuggestionDenyListEntriesResponse

Response message for CompletionService.ImportSuggestionDenyListEntries method.

ImportUserEventsMetadata

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

ImportUserEventsRequest

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

InlineSource

The inline source for the input config for ImportUserEvents method.

ImportUserEventsResponse

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.

IndustryVertical

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.

Interval

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

ListConversationsRequest

Request for ListConversations method.

ListConversationsResponse

Response for ListConversations method.

ListDataStoresRequest

Request message for DataStoreService.ListDataStores method.

ListDataStoresResponse

Response message for DataStoreService.ListDataStores method.

ListDocumentsRequest

Request message for DocumentService.ListDocuments method.

ListDocumentsResponse

Response message for DocumentService.ListDocuments method.

ListEnginesRequest

Request message for EngineService.ListEngines method.

ListEnginesResponse

Response message for EngineService.ListEngines method.

ListSchemasRequest

Request message for SchemaService.ListSchemas method.

ListSchemasResponse

Response message for SchemaService.ListSchemas method.

ListServingConfigsRequest

Request for ListServingConfigs method.

ListServingConfigsResponse

Response for ListServingConfigs method.

ListSessionsRequest

Request for ListSessions method.

ListSessionsResponse

Response for ListSessions method.

ListTargetSitesRequest

Request message for SiteSearchEngineService.ListTargetSites method.

ListTargetSitesResponse

Response message for SiteSearchEngineService.ListTargetSites method.

MediaInfo

Media-specific user event information.

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

PageInfo

Detailed page information.

PanelInfo

Detailed panel information associated with a user event.

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

PauseEngineRequest

Request for pausing training of an engine.

PurgeDocumentsMetadata

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

PurgeDocumentsRequest

Request message for DocumentService.PurgeDocuments method.

PurgeDocumentsResponse

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.

PurgeSuggestionDenyListEntriesMetadata

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

PurgeSuggestionDenyListEntriesRequest

Request message for CompletionService.PurgeSuggestionDenyListEntries method.

PurgeSuggestionDenyListEntriesResponse

Response message for CompletionService.PurgeSuggestionDenyListEntries method.

Query

Defines a user inputed query.

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

RankRequest

Request message for RankService.Rank method.

RankResponse

Response message for RankService.Rank method.

RankingRecord

Record message for RankService.Rank method.

RecommendRequest

Request message for Recommend method.

ParamsEntry

The abstract base class for a message.

UserLabelsEntry

The abstract base class for a message.

RecommendResponse

Response message for Recommend method.

RecommendationResult

RecommendationResult represents a generic recommendation result with associated metadata.

MetadataEntry

The abstract base class for a message.

RecrawlUrisMetadata

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

RecrawlUrisRequest

Request message for SiteSearchEngineService.RecrawlUris method.

RecrawlUrisResponse

Response message for SiteSearchEngineService.RecrawlUris method.

FailureInfo

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

FailureReason

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

CorpusType

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.

Reply

Defines a reply message to user.

Reference

Defines reference in reply.

ResumeEngineRequest

Request for resuming training of an engine.

Schema

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

SearchAddOn

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.

SearchInfo

Detailed search information.

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

SearchRequest

Request message for SearchService.Search method.

BoostSpec

Boost specification to boost certain documents.

ConditionBoostSpec

Boost applies to documents which match a condition.

BoostControlSpec

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

AttributeType

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.

ControlPoint

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

InterpolationType

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.

ContentSearchSpec

A specification for configuring the behavior of content search.

ExtractiveContentSpec

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

SnippetSpec

A specification for configuring snippets in a search response.

SummarySpec

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

ModelPromptSpec

Specification of the prompt to use with the model.

ModelSpec

Specification of the model.

DataStoreSpec

A struct to define data stores to filter on in a search call.

EmbeddingSpec

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

EmbeddingVector

Embedding vector.

FacetSpec

A facet specification to perform faceted search.

FacetKey

Specifies how a facet is computed.

ImageQuery

Specifies the image query input.

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

ParamsEntry

The abstract base class for a message.

QueryExpansionSpec

Specification to determine under which conditions query expansion should occur.

Condition

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.

SpellCorrectionSpec

The specification for query spell correction.

Mode

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.

UserLabelsEntry

The abstract base class for a message.

SearchResponse

Response message for SearchService.Search method.

Facet

A facet result.

FacetValue

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

GeoSearchDebugInfo

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

GuidedSearchResult

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.

RefinementAttribute

Useful attribute for search result refinements.

QueryExpansionInfo

Information describing query expansion including whether expansion has occurred.

SearchResult

Represents the search results.

ModelScoresEntry

The abstract base class for a message.

Summary

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

Citation

Citation info for a segment.

CitationMetadata

Citation metadata.

CitationSource

Citation source.

Reference

Document reference.

ChunkContent

Chunk content.

SafetyAttributes

Safety Attribute categories and their associated confidence scores.

SummarySkippedReason

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.

SummaryWithMetadata

Summary with metadata information.

SearchTier

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.

ServingConfig

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

GenericConfig

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

• content_search_spec: configuration for generic content search.

MediaConfig

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

Session

External session proto definition.

State

Enumeration of the state of the session.

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

Turn

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

SiteSearchEngine

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

SiteVerificationInfo

Verification information for target sites in advanced site search.

SiteVerificationState

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.

SolutionType

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.

SpannerSource

The Spanner source for importing data

SuggestionDenyListEntry

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

MatchOperator

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.

TargetSite

A target site for the SiteSearchEngine.

FailureReason

Site search indexing failure reasons.

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

QuotaFailure

Failed due to insufficient quota.

IndexingStatus

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.

Type

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.

TextInput

Defines text input.

TrainCustomModelMetadata

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

TrainCustomModelRequest

Request message for SearchTuningService.TrainCustomModel method.

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

GcsTrainingInput

Cloud Storage training data input.

TrainCustomModelResponse

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

MetricsEntry

The abstract base class for a message.

TransactionInfo

A transaction represents the entire purchase transaction.

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

TuneEngineMetadata

Metadata associated with a tune operation.

TuneEngineRequest

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

TuneEngineResponse

Response associated with a tune operation.

UpdateConversationRequest

Request for UpdateConversation method.

UpdateDataStoreRequest

Request message for DataStoreService.UpdateDataStore method.

UpdateDocumentRequest

Request message for DocumentService.UpdateDocument method.

UpdateEngineRequest

Request message for EngineService.UpdateEngine method.

UpdateSchemaMetadata

Metadata for UpdateSchema LRO.

UpdateSchemaRequest

Request message for SchemaService.UpdateSchema method.

UpdateServingConfigRequest

Request for UpdateServingConfig method.

UpdateSessionRequest

Request for UpdateSession method.

UpdateTargetSiteMetadata

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

UpdateTargetSiteRequest

Request message for SiteSearchEngineService.UpdateTargetSite method.

UserEvent

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

AttributesEntry

The abstract base class for a message.

UserInfo

Information of an end user.

WriteUserEventRequest

Request message for WriteUserEvent method.

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

Modules

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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

pagers

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