Class: Google::Cloud::DataQnA::V1alpha::SuggestQueriesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataqna/v1alpha/auto_suggestion_service.rb

Overview

Request for query suggestions.

Instance Attribute Summary collapse

Instance Attribute Details

#parent ⇒ ::String

Returns Required. The parent of the suggestion query is the resource denoting the project and location.

Returns:

  • (::String) —

    Required. The parent of the suggestion query is the resource denoting the project and location.



47
48
49
50
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/auto_suggestion_service.rb', line 47

class SuggestQueriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#query ⇒ ::String

Returns User query for which to generate suggestions. If the query is empty, zero state suggestions are returned. This allows UIs to display suggestions right away, helping the user to get a sense of what a query might look like.

Returns:

  • (::String) —

    User query for which to generate suggestions. If the query is empty, zero state suggestions are returned. This allows UIs to display suggestions right away, helping the user to get a sense of what a query might look like.



47
48
49
50
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/auto_suggestion_service.rb', line 47

class SuggestQueriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#scopes ⇒ ::Array<::String>

Returns The scopes to which this search is restricted. The only supported scope pattern is //bigquery.googleapis.com/projects/{GCP-PROJECT-ID}/datasets/{DATASET-ID}/tables/{TABLE-ID}.

Returns:

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

    The scopes to which this search is restricted. The only supported scope pattern is //bigquery.googleapis.com/projects/{GCP-PROJECT-ID}/datasets/{DATASET-ID}/tables/{TABLE-ID}.



47
48
49
50
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/auto_suggestion_service.rb', line 47

class SuggestQueriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#suggestion_types ⇒ ::Array<::Google::Cloud::DataQnA::V1alpha::SuggestionType>

Returns The requested suggestion type. Multiple suggestion types can be requested, but there is no guarantee that the service will return suggestions for each type. Suggestions for a requested type might rank lower than suggestions for other types and the service may decide to cut these suggestions off.

Returns:

  • (::Array<::Google::Cloud::DataQnA::V1alpha::SuggestionType>) —

    The requested suggestion type. Multiple suggestion types can be requested, but there is no guarantee that the service will return suggestions for each type. Suggestions for a requested type might rank lower than suggestions for other types and the service may decide to cut these suggestions off.



47
48
49
50
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/auto_suggestion_service.rb', line 47

class SuggestQueriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end