Method: projects.locations.groundingConfigs.check

Effectue une vérification de l'ancrage.

Requête HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{groundingConfig=projects/*/locations/*/groundingConfigs/*}:check

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
groundingConfig

string

Obligatoire. Nom de ressource de la configuration d'ancrage, par exemple projects/*/locations/global/groundingConfigs/default_grounding_config.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "answerCandidate": string,
  "facts": [
    {
      object (GroundingFact)
    }
  ],
  "groundingSpec": {
    object (CheckGroundingSpec)
  },
  "userLabels": {
    string: string,
    ...
  }
}
Champs
answerCandidate

string

Réponse candidate à vérifier. Il peut comporter jusqu'à 4 096 jetons.
facts[]

object (GroundingFact)

Liste des faits pour la vérification de la mise à la terre. Nous acceptons jusqu'à 200 faits.
groundingSpec

object (CheckGroundingSpec)

Configuration de la vérification de l'ancrage.
userLabels

map (key: string, value: string)

Les libellés utilisateur appliqués à une ressource doivent répondre aux exigences suivantes :

  • Chaque ressource peut posséder plusieurs libellés, jusqu'à un maximum de 64.
  • Chaque étiquette doit correspondre à une paire clé/valeur.
  • Les clés doivent comporter un (1) caractère au minimum et 63 au maximum, et ne peuvent pas être vides. Les valeurs peuvent être vides et comporter 63 caractères au maximum.
  • Les clés et les valeurs ne peuvent contenir que des lettres minuscules, des chiffres, des traits de soulignement et des tirets. Tous les caractères doivent être au format d'encodage UTF-8. Les caractères internationaux sont autorisés.
  • La partie clé d'un libellé doit être unique. Cependant, vous pouvez utiliser la même clé avec plusieurs ressources.
  • Les clés doivent commencer par une lettre minuscule ou un caractère international.

Pour en savoir plus, consultez la documentation Google Cloud.

Corps de la réponse

Message de réponse pour la méthode GroundedGenerationService.CheckGrounding.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "citedChunks": [
    {
      object (FactChunk)
    }
  ],
  "citedFacts": [
    {
      object (CheckGroundingFactChunk)
    }
  ],
  "claims": [
    {
      object (Claim)
    }
  ],
  "supportScore": number
}
Champs
citedChunks[]

object (FactChunk)

Liste des faits cités dans toutes les affirmations de la réponse candidate. Elles sont issues des faits fournis dans la demande.
citedFacts[]

object (CheckGroundingFactChunk)

Liste des faits cités dans toutes les affirmations de la réponse candidate. Elles sont issues des faits fournis dans la demande.
claims[]

object (Claim)

Textes de revendication et informations de citation pour toutes les revendications dans la réponse candidate.
supportScore

number

Score de soutien pour la réponse candidate saisie. Plus le score est élevé, plus la fraction d'affirmations étayées par les faits fournis est importante. Cette valeur est toujours définie lorsqu'une réponse est renvoyée.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource groundingConfig :

  • discoveryengine.groundingConfigs.check

Pour en savoir plus, consultez la documentation IAM.

GroundingFact

Ancrage factuel.

Représentation JSON 
{
  "factText": string,
  "attributes": {
    string: string,
    ...
  }
}
Champs
factText

string

Contenu textuel du fait. Ne doit pas dépasser 10 000 caractères.
attributes

map (key: string, value: string)

Attributs associés au fait. Les attributs courants incluent source (indiquant la source du fait), author (indiquant l'auteur du fait), etc.

CheckGroundingSpec

Spécification pour la vérification de l'ancrage.

Représentation JSON 
{
  "citationThreshold": number,
  "enableClaimLevelScore": boolean
}
Champs
citationThreshold

number

Seuil (dans [0,1]) utilisé pour déterminer si un fait doit être cité pour une affirmation dans la réponse candidate. Si vous choisissez un seuil plus élevé, vous obtiendrez moins de citations, mais elles seront très pertinentes. Si vous choisissez un seuil plus bas, vous obtiendrez plus de citations, mais elles seront moins pertinentes. Si elle n'est pas définie, le seuil est défini par défaut sur 0,6.
enableClaimLevelScore

boolean

Indicateur de contrôle qui active le score d'ancrage au niveau de l'affirmation dans la réponse.

FactChunk

Morceau de fait.

Représentation JSON 
{
  "chunkText": string,
  "source": string,
  "index": integer,
  "sourceMetadata": {
    string: string,
    ...
  },
  "uri": string,
  "title": string,
  "domain": string
}
Champs
chunkText

string

Contenu textuel du bloc de faits. Ne doit pas dépasser 10 000 caractères.
source

string

Source à partir de laquelle ce bloc de faits a été récupéré. Si le bloc a été récupéré à partir des GroundingFacts fournis dans la requête, ce champ contient l'index du fait spécifique à partir duquel il a été récupéré.
index

integer

Index de ce fragment. Actuellement utilisé uniquement pour le mode streaming.
sourceMetadata

map (key: string, value: string)

Informations plus précises sur la référence source.
uri

string

URI de la source.
title

string

Titre de la source.
domain

string

Domaine de la source.

CheckGroundingFactChunk

Bloc d'informations pour la vérification de l'ancrage.

Représentation JSON 
{
  "chunkText": string
}
Champs
chunkText

string

Contenu textuel du bloc de faits. Ne doit pas dépasser 10 000 caractères.

Revendication

Texte et informations de citation pour une affirmation dans la réponse candidate.

Représentation JSON 
{
  "claimText": string,
  "citationIndices": [
    integer
  ],
  "startPos": integer,
  "endPos": integer,
  "groundingCheckRequired": boolean,
  "score": number
}
Champs
claimText

string

Texte de l'affirmation dans la réponse candidate. Toujours fourni, que des citations ou des anticitation soient trouvées ou non.
citationIndices[]

integer

Liste d'index (dans "citedChunks") spécifiant les citations associées à l'affirmation. Par exemple, [1,3,4] signifie que citedChunks[1], citedChunks[3] et citedChunks[4] sont les faits cités à l'appui de l'affirmation. Une citation d'un fait indique que l'affirmation est étayée par ce fait.
startPos

integer

Position indiquant le début de l'affirmation dans la réponse candidate, mesurée en octets. Notez que cette valeur n'est pas mesurée en caractères. Elle doit donc être affichée dans l'interface utilisateur en gardant à l'esprit que certains caractères peuvent prendre plus d'un octet. Par exemple, si le texte de la revendication contient des caractères non ASCII, les positions de début et de fin varient selon qu'elles sont mesurées en caractères (en fonction du langage de programmation) ou en octets (indépendamment du langage de programmation).
endPos

integer

Position indiquant la fin de l'affirmation dans la réponse candidate, exclusive, en octets. Notez que cette valeur n'est pas mesurée en caractères et doit donc être affichée telle quelle. Par exemple, si le texte de la revendication contient des caractères non ASCII, les positions de début et de fin varient selon qu'elles sont mesurées en caractères (en fonction du langage de programmation) ou en octets (indépendamment du langage de programmation).
groundingCheckRequired

boolean

Indique que cette affirmation a nécessité une vérification de l'ancrage. Lorsque le système décide que cette affirmation ne nécessite pas de vérification de l'attribution/de l'ancrage, ce champ est défini sur "false". Dans ce cas, aucune vérification de l'ancrage n'a été effectuée pour l'affirmation. Par conséquent, citationIndices ne doit pas être renvoyé.
score

number

Score de confiance pour l'affirmation dans la réponse candidate, dans la plage [0, 1]. Cette valeur n'est définie que lorsque CheckGroundingRequest.grounding_spec.enable_claim_level_score est défini sur "true".