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. Suporta a superfície de referência.
references[]

object (Reference)

Referências.
relatedQuestions[]

string

Perguntas relacionadas sugeridas.
steps[]

object (Step)

Passos de geração de respostas.
queryUnderstandingInfo

object (QueryUnderstandingInfo)

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

enum (AnswerSkippedReason)

Motivos adicionais para a omissão de respostas. Isto indica o motivo dos casos ignorados. Se nada for ignorado, este campo não é definido.
createTime

string (Timestamp format)

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

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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. Data/hora de conclusão da resposta.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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 de [0, 1] que descreve o quão fundamentada está a resposta nos fragmentos de referência.

Estado

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

Enumerações
STATE_UNSPECIFIED Desconhecido.
IN_PROGRESS A geração de respostas está atualmente em curso.
FAILED A geração de respostas falhou.
SUCCEEDED A geração de respostas foi bem-sucedida.
STREAMING A geração de respostas está atualmente em curso.

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 existirem carateres de vários bytes,como carateres não ASCII, a medição do índice é superior ao comprimento da string.
endIndex

string (int64 format)

Fim do segmento atribuído, exclusivo. Medido em bytes (Unicode UTF-8). Se existirem carateres de vários bytes,como carateres não ASCII, a medição do índice é superior ao comprimento da string.
sources[]

object (CitationSource)

Origens das citações para o segmento atribuído.

CitationSource

Fonte da citação.

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

string

ID da origem da citação.

GroundingSupport

Fundamentação do apoio técnico para uma reivindicaçã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 reivindicação, medido em bytes (Unicode UTF-8).
endIndex

string (int64 format)

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

object (CitationSource)

Opcional. Origens das citações para a reivindicação.
groundingScore

number

Uma pontuação no intervalo de [0, 1] que descreve o quão fundamentada está uma reivindicação específica pelas referências. Um valor mais elevado significa que a afirmação é mais bem suportada pelos fragmentos de referência.
groundingCheckRequired

boolean

Indica que esta reivindicação exigiu uma verificação de fundamentação. Quando o sistema decidiu que esta reivindicação não exigia 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, groundingScore, sources não é devolvido.

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 só pode ser uma das seguintes opções:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

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

object (ChunkInfo)

Informações de blocos.
structuredDocumentInfo

object (StructuredDocumentInfo)

Informações estruturadas sobre documentos.

UnstructuredDocumentInfo

Informações de documentos não estruturadas.

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údos de fragmentos citados derivados do conteúdo do documento.
structData

object (Struct format)

Os metadados JSON estruturados do documento. É preenchido a partir dos dados estruturados do fragmento no resultado da pesquisa.

ChunkContent

Dividir o conteúdo em partes.

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

string

Dividir o conteúdo textual em partes.
pageIdentifier

string

Identificador da página.
relevanceScore

number

A relevância do fragmento para uma determinada consulta. Os valores variam entre 0,0 (completamente irrelevante) e 1,0 (completamente relevante). Este valor destina-se apenas a fins informativos. Pode mudar para a mesma consulta e bloco em qualquer altura devido a uma reciclagem do modelo ou a uma alteração na implementação.

ChunkInfo

Informações de blocos.

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

string

Nome do recurso do fragmento.
content

string

Dividir o conteúdo textual em partes.
documentMetadata

object (DocumentMetadata)

Metadados do documento.
relevanceScore

number

A relevância do fragmento para uma determinada consulta. Os valores variam entre 0,0 (completamente irrelevante) e 1,0 (completamente relevante). Este valor destina-se apenas a fins informativos. Pode mudar para a mesma consulta e bloco em qualquer altura devido a uma reciclagem do modelo ou a uma 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. É preenchido a partir dos dados estruturados do fragmento 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 de pesquisa estruturados.
title

string

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

string

Apenas saída. O URI do documento.

Passo

Informações sobre os passos.

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

enum (State)

O estado do passo.
description

string

A descrição do passo.
thought

string

O pensamento do passo.
actions[]

object (Action)

Ações.

Estado

Enumeração do estado do passo.

Enumerações
STATE_UNSPECIFIED Desconhecido.
IN_PROGRESS O passo está atualmente em curso.
FAILED O passo falhou atualmente.
SUCCEEDED O passo foi concluído com êxito.

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 só pode ser uma das seguintes opções:
searchAction

object (SearchAction)

Ação de pesquisa.

SearchAction

Ação de pesquisa.

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

string

A consulta a pesquisar.

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 fragmentos ou informações de blocos, consoante o tipo de citação definido pelo utilizador.

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 fragmentos ao nível do documento.
chunkInfo[]

object (ChunkInfo)

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

object (Struct format)

Representação de dados. Os dados JSON estruturados para o documento. É preenchido a partir dos dados estruturados do documento ou do fragmento no resultado da pesquisa.

SnippetInfo

Informações do fragmento.

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

string

Conteúdo do fragmento.
snippetStatus

string

Estado do fragmento definido pela equipa de pesquisa.

ChunkInfo

Informações de blocos.

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

string

Nome do recurso do fragmento.
content

string

Dividir o conteúdo textual em partes.
relevanceScore

number

A relevância do fragmento para uma determinada consulta. Os valores variam entre 0,0 (completamente irrelevante) e 1,0 (completamente relevante). Este valor destina-se apenas a fins informativos. Pode mudar para a mesma consulta e bloco em qualquer altura devido a uma reciclagem do modelo ou a uma alteração na implementação.

QueryUnderstandingInfo

Informações de compreensão de consultas.

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

object (QueryClassificationInfo)

Informações de classificação de consultas.

QueryClassificationInfo

Informações de classificação de consultas.

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

enum (Type)

Tipo de classificação de consulta.
positive

boolean

Resultado da classificação.

Tipo

Tipos de classificação de consultas.

Enumerações
TYPE_UNSPECIFIED Tipo de classificação de consulta não especificado.
ADVERSARIAL_QUERY Tipo de classificação de consultas adversariais.
NON_ANSWER_SEEKING_QUERY Tipo de classificação de consulta que não procura respostas, para conversas informais.
JAIL_BREAKING_QUERY Tipo de classificação de consultas de jailbreak.
NON_ANSWER_SEEKING_QUERY_V2 Tipo de classificação de consulta que não procura respostas, sem uma intenção clara.
USER_DEFINED_CLASSIFICATION_QUERY Tipo de classificação de consulta definido pelo utilizador.

AnswerSkippedReason

Uma enumeração para os motivos pelos quais a resposta foi ignorada.

Enumerações
ANSWER_SKIPPED_REASON_UNSPECIFIED Valor predefinido. O motivo pelo qual a resposta foi ignorada não está especificado.
ADVERSARIAL_QUERY_IGNORED A consulta adversária ignorou as maiúsculas e minúsculas.
NON_ANSWER_SEEKING_QUERY_IGNORED

A consulta que não procura respostas ignorou as maiúsculas/minúsculas

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

A consulta fora do domínio ignorou as maiúsculas/minúsculas.

O Google ignora a resposta se não existirem resultados da pesquisa de alta relevância.
POTENTIAL_POLICY_VIOLATION

O registo de potencial violação de política.

O Google ignora a resposta se for detetada uma potencial violação de política. Isto inclui conteúdo que pode ser violento ou tóxico.
NO_RELEVANT_CONTENT

O caso de não haver conteúdo relevante.

O Google ignora a resposta se não existir conteúdo relevante nos resultados da pesquisa obtidos.
JAIL_BREAKING_QUERY_IGNORED

A consulta de desbloqueio ignorou as maiúsculas e minúsculas.

Por exemplo, "Responde com o tom do CEO de uma empresa concorrente". O Google ignora a resposta se a consulta for classificada como uma consulta de jailbreak.
CUSTOMER_POLICY_VIOLATION

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

A Google ignora o resumo se for detetada uma violação da política de clientes. A política é definida pelo cliente.
NON_ANSWER_SEEKING_QUERY_IGNORED_V2

A consulta que não procura respostas ignorou as maiúsculas/minúsculas.

O Google ignora a resposta se a consulta não tiver uma intenção clara.
LOW_GROUNDED_ANSWER

O caso de resposta com base em factos.

O Google ignora a resposta se não for possível gerar uma resposta bem fundamentada.
USER_DEFINED_CLASSIFICATION_QUERY_IGNORED

A classificação de consultas definida pelo utilizador ignorou a capitalização.

O Google ignora a resposta se a consulta for classificada como uma classificação de consulta definida pelo utilizador.
UNHELPFUL_ANSWER

O caso da resposta inútil.

O Google ignora a resposta se esta não for útil. Isto pode dever-se a vários fatores, incluindo, entre outros: a consulta não tem resposta, 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 danos.
probability

enum (HarmProbability)

Apenas saída. 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 dos danos no conteúdo.
severityScore

number

Apenas saída. Gravidade do dano.
blocked

boolean

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

HarmCategory

Categorias de danos que bloqueiam o conteúdo.

Enumerações
HARM_CATEGORY_UNSPECIFIED A categoria de danos não está especificada.
HARM_CATEGORY_HATE_SPEECH A categoria de conteúdo prejudicial é incitamento ao ódio.
HARM_CATEGORY_DANGEROUS_CONTENT A categoria de danos é conteúdo perigoso.
HARM_CATEGORY_HARASSMENT A categoria de danos é assédio.
HARM_CATEGORY_SEXUALLY_EXPLICIT A categoria de danos é conteúdo sexualmente explícito.
HARM_CATEGORY_CIVIC_INTEGRITY A categoria de danos é integridade cívica.

HarmProbability

Níveis de probabilidade de danos no conteúdo.

Enumerações
HARM_PROBABILITY_UNSPECIFIED Probabilidade de danos não especificada.
NEGLIGIBLE Nível de dano insignificante.
LOW Nível de dano baixo.
MEDIUM Nível de dano moderado.
HIGH Nível elevado de danos.

HarmSeverity

Níveis de gravidade dos danos.

Enumerações
HARM_SEVERITY_UNSPECIFIED Gravidade dos danos não especificada.
HARM_SEVERITY_NEGLIGIBLE Nível de gravidade dos danos insignificante.
HARM_SEVERITY_LOW Nível de gravidade de danos baixo.
HARM_SEVERITY_MEDIUM Nível médio de gravidade dos danos.
HARM_SEVERITY_HIGH Nível elevado de gravidade de danos.

Métodos

get

 Recebe uma resposta.