check(groundingConfig, body=None, x__xgafv=None)
Performs a grounding check.
Close httplib2 connections.
check(groundingConfig, body=None, x__xgafv=None)
Performs a grounding check.
Args:
groundingConfig: string, Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for GroundedGenerationService.CheckGrounding method.
"answerCandidate": "A String", # Answer candidate to check. It can have a maximum length of 4096 tokens.
"facts": [ # List of facts for the grounding check. We support up to 200 facts.
{ # Grounding Fact.
"attributes": { # Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on.
"a_key": "A String",
},
"factText": "A String", # Text content of the fact. Can be at most 10K characters long.
},
],
"groundingSpec": { # Specification for the grounding check. # Configuration of the grounding check.
"citationThreshold": 3.14, # The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6.
},
"userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
"a_key": "A String",
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the GroundedGenerationService.CheckGrounding method.
"citedChunks": [ # List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.
{ # Fact chunk for grounding check.
"chunkText": "A String", # Text content of the fact chunk. Can be at most 10K characters long.
"source": "A String", # Source from which this fact chunk was retrieved. For a fact chunk retrieved from inline facts, this field will contain the index of the specific fact from which this chunk was retrieved.
},
],
"claims": [ # Claim texts and citation info across all claims in the answer candidate.
{ # Text and citation info for a claim in the answer candidate.
"citationIndices": [ # 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.
42,
],
"claimText": "A String", # Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.
"endPos": 42, # Position indicating the end of the claim in the answer candidate, exclusive.
"groundingCheckRequired": True or False, # 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 citation_indices, anti_citation_indices, and score should not be returned.
"startPos": 42, # Position indicating the start of the claim in the answer candidate, measured in bytes.
},
],
"supportScore": 3.14, # 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.
}
close()
Close httplib2 connections.