Class: Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb

Overview

Response message for the GroundedGenerationService.CheckGrounding method.

Defined Under Namespace

Classes: Claim

Instance Attribute Summary collapse

Instance Attribute Details

#cited_chunks ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1beta::FactChunk>

Returns List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.

Returns:



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb', line 102

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

  # Text and citation info for a claim in the answer candidate.
  # @!attribute [rw] start_pos
  #   @return [::Integer]
  #     Position indicating the start of the claim in the answer candidate,
  #     measured in bytes.
  # @!attribute [rw] end_pos
  #   @return [::Integer]
  #     Position indicating the end of the claim in the answer candidate,
  #     exclusive.
  # @!attribute [rw] claim_text
  #   @return [::String]
  #     Text for the claim in the answer candidate. Always provided regardless of
  #     whether citations or anti-citations are found.
  # @!attribute [rw] citation_indices
  #   @return [::Array<::Integer>]
  #     A list of indices (into 'cited_chunks') specifying the citations
  #     associated with the claim. For instance [1,3,4] means that
  #     cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited
  #     supporting for the claim. A citation to a fact indicates that the claim
  #     is supported by the fact.
  # @!attribute [rw] grounding_check_required
  #   @return [::Boolean]
  #     Indicates that this claim required grounding check. When the system
  #     decided this claim doesn't require attribution/grounding check, this
  #     field will be set to false. In that case, no grounding check was done for
  #     the claim and therefore
  #     {::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::Claim#citation_indices citation_indices},
  #     and
  #     [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices]
  #     should not be returned.
  class Claim
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#claims ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::Claim>

Returns Claim texts and citation info across all claims in the answer candidate.

Returns:



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb', line 102

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

  # Text and citation info for a claim in the answer candidate.
  # @!attribute [rw] start_pos
  #   @return [::Integer]
  #     Position indicating the start of the claim in the answer candidate,
  #     measured in bytes.
  # @!attribute [rw] end_pos
  #   @return [::Integer]
  #     Position indicating the end of the claim in the answer candidate,
  #     exclusive.
  # @!attribute [rw] claim_text
  #   @return [::String]
  #     Text for the claim in the answer candidate. Always provided regardless of
  #     whether citations or anti-citations are found.
  # @!attribute [rw] citation_indices
  #   @return [::Array<::Integer>]
  #     A list of indices (into 'cited_chunks') specifying the citations
  #     associated with the claim. For instance [1,3,4] means that
  #     cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited
  #     supporting for the claim. A citation to a fact indicates that the claim
  #     is supported by the fact.
  # @!attribute [rw] grounding_check_required
  #   @return [::Boolean]
  #     Indicates that this claim required grounding check. When the system
  #     decided this claim doesn't require attribution/grounding check, this
  #     field will be set to false. In that case, no grounding check was done for
  #     the claim and therefore
  #     {::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::Claim#citation_indices citation_indices},
  #     and
  #     [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices]
  #     should not be returned.
  class Claim
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#support_score ⇒ ::Float

Returns The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned.

Returns:

  • (::Float) —

    The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned.



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb', line 102

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

  # Text and citation info for a claim in the answer candidate.
  # @!attribute [rw] start_pos
  #   @return [::Integer]
  #     Position indicating the start of the claim in the answer candidate,
  #     measured in bytes.
  # @!attribute [rw] end_pos
  #   @return [::Integer]
  #     Position indicating the end of the claim in the answer candidate,
  #     exclusive.
  # @!attribute [rw] claim_text
  #   @return [::String]
  #     Text for the claim in the answer candidate. Always provided regardless of
  #     whether citations or anti-citations are found.
  # @!attribute [rw] citation_indices
  #   @return [::Array<::Integer>]
  #     A list of indices (into 'cited_chunks') specifying the citations
  #     associated with the claim. For instance [1,3,4] means that
  #     cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited
  #     supporting for the claim. A citation to a fact indicates that the claim
  #     is supported by the fact.
  # @!attribute [rw] grounding_check_required
  #   @return [::Boolean]
  #     Indicates that this claim required grounding check. When the system
  #     decided this claim doesn't require attribution/grounding check, this
  #     field will be set to false. In that case, no grounding check was done for
  #     the claim and therefore
  #     {::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::Claim#citation_indices citation_indices},
  #     and
  #     [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices]
  #     should not be returned.
  class Claim
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end