REST Resource: projects.locations.collections.dataStores.conversations

Recurso: conversa

Definição do proto de conversa externa.

Representação JSON 
{
  "name": string,
  "state": enum (State),
  "userPseudoId": string,
  "messages": [
    {
      object (ConversationMessage)
    }
  ],
  "startTime": string,
  "endTime": string
}
Campos
name

string

Imutável. Nome totalmente qualificado projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/* ou projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*.
state

enum (State)

O estado da conversa.
userPseudoId

string

Um identificador exclusivo para acompanhar os utilizadores.
messages[]

object (ConversationMessage)

Mensagens de conversas.
startTime

string (Timestamp format)

Apenas saída. A hora em que a conversa foi iniciada.

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".
endTime

string (Timestamp format)

Apenas saída. A hora em que a conversa terminou.

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".

Estado

Enumeração do estado da conversa.

Enumerações
STATE_UNSPECIFIED Desconhecido.
IN_PROGRESS A conversa está aberta.
COMPLETED A conversa foi concluída.

ConversationMessage

Define uma mensagem de conversa.

Representação JSON 
{
  "createTime": string,

  // Union field message can be only one of the following:
  "userInput": {
    object (TextInput)
  },
  "reply": {
    object (Reply)
  }
  // End of list of possible types for union field message.
}
Campos
createTime

string (Timestamp format)

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

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".

Campo de união message.

message só pode ser uma das seguintes opções:
userInput

object (TextInput)

Introdução de texto do utilizador.
reply

object (Reply)

Pesquisar resposta.

TextInput

Define a introdução de texto.

Representação JSON 
{
  "input": string,
  "context": {
    object (ConversationContext)
  }
}
Campos
input

string

Entrada de texto.
context

object (ConversationContext)

Contexto da conversa da entrada.

ConversationContext

Define o contexto da conversa

Representação JSON 
{
  "contextDocuments": [
    string
  ],
  "activeDocument": string
}
Campos
contextDocuments[]

string

A lista atual de documentos que o utilizador está a ver. Contém as referências de recursos de documentos.
activeDocument

string

O documento ativo atual que o utilizador abriu. Contém a referência do recurso do documento.

Responder

Define uma mensagem de resposta ao utilizador.

Representação JSON 
{
  "summary": {
    object (Summary)
  }
}
Campos
summary

object (Summary)

Resumo com base nos resultados da pesquisa.

Resumo

Resumo dos N principais resultados da pesquisa especificados pela especificação do resumo.

Representação JSON 
{
  "summaryText": string,
  "summarySkippedReasons": [
    enum (SummarySkippedReason)
  ],
  "safetyAttributes": {
    object (SafetyAttributes)
  },
  "summaryWithMetadata": {
    object (SummaryWithMetadata)
  }
}
Campos
summaryText

string

O conteúdo do resumo.
summarySkippedReasons[]

enum (SummarySkippedReason)

Outros motivos de omissão do resumo. Isto indica o motivo dos casos ignorados. Se nada for ignorado, este campo não é definido.
safetyAttributes

object (SafetyAttributes)

Uma coleção de categorias de atributos de segurança e as respetivas classificações de confiança associadas.
summaryWithMetadata

object (SummaryWithMetadata)

Resumo com informações de metadados.

SummarySkippedReason

Uma enumeração para os motivos de omissão do resumo.

Enumerações
SUMMARY_SKIPPED_REASON_UNSPECIFIED Valor predefinido. O motivo pelo qual o resumo foi ignorado não está especificado.
ADVERSARIAL_QUERY_IGNORED

A consulta adversária ignorou as maiúsculas e minúsculas.

Usado apenas quando SummarySpec.ignore_adversarial_query está definido como true.
NON_SUMMARY_SEEKING_QUERY_IGNORED

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

O Google ignora o resumo se a consulta for uma conversa informal. Usado apenas quando SummarySpec.ignore_non_summary_seeking_query está definido como true.
OUT_OF_DOMAIN_QUERY_IGNORED

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

O Google ignora o resumo se não existirem resultados da pesquisa de alta relevância. Por exemplo, o repositório de dados contém factos sobre a empresa A, mas a consulta do utilizador está a fazer perguntas sobre a empresa B.
POTENTIAL_POLICY_VIOLATION

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

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

O caso em que o suplemento do MDG não está ativado.

O Google ignora o resumo se o suplemento do MDG não estiver ativado.
NO_RELEVANT_CONTENT

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

O Google ignora o resumo 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". Usado apenas quando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] está definido como true.
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_SUMMARY_SEEKING_QUERY_IGNORED_V2

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

O Google ignora o resumo se a consulta não tiver uma intenção clara. Usado apenas quando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] está definido como true.
TIME_OUT

A capa que evita que o telemóvel se desligue.

O Google ignora o resumo se o tempo limite for excedido.

SafetyAttributes

Categorias de atributos de segurança e respetivas classificações de confiança associadas.

Representação JSON 
{
  "categories": [
    string
  ],
  "scores": [
    number
  ]
}
Campos
categories[]

string

Os nomes a apresentar das categorias de atributos de segurança associadas ao conteúdo gerado. A ordem corresponde às pontuações.
scores[]

number

As pontuações de confiança de cada categoria. Um valor mais elevado significa uma confiança mais elevada. A ordem corresponde às categorias.

SummaryWithMetadata

Resumo com informações de metadados.

Representação JSON 
{
  "summary": string,
  "citationMetadata": {
    object (CitationMetadata)
  },
  "references": [
    {
      object (Reference)
    }
  ]
}
Campos
summary

string

Texto de resumo sem informações de citação.
citationMetadata

object (CitationMetadata)

Metadados de citações para o resumo fornecido.
references[]

object (Reference)

Referências de documentos.

CitationMetadata

Metadados de citações.

Representação JSON 
{
  "citations": [
    {
      object (Citation)
    }
  ]
}
Campos
citations[]

object (Citation)

Citações para segmentos.

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.
endIndex

string (int64 format)

Fim do segmento atribuído, exclusivo.
sources[]

object (CitationSource)

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

CitationSource

Fonte da citação.

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

string (int64 format)

Índice de referência do documento de SummaryWithMetadata.references. Tem índice 0 e o valor é zero se o referenceIndex não for definido explicitamente.

Referência

Referência do documento.

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

string

Título do documento.
document

string

Obrigatório. Document.name do documento. Nome completo do recurso do documento referenciado, no formato projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.
uri

string

URI do Cloud Storage ou HTTP para o documento.
chunkContents[]

object (ChunkContent)

Lista de conteúdos de fragmentos citados derivados do conteúdo do documento.

ChunkContent

Dividir o conteúdo em partes.

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

string

Dividir o conteúdo textual em partes.
pageIdentifier

string

Identificador da página.

Métodos

converse

 Converse com uma conversa.

create

 Cria uma conversa.

delete

 Elimina uma conversa.

get

 Recebe uma conversa.

list

 Lista todas as conversas pelo respetivo elemento principal DataStore.

patch

 Atualiza uma conversa.