Class: Google::Cloud::DataQnA::V1alpha::Interpretation

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

Overview

An interpretation of a natural language query.

Instance Attribute Summary collapse

Instance Attribute Details

#confidence ⇒ ::Float

Returns The level of confidence that one of the interpretations is correct. This is a value in the range [0, 1] where a value of 0.5 or below is to be considered a low confidence.

Returns:

  • (::Float) —

    The level of confidence that one of the interpretations is correct. This is a value in the range [0, 1] where a value of 0.5 or below is to be considered a low confidence.



239
240
241
242
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 239

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

#data_query ⇒ ::Google::Cloud::DataQnA::V1alpha::DataQuery

Returns Representation of the data query to be sent to the backend.

Returns:



239
240
241
242
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 239

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

#data_sources ⇒ ::Array<::String>

Returns List of data sources used in the current understanding.

Returns:

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

    List of data sources used in the current understanding.



239
240
241
242
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 239

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

#execution_info ⇒ ::Google::Cloud::DataQnA::V1alpha::ExecutionInfo

Returns Information about the backend response. This is populated only if execution of an interpretation was requested.

Returns:



239
240
241
242
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 239

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

#human_readable ⇒ ::Google::Cloud::DataQnA::V1alpha::HumanReadable

Returns Human readable representation of the query.

Returns:



239
240
241
242
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 239

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

#interpretation_structure ⇒ ::Google::Cloud::DataQnA::V1alpha::InterpretationStructure

Returns Information about the interpretation structure that helps to understand and visualize the response.

Returns:



239
240
241
242
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 239

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

#unused_phrases ⇒ ::Array<::String>

Returns A list of unused phrases. Clients should display a Did You Mean (DYM) dialog if this is non-empty, even if this is the only interpretation.

Returns:

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

    A list of unused phrases. Clients should display a Did You Mean (DYM) dialog if this is non-empty, even if this is the only interpretation.



239
240
241
242
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 239

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