Class: Google::Cloud::DiscoveryEngine::V1::RecommendResponse

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1::RecommendResponse

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb

Overview

Response message for Recommend method.

Defined Under Namespace

Classes: RecommendationResult

Instance Attribute Summary

• #attribution_token ⇒ ::String

  A unique attribution token.

• #missing_ids ⇒ ::Array<::String>

  IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.

• #results ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::RecommendResponse::RecommendationResult>

  A list of recommended Documents.

• #validate_only ⇒ ::Boolean

  True if RecommendRequest.validate_only was set.

Instance Attribute Details

#attribution_token ⇒ ::String

# File 'proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb', line 191

class RecommendResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RecommendationResult represents a generic recommendation result with
  # associated metadata.
  # @!attribute [rw] id
  #   @return [::String]
  #     Resource ID of the recommended Document.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Document]
  #     Set if `returnDocument` is set to true in
  #     {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest#params RecommendRequest.params}.
  # @!attribute [rw] metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional Document metadata or annotations.
  #
  #     Possible values:
  #
  #     * `score`: Recommendation score in double value. Is set if
  #       `returnScore` is set to true in
  #       {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest#params RecommendRequest.params}.
  class RecommendationResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class MetadataEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#missing_ids ⇒ ::Array<::String>

# File 'proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb', line 191

class RecommendResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RecommendationResult represents a generic recommendation result with
  # associated metadata.
  # @!attribute [rw] id
  #   @return [::String]
  #     Resource ID of the recommended Document.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Document]
  #     Set if `returnDocument` is set to true in
  #     {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest#params RecommendRequest.params}.
  # @!attribute [rw] metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional Document metadata or annotations.
  #
  #     Possible values:
  #
  #     * `score`: Recommendation score in double value. Is set if
  #       `returnScore` is set to true in
  #       {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest#params RecommendRequest.params}.
  class RecommendationResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class MetadataEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#results ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::RecommendResponse::RecommendationResult>

# File 'proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb', line 191

class RecommendResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RecommendationResult represents a generic recommendation result with
  # associated metadata.
  # @!attribute [rw] id
  #   @return [::String]
  #     Resource ID of the recommended Document.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Document]
  #     Set if `returnDocument` is set to true in
  #     {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest#params RecommendRequest.params}.
  # @!attribute [rw] metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional Document metadata or annotations.
  #
  #     Possible values:
  #
  #     * `score`: Recommendation score in double value. Is set if
  #       `returnScore` is set to true in
  #       {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest#params RecommendRequest.params}.
  class RecommendationResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class MetadataEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#validate_only ⇒ ::Boolean

# File 'proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb', line 191

class RecommendResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RecommendationResult represents a generic recommendation result with
  # associated metadata.
  # @!attribute [rw] id
  #   @return [::String]
  #     Resource ID of the recommended Document.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Document]
  #     Set if `returnDocument` is set to true in
  #     {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest#params RecommendRequest.params}.
  # @!attribute [rw] metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional Document metadata or annotations.
  #
  #     Possible values:
  #
  #     * `score`: Recommendation score in double value. Is set if
  #       `returnScore` is set to true in
  #       {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest#params RecommendRequest.params}.
  class RecommendationResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class MetadataEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end