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

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

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

    Creates a Engine.

    Create Engine Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Engine(name: string, args: EngineArgs, opts?: CustomResourceOptions);
    @overload
def Engine(resource_name: str,
           args: EngineArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Engine(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           display_name: Optional[str] = None,
           collection_id: Optional[str] = None,
           solution_type: Optional[EngineSolutionType] = None,
           engine_id: Optional[str] = None,
           industry_vertical: Optional[EngineIndustryVertical] = None,
           data_store_ids: Optional[Sequence[str]] = None,
           chat_engine_config: Optional[GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigArgs] = None,
           location: Optional[str] = None,
           media_recommendation_engine_config: Optional[GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigArgs] = None,
           name: Optional[str] = None,
           project: Optional[str] = None,
           search_engine_config: Optional[GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigArgs] = None,
           similar_documents_config: Optional[GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfigArgs] = None,
           common_config: Optional[GoogleCloudDiscoveryengineV1alphaEngineCommonConfigArgs] = None)
    func NewEngine(ctx *Context, name string, args EngineArgs, opts ...ResourceOption) (*Engine, error)
    public Engine(string name, EngineArgs args, CustomResourceOptions? opts = null)
    public Engine(String name, EngineArgs args)
public Engine(String name, EngineArgs args, CustomResourceOptions options)

    type: google-native:discoveryengine/v1alpha:Engine
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EngineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EngineArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EngineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EngineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EngineArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var engineResource = new GoogleNative.DiscoveryEngine.V1Alpha.Engine("engineResource", new()
{
    DisplayName = "string",
    CollectionId = "string",
    SolutionType = GoogleNative.DiscoveryEngine.V1Alpha.EngineSolutionType.SolutionTypeUnspecified,
    EngineId = "string",
    IndustryVertical = GoogleNative.DiscoveryEngine.V1Alpha.EngineIndustryVertical.IndustryVerticalUnspecified,
    DataStoreIds = new[]
    {
        "string",
    },
    ChatEngineConfig = new GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigArgs
    {
        AgentCreationConfig = new GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfigArgs
        {
            DefaultLanguageCode = "string",
            TimeZone = "string",
            Business = "string",
        },
        DialogflowAgentToLink = "string",
    },
    Location = "string",
    MediaRecommendationEngineConfig = new GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigArgs
    {
        Type = "string",
        OptimizationObjective = "string",
        OptimizationObjectiveConfig = new GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfigArgs
        {
            TargetField = "string",
            TargetFieldValueFloat = 0,
        },
        TrainingState = GoogleNative.DiscoveryEngine.V1Alpha.GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigTrainingState.TrainingStateUnspecified,
    },
    Name = "string",
    Project = "string",
    SearchEngineConfig = new GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigArgs
    {
        SearchAddOns = new[]
        {
            GoogleNative.DiscoveryEngine.V1Alpha.GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchAddOnsItem.SearchAddOnUnspecified,
        },
        SearchTier = GoogleNative.DiscoveryEngine.V1Alpha.GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchTier.SearchTierUnspecified,
    },
    SimilarDocumentsConfig = null,
    CommonConfig = new GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaEngineCommonConfigArgs
    {
        CompanyName = "string",
    },
});

    example, err := discoveryengine.NewEngine(ctx, "engineResource", &discoveryengine.EngineArgs{
DisplayName: pulumi.String("string"),
CollectionId: pulumi.String("string"),
SolutionType: discoveryengine.EngineSolutionTypeSolutionTypeUnspecified,
EngineId: pulumi.String("string"),
IndustryVertical: discoveryengine.EngineIndustryVerticalIndustryVerticalUnspecified,
DataStoreIds: pulumi.StringArray{
pulumi.String("string"),
},
ChatEngineConfig: &discoveryengine.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigArgs{
AgentCreationConfig: &discoveryengine.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfigArgs{
DefaultLanguageCode: pulumi.String("string"),
TimeZone: pulumi.String("string"),
Business: pulumi.String("string"),
},
DialogflowAgentToLink: pulumi.String("string"),
},
Location: pulumi.String("string"),
MediaRecommendationEngineConfig: &discoveryengine.GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigArgs{
Type: pulumi.String("string"),
OptimizationObjective: pulumi.String("string"),
OptimizationObjectiveConfig: &discoveryengine.GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfigArgs{
TargetField: pulumi.String("string"),
TargetFieldValueFloat: pulumi.Float64(0),
},
TrainingState: discoveryengine.GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigTrainingStateTrainingStateUnspecified,
},
Name: pulumi.String("string"),
Project: pulumi.String("string"),
SearchEngineConfig: &discoveryengine.GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigArgs{
SearchAddOns: discoveryengine.GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchAddOnsItemArray{
discoveryengine.GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchAddOnsItemSearchAddOnUnspecified,
},
SearchTier: discoveryengine.GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchTierSearchTierUnspecified,
},
SimilarDocumentsConfig: nil,
CommonConfig: &discoveryengine.GoogleCloudDiscoveryengineV1alphaEngineCommonConfigArgs{
CompanyName: pulumi.String("string"),
},
})

    var engineResource = new Engine("engineResource", EngineArgs.builder()        
    .displayName("string")
    .collectionId("string")
    .solutionType("SOLUTION_TYPE_UNSPECIFIED")
    .engineId("string")
    .industryVertical("INDUSTRY_VERTICAL_UNSPECIFIED")
    .dataStoreIds("string")
    .chatEngineConfig(GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigArgs.builder()
        .agentCreationConfig(GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfigArgs.builder()
            .defaultLanguageCode("string")
            .timeZone("string")
            .business("string")
            .build())
        .dialogflowAgentToLink("string")
        .build())
    .location("string")
    .mediaRecommendationEngineConfig(GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigArgs.builder()
        .type("string")
        .optimizationObjective("string")
        .optimizationObjectiveConfig(GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfigArgs.builder()
            .targetField("string")
            .targetFieldValueFloat(0)
            .build())
        .trainingState("TRAINING_STATE_UNSPECIFIED")
        .build())
    .name("string")
    .project("string")
    .searchEngineConfig(GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigArgs.builder()
        .searchAddOns("SEARCH_ADD_ON_UNSPECIFIED")
        .searchTier("SEARCH_TIER_UNSPECIFIED")
        .build())
    .similarDocumentsConfig()
    .commonConfig(GoogleCloudDiscoveryengineV1alphaEngineCommonConfigArgs.builder()
        .companyName("string")
        .build())
    .build());

    engine_resource = google_native.discoveryengine.v1alpha.Engine("engineResource",
    display_name="string",
    collection_id="string",
    solution_type=google_native.discoveryengine.v1alpha.EngineSolutionType.SOLUTION_TYPE_UNSPECIFIED,
    engine_id="string",
    industry_vertical=google_native.discoveryengine.v1alpha.EngineIndustryVertical.INDUSTRY_VERTICAL_UNSPECIFIED,
    data_store_ids=["string"],
    chat_engine_config=google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigArgs(
        agent_creation_config=google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfigArgs(
            default_language_code="string",
            time_zone="string",
            business="string",
        ),
        dialogflow_agent_to_link="string",
    ),
    location="string",
    media_recommendation_engine_config=google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigArgs(
        type="string",
        optimization_objective="string",
        optimization_objective_config=google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfigArgs(
            target_field="string",
            target_field_value_float=0,
        ),
        training_state=google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigTrainingState.TRAINING_STATE_UNSPECIFIED,
    ),
    name="string",
    project="string",
    search_engine_config=google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigArgs(
        search_add_ons=[google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchAddOnsItem.SEARCH_ADD_ON_UNSPECIFIED],
        search_tier=google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchTier.SEARCH_TIER_UNSPECIFIED,
    ),
    similar_documents_config=google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfigArgs(),
    common_config=google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaEngineCommonConfigArgs(
        company_name="string",
    ))

    const engineResource = new google_native.discoveryengine.v1alpha.Engine("engineResource", {
    displayName: "string",
    collectionId: "string",
    solutionType: google_native.discoveryengine.v1alpha.EngineSolutionType.SolutionTypeUnspecified,
    engineId: "string",
    industryVertical: google_native.discoveryengine.v1alpha.EngineIndustryVertical.IndustryVerticalUnspecified,
    dataStoreIds: ["string"],
    chatEngineConfig: {
        agentCreationConfig: {
            defaultLanguageCode: "string",
            timeZone: "string",
            business: "string",
        },
        dialogflowAgentToLink: "string",
    },
    location: "string",
    mediaRecommendationEngineConfig: {
        type: "string",
        optimizationObjective: "string",
        optimizationObjectiveConfig: {
            targetField: "string",
            targetFieldValueFloat: 0,
        },
        trainingState: google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigTrainingState.TrainingStateUnspecified,
    },
    name: "string",
    project: "string",
    searchEngineConfig: {
        searchAddOns: [google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchAddOnsItem.SearchAddOnUnspecified],
        searchTier: google_native.discoveryengine.v1alpha.GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchTier.SearchTierUnspecified,
    },
    similarDocumentsConfig: {},
    commonConfig: {
        companyName: "string",
    },
});

    type: google-native:discoveryengine/v1alpha:Engine
properties:
    chatEngineConfig:
        agentCreationConfig:
            business: string
            defaultLanguageCode: string
            timeZone: string
        dialogflowAgentToLink: string
    collectionId: string
    commonConfig:
        companyName: string
    dataStoreIds:
        - string
    displayName: string
    engineId: string
    industryVertical: INDUSTRY_VERTICAL_UNSPECIFIED
    location: string
    mediaRecommendationEngineConfig:
        optimizationObjective: string
        optimizationObjectiveConfig:
            targetField: string
            targetFieldValueFloat: 0
        trainingState: TRAINING_STATE_UNSPECIFIED
        type: string
    name: string
    project: string
    searchEngineConfig:
        searchAddOns:
            - SEARCH_ADD_ON_UNSPECIFIED
        searchTier: SEARCH_TIER_UNSPECIFIED
    similarDocumentsConfig: {}
    solutionType: SOLUTION_TYPE_UNSPECIFIED

    Engine Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Engine resource accepts the following input properties:

    CollectionId string
    DisplayName string
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    EngineId string
    Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
    SolutionType Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.EngineSolutionType
    The solutions of the engine.
    ChatEngineConfig Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig
    Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    CommonConfig Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaEngineCommonConfig
    Common config spec that specifies the metadata of the engine.
    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.
    IndustryVertical Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.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.
    Location string
    MediaRecommendationEngineConfig Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
    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.
    Project string
    SearchEngineConfig Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig
    Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
    SimilarDocumentsConfig Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig
    Additional config specs for a similar-items engine.
    CollectionId string
    DisplayName string
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    EngineId string
    Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
    SolutionType EngineSolutionType
    The solutions of the engine.
    ChatEngineConfig GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigArgs
    Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    CommonConfig GoogleCloudDiscoveryengineV1alphaEngineCommonConfigArgs
    Common config spec that specifies the metadata of the engine.
    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.
    IndustryVertical 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.
    Location string
    MediaRecommendationEngineConfig GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigArgs
    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.
    Project string
    SearchEngineConfig GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigArgs
    Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
    SimilarDocumentsConfig GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfigArgs
    Additional config specs for a similar-items engine.
    collectionId String
    displayName String
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engineId String
    Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
    solutionType EngineSolutionType
    The solutions of the engine.
    chatEngineConfig GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig
    Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    commonConfig GoogleCloudDiscoveryengineV1alphaEngineCommonConfig
    Common config spec that specifies the metadata of the engine.
    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.
    industryVertical 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.
    location String
    mediaRecommendationEngineConfig GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
    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.
    project String
    searchEngineConfig GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig
    Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
    similarDocumentsConfig GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig
    Additional config specs for a similar-items engine.
    collectionId string
    displayName string
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engineId string
    Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
    solutionType EngineSolutionType
    The solutions of the engine.
    chatEngineConfig GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig
    Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    commonConfig GoogleCloudDiscoveryengineV1alphaEngineCommonConfig
    Common config spec that specifies the metadata of the engine.
    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.
    industryVertical 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.
    location string
    mediaRecommendationEngineConfig GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
    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.
    project string
    searchEngineConfig GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig
    Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
    similarDocumentsConfig GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig
    Additional config specs for a similar-items engine.
    collection_id str
    display_name str
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engine_id str
    Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
    solution_type EngineSolutionType
    The solutions of the engine.
    chat_engine_config GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigArgs
    Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    common_config GoogleCloudDiscoveryengineV1alphaEngineCommonConfigArgs
    Common config spec that specifies the metadata of the engine.
    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.
    industry_vertical 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.
    location str
    media_recommendation_engine_config GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigArgs
    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.
    project str
    search_engine_config GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigArgs
    Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
    similar_documents_config GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfigArgs
    Additional config specs for a similar-items engine.
    collectionId String
    displayName String
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engineId String
    Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
    solutionType "SOLUTION_TYPE_UNSPECIFIED" | "SOLUTION_TYPE_RECOMMENDATION" | "SOLUTION_TYPE_SEARCH" | "SOLUTION_TYPE_CHAT"
    The solutions of the engine.
    chatEngineConfig Property Map
    Configurations for 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.
    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.
    industryVertical "INDUSTRY_VERTICAL_UNSPECIFIED" | "GENERIC" | "MEDIA"
    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.
    location String
    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.
    project String
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Engine resource produces the following output properties:

    ChatEngineMetadata Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Outputs.GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadataResponse
    Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    CreateTime string
    Timestamp the Recommendation Engine was created at.
    Id string
    The provider-assigned unique ID for this managed resource.
    RecommendationMetadata Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Outputs.GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadataResponse
    Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
    UpdateTime string
    Timestamp the Recommendation Engine was last updated.
    ChatEngineMetadata GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadataResponse
    Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    CreateTime string
    Timestamp the Recommendation Engine was created at.
    Id string
    The provider-assigned unique ID for this managed resource.
    RecommendationMetadata GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadataResponse
    Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
    UpdateTime string
    Timestamp the Recommendation Engine was last updated.
    chatEngineMetadata GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadataResponse
    Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    createTime String
    Timestamp the Recommendation Engine was created at.
    id String
    The provider-assigned unique ID for this managed resource.
    recommendationMetadata GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadataResponse
    Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
    updateTime String
    Timestamp the Recommendation Engine was last updated.
    chatEngineMetadata GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadataResponse
    Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    createTime string
    Timestamp the Recommendation Engine was created at.
    id string
    The provider-assigned unique ID for this managed resource.
    recommendationMetadata GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadataResponse
    Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
    updateTime string
    Timestamp the Recommendation Engine was last updated.
    chat_engine_metadata GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadataResponse
    Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    create_time str
    Timestamp the Recommendation Engine was created at.
    id str
    The provider-assigned unique ID for this managed resource.
    recommendation_metadata GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadataResponse
    Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
    update_time str
    Timestamp the Recommendation Engine was last updated.
    chatEngineMetadata Property Map
    Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    createTime String
    Timestamp the Recommendation Engine was created at.
    id String
    The provider-assigned unique ID for this managed resource.
    recommendationMetadata Property Map
    Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
    updateTime String
    Timestamp the Recommendation Engine was last updated.

    Supporting Types

    EngineIndustryVertical, EngineIndustryVerticalArgs

    IndustryVerticalUnspecified
    INDUSTRY_VERTICAL_UNSPECIFIEDValue used when unset.
    Generic
    GENERICThe generic vertical for documents that are not specific to any industry vertical.
    Media
    MEDIAThe media industry vertical.
    EngineIndustryVerticalIndustryVerticalUnspecified
    INDUSTRY_VERTICAL_UNSPECIFIEDValue used when unset.
    EngineIndustryVerticalGeneric
    GENERICThe generic vertical for documents that are not specific to any industry vertical.
    EngineIndustryVerticalMedia
    MEDIAThe media industry vertical.
    IndustryVerticalUnspecified
    INDUSTRY_VERTICAL_UNSPECIFIEDValue used when unset.
    Generic
    GENERICThe generic vertical for documents that are not specific to any industry vertical.
    Media
    MEDIAThe media industry vertical.
    IndustryVerticalUnspecified
    INDUSTRY_VERTICAL_UNSPECIFIEDValue used when unset.
    Generic
    GENERICThe generic vertical for documents that are not specific to any industry vertical.
    Media
    MEDIAThe media industry vertical.
    INDUSTRY_VERTICAL_UNSPECIFIED
    INDUSTRY_VERTICAL_UNSPECIFIEDValue used when unset.
    GENERIC
    GENERICThe generic vertical for documents that are not specific to any industry vertical.
    MEDIA
    MEDIAThe media industry vertical.
    "INDUSTRY_VERTICAL_UNSPECIFIED"
    INDUSTRY_VERTICAL_UNSPECIFIEDValue used when unset.
    "GENERIC"
    GENERICThe generic vertical for documents that are not specific to any industry vertical.
    "MEDIA"
    MEDIAThe media industry vertical.

    EngineSolutionType, EngineSolutionTypeArgs

    SolutionTypeUnspecified
    SOLUTION_TYPE_UNSPECIFIEDDefault value.
    SolutionTypeRecommendation
    SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
    SolutionTypeSearch
    SOLUTION_TYPE_SEARCHUsed for Discovery Search.
    SolutionTypeChat
    SOLUTION_TYPE_CHATUsed for use cases related to the Generative AI agent.
    EngineSolutionTypeSolutionTypeUnspecified
    SOLUTION_TYPE_UNSPECIFIEDDefault value.
    EngineSolutionTypeSolutionTypeRecommendation
    SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
    EngineSolutionTypeSolutionTypeSearch
    SOLUTION_TYPE_SEARCHUsed for Discovery Search.
    EngineSolutionTypeSolutionTypeChat
    SOLUTION_TYPE_CHATUsed for use cases related to the Generative AI agent.
    SolutionTypeUnspecified
    SOLUTION_TYPE_UNSPECIFIEDDefault value.
    SolutionTypeRecommendation
    SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
    SolutionTypeSearch
    SOLUTION_TYPE_SEARCHUsed for Discovery Search.
    SolutionTypeChat
    SOLUTION_TYPE_CHATUsed for use cases related to the Generative AI agent.
    SolutionTypeUnspecified
    SOLUTION_TYPE_UNSPECIFIEDDefault value.
    SolutionTypeRecommendation
    SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
    SolutionTypeSearch
    SOLUTION_TYPE_SEARCHUsed for Discovery Search.
    SolutionTypeChat
    SOLUTION_TYPE_CHATUsed for use cases related to the Generative AI agent.
    SOLUTION_TYPE_UNSPECIFIED
    SOLUTION_TYPE_UNSPECIFIEDDefault value.
    SOLUTION_TYPE_RECOMMENDATION
    SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
    SOLUTION_TYPE_SEARCH
    SOLUTION_TYPE_SEARCHUsed for Discovery Search.
    SOLUTION_TYPE_CHAT
    SOLUTION_TYPE_CHATUsed for use cases related to the Generative AI agent.
    "SOLUTION_TYPE_UNSPECIFIED"
    SOLUTION_TYPE_UNSPECIFIEDDefault value.
    "SOLUTION_TYPE_RECOMMENDATION"
    SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
    "SOLUTION_TYPE_SEARCH"
    SOLUTION_TYPE_SEARCHUsed for Discovery Search.
    "SOLUTION_TYPE_CHAT"
    SOLUTION_TYPE_CHATUsed for use cases related to the Generative AI agent.

    GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig, GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigArgs

    AgentCreationConfig Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig
    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 GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig
    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 GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig
    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 GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig
    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 GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig
    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.

    GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig, GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfigArgs

    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 string
    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 str
    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.

    GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfigResponse, GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfigResponseArgs

    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, GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigResponseArgs

    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, GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadataResponseArgs

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

    GoogleCloudDiscoveryengineV1alphaEngineCommonConfig, GoogleCloudDiscoveryengineV1alphaEngineCommonConfigArgs

    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.

    GoogleCloudDiscoveryengineV1alphaEngineCommonConfigResponse, GoogleCloudDiscoveryengineV1alphaEngineCommonConfigResponseArgs

    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.

    GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig, GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigArgs

    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 Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
    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 Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigTrainingState
    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 GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
    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 GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigTrainingState
    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 GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
    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 GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigTrainingState
    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 GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
    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 GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigTrainingState
    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.
    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 GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
    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 GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigTrainingState
    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 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 "TRAINING_STATE_UNSPECIFIED" | "PAUSED" | "TRAINING"
    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.

    GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig, GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfigArgs

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

    GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfigResponse, GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfigResponseArgs

    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, GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigResponseArgs

    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.

    GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigTrainingState, GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigTrainingStateArgs

    TrainingStateUnspecified
    TRAINING_STATE_UNSPECIFIEDUnspecified training state.
    Paused
    PAUSEDThe engine training is paused.
    Training
    TRAININGThe engine is training.
    GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigTrainingStateTrainingStateUnspecified
    TRAINING_STATE_UNSPECIFIEDUnspecified training state.
    GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigTrainingStatePaused
    PAUSEDThe engine training is paused.
    GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigTrainingStateTraining
    TRAININGThe engine is training.
    TrainingStateUnspecified
    TRAINING_STATE_UNSPECIFIEDUnspecified training state.
    Paused
    PAUSEDThe engine training is paused.
    Training
    TRAININGThe engine is training.
    TrainingStateUnspecified
    TRAINING_STATE_UNSPECIFIEDUnspecified training state.
    Paused
    PAUSEDThe engine training is paused.
    Training
    TRAININGThe engine is training.
    TRAINING_STATE_UNSPECIFIED
    TRAINING_STATE_UNSPECIFIEDUnspecified training state.
    PAUSED
    PAUSEDThe engine training is paused.
    TRAINING
    TRAININGThe engine is training.
    "TRAINING_STATE_UNSPECIFIED"
    TRAINING_STATE_UNSPECIFIEDUnspecified training state.
    "PAUSED"
    PAUSEDThe engine training is paused.
    "TRAINING"
    TRAININGThe engine is training.

    GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadataResponse, GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadataResponseArgs

    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.

    GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig, GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigArgs

    SearchAddOns List<Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchAddOnsItem>
    The add-on that this search engine enables.
    SearchTier Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.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.
    SearchAddOns []GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchAddOnsItem
    The add-on that this search engine enables.
    SearchTier 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.
    searchAddOns List<GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchAddOnsItem>
    The add-on that this search engine enables.
    searchTier 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.
    searchAddOns GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchAddOnsItem[]
    The add-on that this search engine enables.
    searchTier 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.
    search_add_ons Sequence[GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchAddOnsItem]
    The add-on that this search engine enables.
    search_tier 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.
    searchAddOns List<"SEARCH_ADD_ON_UNSPECIFIED" | "SEARCH_ADD_ON_LLM">
    The add-on that this search engine enables.
    searchTier "SEARCH_TIER_UNSPECIFIED" | "SEARCH_TIER_STANDARD" | "SEARCH_TIER_ENTERPRISE"
    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.

    GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigResponse, GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigResponseArgs

    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.

    GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchAddOnsItem, GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchAddOnsItemArgs

    SearchAddOnUnspecified
    SEARCH_ADD_ON_UNSPECIFIEDDefault value when the enum is unspecified. This is invalid to use.
    SearchAddOnLlm
    SEARCH_ADD_ON_LLMLarge language model add-on.
    GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchAddOnsItemSearchAddOnUnspecified
    SEARCH_ADD_ON_UNSPECIFIEDDefault value when the enum is unspecified. This is invalid to use.
    GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchAddOnsItemSearchAddOnLlm
    SEARCH_ADD_ON_LLMLarge language model add-on.
    SearchAddOnUnspecified
    SEARCH_ADD_ON_UNSPECIFIEDDefault value when the enum is unspecified. This is invalid to use.
    SearchAddOnLlm
    SEARCH_ADD_ON_LLMLarge language model add-on.
    SearchAddOnUnspecified
    SEARCH_ADD_ON_UNSPECIFIEDDefault value when the enum is unspecified. This is invalid to use.
    SearchAddOnLlm
    SEARCH_ADD_ON_LLMLarge language model add-on.
    SEARCH_ADD_ON_UNSPECIFIED
    SEARCH_ADD_ON_UNSPECIFIEDDefault value when the enum is unspecified. This is invalid to use.
    SEARCH_ADD_ON_LLM
    SEARCH_ADD_ON_LLMLarge language model add-on.
    "SEARCH_ADD_ON_UNSPECIFIED"
    SEARCH_ADD_ON_UNSPECIFIEDDefault value when the enum is unspecified. This is invalid to use.
    "SEARCH_ADD_ON_LLM"
    SEARCH_ADD_ON_LLMLarge language model add-on.

    GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchTier, GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchTierArgs

    SearchTierUnspecified
    SEARCH_TIER_UNSPECIFIEDDefault value when the enum is unspecified. This is invalid to use.
    SearchTierStandard
    SEARCH_TIER_STANDARDStandard tier.
    SearchTierEnterprise
    SEARCH_TIER_ENTERPRISEEnterprise tier.
    GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchTierSearchTierUnspecified
    SEARCH_TIER_UNSPECIFIEDDefault value when the enum is unspecified. This is invalid to use.
    GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchTierSearchTierStandard
    SEARCH_TIER_STANDARDStandard tier.
    GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigSearchTierSearchTierEnterprise
    SEARCH_TIER_ENTERPRISEEnterprise tier.
    SearchTierUnspecified
    SEARCH_TIER_UNSPECIFIEDDefault value when the enum is unspecified. This is invalid to use.
    SearchTierStandard
    SEARCH_TIER_STANDARDStandard tier.
    SearchTierEnterprise
    SEARCH_TIER_ENTERPRISEEnterprise tier.
    SearchTierUnspecified
    SEARCH_TIER_UNSPECIFIEDDefault value when the enum is unspecified. This is invalid to use.
    SearchTierStandard
    SEARCH_TIER_STANDARDStandard tier.
    SearchTierEnterprise
    SEARCH_TIER_ENTERPRISEEnterprise tier.
    SEARCH_TIER_UNSPECIFIED
    SEARCH_TIER_UNSPECIFIEDDefault value when the enum is unspecified. This is invalid to use.
    SEARCH_TIER_STANDARD
    SEARCH_TIER_STANDARDStandard tier.
    SEARCH_TIER_ENTERPRISE
    SEARCH_TIER_ENTERPRISEEnterprise tier.
    "SEARCH_TIER_UNSPECIFIED"
    SEARCH_TIER_UNSPECIFIEDDefault value when the enum is unspecified. This is invalid to use.
    "SEARCH_TIER_STANDARD"
    SEARCH_TIER_STANDARDStandard tier.
    "SEARCH_TIER_ENTERPRISE"
    SEARCH_TIER_ENTERPRISEEnterprise tier.

    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