discoveryengine library
Classes
- Conversation
- Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. Auto-naming is currently not supported for this resource.
- ConversationArgs
- The set of arguments for Conversation. The set of arguments for Conversation.
- ConversationDiscoveryengineV1beta
- Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. Auto-naming is currently not supported for this resource.
- ConversationDiscoveryengineV1betaArgs
- The set of arguments for Conversation. The set of arguments for Conversation.
- DataStore
- Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
- DataStoreArgs
- The set of arguments for DataStore. The set of arguments for DataStore.
- Document
- Creates a Document.
- DocumentArgs
- The set of arguments for Document. The set of arguments for Document.
- DocumentDiscoveryengineV1beta
- Creates a Document.
- DocumentDiscoveryengineV1betaArgs
- The set of arguments for Document. The set of arguments for Document.
- Engine
- Creates a Engine.
- EngineArgs
- The set of arguments for Engine. The set of arguments for Engine.
- GetConversationArgs
- Arguments for getConversation. Arguments for getConversation.
- GetConversationDiscoveryengineV1betaArgs
- Arguments for getConversation. Arguments for getConversation.
- GetConversationDiscoveryengineV1betaResult
- Result data returned by getConversation.
- GetConversationResult
- Result data returned by getConversation.
- GetDataStoreArgs
- Arguments for getDataStore. Arguments for getDataStore.
- GetDataStoreResult
- Result data returned by getDataStore.
- GetDocumentArgs
- Arguments for getDocument. Arguments for getDocument.
- GetDocumentDiscoveryengineV1betaArgs
- Arguments for getDocument. Arguments for getDocument.
- GetDocumentDiscoveryengineV1betaResult
- Result data returned by getDocument.
- GetDocumentResult
- Result data returned by getDocument.
- GetEngineArgs
- Arguments for getEngine. Arguments for getEngine.
- GetEngineResult
- Result data returned by getEngine.
- GetSchemaArgs
- Arguments for getSchema. Arguments for getSchema.
- GetSchemaDiscoveryengineV1betaArgs
- Arguments for getSchema. Arguments for getSchema.
- GetSchemaDiscoveryengineV1betaResult
- Result data returned by getSchema.
- GetSchemaResult
- Result data returned by getSchema.
- GoogleCloudDiscoveryengineV1alphaConversationContext
- Defines context of the conversation
- GoogleCloudDiscoveryengineV1alphaConversationContextResponse
- Defines context of the conversation
- GoogleCloudDiscoveryengineV1alphaConversationMessage
- Defines a conversation message.
- GoogleCloudDiscoveryengineV1alphaConversationMessageResponse
- Defines a conversation message.
- GoogleCloudDiscoveryengineV1alphaDocumentContent
- Unstructured data linked to this document.
- GoogleCloudDiscoveryengineV1alphaDocumentContentResponse
- Unstructured data linked to this document.
- GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig
- Configurations for a Chat Engine.
- GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig
- 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.
- GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfigResponse
- 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.
- GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigResponse
- Configurations for a Chat Engine.
- GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadataResponse
- Additional information of a Chat Engine. Fields in this message are output only.
- GoogleCloudDiscoveryengineV1alphaEngineCommonConfig
- Common configurations for an Engine.
- GoogleCloudDiscoveryengineV1alphaEngineCommonConfigResponse
- Common configurations for an Engine.
- GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
- Additional config specs for a Media Recommendation engine.
- GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
-
Custom threshold for
cvroptimization_objective. - GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfigResponse
-
Custom threshold for
cvroptimization_objective. - GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigResponse
- Additional config specs for a Media Recommendation engine.
- GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadataResponse
- Additional information of a recommendation engine.
- GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig
- Configurations for a Search Engine.
- GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigResponse
- Configurations for a Search Engine.
- GoogleCloudDiscoveryengineV1alphaFieldConfigResponse
- Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
- GoogleCloudDiscoveryengineV1alphaReply
- Defines a reply message to user.
- GoogleCloudDiscoveryengineV1alphaReplyReference
- Defines reference in reply.
- GoogleCloudDiscoveryengineV1alphaReplyReferenceResponse
- Defines reference in reply.
- GoogleCloudDiscoveryengineV1alphaReplyResponse
- Defines a reply message to user.
- GoogleCloudDiscoveryengineV1alphaSearchResponseSummary
- Summary of the top N search result specified by the summary spec.
- GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryResponse
- Summary of the top N search result specified by the summary spec.
- GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes
- Safety Attribute categories and their associated confidence scores.
- GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributesResponse
- Safety Attribute categories and their associated confidence scores.
- GoogleCloudDiscoveryengineV1alphaTextInput
- Defines text input.
- GoogleCloudDiscoveryengineV1alphaTextInputResponse
- Defines text input.
- GoogleCloudDiscoveryengineV1betaConversationContext
- Defines context of the conversation
- GoogleCloudDiscoveryengineV1betaConversationContextResponse
- Defines context of the conversation
- GoogleCloudDiscoveryengineV1betaConversationMessage
- Defines a conversation message.
- GoogleCloudDiscoveryengineV1betaConversationMessageResponse
- Defines a conversation message.
- GoogleCloudDiscoveryengineV1betaDocumentContent
- Unstructured data linked to this document.
- GoogleCloudDiscoveryengineV1betaDocumentContentResponse
- Unstructured data linked to this document.
- GoogleCloudDiscoveryengineV1betaReply
- Defines a reply message to user.
- GoogleCloudDiscoveryengineV1betaReplyReference
- Defines reference in reply.
- GoogleCloudDiscoveryengineV1betaReplyReferenceResponse
- Defines reference in reply.
- GoogleCloudDiscoveryengineV1betaReplyResponse
- Defines a reply message to user.
- GoogleCloudDiscoveryengineV1betaSearchResponseSummary
- Summary of the top N search result specified by the summary spec.
- GoogleCloudDiscoveryengineV1betaSearchResponseSummaryResponse
- Summary of the top N search result specified by the summary spec.
- GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes
- Safety Attribute categories and their associated confidence scores.
- GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributesResponse
- Safety Attribute categories and their associated confidence scores.
- GoogleCloudDiscoveryengineV1betaTextInput
- Defines text input.
- GoogleCloudDiscoveryengineV1betaTextInputResponse
- Defines text input.
- Schema
- Creates a Schema.
- SchemaArgs
- The set of arguments for Schema. The set of arguments for Schema.
- SchemaDiscoveryengineV1beta
- Creates a Schema.
- SchemaDiscoveryengineV1betaArgs
- The set of arguments for Schema. The set of arguments for Schema.
Enums
- ConversationState
- The state of the Conversation.
- ConversationStateDiscoveryengineV1beta
- The state of the Conversation.
- DataStoreContentConfig
- Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
- DataStoreIndustryVertical
- Immutable. The industry vertical that the data store registers.
- DataStoreSolutionTypesItem
- EngineIndustryVertical
-
The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to
GENERIC. Vertical on Engine has to match vertical of the DataStore liniked to the engine. - EngineSolutionType
- Required. The solutions of the engine.
- GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigTrainingState
-
The training state that the engine is in (e.g.
TRAININGorPAUSED). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value forCreateEnginemethod isTRAINING. The default value forUpdateEnginemethod is to keep the state the same as before. - GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchAddOnsItem
- GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchTier
- The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
- GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummarySkippedReasonsItem
- GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummarySkippedReasonsItem
Functions
-
getConversation(
GetConversationArgs args, {InvokeOptions? options}) → Future< GetConversationResult> -
Gets a Conversation.
argsArguments passed to this invoke. Arguments for getConversation.optionsInvoke options controlling this call. -
getConversationDiscoveryengineV1beta(
GetConversationDiscoveryengineV1betaArgs args, {InvokeOptions? options}) → Future< GetConversationDiscoveryengineV1betaResult> -
Gets a Conversation.
argsArguments passed to this invoke. Arguments for getConversation.optionsInvoke options controlling this call. -
getDataStore(
GetDataStoreArgs args, {InvokeOptions? options}) → Future< GetDataStoreResult> -
Gets a DataStore.
argsArguments passed to this invoke. Arguments for getDataStore.optionsInvoke options controlling this call. -
getDocument(
GetDocumentArgs args, {InvokeOptions? options}) → Future< GetDocumentResult> -
Gets a Document.
argsArguments passed to this invoke. Arguments for getDocument.optionsInvoke options controlling this call. -
getDocumentDiscoveryengineV1beta(
GetDocumentDiscoveryengineV1betaArgs args, {InvokeOptions? options}) → Future< GetDocumentDiscoveryengineV1betaResult> -
Gets a Document.
argsArguments passed to this invoke. Arguments for getDocument.optionsInvoke options controlling this call. -
getEngine(
GetEngineArgs args, {InvokeOptions? options}) → Future< GetEngineResult> -
Gets a Engine.
argsArguments passed to this invoke. Arguments for getEngine.optionsInvoke options controlling this call. -
getSchema(
GetSchemaArgs args, {InvokeOptions? options}) → Future< GetSchemaResult> -
Gets a Schema.
argsArguments passed to this invoke. Arguments for getSchema.optionsInvoke options controlling this call. -
getSchemaDiscoveryengineV1beta(
GetSchemaDiscoveryengineV1betaArgs args, {InvokeOptions? options}) → Future< GetSchemaDiscoveryengineV1betaResult> -
Gets a Schema.
argsArguments passed to this invoke. Arguments for getSchema.optionsInvoke options controlling this call.