Class: Google::Cloud::DataQnA::V1alpha::Question

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

Overview

The question resource represents a natural language query, its settings, understanding generated by the system, and answer retrieval status. A question cannot be modified.

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns Time when the question was created.

Returns:



75
76
77
78
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 75

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

#data_source_annotations ⇒ ::Array<::String>

Returns A list of annotations to use instead of the default annotation of a data source (set in the data source reference resource). There must not be more than one annotation with the same data source reference.

Returns:

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

    A list of annotations to use instead of the default annotation of a data source (set in the data source reference resource). There must not be more than one annotation with the same data source reference.



75
76
77
78
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 75

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

#debug_flags ⇒ ::Google::Cloud::DataQnA::V1alpha::DebugFlags

Returns Input only. Immutable. Flags to request additional information for debugging purposes.

Returns:



75
76
77
78
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 75

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

#debug_info ⇒ ::Google::Protobuf::Any

Returns Top level debug information. This will be stored as the type DebugInformation. Using Any so clients don't need to pull in anything inside the debug message.

Returns:

  • (::Google::Protobuf::Any) —

    Top level debug information. This will be stored as the type DebugInformation. Using Any so clients don't need to pull in anything inside the debug message.



75
76
77
78
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 75

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

#interpret_error ⇒ ::Google::Cloud::DataQnA::V1alpha::InterpretError

Returns An error field explaining why interpretation failed. This is only populated if the interpretation failed.

Note: This is different from getting a status error on the request itself. This is not a client or server error and the Question resource is still persisted, but the service could not interpret the question. Clients should present the error to the user so the user can rephrase the question.

Returns:

  • (::Google::Cloud::DataQnA::V1alpha::InterpretError) —

    An error field explaining why interpretation failed. This is only populated if the interpretation failed.

    Note: This is different from getting a status error on the request itself. This is not a client or server error and the Question resource is still persisted, but the service could not interpret the question. Clients should present the error to the user so the user can rephrase the question.



75
76
77
78
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 75

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

#interpretations ⇒ ::Array<::Google::Cloud::DataQnA::V1alpha::Interpretation>

Returns A list of interpretations for this question.

Returns:



75
76
77
78
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 75

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

#name ⇒ ::String (readonly)

Returns Output only. Immutable. The unique identifier for the Question. The ID is server-generated. Example: projects/foo/locations/bar/questions/123.

Returns:

  • (::String) —

    Output only. Immutable. The unique identifier for the Question. The ID is server-generated. Example: projects/foo/locations/bar/questions/123



75
76
77
78
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 75

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

#query ⇒ ::String

Returns Required. Immutable. The query in natural language.

Returns:

  • (::String) —

    Required. Immutable. The query in natural language.



75
76
77
78
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 75

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

#scopes ⇒ ::Array<::String>

Returns Required. Immutable. Scopes to be used for the question. A scope defines the relevant data set scope. It can be a reference to a specific data source or a collection of data sources. Currently, support is limited to a single BigQuery table. There must be exactly one scopes element.

Example: //bigquery.googleapis.com/projects/test-project/datasets/foo/tables/bar.

Returns:

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

    Required. Immutable. Scopes to be used for the question. A scope defines the relevant data set scope. It can be a reference to a specific data source or a collection of data sources. Currently, support is limited to a single BigQuery table. There must be exactly one scopes element.

    Example: //bigquery.googleapis.com/projects/test-project/datasets/foo/tables/bar



75
76
77
78
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 75

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

#user_email ⇒ ::String (readonly)

Returns Output only. The e-mail address of the user that created this question.

Returns:

  • (::String) —

    Output only. The e-mail address of the user that created this question.



75
76
77
78
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 75

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