BigQuery Data QnA V1alpha API - Class Google::Cloud::DataQnA::V1alpha::Question (v0.6.0)

Reference documentation and code samples for the BigQuery Data QnA V1alpha API class Google::Cloud::DataQnA::V1alpha::Question.

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Time when the question was created.

#create_time=

def create_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — Time when the question was created.

Returns

(::Google::Protobuf::Timestamp) — Time when the question was created.

#data_source_annotations

def data_source_annotations() -> ::Array<::String>

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.

#data_source_annotations=

def data_source_annotations=(value) -> ::Array<::String>

Parameter

value (::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.

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.

#debug_flags

def debug_flags() -> ::Google::Cloud::DataQnA::V1alpha::DebugFlags

Returns

(::Google::Cloud::DataQnA::V1alpha::DebugFlags) — Input only. Immutable. Flags to request additional information for debugging purposes.

#debug_flags=

def debug_flags=(value) -> ::Google::Cloud::DataQnA::V1alpha::DebugFlags

Parameter

value (::Google::Cloud::DataQnA::V1alpha::DebugFlags) — Input only. Immutable. Flags to request additional information for debugging purposes.

Returns

(::Google::Cloud::DataQnA::V1alpha::DebugFlags) — Input only. Immutable. Flags to request additional information for debugging purposes.

#debug_info

def debug_info() -> ::Google::Protobuf::Any

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.

#debug_info=

def debug_info=(value) -> ::Google::Protobuf::Any

Parameter

value (::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.

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.

#interpret_error

def interpret_error() -> ::Google::Cloud::DataQnA::V1alpha::InterpretError

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.

#interpret_error=

def interpret_error=(value) -> ::Google::Cloud::DataQnA::V1alpha::InterpretError

Parameter

value (::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.

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.

#interpretations

def interpretations() -> ::Array<::Google::Cloud::DataQnA::V1alpha::Interpretation>

Returns

(::Array<::Google::Cloud::DataQnA::V1alpha::Interpretation>) — A list of interpretations for this question.

#interpretations=

def interpretations=(value) -> ::Array<::Google::Cloud::DataQnA::V1alpha::Interpretation>

Parameter

value (::Array<::Google::Cloud::DataQnA::V1alpha::Interpretation>) — A list of interpretations for this question.

Returns

(::Array<::Google::Cloud::DataQnA::V1alpha::Interpretation>) — A list of interpretations for this question.

#name

def name() -> ::String

Returns

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

#query

def query() -> ::String

Returns

(::String) — Required. Immutable. The query in natural language.

#query=

def query=(value) -> ::String

Parameter

value (::String) — Required. Immutable. The query in natural language.

Returns

(::String) — Required. Immutable. The query in natural language.

#scopes

def scopes() -> ::Array<::String>

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

#scopes=

def scopes=(value) -> ::Array<::String>

Parameter

value (::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

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

#user_email

def user_email() -> ::String

Returns

(::String) — Output only. The e-mail address of the user that created this question.