Uma mensagem em uma conversa.
| Representação JSON |
|---|
{
"role": string,
"chunks": [
{
object ( |
| Campos | |
|---|---|
role |
Opcional. A função na conversa, por exemplo, usuário, agente. |
chunks[] |
Opcional. Conteúdo da mensagem como uma série de partes. |
eventTime |
Opcional. Carimbo de data/hora em que a mensagem foi enviada ou recebida. Não pode ser usado se a mensagem fizer parte de um 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: |
Chunk
Um trecho de conteúdo em uma mensagem.
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união data. Divida os dados em blocos. data pode ser apenas de um dos tipos a seguir: |
|
text |
Opcional. Dados de texto. |
transcript |
Opcional. Transcrição associada ao áudio. |
blob |
Opcional. Dados de blob. |
payload |
Opcional. Dados de payload personalizados. |
image |
Opcional. Dados da imagem. |
toolCall |
Opcional. Solicitação de execução de ferramenta. |
toolResponse |
Opcional. Resposta de execução da ferramenta. |
agentTransfer |
Opcional. Evento de transferência do agente. |
updatedVariables |
Uma struct representa variáveis que foram atualizadas na conversa, com chaves pelos nomes das variáveis. |
defaultVariables |
Uma struct representa variáveis padrão no início da conversa, com chaves de nomes de variáveis. |
Blob
Representa uma entrada ou saída de blob na conversa.
| Representação JSON |
|---|
{ "mimeType": string, "data": string } |
| Campos | |
|---|---|
mimeType |
Obrigatório. O tipo MIME padrão da IANA dos dados de origem. |
data |
Obrigatório. Bytes brutos do blob. Uma string codificada em base64. |
Imagem
Representa uma entrada ou saída de imagem na conversa.
| Representação JSON |
|---|
{ "mimeType": string, "data": string } |
| Campos | |
|---|---|
mimeType |
Obrigatório. O tipo MIME padrão da IANA dos dados de origem. Os tipos de imagem compatíveis incluem: * image/png * image/jpeg * image/webp |
data |
Obrigatório. Bytes brutos da imagem. Uma string codificada em base64. |
ToolCall
Solicitação para o cliente ou o agente executar a ferramenta especificada.
| Representação JSON |
|---|
{ "id": string, "displayName": string, "args": { object }, "parentToolCallId": string, "agentName": string, // Union field |
| Campos | |
|---|---|
id |
Opcional. O identificador exclusivo da chamada de função. Se preenchido, o cliente vai retornar o resultado da execução com o código correspondente em |
displayName |
Apenas saída. Nome de exibição da ferramenta. |
args |
Opcional. Os parâmetros e valores de entrada da ferramenta no formato de objeto JSON. |
parentToolCallId |
Apenas saída. O ID da chamada de função que causou esta, quando ela foi emitida por um subagente trabalhando em nome de uma chamada principal. Vazio para chamadas de nível superior. Permite que um cliente agrupe o trabalho de um subagente na chamada que o iniciou, em vez de renderizar cada etapa como um irmão. |
agentName |
Apenas saída. Nome legível por humanos do agente que emitiu essa chamada, por exemplo, "Arquiteto de contratos". Fica vazio quando o agente raiz emite o token. |
Campo de união tool_identifier. O identificador da ferramenta a ser executada. Ela pode ser uma ferramenta persistente ou de um conjunto de ferramentas. tool_identifier pode ser apenas de um dos tipos a seguir: |
|
tool |
Opcional. O nome da ferramenta a ser executada. Formato: |
toolsetTool |
Opcional. A ferramenta do conjunto de ferramentas a ser executada. |
ToolsetTool
Uma ferramenta criada com um conjunto de ferramentas.
| Representação JSON |
|---|
{ "toolset": string, "toolId": string } |
| Campos | |
|---|---|
toolset |
Obrigatório. O nome do recurso do Toolset de que essa ferramenta deriva. Formato: |
toolId |
Opcional. O ID da ferramenta para filtrar as ferramentas e recuperar o esquema. |
ToolResponse
O resultado da execução de uma ferramenta específica do cliente ou do agente.
| Representação JSON |
|---|
{ "id": string, "displayName": string, "response": { object }, "parentToolCallId": string, "agentName": string, // Union field |
| Campos | |
|---|---|
id |
Opcional. O código correspondente do |
displayName |
Apenas saída. Nome de exibição da ferramenta. |
response |
Obrigatório. O resultado da execução da ferramenta no formato de objeto JSON. Use a chave "output" para especificar a resposta da ferramenta e a chave "error" para especificar os detalhes do erro (se houver). Se as chaves "output" e "error" não forem especificadas, toda a "response" será tratada como resultado da execução da ferramenta. |
parentToolCallId |
Apenas saída. O ID da chamada de função que causou esta, quando ela foi emitida por um subagente trabalhando em nome de uma chamada principal. Vazio para chamadas de nível superior. Permite que um cliente agrupe o trabalho de um subagente na chamada que o iniciou, em vez de renderizar cada etapa como um irmão. |
agentName |
Apenas saída. Nome legível por humanos do agente que emitiu essa chamada, por exemplo, "Arquiteto de contratos". Fica vazio quando o agente raiz emite o token. |
Campo de união tool_identifier. O identificador da ferramenta que foi executada. Ela pode ser uma ferramenta persistente ou de um conjunto de ferramentas. tool_identifier pode ser apenas de um dos tipos a seguir: |
|
tool |
Opcional. O nome da ferramenta a ser executada. Formato: |
toolsetTool |
Opcional. A ferramenta do conjunto de ferramentas que foi executada. |
AgentTransfer
Representa um evento que indica a transferência de uma conversa para outro agente.
| Representação JSON |
|---|
{ "targetAgent": string, "displayName": string } |
| Campos | |
|---|---|
targetAgent |
Obrigatório. O agente para quem a conversa está sendo transferida. O agente vai cuidar da conversa a partir desse ponto. Formato: |
displayName |
Apenas saída. Nome de exibição do agente. |