View Source GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaRecommendResponse (google_api_discovery_engine v0.7.0)

Response message for Recommend method.

Attributes

  • attributionToken (type: String.t, default: nil) - A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.
  • missingIds (type: list(String.t), default: nil) - IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.
  • results (type: list(GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult.t), default: nil) - A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).
  • validateOnly (type: boolean(), default: nil) - True if RecommendRequest.validate_only was set.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaRecommendResponse{
    attributionToken: String.t() | nil,
    missingIds: [String.t()] | nil,
    results:
      [
        GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult.t()
      ]
      | nil,
    validateOnly: boolean() | nil
  }

Functions

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

Unwrap a decoded JSON object into its complex fields.