Method: projects.locations.groundingConfigs.check

Esegue un controllo di messa a terra.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
groundingConfig

string

Obbligatorio. Il nome risorsa della configurazione di grounding, ad esempio projects/*/locations/global/groundingConfigs/default_grounding_config.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "answerCandidate": string,
  "facts": [
    {
      object (GroundingFact)
    }
  ],
  "groundingSpec": {
    object (CheckGroundingSpec)
  },
  "userLabels": {
    string: string,
    ...
  }
}
Campi
answerCandidate

string

Risposta del candidato da controllare. Può avere una lunghezza massima di 4096 token.
facts[]

object (GroundingFact)

Elenco dei fatti per il controllo della fondatezza. Supportiamo fino a 200 fatti.
groundingSpec

object (CheckGroundingSpec)

Configurazione del controllo di grounding.
userLabels

map (key: string, value: string)

Le etichette utente applicate a una risorsa devono soddisfare i seguenti requisiti:

  • Ogni risorsa può avere più etichette, fino a un massimo di 64.
  • Ogni etichetta deve essere una coppia chiave-valore.
  • Le chiavi hanno una lunghezza minima di 1 carattere e una lunghezza massima di 63 caratteri e non possono essere vuote. I valori possono essere vuoti e avere una lunghezza massima di 63 caratteri.
  • Le chiavi e i valori possono contenere solo lettere minuscole, caratteri numerici, trattini bassi e trattini. Tutti i caratteri devono utilizzare la codifica UTF-8 e sono consentiti i caratteri internazionali.
  • La parte della chiave di un'etichetta deve essere univoca. Tuttavia, puoi utilizzare la stessa chiave con più risorse.
  • Le chiavi devono iniziare con una lettera minuscola o un carattere internazionale.

Per ulteriori dettagli, consulta il documento Google Cloud.

Corpo della risposta

Messaggio di risposta per il metodo GroundedGenerationService.CheckGrounding.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "citedChunks": [
    {
      object (FactChunk)
    }
  ],
  "citedFacts": [
    {
      object (CheckGroundingFactChunk)
    }
  ],
  "claims": [
    {
      object (Claim)
    }
  ],
  "supportScore": number
}
Campi
citedChunks[]

object (FactChunk)

Elenco dei fatti citati in tutte le rivendicazioni nella risposta candidata. Queste informazioni derivano dai fatti forniti nella richiesta.
citedFacts[]

object (CheckGroundingFactChunk)

Elenco dei fatti citati in tutte le rivendicazioni nella risposta candidata. Queste informazioni derivano dai fatti forniti nella richiesta.
claims[]

object (Claim)

Testi delle rivendicazioni e informazioni sulle citazioni in tutte le rivendicazioni del candidato alla risposta.
supportScore

number

Il punteggio di supporto per la risposta candidata inserita. Più alto è il punteggio, maggiore è la frazione di affermazioni supportate dai fatti forniti. Questo valore viene sempre impostato quando viene restituita una risposta.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa groundingConfig:

  • discoveryengine.groundingConfigs.check

Per saperne di più, consulta la documentazione di IAM.

GroundingFact

Grounding Fact.

Rappresentazione JSON 
{
  "factText": string,
  "attributes": {
    string: string,
    ...
  }
}
Campi
factText

string

Contenuto testuale del fatto. Può contenere al massimo 10.000 caratteri.
attributes

map (key: string, value: string)

Attributi associati al fatto. Gli attributi comuni includono source (che indica la fonte del fatto), author (che indica l'autore del fatto) e così via.

CheckGroundingSpec

Specifica per il controllo della messa a terra.

Rappresentazione JSON 
{
  "citationThreshold": number,
  "enableClaimLevelScore": boolean
}
Campi
citationThreshold

number

La soglia (in [0,1]) utilizzata per determinare se un fatto deve essere citato per un'affermazione nella risposta candidata. La scelta di una soglia più alta comporterà un numero inferiore di citazioni, ma molto solide, mentre la scelta di una soglia più bassa potrebbe comportare un numero maggiore di citazioni, ma un po' più deboli. Se non viene impostata, la soglia verrà impostata su 0,6 per impostazione predefinita.
enableClaimLevelScore

boolean

Il flag di controllo che attiva il punteggio di grounding a livello di rivendicazione nella risposta.

FactChunk

Fact Chunk.

Rappresentazione JSON 
{
  "chunkText": string,
  "source": string,
  "index": integer,
  "sourceMetadata": {
    string: string,
    ...
  },
  "uri": string,
  "title": string,
  "domain": string
}
Campi
chunkText

string

Contenuto testuale del blocco di fatti. Può contenere al massimo 10.000 caratteri.
source

string

L'origine da cui è stato recuperato questo blocco di fatti. Se è stato recuperato da GroundingFacts forniti nella richiesta, questo campo conterrà l'indice del fatto specifico da cui è stato recuperato questo chunk.
index

integer

L'indice di questo blocco. Attualmente utilizzato solo per la modalità di streaming.
sourceMetadata

map (key: string, value: string)

Informazioni più granulari per il riferimento alla fonte.
uri

string

L'URI dell'origine.
title

string

Il titolo della fonte.
domain

string

Il dominio della sorgente.

CheckGroundingFactChunk

Blocco di fatti per il controllo della fondatezza.

Rappresentazione JSON 
{
  "chunkText": string
}
Campi
chunkText

string

Contenuto testuale del blocco di fatti. Può contenere al massimo 10.000 caratteri.

Attestazione

Testo e informazioni sulla citazione per un'affermazione nella risposta candidata.

Rappresentazione JSON 
{
  "claimText": string,
  "citationIndices": [
    integer
  ],
  "startPos": integer,
  "endPos": integer,
  "groundingCheckRequired": boolean,
  "score": number
}
Campi
claimText

string

Testo dell'affermazione nel candidato risposta. Fornito sempre, indipendentemente dal fatto che vengano trovate citazioni o anti-citazioni.
citationIndices[]

integer

Un elenco di indici (in "citedChunks") che specificano le citazioni associate alla rivendicazione. Ad esempio, [1,3,4] significa che citedChunks[1], citedChunks[3] e citedChunks[4] sono i fatti citati a sostegno dell'affermazione. Una citazione di un fatto indica che l'affermazione è supportata dal fatto.
startPos

integer

Posizione che indica l'inizio dell'affermazione nel candidato alla risposta, misurata in byte. Tieni presente che questa metrica non viene misurata in caratteri e, pertanto, deve essere visualizzata nell'interfaccia utente tenendo presente che alcuni caratteri potrebbero occupare più di un byte. Ad esempio, se il testo della rivendicazione contiene caratteri non ASCII, le posizioni iniziale e finale variano se misurate in caratteri (a seconda del linguaggio di programmazione) e se misurate in byte (indipendentemente dal linguaggio di programmazione).
endPos

integer

Posizione che indica la fine dell'affermazione nel candidato alla risposta, esclusiva, in byte. Tieni presente che non viene misurato in caratteri e, pertanto, deve essere visualizzato come tale. Ad esempio, se il testo della rivendicazione contiene caratteri non ASCII, le posizioni iniziale e finale variano se misurate in caratteri (a seconda del linguaggio di programmazione) e se misurate in byte (indipendentemente dal linguaggio di programmazione).
groundingCheckRequired

boolean

Indica che questa rivendicazione richiedeva un controllo della messa a terra. Quando il sistema ha deciso che questa affermazione non richiede un controllo di attribuzione/fondatezza, questo campo verrà impostato su false. In questo caso, non è stata eseguita alcuna verifica di fondatezza per la rivendicazione e pertanto non deve essere restituito citationIndices.
score

number

Punteggio di affidabilità per l'affermazione nel candidato alla risposta, nell'intervallo [0, 1]. Questo valore viene impostato solo quando CheckGroundingRequest.grounding_spec.enable_claim_level_score è true.