Method: projects.locations.groundingConfigs.check

Führt eine Fundierungsprüfung durch

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
groundingConfig

string

Erforderlich. Der Ressourcenname der Fundierungskonfiguration, 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

Antwortvorschlag zur Überprüfung. Darf maximal 4.096 Tokens lang sein.
facts[]

object (GroundingFact)

Liste der Fakten für die Fundierungsprüfung. Bis zu 200 Fakten werden unterstützt.
groundingSpec

object (CheckGroundingSpec)

Konfiguration der Fundierungsprüfung.
userLabels

map (key: string, value: string)

Für die auf Ressourcen angewendeten Nutzerlabels gilt Folgendes:

  • Jede Ressource kann bis zu 64 Labels haben.
  • Jedes Label muss ein Schlüssel/Wert-Paar sein.
  • Schlüssel sind mindestens ein Zeichen und höchstens 63 Zeichen lang 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 abgeschlossen wurde, enthält der Antworttext Daten mit der folgenden 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 Antwortvorschlag zitiert werden. Sie werden aus den in der Anfrage angegebenen Fakten abgeleitet.
citedFacts[]

object (CheckGroundingFactChunk)

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

object (Claim)

Behauptungstexte und Zitatinformationen für alle Behauptungen im Antwortvorschlag.
supportScore

number

Die Fundierungsbewertung für den Antwortvorschlag. Je höher der Wert, desto höher ist der Anteil der Behauptungen, die durch die angegebenen Fakten gestützt werden. 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 dem Fakt verknüpft sind. Zu den allgemeinen Attributen gehören source (gibt an, woher die Fakten stammen) und author (gibt an, wer den Fakt aufgezeichnet hat).

CheckGroundingSpec

Spezifikation für die Fundierungsprüfung.

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

number

Der Schwellenwert (im Bereich [0,1]), mit dem bestimmt wird, ob für eine Behauptung im Antwortvorschlag eine Quelle angegeben werden muss. Bei einem höheren Schwellenwert werden zwar weniger, dafür aber sehr starke Quellen ausgegeben. Bei einem niedrigeren Schwellenwert werden möglicherweise mehr, dafür aber etwas schwächere Quellen ausgegeben. Wenn nicht festgelegt, beträgt der Schwellenwert standardmäßig 0,6.
enableClaimLevelScore

boolean

Das Steuerungsflag, das in der Antwort die Fundierungsbewertung auf Behauptungsebene aktiviert.

FactChunk

Faktenblock.

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 Block aus den in der Anfrage angegebenen GroundingFacts stammt, enthält dieses Feld den Index des spezifischen Fakts, aus dem der Block abgerufen wurde.
index

integer

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

map (key: string, value: string)

Detailliertere Informationen zum Quellenverweis.
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.

Claim

Text- und Quelleninformationen 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 angegeben, unabhängig davon, ob Quellen oder Gegenquellen gefunden werden.
citationIndices[]

integer

Eine Liste von Indexen (in „citedChunks“) mit den Quellenangaben für die Behauptung. Beispiel: [1,3,4] bedeutet, dass citedChunks[1], citedChunks[3] und citedChunks[4] die Fakten sind, die die Behauptung stützen. Eine Quellenangabe zu einem Fakt weist darauf hin, dass die Behauptung durch den Fakt gestützt wird.
startPos

integer

Position, die den Beginn der Behauptung im Antwortvorschlag 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 Behauptungstext beispielsweise Nicht-ASCII-Zeichen enthält, variieren die Start- und Endpositionen, je nachdem, ob sie in Zeichen (programmiersprachenabhängig) oder in Byte (programmiersprachenunabhängig) gemessen werden.
endPos

integer

Position, die das Ende der Behauptung im Antwortvorschlag angibt (ausschließlich), in Byte. Die Länge wird nicht in Zeichen gemessen und muss daher entsprechend gerendert werden. Wenn der Behauptungstext beispielsweise Nicht-ASCII-Zeichen enthält, variieren die Start- und Endpositionen, je nachdem, ob sie in Zeichen (programmiersprachenabhängig) oder in Byte (programmiersprachenunabhängig) gemessen werden.
groundingCheckRequired

boolean

Gibt an, dass für diese Behauptung eine Fundierungsprüfung erforderlich ist. 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 für die Behauptung keine Fundierungsprüfung durchgeführt. Daher sollten keine citationIndices zurückgegeben werden.
score

number

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