Uma mensagem em uma conversa.
| Representação JSON |
|---|
{
"role": string,
"chunks": [
{
object ( |
| Campos | |
|---|---|
role |
Opcional. O papel na conversa, por exemplo, usuário, agente. |
chunks[] |
Opcional. Conteúdo da mensagem como uma série de blocos. |
eventTime |
Opcional. Carimbo de data/hora de quando a mensagem foi enviada ou recebida. Não deve 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: |
Pedaço
Um trecho de conteúdo em uma mensagem.
| Representação JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "text": string, "transcript": string, "blob": { object ( |
| Campos | |
|---|---|
| Dividir dados em blocos. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
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 da execução da ferramenta. |
agentTransfer |
Opcional. Evento de transferência do agente. |
updatedVariables |
Uma estrutura representa as variáveis que foram atualizadas na conversa, identificadas pelos nomes das variáveis. |
defaultVariables |
Uma struct representa variáveis padrão no início da conversa, identificadas por nomes de variáveis. |
| Fim dos campos mutuamente exclusivos. | |
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, "altText": 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. |
altText |
Opcional. O texto alternativo da imagem. |
ToolCall
Solicitação para que o cliente ou o agente execute a ferramenta especificada.
| Representação JSON |
|---|
{
"id": string,
"displayName": string,
"args": {
object
},
"parentToolCallId": string,
"agentName": string,
"targetApp": string,
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"tool": string,
"toolsetTool": {
object ( |
| Campos | |
|---|---|
id |
Opcional. O identificador exclusivo da chamada de ferramenta. 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 de entrada e os valores da ferramenta no formato de objeto JSON. |
parentToolCallId |
Apenas saída. O ID da chamada de ferramenta que causou esta, quando foi emitida por um subagente trabalhando em nome de uma chamada pai. 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". Vazio quando o agente raiz o emitiu. |
targetApp |
Apenas saída. O app que essa chamada segmenta, derivado pelo assistente dos argumentos de recurso da chamada: um nome de recurso de app, |
| O identificador da ferramenta a ser executada. Pode ser uma ferramenta persistente ou de um conjunto de ferramentas. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
tool |
Opcional. O nome da ferramenta a ser executada. Formato: |
toolsetTool |
Opcional. A ferramenta do conjunto de ferramentas a ser executada. |
| Fim dos campos mutuamente exclusivos. | |
ToolsetTool
Uma ferramenta criada com base em um conjunto de ferramentas.
| Representação JSON |
|---|
{ "toolset": string, "toolId": string } |
| Campos | |
|---|---|
toolset |
Obrigatório. O nome do recurso do conjunto de ferramentas de onde essa ferramenta é derivada. 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,
"targetApp": string,
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"tool": string,
"toolsetTool": {
object ( |
| 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 ferramenta que causou esta, quando foi emitida por um subagente trabalhando em nome de uma chamada pai. 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". Vazio quando o agente raiz o emitiu. |
targetApp |
Apenas saída. O app que a ferramenta executada segmentou; espelha |
| O identificador da ferramenta que foi executada. Pode ser uma ferramenta persistente ou de um conjunto de ferramentas. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
tool |
Opcional. O nome da ferramenta a ser executada. Formato: |
toolsetTool |
Opcional. A ferramenta do conjunto que foi executada. |
| Fim dos campos mutuamente exclusivos. | |
AgentTransfer
Representa um evento que indica a transferência de uma conversa para um agente diferente.
| Representação JSON |
|---|
{ "targetAgent": string, "displayName": string } |
| Campos | |
|---|---|
targetAgent |
Obrigatório. O agente para quem a conversa está sendo transferida. O agente vai assumir a conversa a partir desse momento. Formato: |
displayName |
Apenas saída. Nome de exibição do agente. |