Class: Google::Cloud::DiscoveryEngine::V1beta::SampleQuery::QueryEntry

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

Overview

Query Entry captures metadata to be used for search evaluation.

Defined Under Namespace

Classes: Target

Instance Attribute Summary collapse

Instance Attribute Details

#query ⇒ ::String

Returns Required. The query.

Returns:

  • (::String) —

    Required. The query.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/sample_query.rb', line 51

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

  # Defines the parameters of the query's expected outcome.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Expected uri of the target.
  #
  #     This field must be a UTF-8 encoded string with a length limit of 2048
  #     characters.
  #
  #     Example of valid uris: `https://example.com/abc`,
  #     `gcs://example/example.pdf`.
  # @!attribute [rw] page_numbers
  #   @return [::Array<::Integer>]
  #     Expected page numbers of the target.
  #
  #     Each page number must be non negative.
  # @!attribute [rw] score
  #   @return [::Float]
  #     Relevance score of the target.
  class Target
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#targets ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery::QueryEntry::Target>

Returns List of targets for the query.

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/sample_query.rb', line 51

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

  # Defines the parameters of the query's expected outcome.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Expected uri of the target.
  #
  #     This field must be a UTF-8 encoded string with a length limit of 2048
  #     characters.
  #
  #     Example of valid uris: `https://example.com/abc`,
  #     `gcs://example/example.pdf`.
  # @!attribute [rw] page_numbers
  #   @return [::Array<::Integer>]
  #     Expected page numbers of the target.
  #
  #     Each page number must be non negative.
  # @!attribute [rw] score
  #   @return [::Float]
  #     Relevance score of the target.
  class Target
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end