Package types (0.12.2)

API documentation for discoveryengine_v1.types package.

Classes

AlloyDbSource

AlloyDB source import data from.

Answer

Defines an answer.

AnswerQueryRequest

Request message for ConversationalSearchService.AnswerQuery method.

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.

BatchGetDocumentsMetadataRequest

Request message for DocumentService.BatchGetDocumentsMetadata method.

BatchGetDocumentsMetadataResponse

Response message for DocumentService.BatchGetDocumentsMetadata 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.

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

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.

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

CompletionInfo

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

CompletionSuggestion

Autocomplete suggestions that are imported from Customer.

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

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

Condition

Defines circumstances to be checked before allowing a behavior

Control

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

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

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

Conversation

External conversation proto definition.

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.

ConverseConversationResponse

Response message for ConversationalSearchService.ConverseConversation method.

CreateControlRequest

Request for CreateControl 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.

CustomTuningModel

Metadata that describes a custom tuned model.

DataStore

DataStore captures global settings and configs at the DataStore level.

DeleteControlRequest

Request for DeleteControl method.

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

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.

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

FactChunk

Fact Chunk.

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.

GetControlRequest

Request for GetControl 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.

GetSessionRequest

Request for GetSession method.

GetSiteSearchEngineRequest

Request message for SiteSearchEngineService.GetSiteSearchEngine method.

GetTargetSiteRequest

Request message for SiteSearchEngineService.GetTargetSite method.

GroundingFact

Grounding Fact.

ImportCompletionSuggestionsMetadata

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

ImportCompletionSuggestionsRequest

Request message for CompletionService.ImportCompletionSuggestions method.

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

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

ImportCompletionSuggestionsResponse

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

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

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

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

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.

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

ListControlsRequest

Request for ListControls method.

ListControlsResponse

Response for ListControls method.

ListConversationsRequest

Request for ListConversations method.

ListConversationsResponse

Response for ListConversations method.

ListCustomModelsRequest

Request message for SearchTuningService.ListCustomModels method.

ListCustomModelsResponse

Response message for SearchTuningService.ListCustomModels 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.

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

Project

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

ProvisionProjectMetadata

Metadata associated with a project provision operation.

ProvisionProjectRequest

Request for ProjectService.ProvisionProject method.

PurgeCompletionSuggestionsMetadata

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

PurgeCompletionSuggestionsRequest

Request message for CompletionService.PurgeCompletionSuggestions method.

PurgeCompletionSuggestionsResponse

Response message for CompletionService.PurgeCompletionSuggestions 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.

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

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.

RecommendResponse

Response message for Recommend method.

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.

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.

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.

SearchResponse

Response message for SearchService.Search method.

SearchTier

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

SearchUseCase

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

Session

External session proto definition.

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.

SolutionType

The type of 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.

TargetSite

A target site for the SiteSearchEngine.

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

TrainCustomModelResponse

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

TransactionInfo

A transaction represents the entire purchase transaction.

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

UpdateControlRequest

Request for UpdateControl method.

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.

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

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