Class: Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb

Overview

Response message for Recommend method.

Defined Under Namespace

Classes: RecommendationResult

Instance Attribute Summary collapse

Instance Attribute Details

#attribution_token ⇒ ::String

Returns A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.

Returns:

  • (::String) —

    A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb', line 171

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::V1beta::Document]
  #     Set if `returnDocument` is set to true in
  #     {::Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#params RecommendRequest.params}.
  # @!attribute [rw] metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional Document metadata / annotations.
  #
  #     Possible values:
  #
  #     * `score`: Recommendation score in double value. Is set if
  #       `returnScore` is set to true in
  #       {::Google::Cloud::DiscoveryEngine::V1beta::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>

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

Returns:

  • (::Array<::String>) —

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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb', line 171

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::V1beta::Document]
  #     Set if `returnDocument` is set to true in
  #     {::Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#params RecommendRequest.params}.
  # @!attribute [rw] metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional Document metadata / annotations.
  #
  #     Possible values:
  #
  #     * `score`: Recommendation score in double value. Is set if
  #       `returnScore` is set to true in
  #       {::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::RecommendResponse::RecommendationResult>

Returns A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).

Returns:



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb', line 171

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::V1beta::Document]
  #     Set if `returnDocument` is set to true in
  #     {::Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#params RecommendRequest.params}.
  # @!attribute [rw] metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional Document metadata / annotations.
  #
  #     Possible values:
  #
  #     * `score`: Recommendation score in double value. Is set if
  #       `returnScore` is set to true in
  #       {::Google::Cloud::DiscoveryEngine::V1beta::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

Returns True if RecommendRequest.validate_only was set.

Returns:



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb', line 171

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::V1beta::Document]
  #     Set if `returnDocument` is set to true in
  #     {::Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#params RecommendRequest.params}.
  # @!attribute [rw] metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional Document metadata / annotations.
  #
  #     Possible values:
  #
  #     * `score`: Recommendation score in double value. Is set if
  #       `returnScore` is set to true in
  #       {::Google::Cloud::DiscoveryEngine::V1beta::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