View Source GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaEngine (google_api_discovery_engine v0.27.0)

Metadata that describes the training and serving parameters of an Engine.

Attributes

  • chatEngineConfig (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig.t, default: nil) - Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
  • chatEngineMetadata (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata.t, default: nil) - Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
  • commonConfig (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaEngineCommonConfig.t, default: nil) - Common config spec that specifies the metadata of the engine.
  • createTime (type: DateTime.t, default: nil) - Output only. Timestamp the Recommendation Engine was created at.
  • dataStoreIds (type: list(String.t), default: nil) - 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.
  • disableAnalytics (type: boolean(), default: nil) - Optional. Whether to disable analytics for searches performed on this engine.
  • displayName (type: String.t, default: nil) - Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
  • industryVertical (type: String.t, default: nil) - 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.
  • mediaRecommendationEngineConfig (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig.t, default: nil) - Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
  • name (type: String.t, default: nil) - 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}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
  • recommendationMetadata (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata.t, default: nil) - Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
  • searchEngineConfig (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig.t, default: nil) - Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
  • similarDocumentsConfig (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig.t, default: nil) - Additional config specs for a similar-items engine.
  • solutionType (type: String.t, default: nil) - Required. The solutions of the engine.
  • updateTime (type: DateTime.t, default: nil) - Output only. Timestamp the Recommendation Engine was last updated.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaEngine{
    chatEngineConfig:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig.t()
      | nil,
    chatEngineMetadata:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata.t()
      | nil,
    commonConfig:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaEngineCommonConfig.t()
      | nil,
    createTime: DateTime.t() | nil,
    dataStoreIds: [String.t()] | nil,
    disableAnalytics: boolean() | nil,
    displayName: String.t() | nil,
    industryVertical: String.t() | nil,
    mediaRecommendationEngineConfig:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig.t()
      | nil,
    name: String.t() | nil,
    recommendationMetadata:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata.t()
      | nil,
    searchEngineConfig:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig.t()
      | nil,
    similarDocumentsConfig:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig.t()
      | nil,
    solutionType: String.t() | nil,
    updateTime: DateTime.t() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.