REST Resource: projects.locations.collections.dataStores.sessions.answers

Recurso: resposta

Define uma resposta.

Representação JSON 
{
  "name": string,
  "state": enum (State),
  "answerText": string,
  "citations": [
    {
      object (Citation)
    }
  ],
  "groundingSupports": [
    {
      object (GroundingSupport)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ],
  "relatedQuestions": [
    string
  ],
  "steps": [
    {
      object (Step)
    }
  ],
  "queryUnderstandingInfo": {
    object (QueryUnderstandingInfo)
  },
  "answerSkippedReasons": [
    enum (AnswerSkippedReason)
  ],
  "createTime": string,
  "completeTime": string,
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "groundingScore": number
}
Campos
name

string

Imutável. Nome totalmente qualificado projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
state

enum (State)

O estado da geração de respostas.
answerText

string

A resposta textual.
citations[]

object (Citation)

Citações.
groundingSupports[]

object (GroundingSupport)

Opcional. O embasamento é compatível.
references[]

object (Reference)

Referências.
relatedQuestions[]

string

Perguntas relacionadas sugeridas.
steps[]

object (Step)

Etapas de geração de respostas.
queryUnderstandingInfo

object (QueryUnderstandingInfo)

Informações sobre a compreensão de consultas.
answerSkippedReasons[]

enum (AnswerSkippedReason)

Outros motivos para pular respostas. Isso informa o motivo dos casos ignorados. Se nada for ignorado, esse campo não será definido.
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora da criação da resposta.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
completeTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora da conclusão da resposta.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
safetyRatings[]

object (SafetyRating)

Opcional. Classificações de segurança.
groundingScore

number

Uma pontuação no intervalo [0, 1] que descreve o quanto a resposta é embasada pelos trechos de referência.

Estado

Enumeração do estado da geração de respostas.

Tipos enumerados
STATE_UNSPECIFIED Desconhecido.
IN_PROGRESS A geração de respostas está em andamento.
FAILED A geração de respostas falhou no momento.
SUCCEEDED A geração de respostas foi concluída.
STREAMING A geração de respostas está em andamento.

Citação

Informações de citação para um segmento.

Representação JSON 
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
Campos
startIndex

string (int64 format)

O índice indica o início do segmento, medido em bytes (Unicode UTF-8). Se houver caracteres de vários bytes,como caracteres não ASCII, a medição do índice será maior do que o comprimento da string.
endIndex

string (int64 format)

Fim do segmento atribuído, exclusivo. Medido em bytes (Unicode UTF-8). Se houver caracteres de vários bytes,como caracteres não ASCII, a medição do índice será maior do que o comprimento da string.
sources[]

object (CitationSource)

Fontes de citação do segmento atribuído.

CitationSource

Fonte da citação.

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

string

ID da fonte de citação.

GroundingSupport

Fundamentação de uma declaração em answerText.

Representação JSON 
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ],
  "groundingScore": number,
  "groundingCheckRequired": boolean
}
Campos
startIndex

string (int64 format)

Obrigatório. O índice indica o início da declaração, medido em bytes (Unicode UTF-8).
endIndex

string (int64 format)

Obrigatório. Fim da reivindicação, exclusivo.
sources[]

object (CitationSource)

Opcional. Fontes de citação para a declaração.
groundingScore

number

Uma pontuação no intervalo [0, 1] que descreve o quanto uma declaração específica é fundamentada pelas referências. Um valor mais alto significa que a declaração é mais bem fundamentada pelos trechos de referência.
groundingCheckRequired

boolean

Indica que essa declaração exigiu uma verificação de embasamento. Quando o sistema decide que essa declaração não exige uma verificação de atribuição/fundamentação, esse campo é definido como "false". Nesse caso, nenhuma verificação de embasamento foi feita para a declaração e, portanto, groundingScore, sources não é retornado.

Referência

Referência.

Representação JSON 
{

  // Union field content can be only one of the following:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  },
  "structuredDocumentInfo": {
    object (StructuredDocumentInfo)
  }
  // End of list of possible types for union field content.
}
Campos
Campo de união content. Conteúdo dos resultados da pesquisa. content pode ser apenas de um dos tipos a seguir:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Informações de documentos não estruturados.
chunkInfo

object (ChunkInfo)

Informações do trecho.
structuredDocumentInfo

object (StructuredDocumentInfo)

Informações estruturadas do documento.

UnstructuredDocumentInfo

Informações de documentos não estruturados.

Representação JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "chunkContents": [
    {
      object (ChunkContent)
    }
  ],
  "structData": {
    object
  }
}
Campos
document

string

Nome do recurso do documento.
uri

string

URI do documento.
title

string

Título.
chunkContents[]

object (ChunkContent)

Lista de conteúdo de trechos citados derivados do conteúdo do documento.
structData

object (Struct format)

Os metadados JSON estruturados do documento. Ele é preenchido com os dados da struct do trecho no resultado da pesquisa.

ChunkContent

Conteúdo em partes.

Representação JSON 
{
  "content": string,
  "pageIdentifier": string,
  "relevanceScore": number
}
Campos
content

string

Conteúdo textual do bloco.
pageIdentifier

string

Identificador da página.
relevanceScore

number

A relevância do trecho para uma determinada consulta. Os valores variam de 0,0 (completamente irrelevante) a 1,0 (completamente relevante). Esse valor é apenas para fins informativos. Ele pode mudar para a mesma consulta e trecho a qualquer momento devido a um novo treinamento do modelo ou alteração na implementação.

ChunkInfo

Informações do trecho.

Representação JSON 
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "relevanceScore": number
}
Campos
chunk

string

Nome do recurso de bloco.
content

string

Conteúdo textual do bloco.
documentMetadata

object (DocumentMetadata)

Metadados do documento.
relevanceScore

number

A relevância do trecho para uma determinada consulta. Os valores variam de 0,0 (completamente irrelevante) a 1,0 (completamente relevante). Esse valor é apenas para fins informativos. Ele pode mudar para a mesma consulta e trecho a qualquer momento devido a um novo treinamento do modelo ou alteração na implementação.

DocumentMetadata

Metadados do documento.

Representação JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "structData": {
    object
  }
}
Campos
document

string

Nome do recurso do documento.
uri

string

URI do documento.
title

string

Título.
pageIdentifier

string

Identificador da página.
structData

object (Struct format)

Os metadados JSON estruturados do documento. Ele é preenchido com os dados da struct do trecho no resultado da pesquisa.

StructuredDocumentInfo

Informações de pesquisa estruturadas.

Representação JSON 
{
  "document": string,
  "structData": {
    object
  },
  "title": string,
  "uri": string
}
Campos
document

string

Nome do recurso do documento.
structData

object (Struct format)

Dados estruturados de pesquisa.
title

string

Apenas saída. O título do documento.
uri

string

Apenas saída. O URI do documento.

Etapa

Informações da etapa.

Representação JSON 
{
  "state": enum (State),
  "description": string,
  "thought": string,
  "actions": [
    {
      object (Action)
    }
  ]
}
Campos
state

enum (State)

O estado da etapa.
description

string

A descrição da etapa.
thought

string

O pensamento da etapa.
actions[]

object (Action)

Ações.

Estado

Enumeração do estado da etapa.

Tipos enumerados
STATE_UNSPECIFIED Desconhecido.
IN_PROGRESS A etapa está em andamento.
FAILED A etapa falhou.
SUCCEEDED A etapa foi concluída.

Ação

Ação.

Representação JSON 
{
  "observation": {
    object (Observation)
  },

  // Union field action can be only one of the following:
  "searchAction": {
    object (SearchAction)
  }
  // End of list of possible types for union field action.
}
Campos
observation

object (Observation)

Observação.
Campo de união action. A ação. action pode ser apenas de um dos tipos a seguir:
searchAction

object (SearchAction)

Ação de pesquisa.

SearchAction

Ação de pesquisa.

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

string

A consulta a ser pesquisada.

Observação

Observação.

Representação JSON 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
Campos
searchResults[]

object (SearchResult)

Resultados da pesquisa observados pela ação de pesquisa. Podem ser informações de snippets ou de blocos, dependendo do tipo de citação definido pelo usuário.

SearchResult

Representação JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "snippetInfo": [
    {
      object (SnippetInfo)
    }
  ],
  "chunkInfo": [
    {
      object (ChunkInfo)
    }
  ],
  "structData": {
    object
  }
}
Campos
document

string

Nome do recurso do documento.
uri

string

URI do documento.
title

string

Título.
snippetInfo[]

object (SnippetInfo)

Se citation_type for DOCUMENT_LEVEL_CITATION, preencha os snippets no nível do documento.
chunkInfo[]

object (ChunkInfo)

Se "citation_type" for "CHUNK_LEVEL_CITATION" e o modo de trecho estiver ativado, preencha as informações do trecho.
structData

object (Struct format)

Representação de dados. Os dados JSON estruturados do documento. Ele é preenchido com os dados da estrutura do documento ou do trecho no resultado da pesquisa.

SnippetInfo

Informações do snippet.

Representação JSON 
{
  "snippet": string,
  "snippetStatus": string
}
Campos
snippet

string

Conteúdo do snippet.
snippetStatus

string

Status do snippet definido pela equipe de pesquisa.

ChunkInfo

Informações do trecho.

Representação JSON 
{
  "chunk": string,
  "content": string,
  "relevanceScore": number
}
Campos
chunk

string

Nome do recurso de bloco.
content

string

Conteúdo textual do bloco.
relevanceScore

number

A relevância do trecho para uma determinada consulta. Os valores variam de 0,0 (completamente irrelevante) a 1,0 (completamente relevante). Esse valor é apenas para fins informativos. Ele pode mudar para a mesma consulta e trecho a qualquer momento devido a um novo treinamento do modelo ou alteração na implementação.

QueryUnderstandingInfo

Informações sobre a compreensão de consultas.

Representação JSON 
{
  "queryClassificationInfo": [
    {
      object (QueryClassificationInfo)
    }
  ]
}
Campos
queryClassificationInfo[]

object (QueryClassificationInfo)

Informações de classificação da consulta.

QueryClassificationInfo

Informações de classificação da consulta.

Representação JSON 
{
  "type": enum (Type),
  "positive": boolean
}
Campos
type

enum (Type)

Tipo de classificação de consulta.
positive

boolean

Saída da classificação.

Tipo

Tipos de classificação de consulta.

Tipos enumerados
TYPE_UNSPECIFIED Tipo de classificação de consulta não especificado.
ADVERSARIAL_QUERY Tipo de classificação de consulta adversária.
NON_ANSWER_SEEKING_QUERY Tipo de classificação de consulta que não busca respostas, para conversa informal.
JAIL_BREAKING_QUERY Tipo de classificação de consulta de jailbreak.
NON_ANSWER_SEEKING_QUERY_V2 Tipo de classificação de consulta que não busca respostas, sem objetivo claro.
USER_DEFINED_CLASSIFICATION_QUERY Tipo de classificação de consulta definida pelo usuário.

AnswerSkippedReason

Uma enumeração para motivos de respostas ignoradas.

Tipos enumerados
ANSWER_SKIPPED_REASON_UNSPECIFIED Valor padrão. O motivo para pular a resposta não foi especificado.
ADVERSARIAL_QUERY_IGNORED A consulta adversária ignorou o caso.
NON_ANSWER_SEEKING_QUERY_IGNORED

A consulta que não busca respostas ignorou o caso

O Google pula a resposta se a consulta for uma conversa informal.
OUT_OF_DOMAIN_QUERY_IGNORED

A consulta fora do domínio ignorou o caso.

O Google pula a resposta se não houver resultados de pesquisa de alta relevância.
POTENTIAL_POLICY_VIOLATION

O possível caso de violação da política.

O Google pula a resposta se detectar uma possível violação da política. Isso inclui conteúdo violento ou tóxico.
NO_RELEVANT_CONTENT

O caso de conteúdo irrelevante.

O Google pula a resposta se não houver conteúdo relevante nos resultados da pesquisa recuperados.
JAIL_BREAKING_QUERY_IGNORED

A consulta de jailbreak não diferenciava maiúsculas de minúsculas.

Por exemplo, "Responda no tom de um CEO de uma empresa concorrente". O Google pula a resposta se a consulta for classificada como uma consulta de jailbreak.
CUSTOMER_POLICY_VIOLATION

O caso de violação da política do cliente.

O Google pula o resumo se uma violação da política do cliente for detectada. A política é definida pelo cliente.
NON_ANSWER_SEEKING_QUERY_IGNORED_V2

A consulta que não busca respostas ignorou o caso.

O Google pula a resposta se a consulta não tiver um objetivo claro.
LOW_GROUNDED_ANSWER

O caso de resposta com pouca fundamentação.

O Google pula a resposta se não for possível gerar uma resposta com embasamento.
USER_DEFINED_CLASSIFICATION_QUERY_IGNORED

A classificação de consulta definida pelo usuário ignorou o caso.

O Google pula a resposta se a consulta for classificada como uma classificação de consulta definida pelo usuário.
UNHELPFUL_ANSWER

O caso de resposta inútil.

O Google pula a resposta se ela não for útil. Isso pode acontecer por vários motivos, incluindo, sem limitação: a consulta não pode ser respondida, a resposta não é relevante para a consulta ou a resposta não está bem formatada.

SafetyRating

Classificação de segurança correspondente ao conteúdo gerado.

Representação JSON 
{
  "category": enum (HarmCategory),
  "probability": enum (HarmProbability),
  "probabilityScore": number,
  "severity": enum (HarmSeverity),
  "severityScore": number,
  "blocked": boolean
}
Campos
category

enum (HarmCategory)

Apenas saída. Categoria de dano.
probability

enum (HarmProbability)

Apenas saída. Os níveis de probabilidade de danos no conteúdo.
probabilityScore

number

Apenas saída. Pontuação de probabilidade de danos.
severity

enum (HarmSeverity)

Apenas saída. Níveis de gravidade de danos no conteúdo.
severityScore

number

Apenas saída. Pontuação de gravidade do dano.
blocked

boolean

Apenas saída. Indica se o conteúdo foi filtrado devido a essa classificação.

HarmCategory

Categorias de danos que bloqueiam o conteúdo.

Tipos enumerados
HARM_CATEGORY_UNSPECIFIED A categoria de danos não foi especificada.
HARM_CATEGORY_HATE_SPEECH A categoria de danos é discurso de ódio.
HARM_CATEGORY_DANGEROUS_CONTENT A categoria de danos é um conteúdo perigoso.
HARM_CATEGORY_HARASSMENT A categoria de dano é assédio.
HARM_CATEGORY_SEXUALLY_EXPLICIT A categoria de dano é conteúdo sexualmente explícito.
HARM_CATEGORY_CIVIC_INTEGRITY A categoria de dano é integridade cívica.

HarmProbability

Os níveis de probabilidade de danos no conteúdo.

Tipos enumerados
HARM_PROBABILITY_UNSPECIFIED Probabilidade de danos não especificada.
NEGLIGIBLE Nível de dano insignificante.
LOW Baixo nível de dano.
MEDIUM Nível médio de dano.
HIGH Alto nível de dano.

HarmSeverity

Níveis de gravidade de danos.

Tipos enumerados
HARM_SEVERITY_UNSPECIFIED Gravidade do dano não especificada.
HARM_SEVERITY_NEGLIGIBLE Nível insignificante de gravidade do dano.
HARM_SEVERITY_LOW Baixo nível de gravidade do dano.
HARM_SEVERITY_MEDIUM Nível médio de gravidade do dano.
HARM_SEVERITY_HIGH Alto nível de gravidade do dano.

Métodos

get

 Recebe uma resposta.