Method: projects.locations.groundingConfigs.check

Realiza una verificación de fundamentación.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
groundingConfig

string

Obligatorio. Es el nombre del recurso de la configuración de fundamentación, como projects/*/locations/global/groundingConfigs/default_grounding_config.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

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

string

Es la respuesta candidata que se debe verificar. Puede tener una longitud máxima de 4,096 tokens.
facts[]

object (GroundingFact)

Es la lista de hechos para la verificación de fundamentación. Admitimos hasta 200 hechos.
groundingSpec

object (CheckGroundingSpec)

Es la configuración de la verificación de fundamentación.
userLabels

map (key: string, value: string)

Las etiquetas de usuario que se aplican a un recurso deben cumplir con los siguientes requisitos:

  • Cada recurso puede tener varias etiquetas, hasta 64.
  • Cada etiqueta debe ser un par clave-valor.
  • Las claves deben tener 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 su longitud máxima es de 63 caracteres.
  • Las claves y los valores solo pueden contener letras en minúscula, números, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se permiten los caracteres internacionales.
  • La porción de clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave en varios recursos.
  • Las claves deben comenzar con una letra en minúscula o un carácter internacional.

Consulta Google Cloud Document para obtener más detalles.

Cuerpo de la respuesta

Mensaje de respuesta para el método GroundedGenerationService.CheckGrounding.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene 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 afirmaciones del candidato a respuesta. Se derivan de los hechos proporcionados en la solicitud.
citedFacts[]

object (CheckGroundingFactChunk)

Lista de hechos citados en todas las afirmaciones del candidato a respuesta. Se derivan de los hechos proporcionados en la solicitud.
claims[]

object (Claim)

Textos de reclamos y la información de citas en todos los reclamos del candidato a respuesta.
supportScore

number

Es la puntuación de asistencia para la respuesta candidata de entrada. Cuanto más alta sea la puntuación, mayor será la fracción de reclamos respaldados por los hechos proporcionados. Siempre se establece cuando se devuelve una respuesta.

Permisos de autorización

Se necesita 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 Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso groundingConfig:

  • discoveryengine.groundingConfigs.check

Para obtener más información, consulta la documentación de IAM.

GroundingFact

Es un hecho básico.

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

string

Es el contenido de texto del hecho. Puede tener hasta 10,000 caracteres.
attributes

map (key: string, value: string)

Son los atributos asociados con el hecho. Los atributos comunes incluyen source (que indica la fuente del hecho), author (que indica el autor del hecho), etcétera.

CheckGroundingSpec

Es la especificación para la verificación de fundamentación.

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

number

Es el umbral (en [0,1]) que se usa para determinar si se debe citar un hecho para una afirmación en el candidato a respuesta. Elegir un umbral más alto generará menos citas, pero muy sólidas, mientras que elegir un umbral más bajo puede generar más citas, pero algo más débiles. Si no se establece, el umbral se establecerá de forma predeterminada en 0.6.
enableClaimLevelScore

boolean

Es la marca de control que habilita la puntuación de fundamentación a nivel del reclamo en la respuesta.

FactChunk

Es un fragmento de hecho.

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

string

Es el contenido de texto del fragmento de hecho. Puede tener hasta 10,000 caracteres.
source

string

Es la fuente desde la que se recuperó este fragmento de hecho. Si se recuperó de los GroundingFacts proporcionados en la solicitud, este campo contendrá el índice del hecho específico del que se recuperó este fragmento.
index

integer

Es el índice de este fragmento. Actualmente, solo se usa para el modo de transmisión.
sourceMetadata

map (key: string, value: string)

Es información más detallada para la referencia de la fuente.
uri

string

Es el URI de la fuente.
title

string

Es el título de la fuente.
domain

string

Es el dominio de la fuente.

CheckGroundingFactChunk

Es un fragmento de hecho para la verificación de fundamentación.

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

string

Es el contenido de texto del fragmento de hecho. Puede tener hasta 10,000 caracteres.

Reclamación

Es el texto y la información de la cita de un reclamo en la respuesta candidata.

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

string

Es el texto de la afirmación en la respuesta candidata. Siempre se proporciona, independientemente de si se encuentran citas o anticitas.
citationIndices[]

integer

Es una lista de índices (en "citedChunks") que especifican las citas asociadas con la afirmació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 a un hecho indica que la afirmación se basa en ese hecho.
startPos

integer

Posición que indica el inicio de la afirmación en el candidato a respuesta, medida en bytes. Ten en cuenta que esto no se mide en caracteres y, por lo tanto, se debe renderizar en la interfaz de usuario teniendo en cuenta que algunos caracteres pueden ocupar más de un byte. Por ejemplo, si el texto del reclamo contiene caracteres que no son ASCII, las posiciones de inicio y finalización varían cuando se miden en caracteres (dependiente del lenguaje de programación) y cuando se miden en bytes (independiente del lenguaje de programación).
endPos

integer

Posición que indica el final del reclamo en el candidato a respuesta, exclusiva, en bytes. Ten en cuenta que esto no se mide en caracteres y, por lo tanto, debe renderizarse como tal. Por ejemplo, si el texto del reclamo contiene caracteres que no son ASCII, las posiciones de inicio y finalización varían cuando se miden en caracteres (dependiente del lenguaje de programación) y cuando se miden en bytes (independiente del lenguaje de programación).
groundingCheckRequired

boolean

Indica que esta afirmación requirió una verificación de fundamentación. Cuando el sistema decida que esta afirmación no requiere una verificación de atribución o fundamentación, este campo se establecerá como falso. En ese caso, no se realizó ninguna verificación de fundamentación para la afirmación y, por lo tanto, no se debe devolver citationIndices.
score

number

Es la puntuación de confianza para la afirmación en la respuesta candidata, en el rango de [0, 1]. Este parámetro solo se establece cuando CheckGroundingRequest.grounding_spec.enable_claim_level_score es verdadero.