This product is not supported for your selected Datadog site. ().

gcp_discoveryengine_engine

ancestors

Type: UNORDERED_LIST_STRING

chat_engine_config

Type: STRUCT
Provider name: chatEngineConfig
Description: Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

  • agent_creation_config
    Type: STRUCT
    Provider name: agentCreationConfig
    Description: 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.
    • business
      Type: STRING
      Provider name: business
      Description: 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
      Type: STRING
      Provider name: defaultLanguageCode
      Description: Required. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.
    • location
      Type: STRING
      Provider name: location
      Description: Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.
    • time_zone
      Type: STRING
      Provider name: timeZone
      Description: Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
  • allow_cross_region
    Type: BOOLEAN
    Provider name: allowCrossRegion
    Description: Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the allow_cross_region are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
  • dialogflow_agent_to_link
    Type: STRING
    Provider name: dialogflowAgentToLink
    Description: 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. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.

chat_engine_metadata

Type: STRUCT
Provider name: chatEngineMetadata
Description: Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

  • dialogflow_agent
    Type: STRING
    Provider name: dialogflowAgent
    Description: The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: projects//locations//agents/.

common_config

Type: STRUCT
Provider name: commonConfig
Description: Common config spec that specifies the metadata of the engine.

  • company_name
    Type: STRING
    Provider name: companyName
    Description: The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. Timestamp the Recommendation Engine was created at.

data_store_ids

Type: UNORDERED_LIST_STRING
Provider name: dataStoreIds
Description: Optional. 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 initializations.

disable_analytics

Type: BOOLEAN
Provider name: disableAnalytics
Description: Optional. Whether to disable analytics for searches performed on this engine.

gcp_display_name

Type: STRING
Provider name: displayName
Description: Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.

industry_vertical

Type: STRING
Provider name: industryVertical
Description: Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
Possible values:

  • INDUSTRY_VERTICAL_UNSPECIFIED - Value used when unset.
  • GENERIC - The generic vertical for documents that are not specific to any industry vertical.
  • MEDIA - The media industry vertical.
  • HEALTHCARE_FHIR - The healthcare FHIR vertical.

labels

Type: UNORDERED_LIST_STRING

media_recommendation_engine_config

Type: STRUCT
Provider name: mediaRecommendationEngineConfig
Description: Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.

  • engine_features_config
    Type: STRUCT
    Provider name: engineFeaturesConfig
    Description: Optional. Additional engine features config.
    • most_popular_config
      Type: STRUCT
      Provider name: mostPopularConfig
      Description: Most popular engine feature config.
      • time_window_days
        Type: INT64
        Provider name: timeWindowDays
        Description: The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the most-popular-items engine.
    • recommended_for_you_config
      Type: STRUCT
      Provider name: recommendedForYouConfig
      Description: Recommended for you engine feature config.
      • context_event_type
        Type: STRING
        Provider name: contextEventType
        Description: The type of event with which the engine is queried at prediction time. If set to generic, only view-item, media-play,and media-complete will be used as context-event in engine training. If set to view-home-page, view-home-page will also be used as context-events in addition to view-item, media-play, and media-complete. Currently supported for the recommended-for-you engine. Currently supported values: view-home-page, generic.
  • optimization_objective
    Type: STRING
    Provider name: optimizationObjective
    Description: 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
    Type: STRUCT
    Provider name: optimizationObjectiveConfig
    Description: 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).
    • target_field
      Type: STRING
      Provider name: targetField
      Description: Required. The name of the field to target. Currently supported values: watch-percentage, watch-time.
    • target_field_value_float
      Type: FLOAT
      Provider name: targetFieldValueFloat
      Description: Required. The threshold to be applied to the target (e.g., 0.5).
  • training_state
    Type: STRING
    Provider name: trainingState
    Description: 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.
    Possible values:
    • TRAINING_STATE_UNSPECIFIED - Unspecified training state.
    • PAUSED - The engine training is paused.
    • TRAINING - The engine is training.
  • type
    Type: STRING
    Provider name: type
    Description: Required. 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.

name

Type: STRING
Provider name: name
Description: Immutable. Identifier. 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}/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.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

search_engine_config

Type: STRUCT
Provider name: searchEngineConfig
Description: Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

  • search_add_ons
    Type: UNORDERED_LIST_STRING
    Provider name: searchAddOns
    Description: The add-on that this search engine enables.
  • search_tier
    Type: STRING
    Provider name: searchTier
    Description: The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
    Possible values:
    • SEARCH_TIER_UNSPECIFIED - Default value when the enum is unspecified. This is invalid to use.
    • SEARCH_TIER_STANDARD - Standard tier.
    • SEARCH_TIER_ENTERPRISE - Enterprise tier.

solution_type

Type: STRING
Provider name: solutionType
Description: Required. The solutions of the engine.
Possible values:

  • SOLUTION_TYPE_UNSPECIFIED - Default value.
  • SOLUTION_TYPE_RECOMMENDATION - Used for Recommendations AI.
  • SOLUTION_TYPE_SEARCH - Used for Discovery Search.
  • SOLUTION_TYPE_CHAT - Used for use cases related to the Generative AI agent.
  • SOLUTION_TYPE_GENERATIVE_CHAT - Used for use cases related to the Generative Chat agent. It’s used for Generative chat engine only, the associated data stores must enrolled with SOLUTION_TYPE_CHAT solution.

tags

Type: UNORDERED_LIST_STRING

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. Timestamp the Recommendation Engine was last updated.