Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. discoveryengine
  5. discoveryengine/v1alpha
  6. getEngine

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.discoveryengine/v1alpha.getEngine

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Gets a Engine.

    Using getEngine

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEngine(args: GetEngineArgs, opts?: InvokeOptions): Promise<GetEngineResult>
function getEngineOutput(args: GetEngineOutputArgs, opts?: InvokeOptions): Output<GetEngineResult>
    def get_engine(collection_id: Optional[str] = None,
               engine_id: Optional[str] = None,
               location: Optional[str] = None,
               project: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetEngineResult
def get_engine_output(collection_id: Optional[pulumi.Input[str]] = None,
               engine_id: Optional[pulumi.Input[str]] = None,
               location: Optional[pulumi.Input[str]] = None,
               project: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetEngineResult]
    func LookupEngine(ctx *Context, args *LookupEngineArgs, opts ...InvokeOption) (*LookupEngineResult, error)
func LookupEngineOutput(ctx *Context, args *LookupEngineOutputArgs, opts ...InvokeOption) LookupEngineResultOutput

    > Note: This function is named LookupEngine in the Go SDK.

    public static class GetEngine 
{
    public static Task<GetEngineResult> InvokeAsync(GetEngineArgs args, InvokeOptions? opts = null)
    public static Output<GetEngineResult> Invoke(GetEngineInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEngineResult> getEngine(GetEngineArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:discoveryengine/v1alpha:getEngine
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CollectionId string
    EngineId string
    Location string
    Project string
    CollectionId string
    EngineId string
    Location string
    Project string
    collectionId String
    engineId String
    location String
    project String
    collectionId string
    engineId string
    location string
    project string
    collectionId String
    engineId String
    location String
    project String

    getEngine Result

    The following output properties are available:

    ChatEngineConfig Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Outputs.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigResponse
    Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    ChatEngineMetadata Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Outputs.GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadataResponse
    Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    CommonConfig Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Outputs.GoogleCloudDiscoveryengineV1alphaEngineCommonConfigResponse
    Common config spec that specifies the metadata of the engine.
    CreateTime string
    Timestamp the Recommendation Engine was created at.
    DataStoreIds List<string>
    The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary intializations.
    DisplayName string
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    IndustryVertical string
    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.
    MediaRecommendationEngineConfig Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Outputs.GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigResponse
    Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
    Name string
    Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
    RecommendationMetadata Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Outputs.GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadataResponse
    Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
    SearchEngineConfig Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Outputs.GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigResponse
    Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
    SimilarDocumentsConfig Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Outputs.GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfigResponse
    Additional config specs for a similar-items engine.
    SolutionType string
    The solutions of the engine.
    UpdateTime string
    Timestamp the Recommendation Engine was last updated.
    ChatEngineConfig GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigResponse
    Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    ChatEngineMetadata GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadataResponse
    Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    CommonConfig GoogleCloudDiscoveryengineV1alphaEngineCommonConfigResponse
    Common config spec that specifies the metadata of the engine.
    CreateTime string
    Timestamp the Recommendation Engine was created at.
    DataStoreIds []string
    The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary intializations.
    DisplayName string
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    IndustryVertical string
    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.
    MediaRecommendationEngineConfig GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigResponse
    Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
    Name string
    Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
    RecommendationMetadata GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadataResponse
    Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
    SearchEngineConfig GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigResponse
    Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
    SimilarDocumentsConfig GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfigResponse
    Additional config specs for a similar-items engine.
    SolutionType string
    The solutions of the engine.
    UpdateTime string
    Timestamp the Recommendation Engine was last updated.
    chatEngineConfig GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigResponse
    Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    chatEngineMetadata GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadataResponse
    Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    commonConfig GoogleCloudDiscoveryengineV1alphaEngineCommonConfigResponse
    Common config spec that specifies the metadata of the engine.
    createTime String
    Timestamp the Recommendation Engine was created at.
    dataStoreIds List<String>
    The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary intializations.
    displayName String
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    industryVertical String
    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.
    mediaRecommendationEngineConfig GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigResponse
    Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
    name String
    Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
    recommendationMetadata GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadataResponse
    Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
    searchEngineConfig GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigResponse
    Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
    similarDocumentsConfig GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfigResponse
    Additional config specs for a similar-items engine.
    solutionType String
    The solutions of the engine.
    updateTime String
    Timestamp the Recommendation Engine was last updated.
    chatEngineConfig GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigResponse
    Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    chatEngineMetadata GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadataResponse
    Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    commonConfig GoogleCloudDiscoveryengineV1alphaEngineCommonConfigResponse
    Common config spec that specifies the metadata of the engine.
    createTime string
    Timestamp the Recommendation Engine was created at.
    dataStoreIds string[]
    The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary intializations.
    displayName string
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    industryVertical string
    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.
    mediaRecommendationEngineConfig GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigResponse
    Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
    name string
    Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
    recommendationMetadata GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadataResponse
    Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
    searchEngineConfig GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigResponse
    Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
    similarDocumentsConfig GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfigResponse
    Additional config specs for a similar-items engine.
    solutionType string
    The solutions of the engine.
    updateTime string
    Timestamp the Recommendation Engine was last updated.
    chat_engine_config GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigResponse
    Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    chat_engine_metadata GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadataResponse
    Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    common_config GoogleCloudDiscoveryengineV1alphaEngineCommonConfigResponse
    Common config spec that specifies the metadata of the engine.
    create_time str
    Timestamp the Recommendation Engine was created at.
    data_store_ids Sequence[str]
    The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary intializations.
    display_name str
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    industry_vertical str
    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.
    media_recommendation_engine_config GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigResponse
    Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
    name str
    Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
    recommendation_metadata GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadataResponse
    Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
    search_engine_config GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigResponse
    Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
    similar_documents_config GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfigResponse
    Additional config specs for a similar-items engine.
    solution_type str
    The solutions of the engine.
    update_time str
    Timestamp the Recommendation Engine was last updated.
    chatEngineConfig Property Map
    Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    chatEngineMetadata Property Map
    Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    commonConfig Property Map
    Common config spec that specifies the metadata of the engine.
    createTime String
    Timestamp the Recommendation Engine was created at.
    dataStoreIds List<String>
    The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary intializations.
    displayName String
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    industryVertical String
    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.
    mediaRecommendationEngineConfig Property Map
    Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
    name String
    Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
    recommendationMetadata Property Map
    Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
    searchEngineConfig Property Map
    Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
    similarDocumentsConfig Property Map
    Additional config specs for a similar-items engine.
    solutionType String
    The solutions of the engine.
    updateTime String
    Timestamp the Recommendation Engine was last updated.

    Supporting Types

    GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfigResponse

    Business string
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    DefaultLanguageCode string
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.
    TimeZone string
    The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
    Business string
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    DefaultLanguageCode string
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.
    TimeZone string
    The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
    business String
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    defaultLanguageCode String
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.
    timeZone String
    The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
    business string
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    defaultLanguageCode string
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.
    timeZone string
    The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
    business str
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    default_language_code str
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.
    time_zone str
    The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
    business String
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    defaultLanguageCode String
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.
    timeZone String
    The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

    GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigResponse

    AgentCreationConfig Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfigResponse
    The configurationt generate the Dialogflow agent that is associated to this Engine. 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.
    DialogflowAgentToLink string
    The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide agent_creation_config to create agent or provide an agent name that links the agent with the Chat engine. Format: projects//locations//agents/. Note that the dialogflow_agent_to_link 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. Please use chat_engine_metadata.dialogflow_agent for actual agent association after Engine is created.
    AgentCreationConfig GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfigResponse
    The configurationt generate the Dialogflow agent that is associated to this Engine. 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.
    DialogflowAgentToLink string
    The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide agent_creation_config to create agent or provide an agent name that links the agent with the Chat engine. Format: projects//locations//agents/. Note that the dialogflow_agent_to_link 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. Please use chat_engine_metadata.dialogflow_agent for actual agent association after Engine is created.
    agentCreationConfig GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfigResponse
    The configurationt generate the Dialogflow agent that is associated to this Engine. 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.
    dialogflowAgentToLink String
    The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide agent_creation_config to create agent or provide an agent name that links the agent with the Chat engine. Format: projects//locations//agents/. Note that the dialogflow_agent_to_link 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. Please use chat_engine_metadata.dialogflow_agent for actual agent association after Engine is created.
    agentCreationConfig GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfigResponse
    The configurationt generate the Dialogflow agent that is associated to this Engine. 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.
    dialogflowAgentToLink string
    The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide agent_creation_config to create agent or provide an agent name that links the agent with the Chat engine. Format: projects//locations//agents/. Note that the dialogflow_agent_to_link 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. Please use chat_engine_metadata.dialogflow_agent for actual agent association after Engine is created.
    agent_creation_config GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfigResponse
    The configurationt generate the Dialogflow agent that is associated to this Engine. 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.
    dialogflow_agent_to_link str
    The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide agent_creation_config to create agent or provide an agent name that links the agent with the Chat engine. Format: projects//locations//agents/. Note that the dialogflow_agent_to_link 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. Please use chat_engine_metadata.dialogflow_agent for actual agent association after Engine is created.
    agentCreationConfig Property Map
    The configurationt generate the Dialogflow agent that is associated to this Engine. 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.
    dialogflowAgentToLink String
    The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide agent_creation_config to create agent or provide an agent name that links the agent with the Chat engine. Format: projects//locations//agents/. Note that the dialogflow_agent_to_link 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. Please use chat_engine_metadata.dialogflow_agent for actual agent association after Engine is created.

    GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadataResponse

    DialogflowAgent string
    The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: projects//locations//agents/.
    DialogflowAgent string
    The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: projects//locations//agents/.
    dialogflowAgent String
    The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: projects//locations//agents/.
    dialogflowAgent string
    The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: projects//locations//agents/.
    dialogflow_agent str
    The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: projects//locations//agents/.
    dialogflowAgent String
    The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: projects//locations//agents/.

    GoogleCloudDiscoveryengineV1alphaEngineCommonConfigResponse

    CompanyName string
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
    CompanyName string
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
    companyName String
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
    companyName string
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
    company_name str
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
    companyName String
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.

    GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfigResponse

    TargetField string
    The name of the field to target. Currently supported values: watch-percentage, watch-time.
    TargetFieldValueFloat double
    The threshold to be applied to the target (e.g., 0.5).
    TargetField string
    The name of the field to target. Currently supported values: watch-percentage, watch-time.
    TargetFieldValueFloat float64
    The threshold to be applied to the target (e.g., 0.5).
    targetField String
    The name of the field to target. Currently supported values: watch-percentage, watch-time.
    targetFieldValueFloat Double
    The threshold to be applied to the target (e.g., 0.5).
    targetField string
    The name of the field to target. Currently supported values: watch-percentage, watch-time.
    targetFieldValueFloat number
    The threshold to be applied to the target (e.g., 0.5).
    target_field str
    The name of the field to target. Currently supported values: watch-percentage, watch-time.
    target_field_value_float float
    The threshold to be applied to the target (e.g., 0.5).
    targetField String
    The name of the field to target. Currently supported values: watch-percentage, watch-time.
    targetFieldValueFloat Number
    The threshold to be applied to the target (e.g., 0.5).

    GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigResponse

    OptimizationObjective string
    The optimization objective e.g. cvr. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: ctr, cvr. If not specified, we choose default based on engine type. Default depends on type of recommendation: recommended-for-you => ctr others-you-may-like => ctr
    OptimizationObjectiveConfig Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfigResponse
    Name and value of the custom threshold for cvr optimization_objective. For target_field watch-time, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field watch-percentage, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5).
    TrainingState string
    The training state that the engine is in (e.g. TRAINING or PAUSED). 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 for CreateEngine method is TRAINING. The default value for UpdateEngine method is to keep the state the same as before.
    Type string
    The type of engine e.g. recommended-for-you. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: recommended-for-you, others-you-may-like, more-like-this, most-popular-items.
    OptimizationObjective string
    The optimization objective e.g. cvr. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: ctr, cvr. If not specified, we choose default based on engine type. Default depends on type of recommendation: recommended-for-you => ctr others-you-may-like => ctr
    OptimizationObjectiveConfig GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfigResponse
    Name and value of the custom threshold for cvr optimization_objective. For target_field watch-time, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field watch-percentage, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5).
    TrainingState string
    The training state that the engine is in (e.g. TRAINING or PAUSED). 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 for CreateEngine method is TRAINING. The default value for UpdateEngine method is to keep the state the same as before.
    Type string
    The type of engine e.g. recommended-for-you. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: recommended-for-you, others-you-may-like, more-like-this, most-popular-items.
    optimizationObjective String
    The optimization objective e.g. cvr. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: ctr, cvr. If not specified, we choose default based on engine type. Default depends on type of recommendation: recommended-for-you => ctr others-you-may-like => ctr
    optimizationObjectiveConfig GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfigResponse
    Name and value of the custom threshold for cvr optimization_objective. For target_field watch-time, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field watch-percentage, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5).
    trainingState String
    The training state that the engine is in (e.g. TRAINING or PAUSED). 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 for CreateEngine method is TRAINING. The default value for UpdateEngine method is to keep the state the same as before.
    type String
    The type of engine e.g. recommended-for-you. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: recommended-for-you, others-you-may-like, more-like-this, most-popular-items.
    optimizationObjective string
    The optimization objective e.g. cvr. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: ctr, cvr. If not specified, we choose default based on engine type. Default depends on type of recommendation: recommended-for-you => ctr others-you-may-like => ctr
    optimizationObjectiveConfig GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfigResponse
    Name and value of the custom threshold for cvr optimization_objective. For target_field watch-time, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field watch-percentage, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5).
    trainingState string
    The training state that the engine is in (e.g. TRAINING or PAUSED). 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 for CreateEngine method is TRAINING. The default value for UpdateEngine method is to keep the state the same as before.
    type string
    The type of engine e.g. recommended-for-you. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: recommended-for-you, others-you-may-like, more-like-this, most-popular-items.
    optimization_objective str
    The optimization objective e.g. cvr. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: ctr, cvr. If not specified, we choose default based on engine type. Default depends on type of recommendation: recommended-for-you => ctr others-you-may-like => ctr
    optimization_objective_config GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfigResponse
    Name and value of the custom threshold for cvr optimization_objective. For target_field watch-time, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field watch-percentage, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5).
    training_state str
    The training state that the engine is in (e.g. TRAINING or PAUSED). 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 for CreateEngine method is TRAINING. The default value for UpdateEngine method is to keep the state the same as before.
    type str
    The type of engine e.g. recommended-for-you. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: recommended-for-you, others-you-may-like, more-like-this, most-popular-items.
    optimizationObjective String
    The optimization objective e.g. cvr. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: ctr, cvr. If not specified, we choose default based on engine type. Default depends on type of recommendation: recommended-for-you => ctr others-you-may-like => ctr
    optimizationObjectiveConfig Property Map
    Name and value of the custom threshold for cvr optimization_objective. For target_field watch-time, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field watch-percentage, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5).
    trainingState String
    The training state that the engine is in (e.g. TRAINING or PAUSED). 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 for CreateEngine method is TRAINING. The default value for UpdateEngine method is to keep the state the same as before.
    type String
    The type of engine e.g. recommended-for-you. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: recommended-for-you, others-you-may-like, more-like-this, most-popular-items.

    GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadataResponse

    DataState string
    The state of data requirements for this engine: DATA_OK and DATA_ERROR. Engine cannot be trained if the data is in DATA_ERROR state. Engine can have DATA_ERROR state even if serving state is ACTIVE: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.
    LastTuneTime string
    The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.
    ServingState string
    The serving state of the engine: ACTIVE, NOT_ACTIVE.
    TuningOperation string
    The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.
    DataState string
    The state of data requirements for this engine: DATA_OK and DATA_ERROR. Engine cannot be trained if the data is in DATA_ERROR state. Engine can have DATA_ERROR state even if serving state is ACTIVE: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.
    LastTuneTime string
    The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.
    ServingState string
    The serving state of the engine: ACTIVE, NOT_ACTIVE.
    TuningOperation string
    The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.
    dataState String
    The state of data requirements for this engine: DATA_OK and DATA_ERROR. Engine cannot be trained if the data is in DATA_ERROR state. Engine can have DATA_ERROR state even if serving state is ACTIVE: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.
    lastTuneTime String
    The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.
    servingState String
    The serving state of the engine: ACTIVE, NOT_ACTIVE.
    tuningOperation String
    The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.
    dataState string
    The state of data requirements for this engine: DATA_OK and DATA_ERROR. Engine cannot be trained if the data is in DATA_ERROR state. Engine can have DATA_ERROR state even if serving state is ACTIVE: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.
    lastTuneTime string
    The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.
    servingState string
    The serving state of the engine: ACTIVE, NOT_ACTIVE.
    tuningOperation string
    The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.
    data_state str
    The state of data requirements for this engine: DATA_OK and DATA_ERROR. Engine cannot be trained if the data is in DATA_ERROR state. Engine can have DATA_ERROR state even if serving state is ACTIVE: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.
    last_tune_time str
    The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.
    serving_state str
    The serving state of the engine: ACTIVE, NOT_ACTIVE.
    tuning_operation str
    The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.
    dataState String
    The state of data requirements for this engine: DATA_OK and DATA_ERROR. Engine cannot be trained if the data is in DATA_ERROR state. Engine can have DATA_ERROR state even if serving state is ACTIVE: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.
    lastTuneTime String
    The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.
    servingState String
    The serving state of the engine: ACTIVE, NOT_ACTIVE.
    tuningOperation String
    The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.

    GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigResponse

    SearchAddOns List<string>
    The add-on that this search engine enables.
    SearchTier string
    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.
    SearchAddOns []string
    The add-on that this search engine enables.
    SearchTier string
    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.
    searchAddOns List<String>
    The add-on that this search engine enables.
    searchTier String
    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.
    searchAddOns string[]
    The add-on that this search engine enables.
    searchTier string
    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.
    search_add_ons Sequence[str]
    The add-on that this search engine enables.
    search_tier str
    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.
    searchAddOns List<String>
    The add-on that this search engine enables.
    searchTier String
    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.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native