Class: Google::Cloud::DiscoveryEngine::V1::RecommendRequest

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1::RecommendRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

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

Overview

Request message for Recommend method.

Defined Under Namespace

Classes: ParamsEntry, UserLabelsEntry

Instance Attribute Summary

• #filter ⇒ ::String

  Filter for restricting recommendation results with a length limit of 5,000 characters.

• #page_size ⇒ ::Integer

  Maximum number of results to return.

• #params ⇒ ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}

  Additional domain specific parameters for the recommendations.

• #serving_config ⇒ ::String

  Required.

• #user_event ⇒ ::Google::Cloud::DiscoveryEngine::V1::UserEvent

  Required.

• #user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}

  The user labels applied to a resource must meet the following requirements:.

• #validate_only ⇒ ::Boolean

  Use validate only mode for this recommendation query.

Instance Attribute Details

#filter ⇒ ::String

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

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

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

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

#page_size ⇒ ::Integer

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

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

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

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

#params ⇒ ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}

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

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

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

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

#serving_config ⇒ ::String

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

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

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

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

#user_event ⇒ ::Google::Cloud::DiscoveryEngine::V1::UserEvent

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

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

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

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

#user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}

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

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

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

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

#validate_only ⇒ ::Boolean

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

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

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

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