Method: projects.locations.groundingConfigs.check

Faz uma verificação de ligação à terra.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
groundingConfig

string

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

Corpo do pedido

O corpo do pedido 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 do candidato a verificar. Pode ter um comprimento máximo de 4096 tokens.
facts[]

object (GroundingFact)

Lista de factos para a verificação de fundamentação. Apoiamos até 200 factos.
groundingSpec

object (CheckGroundingSpec)

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

map (key: string, value: string)

As etiquetas de utilizador aplicadas a um recurso têm de cumprir os seguintes requisitos:

  • Cada recurso pode ter várias etiquetas, até um máximo de 64.
  • Cada etiqueta tem de ser um par chave-valor.
  • As chaves têm um comprimento mínimo de 1 carater e um comprimento máximo de 63 carateres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 carateres.
  • As chaves e os valores só podem conter letras minúsculas, carateres numéricos, sublinhados e travessões. Todos os carateres têm de usar a codificação UTF-8, e são permitidos carateres internacionais.
  • A parte da chave de uma etiqueta tem de ser exclusiva. No entanto, pode usar a mesma chave com vários recursos.
  • As chaves têm de começar com uma letra minúscula ou um caráter internacional.

Consulte o documento do Google Cloud para ver mais detalhes.

Corpo da resposta

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

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

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

object (FactChunk)

Lista de factos citados em todas as reivindicações no candidato a resposta. Estes são derivados dos factos fornecidos no pedido.
citedFacts[]

object (CheckGroundingFactChunk)

Lista de factos citados em todas as reivindicações no candidato a resposta. Estes são derivados dos factos fornecidos no pedido.
claims[]

object (Claim)

Reivindicar textos e informações de citações em todas as reivindicações no candidato a resposta.
supportScore

number

A pontuação de apoio técnico para o candidato a resposta de entrada. Quanto mais elevada for a pontuação, maior é a fração de afirmações suportadas pelos factos fornecidos. Esta opção é sempre definida quando é devolvida uma resposta.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso groundingConfig:

  • discoveryengine.groundingConfigs.check

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

GroundingFact

Facto de fundamentação.

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

string

Conteúdo de texto do facto. Pode ter, no máximo, 10 000 carateres.
attributes

map (key: string, value: string)

Atributos associados ao facto. Os atributos comuns incluem source (que indica a origem do facto), author (que indica o autor do facto) e assim sucessivamente.

CheckGroundingSpec

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

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

number

O limite (em [0,1]) usado para determinar se um facto tem de ser citado para uma afirmação no candidato a resposta. A escolha de um limite superior resulta em menos citações, mas muito fortes, enquanto a escolha de um limite inferior pode resultar em mais citações, mas um pouco mais fracas. Se não estiver definido, o limite tem a predefinição de 0,6.
enableClaimLevelScore

boolean

A flag de controlo que ativa a pontuação de fundamentação ao nível da reivindicação na resposta.

FactChunk

Fact Chunk.

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 fragmento de factos. Pode ter, no máximo, 10 000 carateres.
source

string

Origem a partir da qual este fragmento de facto foi obtido. Se foi obtido a partir dos GroundingFacts fornecidos no pedido, este campo contém o índice do facto específico a partir do qual este fragmento foi obtido.
index

integer

O índice deste fragmento. Atualmente, apenas usado 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

Facto para verificação de fundamentação.

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

string

Conteúdo de texto do fragmento de factos. Pode ter, no máximo, 10 000 carateres.

Reivindicar

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

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

string

Texto da afirmação no candidato a resposta. São sempre fornecidas, independentemente de serem encontradas citações ou anticitações.
citationIndices[]

integer

Uma lista de índices (em "citedChunks") que especifica as citações associadas à reivindicação. Por exemplo, [1,3,4] significa que citedChunks[1], citedChunks[3] e citedChunks[4] são os factos citados que fundamentam a afirmação. Uma citação de um facto indica que a afirmação é suportada pelo facto.
startPos

integer

Posição que indica o início da reivindicação no candidato a resposta, medida em bytes. Tenha em atenção que isto não é medido em carateres e, por isso, tem de ser renderizado na interface do utilizador, tendo em atenção que alguns carateres podem ocupar mais do que um byte. Por exemplo, se o texto da reivindicação contiver carateres não ASCII, as posições inicial e final variam quando medidas em carateres (dependente da linguagem de programação) e quando medidas em bytes (independente da linguagem de programação).
endPos

integer

Posição que indica o fim da reivindicação no candidato de resposta, exclusiva, em bytes. Tenha em atenção que isto não é medido em carateres e, por isso, tem de ser renderizado como tal. Por exemplo, se o texto da reivindicação contiver carateres não ASCII, as posições inicial e final variam quando medidas em carateres (dependente da linguagem de programação) e quando medidas em bytes (independente da linguagem de programação).
groundingCheckRequired

boolean

Indica que esta reivindicação exigiu uma verificação de fundamentação. Quando o sistema decide que esta reivindicação não requer uma verificação de atribuição/fundamentação, este campo é definido como falso. Nesse caso, não foi feita nenhuma verificação de fundamentação para a reivindicação e, por isso, citationIndices não deve ser devolvido.
score

number

Pontuação de confiança para a reivindicação no candidato a resposta, no intervalo de [0, 1]. Esta opção só é definida quando CheckGroundingRequest.grounding_spec.enable_claim_level_score é verdadeira.