MCP Tools Reference: ces.googleapis.com

Ferramenta: get_conversation

Recebe detalhes da conversa especificada.

O exemplo a seguir demonstra como usar curl para invocar a ferramenta get_conversation MCP.

Solicitação curl
                  
curl --location 'https://ces.[REGION].rep.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "get_conversation",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'
                

Esquema de entrada

Mensagem de solicitação para AgentService.GetConversation.

GetConversationRequest

Representação JSON
{
  "name": string,
  "source": enum (Source)
}
Campos
name

string

Obrigatório. O nome do recurso da conversa a ser recuperada.

source
(deprecated)

enum (Source)

Opcional. Indique a origem da conversa. Se não for definido, todas as fontes serão pesquisadas.

Esquema de saída

Uma conversa representa uma interação entre um usuário final e o app CES.

Conversa

Representação JSON
{
  "name": string,
  "startTime": string,
  "endTime": string,
  "turns": [
    {
      object (Turn)
    }
  ],
  "turnCount": integer,
  "channelType": enum (ChannelType),
  "source": enum (Source),
  "inputTypes": [
    enum (InputType)
  ],
  "entryAgent": string,
  "deployment": string,
  "appVersion": string,
  "languageCode": string,
  "messages": [
    {
      object (Message)
    }
  ]
}
Campos
name

string

Identificador. O identificador exclusivo da conversa. Formato: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}

startTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora em que a conversa foi criada.

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. Carimbo de data/hora em que a conversa foi concluída.

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

turns[]

object (Turn)

Obrigatório. As rodadas da conversa.

turnCount

integer

Apenas saída. O número de turnos na conversa.

channelType
(deprecated)

enum (ChannelType)

OBSOLETO. Use input_types.

source

enum (Source)

Apenas saída. Indique a origem da conversa.

inputTypes[]

enum (InputType)

Apenas saída. Os tipos de entrada da conversa.

entryAgent

string

Apenas saída. O agente que inicialmente lida com a conversa. Se não for especificado, a conversa será processada pelo agente raiz. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

deployment

string

Apenas saída. A implantação do app usado para processar a conversa. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

appVersion

string

Apenas saída. A versão do app usada para processar a conversa. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}

languageCode

string

Apenas saída. O código do idioma da conversa.

messages[]
(deprecated)

object (Message)

Obsoleto. Use turnos.

Carimbo de data/hora

Representação JSON
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Representa os segundos do horário UTC desde a época Unix 1970-01-01T00:00:00Z. Precisa estar entre -62135596800 e 253402300799 (o que corresponde a 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z).

nanos

integer

Frações não negativas de um segundo com resolução de nanossegundos. Esse campo é a parte de nanossegundos da duração, não uma alternativa aos segundos. Os valores de segundos negativos com frações ainda precisam ter valores em nanossegundos não negativos que representam períodos posteriores. O valor precisa ser de 0 a 999.999.999 (inclusive).

Turn

Representação JSON
{
  "messages": [
    {
      object (Message)
    }
  ],
  "rootSpan": {
    object (Span)
  }
}
Campos
messages[]

object (Message)

Opcional. Lista de mensagens no turno da conversa, incluindo entrada do usuário, respostas do agente e eventos intermediários durante o processamento.

rootSpan

object (Span)

Opcional. O intervalo principal do processamento da ação.

Mensagem

Representação JSON
{
  "role": string,
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "eventTime": string
}
Campos
role

string

Opcional. A função na conversa, por exemplo, usuário, agente.

chunks[]

object (Chunk)

Opcional. Conteúdo da mensagem como uma série de partes.

eventTime

string (Timestamp format)

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

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

Chunk

Representação JSON
{

  // Union field data can be only one of the following:
  "text": string,
  "transcript": string,
  "blob": {
    object (Blob)
  },
  "payload": {
    object
  },
  "image": {
    object (Image)
  },
  "toolCall": {
    object (ToolCall)
  },
  "toolResponse": {
    object (ToolResponse)
  },
  "agentTransfer": {
    object (AgentTransfer)
  },
  "updatedVariables": {
    object
  },
  "defaultVariables": {
    object
  }
  // End of list of possible types for union field data.
}
Campos
Campo de união data. Dados de bloco. data pode ser apenas de um dos tipos a seguir:
text

string

Opcional. Dados de texto.

transcript

string

Opcional. Transcrição associada ao áudio.

blob

object (Blob)

Opcional. Dados de blob.

payload

object (Struct format)

Opcional. Dados de payload personalizados.

image

object (Image)

Opcional. Dados da imagem.

toolCall

object (ToolCall)

Opcional. Solicitação de execução de ferramenta.

toolResponse

object (ToolResponse)

Opcional. Resposta de execução da ferramenta.

agentTransfer

object (AgentTransfer)

Opcional. Evento de transferência de agente.

updatedVariables

object (Struct format)

Uma struct representa variáveis que foram atualizadas na conversa, com chaves pelos nomes das variáveis.

defaultVariables

object (Struct format)

Uma struct representa variáveis padrão no início da conversa, com chaves de nomes de variáveis.

Blob

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

string

Obrigatório. O tipo MIME padrão da IANA dos dados de origem.

data

string (bytes format)

Obrigatório. Bytes brutos do blob.

Uma string codificada em base64.

Struct

Representação JSON
{
  "fields": {
    string: value,
    ...
  }
}
Campos
fields

map (key: string, value: value (Value format))

Mapa não ordenado de valores com tipagem dinâmica.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

Representação JSON
{
  "key": string,
  "value": value
}
Campos
key

string

value

value (Value format)

Valor

Representação JSON
{

  // Union field kind can be only one of the following:
  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
  // End of list of possible types for union field kind.
}
Campos
Campo de união kind. O tipo de valor. kind pode ser apenas de um dos tipos a seguir:
nullValue

null

Representa um valor nulo.

numberValue

number

Representa um valor double.

stringValue

string

Representa um valor de string.

boolValue

boolean

Representa um valor booleano.

structValue

object (Struct format)

Representa um valor estruturado.

listValue

array (ListValue format)

Representa um Value repetido.

ListValue

Representação JSON
{
  "values": [
    value
  ]
}
Campos
values[]

value (Value format)

Campo repetido de valores digitados dinamicamente.

Image

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

string

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

string (bytes format)

Obrigatório. Bytes brutos da imagem.

Uma string codificada em base64.

ToolCall

Representação JSON
{
  "id": string,
  "displayName": string,
  "args": {
    object
  },

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
Campos
id

string

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

displayName

string

Apenas saída. Nome de exibição da ferramenta.

args

object (Struct format)

Opcional. Os parâmetros e valores de entrada da ferramenta no formato de objeto JSON.

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

string

Opcional. O nome da ferramenta a ser executada. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

toolsetTool

object (ToolsetTool)

Opcional. A ferramenta do conjunto de ferramentas a ser executada.

ToolsetTool

Representação JSON
{
  "toolset": string,
  "toolId": string
}
Campos
toolset

string

Obrigatório. O nome do recurso do conjunto de ferramentas de que essa ferramenta deriva. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

toolId

string

Opcional. O ID da ferramenta para filtrar as ferramentas e recuperar o esquema.

ToolResponse

Representação JSON
{
  "id": string,
  "displayName": string,
  "response": {
    object
  },

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
Campos
id

string

Opcional. O código correspondente do tool call a que a resposta se refere.

displayName

string

Apenas saída. Nome de exibição da ferramenta.

response

object (Struct format)

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.

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

string

Opcional. O nome da ferramenta a ser executada. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

toolsetTool

object (ToolsetTool)

Opcional. A ferramenta do conjunto de ferramentas que foi executada.

AgentTransfer

Representação JSON
{
  "targetAgent": string,
  "displayName": string
}
Campos
targetAgent

string

Obrigatório. O agente para quem a conversa está sendo transferida. O agente vai cuidar da conversa a partir desse ponto. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

displayName

string

Apenas saída. Nome de exibição do agente.

Período

Representação JSON
{
  "name": string,
  "startTime": string,
  "endTime": string,
  "duration": string,
  "attributes": {
    object
  },
  "childSpans": [
    {
      object (Span)
    }
  ]
}
Campos
name

string

Apenas saída. O nome do intervalo.

startTime

string (Timestamp format)

Apenas saída. O horário de início do intervalo.

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 de término do período.

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

duration

string (Duration format)

Apenas saída. A duração do período.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

attributes

object (Struct format)

Apenas saída. Atributos de chave-valor associados ao intervalo.

childSpans[]

object (Span)

Apenas saída. Os intervalos filhos aninhados neste intervalo.

Duração

Representação JSON
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Segundos assinados do período. Precisa estar entre -315.576.000.000 e +315.576.000.000 (inclusive). Observação: esses limites são calculados da seguinte forma: 60 s/min * 60 min/h * 24 h/dia * 365,25 dias/ano * 10.000 anos

nanos

integer

Frações assinadas de um segundo com resolução de nanossegundos do período. Durações menores que um segundo são representadas com um campo seconds 0 e um campo nanos positivo ou negativo. Para durações de um segundo ou mais, um valor diferente de zero para o campo nanos precisa ter o mesmo sinal do campo seconds. Precisa estar entre -999.999.999 e +999.999.999 (inclusive).

Anotações de ferramentas

Dica destrutiva: ❌ | Dica idempotente: ✅ | Dica somente leitura: ✅ | Dica de mundo aberto: ❌