Class: Google::Cloud::DiscoveryEngine::V1::CompleteQueryResponse

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

Overview

Response message for CompletionService.CompleteQuery method.

Defined Under Namespace

Classes: QuerySuggestion

Instance Attribute Summary collapse

Instance Attribute Details

#query_suggestions ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::CompleteQueryResponse::QuerySuggestion>

Returns Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/discoveryengine/v1/completion_service.rb', line 95

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

  # Suggestions as search queries.
  # @!attribute [rw] suggestion
  #   @return [::String]
  #     The suggestion for the query.
  # @!attribute [rw] completable_field_paths
  #   @return [::Array<::String>]
  #     The unique document field paths that serve as the source of this
  #     suggestion if it was generated from completable fields.
  #
  #     This field is only populated for the document-completable model.
  class QuerySuggestion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#tail_match_triggered ⇒ ::Boolean

Returns True if the returned suggestions are all tail suggestions.

For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.

Returns:

  • (::Boolean) —

    True if the returned suggestions are all tail suggestions.

    For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/discoveryengine/v1/completion_service.rb', line 95

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

  # Suggestions as search queries.
  # @!attribute [rw] suggestion
  #   @return [::String]
  #     The suggestion for the query.
  # @!attribute [rw] completable_field_paths
  #   @return [::Array<::String>]
  #     The unique document field paths that serve as the source of this
  #     suggestion if it was generated from completable fields.
  #
  #     This field is only populated for the document-completable model.
  class QuerySuggestion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end