Method: projects.locations.groundingConfigs.check

Führt eine Fundierungsprüfung durch.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
groundingConfig

string

Erforderlich. Der Ressourcenname der Grounding-Konfiguration, z. B. projects/*/locations/global/groundingConfigs/default_grounding_config.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "answerCandidate": string,
  "facts": [
    {
      object (GroundingFact)
    }
  ],
  "groundingSpec": {
    object (CheckGroundingSpec)
  },
  "userLabels": {
    string: string,
    ...
  }
}
Felder
answerCandidate

string

Antwortkandidat zur Überprüfung. Sie darf maximal 4.096 Tokens lang sein.
facts[]

object (GroundingFact)

Liste der Fakten für die Fundierungsprüfung. Wir unterstützen bis zu 200 Fakten.
groundingSpec

object (CheckGroundingSpec)

Konfiguration der Fundierungsprüfung.
userLabels

map (key: string, value: string)

Die Nutzerlabels, die auf eine Ressource angewendet werden, müssen die folgenden Anforderungen erfüllen:

  • Jede Ressource kann bis zu 64 Labels haben.
  • Jedes Label muss ein Schlüssel/Wert-Paar sein.
  • Schlüssel haben eine Mindestlänge von einem Zeichen und eine maximale Länge von 63 Zeichen und dürfen nicht leer sein. Werte dürfen leer sein und haben eine maximale Länge von 63 Zeichen.
  • Schlüssel und Werte dürfen nur Kleinbuchstaben, Ziffern, Unterstriche und Bindestriche enthalten. Alle Zeichen müssen UTF-8-codiert sein. Internationale Zeichen sind zulässig.
  • Der Schlüsselabschnitt eines Labels darf nur einmal vorkommen. Sie können jedoch denselben Schlüssel für mehrere Ressourcen verwenden.
  • Schlüssel müssen mit einem Kleinbuchstaben oder einem internationalen Zeichen beginnen.

Weitere Informationen finden Sie im Google Cloud-Dokument.

Antworttext

Antwortnachricht für die Methode GroundedGenerationService.CheckGrounding.

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung 
{
  "citedChunks": [
    {
      object (FactChunk)
    }
  ],
  "citedFacts": [
    {
      object (CheckGroundingFactChunk)
    }
  ],
  "claims": [
    {
      object (Claim)
    }
  ],
  "supportScore": number
}
Felder
citedChunks[]

object (FactChunk)

Liste der Fakten, die in allen Behauptungen im Antwortkandidaten zitiert werden. Diese werden aus den in der Anfrage angegebenen Fakten abgeleitet.
citedFacts[]

object (CheckGroundingFactChunk)

Liste der Fakten, die in allen Behauptungen im Antwortkandidaten zitiert werden. Diese werden aus den in der Anfrage angegebenen Fakten abgeleitet.
claims[]

object (Claim)

Anspruchstexte und Zitationsinformationen für alle Ansprüche im Antwortkandidaten.
supportScore

number

Die Support-Bewertung für den Kandidaten für die Eingabeantwort. Je höher der Wert, desto höher ist der Anteil der Behauptungen, die durch die bereitgestellten Fakten gestützt werden. Diese wird immer festgelegt, wenn eine Antwort zurückgegeben wird.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource groundingConfig:

  • discoveryengine.groundingConfigs.check

Weitere Informationen finden Sie in der IAM-Dokumentation.

GroundingFact

Fundierungsfakt.

JSON-Darstellung 
{
  "factText": string,
  "attributes": {
    string: string,
    ...
  }
}
Felder
factText

string

Textinhalt des Fakts. Darf höchstens 10.000 Zeichen lang sein.
attributes

map (key: string, value: string)

Attribute, die mit der Tatsache verknüpft sind. Zu den allgemeinen Attributen gehören source (gibt an, woher die Fakten stammen) und author (gibt den Autor der Fakten an).

CheckGroundingSpec

Spezifikation für die Fundierungsprüfung.

JSON-Darstellung 
{
  "citationThreshold": number,
  "enableClaimLevelScore": boolean
}
Felder
citationThreshold

number

Der Schwellenwert (im Bereich [0,1]), der verwendet wird, um zu bestimmen, ob für eine Behauptung im Antwortvorschlag eine Quelle angegeben werden muss. Wenn Sie einen höheren Schwellenwert wählen, erhalten Sie weniger, aber sehr starke Zitationen. Wenn Sie einen niedrigeren Schwellenwert wählen, erhalten Sie möglicherweise mehr, aber etwas schwächere Zitationen. Wenn nicht festgelegt, wird der Schwellenwert standardmäßig auf 0,6 gesetzt.
enableClaimLevelScore

boolean

Das Kontrollflag, das den Fundierungs-Score auf Behauptungsebene in der Antwort aktiviert.

FactChunk

Fakten-Chunk.

JSON-Darstellung 
{
  "chunkText": string,
  "source": string,
  "index": integer,
  "sourceMetadata": {
    string: string,
    ...
  },
  "uri": string,
  "title": string,
  "domain": string
}
Felder
chunkText

string

Textinhalt des Faktenblocks. Darf höchstens 10.000 Zeichen lang sein.
source

string

Quelle, aus der dieser Faktenblock stammt. Wenn der Chunk aus den in der Anfrage bereitgestellten GroundingFacts abgerufen wurde, enthält dieses Feld den Index des entsprechenden Fakts.
index

integer

Der Index dieses Chunks. Wird derzeit nur für den Streamingmodus verwendet.
sourceMetadata

map (key: string, value: string)

Detailliertere Informationen zur Quellreferenz.
uri

string

Der URI der Quelle.
title

string

Der Titel der Quelle.
domain

string

Die Domain der Quelle.

CheckGroundingFactChunk

Faktenblock für die Fundierungsprüfung.

JSON-Darstellung 
{
  "chunkText": string
}
Felder
chunkText

string

Textinhalt des Faktenblocks. Darf höchstens 10.000 Zeichen lang sein.

Anforderung

Text und Zitationsinformationen für eine Behauptung im Antwortvorschlag.

JSON-Darstellung 
{
  "claimText": string,
  "citationIndices": [
    integer
  ],
  "startPos": integer,
  "endPos": integer,
  "groundingCheckRequired": boolean,
  "score": number
}
Felder
claimText

string

Text für die Behauptung im Antwortvorschlag. Wird immer bereitgestellt, unabhängig davon, ob Zitationen oder Anti-Zitationen gefunden werden.
citationIndices[]

integer

Eine Liste von Indexen (in „citedChunks“), die die mit der Behauptung verknüpften Quellenangaben angeben. Beispiel: [1,3,4] bedeutet, dass citedChunks[1], citedChunks[3] und citedChunks[4] die Fakten sind, die die Behauptung stützen. Eine Quellenangabe zu einer Tatsache weist darauf hin, dass die Behauptung durch die Tatsache gestützt wird.
startPos

integer

Position, die den Beginn der Behauptung im Antwortkandidaten angibt, gemessen in Byte. Die Länge wird nicht in Zeichen gemessen. Daher muss bei der Darstellung auf der Benutzeroberfläche berücksichtigt werden, dass einige Zeichen mehr als ein Byte belegen können. Wenn der Anspruchstext beispielsweise Nicht-ASCII-Zeichen enthält, variieren die Start- und Endpositionen, wenn sie in Zeichen (programmiersprachenabhängig) und in Byte (programmiersprachenunabhängig) gemessen werden.
endPos

integer

Position, die das Ende der Behauptung im Antwortkandidaten angibt (exklusiv), in Byte. Die Länge wird nicht in Zeichen gemessen und muss daher entsprechend gerendert werden. Wenn der Anspruchstext beispielsweise Nicht-ASCII-Zeichen enthält, variieren die Start- und Endpositionen, wenn sie in Zeichen (programmiersprachenabhängig) und in Byte (programmiersprachenunabhängig) gemessen werden.
groundingCheckRequired

boolean

Gibt an, dass für diesen Anspruch eine Fundierungsprüfung erforderlich war. Wenn das System entschieden hat, dass für diese Behauptung keine Attributions-/Fundierungsprüfung erforderlich ist, wird dieses Feld auf „false“ gesetzt. In diesem Fall wurde keine Fundierungsprüfung für die Behauptung durchgeführt. Daher sollte citationIndices nicht zurückgegeben werden.
score

number

Konfidenzwert für die Behauptung im Antwortkandidaten im Bereich [0, 1]. Wird nur festgelegt, wenn CheckGroundingRequest.grounding_spec.enable_claim_level_score „true“ ist.