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

Recurso: Conversa

Definição de 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 rastrear usuários.
messages[]

object (ConversationMessage)

Mensagens de conversa.
startTime

string (Timestamp format)

Apenas saída. O horário em que a conversa começou.

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

string (Timestamp format)

Apenas saída. O horário em que a conversa terminou.

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

Estado

Enumeração do estado da conversa.

Tipos enumerados
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. Carimbo de data/hora da criação da mensagem.

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

Campo de união message.

message pode ser apenas de um dos tipos a seguir:
userInput

object (TextInput)

Entrada de texto do usuário.
reply

object (Reply)

Resposta da pesquisa.

TextInput

Define a entrada 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 usuário está vendo. Ele contém as referências de recursos de documentos.
activeDocument

string

O documento ativo aberto pelo usuário. Ele contém a referência do recurso de documento.

Responder

Define uma mensagem de resposta para o usuário.

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

string

OBSOLETO: use summary. Resposta de texto.
references[]
(deprecated)

object (Reference)

Referências na resposta.
summary

object (Summary)

Resumo com base nos resultados da pesquisa.

Referência

Define a referência na resposta.

Representação JSON 
{
  "uri": string,
  "anchorText": string,
  "start": integer,
  "end": integer
}
Campos
uri

string

Referência de link de URI.
anchorText

string

Texto âncora.
start

integer

Índice inicial do texto âncora.
end

integer

Índice final do texto âncora.

Resumo

Resumo dos N principais resultados da pesquisa especificados pela especificação de 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 para o resumo ser ignorado. Isso informa o motivo dos casos ignorados. Se nada for ignorado, esse campo não será definido.
safetyAttributes

object (SafetyAttributes)

Uma coleção de categorias de atributo de segurança e as pontuações de confiança associadas a elas.
summaryWithMetadata

object (SummaryWithMetadata)

Resumo com informações de metadados.

SummarySkippedReason

Uma enumeração para motivos de resumo ignorados.

Tipos enumerados
SUMMARY_SKIPPED_REASON_UNSPECIFIED Valor padrão. O motivo para o resumo ter sido ignorado não foi especificado.
ADVERSARIAL_QUERY_IGNORED

A consulta adversária ignorou o caso.

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

A consulta que não busca um resumo ignorou o caso.

O Google pula 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 o caso.

O Google pula o resumo se não houver resultados de pesquisa de alta relevância. Por exemplo, o repositório de dados contém fatos sobre a empresa A, mas a consulta do usuário faz perguntas sobre a empresa B.
POTENTIAL_POLICY_VIOLATION

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

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

O caso em que o complemento de LLM não está ativado.

O Google pula o resumo se o complemento de LLM não estiver ativado.
NO_RELEVANT_CONTENT

O caso de conteúdo irrelevante.

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

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

O Google pula o resumo se a consulta não tiver um objetivo claro. Usado somente quando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] está definido como true.
TIME_OUT

O caso de tempo limite.

O Google pula o resumo se o tempo expirar.

SafetyAttributes

Categorias de atributo de segurança e as pontuações de confiança associadas a elas.

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

string

Os nomes de exibição das categorias de atributo 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, maior valor significa maior confiança. A ordem corresponde às categorias.

SummaryWithMetadata

Resumo com informações de metadados.

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

string

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

object (CitationMetadata)

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

object (Reference)

Referências de documentos.
blobAttachments[]

object (BlobAttachment)

Apenas saída. Armazenar dados multimodais para melhorar as respostas.

CitationMetadata

Metadados da citação.

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)

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

CitationSource

Fonte da citação.

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

string (int64 format)

Índice de referência de documento de SummaryWithMetadata.references. Ele é indexado em zero, e o valor será 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údo de trechos citados derivados do conteúdo do documento.

ChunkContent

Conteúdo em partes.

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

string

Conteúdo textual do bloco.
pageIdentifier

string

Identificador da página.
blobAttachmentIndexes[]

string (int64 format)

Apenas saída. Armazena índices de blobattachments vinculados a este fragmento.

BlobAttachment

Armazena dados binários anexados à resposta de texto, por exemplo, imagem, vídeo, áudio etc.

Representação JSON 
{
  "data": {
    object (Blob)
  },
  "attributionType": enum (AttributionType)
}
Campos
data

object (Blob)

Apenas saída. Os dados do blob.
attributionType

enum (AttributionType)

Apenas saída. O tipo de atribuição do blob.

Blob

Armazena o tipo e os dados do blob.

Representação JSON 
{
  "mimeType": string,
  "data": string
}
Campos
mimeType

string

Apenas saída. O tipo de mídia (tipo MIME) dos dados gerados.
data

string (bytes format)

Apenas saída. Bytes brutos.

Uma string codificada em base64.

AttributionType

Define o tipo de atribuição do blob.

Tipos enumerados
ATTRIBUTION_TYPE_UNSPECIFIED Tipo de atribuição não especificado.
CORPUS Os dados do anexo são do corpus.
GENERATED Os dados do anexo são gerados pelo modelo usando a geração de código.

Métodos

converse

 Conversa uma conversa.

create

 Cria uma conversa.

delete

 Exclui uma conversa.

get

 Recebe uma conversa.

list

 Lista todas as conversas pelo recurso pai DataStore.

patch

 Atualiza uma conversa.