Method: projects.locations.groundingConfigs.check

Realiza una comprobación de puesta a tierra.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
groundingConfig

string

Obligatorio. Nombre de recurso de la configuración de grounding, como projects/*/locations/global/groundingConfigs/default_grounding_config.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos que presentan la siguiente estructura:

Representación JSON 
{
  "answerCandidate": string,
  "facts": [
    {
      object (GroundingFact)
    }
  ],
  "groundingSpec": {
    object (CheckGroundingSpec)
  },
  "userLabels": {
    string: string,
    ...
  }
}
Campos
answerCandidate

string

Respuesta del candidato que se va a comprobar. Puede tener una longitud máxima de 4096 tokens.
facts[]

object (GroundingFact)

Lista de datos para la comprobación de la base. Admitimos hasta 200 datos.
groundingSpec

object (CheckGroundingSpec)

Configuración de la comprobación de la información de base.
userLabels

map (key: string, value: string)

Las etiquetas de usuario aplicadas a un recurso deben cumplir los siguientes requisitos:

  • Cada recurso puede tener varias etiquetas, hasta un máximo de 64.
  • Cada etiqueta debe ser un par clave-valor.
  • Las claves tienen una longitud mínima de 1 carácter y una longitud máxima de 63 caracteres, y no pueden estar vacías. Los valores pueden estar vacíos y tener una longitud máxima de 63 caracteres.
  • Las claves y los valores solo pueden contener letras en minúscula, caracteres numéricos, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se pueden utilizar caracteres internacionales.
  • La parte de la clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave con varios recursos.
  • Las claves deben empezar por una letra minúscula o un carácter internacional.

Consulta más información en el documento de Google Cloud.

Cuerpo de la respuesta

Mensaje de respuesta del método GroundedGenerationService.CheckGrounding.

Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:

Representación JSON 
{
  "citedChunks": [
    {
      object (FactChunk)
    }
  ],
  "citedFacts": [
    {
      object (CheckGroundingFactChunk)
    }
  ],
  "claims": [
    {
      object (Claim)
    }
  ],
  "supportScore": number
}
Campos
citedChunks[]

object (FactChunk)

Lista de hechos citados en todas las reclamaciones de la respuesta candidata. Se derivan de los datos proporcionados en la solicitud.
citedFacts[]

object (CheckGroundingFactChunk)

Lista de hechos citados en todas las reclamaciones de la respuesta candidata. Se derivan de los datos proporcionados en la solicitud.
claims[]

object (Claim)

Textos de reclamaciones e información de citas de todas las reclamaciones de la respuesta candidata.
supportScore

number

Puntuación de asistencia de la respuesta candidata introducida. Cuanto mayor sea la puntuación, mayor será la fracción de las afirmaciones que se respalden con los datos proporcionados. Este valor siempre se asigna cuando se devuelve una respuesta.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso groundingConfig:

  • discoveryengine.groundingConfigs.check

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

GroundingFact

Fundamentación de los hechos.

Representación JSON 
{
  "factText": string,
  "attributes": {
    string: string,
    ...
  }
}
Campos
factText

string

Contenido de texto del dato. Puede tener como máximo 10.000 caracteres.
attributes

map (key: string, value: string)

Atributos asociados al hecho. Entre los atributos comunes se incluyen source (que indica de dónde se ha obtenido el dato) y author (que indica el autor del dato), entre otros.

CheckGroundingSpec

Especificación de la comprobación de puesta a tierra.

Representación JSON 
{
  "citationThreshold": number,
  "enableClaimLevelScore": boolean
}
Campos
citationThreshold

number

Umbral (en [0,1]) que se usa para determinar si se debe citar un dato para una afirmación en la respuesta candidata. Si elige un umbral más alto, obtendrá menos citas, pero serán muy sólidas. Si elige un umbral más bajo, obtendrá más citas, pero serán algo más débiles. Si no se define, el umbral será 0,6 de forma predeterminada.
enableClaimLevelScore

boolean

Marca de control que habilita la puntuación de fundamentación a nivel de reclamación en la respuesta.

FactChunk

Fact Chunk.

Representación JSON 
{
  "chunkText": string,
  "source": string,
  "index": integer,
  "sourceMetadata": {
    string: string,
    ...
  },
  "uri": string,
  "title": string,
  "domain": string
}
Campos
chunkText

string

Contenido de texto del fragmento de información. Puede tener como máximo 10.000 caracteres.
source

string

Fuente de la que se ha obtenido este fragmento de información. Si se ha obtenido de los GroundingFacts proporcionados en la solicitud, este campo contendrá el índice del dato específico del que se ha obtenido este fragmento.
index

integer

Índice de este fragmento. Actualmente, solo se usa en el modo de streaming.
sourceMetadata

map (key: string, value: string)

Información más detallada sobre la referencia de la fuente.
uri

string

URI de la fuente.
title

string

El título de la fuente.
domain

string

El dominio de la fuente.

CheckGroundingFactChunk

Fragmento de información para la comprobación de la base fáctica.

Representación JSON 
{
  "chunkText": string
}
Campos
chunkText

string

Contenido de texto del fragmento de información. Puede tener como máximo 10.000 caracteres.

Reclamar

Texto e información de la cita de una afirmación en la respuesta candidata.

Representación JSON 
{
  "claimText": string,
  "citationIndices": [
    integer
  ],
  "startPos": integer,
  "endPos": integer,
  "groundingCheckRequired": boolean,
  "score": number
}
Campos
claimText

string

Texto de la reclamación en la respuesta candidata. Se proporciona siempre, independientemente de si se encuentran citas o anticitas.
citationIndices[]

integer

Lista de índices (en "citedChunks") que especifican las citas asociadas a la reclamación. Por ejemplo, [1,3,4] significa que citedChunks[1], citedChunks[3] y citedChunks[4] son los hechos citados que respaldan la afirmación. Una cita de un hecho indica que la afirmación se basa en ese hecho.
startPos

integer

Posición que indica el inicio de la reclamación en la respuesta candidata, medida en bytes. Ten en cuenta que no se mide en caracteres y, por lo tanto, debe renderizarse en la interfaz de usuario teniendo en cuenta que algunos caracteres pueden ocupar más de un byte. Por ejemplo, si el texto de la reclamación contiene caracteres no ASCII, las posiciones de inicio y fin varían si se miden en caracteres (depende del lenguaje de programación) o en bytes (no depende del lenguaje de programación).
endPos

integer

Posición que indica el final de la reclamación en el candidato de respuesta, exclusiva, en bytes. Ten en cuenta que no se mide en caracteres y, por lo tanto, debe renderizarse como tal. Por ejemplo, si el texto de la reclamación contiene caracteres no ASCII, las posiciones de inicio y fin varían si se miden en caracteres (depende del lenguaje de programación) o en bytes (no depende del lenguaje de programación).
groundingCheckRequired

boolean

Indica que esta reclamación ha requerido una comprobación de la fundamentación. Si el sistema determina que esta reclamación no requiere una comprobación de atribución o de fundamento, este campo se definirá como "false". En ese caso, no se ha realizado ninguna comprobación de la base de conocimientos de la reclamación y, por lo tanto, no se debería devolver citationIndices.
score

number

Puntuación de confianza de la afirmación en la respuesta candidata, en el intervalo [0, 1]. Este valor solo se define cuando CheckGroundingRequest.grounding_spec.enable_claim_level_score es true.