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

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

Sample Query captures metadata to be used for evaluation.

Defined Under Namespace

Classes: QueryEntry

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp the SampleQuery was created at.

Returns:



40
41
42
43
44
45
46
47
48
49
50
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
78
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/sample_query.rb', line 40

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

  # Query Entry captures metadata to be used for search evaluation.
  # @!attribute [rw] query
  #   @return [::String]
  #     Required. The query.
  # @!attribute [rw] targets
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery::QueryEntry::Target>]
  #     List of targets for the query.
  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
end

#name ⇒ ::String

Returns Identifier. The full resource name of the sample query, in the format of projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Returns:

  • (::String) —

    Identifier. The full resource name of the sample query, in the format of projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}.

    This field must be a UTF-8 encoded string with a length limit of 1024 characters.



40
41
42
43
44
45
46
47
48
49
50
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
78
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/sample_query.rb', line 40

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

  # Query Entry captures metadata to be used for search evaluation.
  # @!attribute [rw] query
  #   @return [::String]
  #     Required. The query.
  # @!attribute [rw] targets
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery::QueryEntry::Target>]
  #     List of targets for the query.
  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
end

#query_entry ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery::QueryEntry

Returns The query entry.

Returns:



40
41
42
43
44
45
46
47
48
49
50
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
78
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/sample_query.rb', line 40

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

  # Query Entry captures metadata to be used for search evaluation.
  # @!attribute [rw] query
  #   @return [::String]
  #     Required. The query.
  # @!attribute [rw] targets
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery::QueryEntry::Target>]
  #     List of targets for the query.
  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
end