Class: Google::Cloud::DataQnA::V1alpha::InterpretError

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

Overview

Details on the failure to interpret the question.

Defined Under Namespace

Modules: InterpretErrorCode Classes: InterpretAmbiguityDetails, InterpretErrorDetails, InterpretIncompleteQueryDetails, InterpretUnsupportedDetails

Instance Attribute Summary collapse

Instance Attribute Details

#code ⇒ ::Google::Cloud::DataQnA::V1alpha::InterpretError::InterpretErrorCode

Returns The code for the error category why the interpretation failed.

Returns:



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 90

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

  # Details on interpretation failure.
  # @!attribute [rw] unsupported_details
  #   @return [::Google::Cloud::DataQnA::V1alpha::InterpretError::InterpretUnsupportedDetails]
  #     Populated if parts of the query are unsupported.
  # @!attribute [rw] incomplete_query_details
  #   @return [::Google::Cloud::DataQnA::V1alpha::InterpretError::InterpretIncompleteQueryDetails]
  #     Populated if the query is incomplete.
  # @!attribute [rw] ambiguity_details
  #   @return [::Google::Cloud::DataQnA::V1alpha::InterpretError::InterpretAmbiguityDetails]
  #     Populated if the query was too ambiguous.
  class InterpretErrorDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about unsupported parts in a query.
  # @!attribute [rw] operators
  #   @return [::Array<::String>]
  #     Unsupported operators. For example: median.
  # @!attribute [rw] intent
  #   @return [::Array<::String>]
  #     Unsupported intents.
  class InterpretUnsupportedDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about an incomplete query.
  # @!attribute [rw] entities
  #   @return [::Array<::Google::Cloud::DataQnA::V1alpha::InterpretEntity>]
  #     List of missing interpret entities.
  class InterpretIncompleteQueryDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about a query that was too ambiguous. Currently, the message
  # has no fields and its presence signals that there was ambiguity.
  class InterpretAmbiguityDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The interpret error code provides an error category why the interpretation
  # failed.
  module InterpretErrorCode
    # No interpret error code was specified.
    INTERPRET_ERROR_CODE_UNSPECIFIED = 0

    # The query is not valid.
    INVALID_QUERY = 1

    # The interpreter failed to understand the question. For example, because
    # it was too ambiguous.
    FAILED_TO_UNDERSTAND = 2

    # The interpreter could understand the question, but was not able to arrive
    # at an answer. For example, because a requested operation is not
    # supported.
    FAILED_TO_ANSWER = 3
  end
end

#details ⇒ ::Google::Cloud::DataQnA::V1alpha::InterpretError::InterpretErrorDetails

Returns Details on interpretation failure.

Returns:



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 90

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

  # Details on interpretation failure.
  # @!attribute [rw] unsupported_details
  #   @return [::Google::Cloud::DataQnA::V1alpha::InterpretError::InterpretUnsupportedDetails]
  #     Populated if parts of the query are unsupported.
  # @!attribute [rw] incomplete_query_details
  #   @return [::Google::Cloud::DataQnA::V1alpha::InterpretError::InterpretIncompleteQueryDetails]
  #     Populated if the query is incomplete.
  # @!attribute [rw] ambiguity_details
  #   @return [::Google::Cloud::DataQnA::V1alpha::InterpretError::InterpretAmbiguityDetails]
  #     Populated if the query was too ambiguous.
  class InterpretErrorDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about unsupported parts in a query.
  # @!attribute [rw] operators
  #   @return [::Array<::String>]
  #     Unsupported operators. For example: median.
  # @!attribute [rw] intent
  #   @return [::Array<::String>]
  #     Unsupported intents.
  class InterpretUnsupportedDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about an incomplete query.
  # @!attribute [rw] entities
  #   @return [::Array<::Google::Cloud::DataQnA::V1alpha::InterpretEntity>]
  #     List of missing interpret entities.
  class InterpretIncompleteQueryDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about a query that was too ambiguous. Currently, the message
  # has no fields and its presence signals that there was ambiguity.
  class InterpretAmbiguityDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The interpret error code provides an error category why the interpretation
  # failed.
  module InterpretErrorCode
    # No interpret error code was specified.
    INTERPRET_ERROR_CODE_UNSPECIFIED = 0

    # The query is not valid.
    INVALID_QUERY = 1

    # The interpreter failed to understand the question. For example, because
    # it was too ambiguous.
    FAILED_TO_UNDERSTAND = 2

    # The interpreter could understand the question, but was not able to arrive
    # at an answer. For example, because a requested operation is not
    # supported.
    FAILED_TO_ANSWER = 3
  end
end

#message ⇒ ::String

Returns Error message explaining why this question could not be interpreted.

Returns:

  • (::String) —

    Error message explaining why this question could not be interpreted.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/question.rb', line 90

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

  # Details on interpretation failure.
  # @!attribute [rw] unsupported_details
  #   @return [::Google::Cloud::DataQnA::V1alpha::InterpretError::InterpretUnsupportedDetails]
  #     Populated if parts of the query are unsupported.
  # @!attribute [rw] incomplete_query_details
  #   @return [::Google::Cloud::DataQnA::V1alpha::InterpretError::InterpretIncompleteQueryDetails]
  #     Populated if the query is incomplete.
  # @!attribute [rw] ambiguity_details
  #   @return [::Google::Cloud::DataQnA::V1alpha::InterpretError::InterpretAmbiguityDetails]
  #     Populated if the query was too ambiguous.
  class InterpretErrorDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about unsupported parts in a query.
  # @!attribute [rw] operators
  #   @return [::Array<::String>]
  #     Unsupported operators. For example: median.
  # @!attribute [rw] intent
  #   @return [::Array<::String>]
  #     Unsupported intents.
  class InterpretUnsupportedDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about an incomplete query.
  # @!attribute [rw] entities
  #   @return [::Array<::Google::Cloud::DataQnA::V1alpha::InterpretEntity>]
  #     List of missing interpret entities.
  class InterpretIncompleteQueryDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details about a query that was too ambiguous. Currently, the message
  # has no fields and its presence signals that there was ambiguity.
  class InterpretAmbiguityDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The interpret error code provides an error category why the interpretation
  # failed.
  module InterpretErrorCode
    # No interpret error code was specified.
    INTERPRET_ERROR_CODE_UNSPECIFIED = 0

    # The query is not valid.
    INVALID_QUERY = 1

    # The interpreter failed to understand the question. For example, because
    # it was too ambiguous.
    FAILED_TO_UNDERSTAND = 2

    # The interpreter could understand the question, but was not able to arrive
    # at an answer. For example, because a requested operation is not
    # supported.
    FAILED_TO_ANSWER = 3
  end
end