discoveryengine library
Classes
- AclConfig
- Access Control Configuration.
- AclConfigArgs
- The set of arguments for AclConfig. The set of arguments for AclConfig.
- AclConfigIdpConfig
- AclConfigIdpConfigExternalIdpConfig
- AclConfigState
- Input properties used for looking up and filtering AclConfig resources.
- Assistant
- Assistant
- AssistantArgs
- The set of arguments for Assistant. The set of arguments for Assistant.
- AssistantCustomerPolicy
- AssistantCustomerPolicyBannedPhrase
- AssistantCustomerPolicyModelArmorConfig
- AssistantGenerationConfig
- AssistantGenerationConfigSystemInstruction
- AssistantState
- Input properties used for looking up and filtering Assistant resources.
- ChatEngine
- Vertex chat and Conversation Engine Chat type
- ChatEngineArgs
- The set of arguments for ChatEngine. The set of arguments for ChatEngine.
- ChatEngineChatEngineConfig
- ChatEngineChatEngineConfigAgentCreationConfig
- ChatEngineChatEngineMetadata
- ChatEngineCommonConfig
- ChatEngineState
- Input properties used for looking up and filtering ChatEngine resources.
- CmekConfig
- CmekConfig represents configurations used to enable CMEK data encryption with Cloud KMS keys.
- CmekConfigArgs
- The set of arguments for CmekConfig. The set of arguments for CmekConfig.
- CmekConfigSingleRegionKey
- CmekConfigState
- Input properties used for looking up and filtering CmekConfig resources.
- Control
- Controls are rules that influence search results.
- ControlArgs
- The set of arguments for Control. The set of arguments for Control.
- ControlBoostAction
- ControlBoostActionInterpolationBoostSpec
- ControlBoostActionInterpolationBoostSpecControlPoint
- ControlCondition
- ControlConditionActiveTimeRange
- ControlConditionQueryTerm
- ControlFilterAction
- ControlPromoteAction
- ControlPromoteActionSearchLinkPromotion
- ControlRedirectAction
- ControlState
- Input properties used for looking up and filtering Control resources.
- ControlSynonymsAction
- DataConnector
- DataConnector manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.
- DataConnectorActionConfig
- DataConnectorArgs
- The set of arguments for DataConnector. The set of arguments for DataConnector.
- DataConnectorBapConfig
- DataConnectorDestinationConfig
- DataConnectorDestinationConfigDestination
- DataConnectorEntity
- DataConnectorError
- DataConnectorState
- Input properties used for looking up and filtering DataConnector resources.
- DataStore
- Data store is a collection of websites and documents used to find answers for end-user's questions in Discovery Engine (a.k.a. Vertex AI Search and Conversation).
- DataStoreAdvancedSiteSearchConfig
- DataStoreArgs
- The set of arguments for DataStore. The set of arguments for DataStore.
- DataStoreDocumentProcessingConfig
- DataStoreDocumentProcessingConfigChunkingConfig
- DataStoreDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig
- DataStoreDocumentProcessingConfigDefaultParsingConfig
- DataStoreDocumentProcessingConfigDefaultParsingConfigLayoutParsingConfig
- DataStoreDocumentProcessingConfigDefaultParsingConfigOcrParsingConfig
- DataStoreDocumentProcessingConfigParsingConfigOverride
- DataStoreDocumentProcessingConfigParsingConfigOverrideLayoutParsingConfig
- DataStoreDocumentProcessingConfigParsingConfigOverrideOcrParsingConfig
- DataStoreState
- Input properties used for looking up and filtering DataStore resources.
- GetDataStoreAdvancedSiteSearchConfig
- GetDataStoreArgs
- Arguments for getDataStore. Arguments for getDataStore.
- GetDataStoreDocumentProcessingConfig
- GetDataStoreDocumentProcessingConfigChunkingConfig
- GetDataStoreDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig
- GetDataStoreDocumentProcessingConfigDefaultParsingConfig
- GetDataStoreDocumentProcessingConfigDefaultParsingConfigLayoutParsingConfig
- GetDataStoreDocumentProcessingConfigDefaultParsingConfigOcrParsingConfig
- GetDataStoreDocumentProcessingConfigParsingConfigOverride
- GetDataStoreDocumentProcessingConfigParsingConfigOverrideLayoutParsingConfig
- GetDataStoreDocumentProcessingConfigParsingConfigOverrideOcrParsingConfig
- GetDataStoreResult
- Result data returned by getDataStore.
- GetDataStoresArgs
- Arguments for getDataStores. Arguments for getDataStores.
- GetDataStoresDataStore
- GetDataStoresResult
- Result data returned by getDataStores.
- GetSearchEngineIamPolicyArgs
- Arguments for getSearchEngineIamPolicy. Arguments for getSearchEngineIamPolicy.
- GetSearchEngineIamPolicyResult
- Result data returned by getSearchEngineIamPolicy.
- LicenseConfig
- License Configuration.
- LicenseConfigArgs
- The set of arguments for LicenseConfig. The set of arguments for LicenseConfig.
- LicenseConfigEndDate
- LicenseConfigStartDate
- LicenseConfigState
- Input properties used for looking up and filtering LicenseConfig resources.
- RecommendationEngine
- Vertex AI Search recommendation apps.
- RecommendationEngineArgs
- The set of arguments for RecommendationEngine. The set of arguments for RecommendationEngine.
- RecommendationEngineCommonConfig
- RecommendationEngineMediaRecommendationEngineConfig
- RecommendationEngineMediaRecommendationEngineConfigEngineFeaturesConfig
- RecommendationEngineMediaRecommendationEngineConfigEngineFeaturesConfigMostPopularConfig
- RecommendationEngineMediaRecommendationEngineConfigEngineFeaturesConfigRecommendedForYouConfig
- RecommendationEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
- RecommendationEngineState
- Input properties used for looking up and filtering RecommendationEngine resources.
- Schema
- Schema defines the structure and layout of a type of document data.
- SchemaArgs
- The set of arguments for Schema. The set of arguments for Schema.
- SchemaState
- Input properties used for looking up and filtering Schema resources.
- SearchEngine
- Vertex AI Search and Conversation can be used to create a search engine or a chat application by connecting it with a datastore
- SearchEngineArgs
- The set of arguments for SearchEngine. The set of arguments for SearchEngine.
- SearchEngineCommonConfig
- SearchEngineIamBinding
- Three different resources help you manage your IAM policy for Discovery Engine SearchEngine. Each of these resources serves a different use case:
- SearchEngineIamBindingArgs
- The set of arguments for SearchEngineIamBinding. The set of arguments for SearchEngineIamBinding.
- SearchEngineIamBindingCondition
- SearchEngineIamBindingState
- Input properties used for looking up and filtering SearchEngineIamBinding resources.
- SearchEngineIamMember
- Three different resources help you manage your IAM policy for Discovery Engine SearchEngine. Each of these resources serves a different use case:
- SearchEngineIamMemberArgs
- The set of arguments for SearchEngineIamMember. The set of arguments for SearchEngineIamMember.
- SearchEngineIamMemberCondition
- SearchEngineIamMemberState
- Input properties used for looking up and filtering SearchEngineIamMember resources.
- SearchEngineIamPolicy
- Three different resources help you manage your IAM policy for Discovery Engine SearchEngine. Each of these resources serves a different use case:
- SearchEngineIamPolicyArgs
- The set of arguments for SearchEngineIamPolicy. The set of arguments for SearchEngineIamPolicy.
- SearchEngineIamPolicyState
- Input properties used for looking up and filtering SearchEngineIamPolicy resources.
- SearchEngineKnowledgeGraphConfig
- SearchEngineKnowledgeGraphConfigFeatureConfig
- SearchEngineSearchEngineConfig
- SearchEngineState
- Input properties used for looking up and filtering SearchEngine resources.
- ServingConfig
- Represents a serving config which is a singleton resource under engine. A default serving config is automatically provisioned and deleted with its parent engine.
- ServingConfigArgs
- The set of arguments for ServingConfig. The set of arguments for ServingConfig.
- ServingConfigState
- Input properties used for looking up and filtering ServingConfig resources.
- Sitemap
- Sitemap is a file where you provide information about the pages, videos, and other files on your site, and the relationships between them.
- SitemapArgs
- The set of arguments for Sitemap. The set of arguments for Sitemap.
- SitemapState
- Input properties used for looking up and filtering Sitemap resources.
- TargetSite
- TargetSite represents a URI pattern that the users want to confine their search.
- TargetSiteArgs
- The set of arguments for TargetSite. The set of arguments for TargetSite.
- TargetSiteFailureReason
- TargetSiteFailureReasonQuotaFailure
- TargetSiteSiteVerificationInfo
- TargetSiteState
- Input properties used for looking up and filtering TargetSite resources.
- UserStore
- Represents a user store.
- UserStoreArgs
- The set of arguments for UserStore. The set of arguments for UserStore.
- UserStoreState
- Input properties used for looking up and filtering UserStore resources.
- WidgetConfig
- Represents a WidgetConfig.
- WidgetConfigAccessSettings
- WidgetConfigArgs
- The set of arguments for WidgetConfig. The set of arguments for WidgetConfig.
- WidgetConfigHomepageSetting
- WidgetConfigHomepageSettingShortcut
- WidgetConfigHomepageSettingShortcutIcon
- WidgetConfigState
- Input properties used for looking up and filtering WidgetConfig resources.
- WidgetConfigUiBranding
- WidgetConfigUiBrandingLogo
- WidgetConfigUiSettings
- WidgetConfigUiSettingsDataStoreUiConfig
- WidgetConfigUiSettingsDataStoreUiConfigFacetField
- WidgetConfigUiSettingsDataStoreUiConfigFieldsUiComponentsMap
- WidgetConfigUiSettingsGenerativeAnswerConfig
Functions
-
getDataStore(
GetDataStoreArgs args, {InvokeOptions? options}) → Future< GetDataStoreResult> - Gets an existing Discovery Engine data store by ID or display name. See the official documentation and API.
-
getDataStoreOutput(
GetDataStoreArgs args, {InvokeOutputOptions? options}) → Output< GetDataStoreResult> -
getDataStores(
GetDataStoresArgs args, {InvokeOptions? options}) → Future< GetDataStoresResult> - Gets a list of existing Discovery Engine data stores. See the official documentation and API.
-
getDataStoresOutput(
GetDataStoresArgs args, {InvokeOutputOptions? options}) → Output< GetDataStoresResult> -
getSearchEngineIamPolicy(
GetSearchEngineIamPolicyArgs args, {InvokeOptions? options}) → Future< GetSearchEngineIamPolicyResult> - Retrieves the current IAM policy data for searchengine
-
getSearchEngineIamPolicyOutput(
GetSearchEngineIamPolicyArgs args, {InvokeOutputOptions? options}) → Output< GetSearchEngineIamPolicyResult>