Method: projects.locations.groundingConfigs.check

Realiza uma verificação de embasamento.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
groundingConfig

string

Obrigatório. O nome do recurso da configuração de embasamento, como projects/*/locations/global/groundingConfigs/default_grounding_config.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "answerCandidate": string,
  "facts": [
    {
      object (GroundingFact)
    }
  ],
  "groundingSpec": {
    object (CheckGroundingSpec)
  },
  "userLabels": {
    string: string,
    ...
  }
}
Campos
answerCandidate

string

Resposta candidata a ser verificada. Ele pode ter um tamanho máximo de 4.096 tokens.
facts[]

object (GroundingFact)

Lista de fatos para a verificação de embasamento. Oferecemos suporte a até 200 fatos.
groundingSpec

object (CheckGroundingSpec)

Configuração da verificação de embasamento.
userLabels

map (key: string, value: string)

Os rótulos de usuário aplicados a um recurso precisam atender aos seguintes requisitos:

  • Cada recurso pode ter vários rótulos, até um máximo de 64.
  • Cada rótulo precisa ser um par de chave-valor.
  • As chaves têm comprimento mínimo de um caractere e comprimento máximo de 63 caracteres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 caracteres.
  • As chaves e os valores podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Todos os caracteres precisam usar a codificação UTF-8, e os caracteres internacionais são permitidos.
  • A parte da chave de um rótulo precisa ser única. No entanto, é possível usar a mesma chave com vários recursos.
  • As chaves precisam começar com uma letra minúscula ou um caractere internacional.

Consulte o documento do Google Cloud para mais detalhes.

Corpo da resposta

Mensagem de resposta para o método GroundedGenerationService.CheckGrounding.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "citedChunks": [
    {
      object (FactChunk)
    }
  ],
  "citedFacts": [
    {
      object (CheckGroundingFactChunk)
    }
  ],
  "claims": [
    {
      object (Claim)
    }
  ],
  "supportScore": number
}
Campos
citedChunks[]

object (FactChunk)

Lista de fatos citados em todas as declarações na resposta candidata. Eles são derivados dos fatos fornecidos na solicitação.
citedFacts[]

object (CheckGroundingFactChunk)

Lista de fatos citados em todas as declarações na resposta candidata. Eles são derivados dos fatos fornecidos na solicitação.
claims[]

object (Claim)

Textos de reivindicação e informações de citação em todas as reivindicações na resposta candidata.
supportScore

number

A pontuação de suporte para a resposta candidata de entrada. Quanto maior a pontuação, maior a fração de declarações que são apoiadas pelos fatos fornecidos. Sempre é definido quando uma resposta é retornada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso groundingConfig:

  • discoveryengine.groundingConfigs.check

Para mais informações, consulte a documentação do IAM.

GroundingFact

Fato.

Representação JSON 
{
  "factText": string,
  "attributes": {
    string: string,
    ...
  }
}
Campos
factText

string

Conteúdo de texto do fato. Pode ter no máximo 10 mil caracteres.
attributes

map (key: string, value: string)

Atributos associados ao fato. Os atributos comuns incluem source (indicando de onde o fato foi extraído), author (indicando o autor do fato) e assim por diante.

CheckGroundingSpec

Especificação para a verificação de embasamento.

Representação JSON 
{
  "citationThreshold": number,
  "enableClaimLevelScore": boolean
}
Campos
citationThreshold

number

O limite (em [0,1]) usado para determinar se um fato precisa ser citado para uma declaração na resposta candidata. Escolher um limite mais alto vai resultar em menos citações, mas muito fortes, enquanto escolher um limite mais baixo pode resultar em mais citações, mas um pouco mais fracas. Se não for definido, o padrão será 0,6.
enableClaimLevelScore

boolean

A flag de controle que ativa a pontuação de embasamento no nível da declaração na resposta.

FactChunk

Bloco de fatos.

Representação JSON 
{
  "chunkText": string,
  "source": string,
  "index": integer,
  "sourceMetadata": {
    string: string,
    ...
  },
  "uri": string,
  "title": string,
  "domain": string
}
Campos
chunkText

string

Conteúdo de texto do trecho de fato. Pode ter no máximo 10 mil caracteres.
source

string

Origem de onde este trecho de fato foi extraído. Se ele foi extraído das GroundingFacts fornecidas na solicitação, esse campo vai conter o índice do fato específico de onde o trecho foi extraído.
index

integer

O índice deste trecho. No momento, usado apenas para o modo de streaming.
sourceMetadata

map (key: string, value: string)

Informações mais detalhadas para a referência da fonte.
uri

string

O URI da origem.
title

string

O título da fonte.
domain

string

O domínio da origem.

CheckGroundingFactChunk

Parte do fato para verificação de embasamento.

Representação JSON 
{
  "chunkText": string
}
Campos
chunkText

string

Conteúdo de texto do trecho de fato. Pode ter no máximo 10 mil caracteres.

Reivindicação

Texto e informações de citação para uma declaração na resposta candidata.

Representação JSON 
{
  "claimText": string,
  "citationIndices": [
    integer
  ],
  "startPos": integer,
  "endPos": integer,
  "groundingCheckRequired": boolean,
  "score": number
}
Campos
claimText

string

Texto da declaração no candidato a resposta. Sempre fornecido, independente de citações ou anticitações serem encontradas.
citationIndices[]

integer

Uma lista de índices (em "citedChunks") que especificam as citações associadas à declaração. Por exemplo, [1,3,4] significa que citedChunks[1], citedChunks[3] e citedChunks[4] são os fatos citados que apoiam a declaração. Uma citação de um fato indica que a declaração é fundamentada nele.
startPos

integer

Posição que indica o início da declaração no candidato a resposta, medida em bytes. Isso não é medido em caracteres e, portanto, precisa ser renderizado na interface do usuário considerando que alguns caracteres podem ocupar mais de um byte. Por exemplo, se o texto da declaração contiver caracteres não ASCII, as posições inicial e final vão variar quando medidas em caracteres (dependente da linguagem de programação) e em bytes (independente da linguagem de programação).
endPos

integer

Posição que indica o fim da declaração no candidato a resposta, exclusiva, em bytes. Isso não é medido em caracteres e, portanto, precisa ser renderizado como tal. Por exemplo, se o texto da declaração contiver caracteres não ASCII, as posições inicial e final vão variar quando medidas em caracteres (dependente da linguagem de programação) e em bytes (independente da linguagem de programação).
groundingCheckRequired

boolean

Indica que essa declaração exigiu uma verificação de embasamento. Quando o sistema decidir que essa declaração não exige uma verificação de atribuição/fundamentação, esse campo será definido como "false". Nesse caso, nenhuma verificação de embasamento foi feita para a declaração e, portanto, citationIndices não deve ser retornado.
score

number

Pontuação de confiança para a declaração na resposta candidata, no intervalo [0, 1]. Isso só é definido quando CheckGroundingRequest.grounding_spec.enable_claim_level_score é verdadeiro.