Close httplib2 connections.
create(parent, body=None, exampleId=None, x__xgafv=None)
Creates a new example in the given app.
delete(name, etag=None, x__xgafv=None)
Deletes the specified example.
Gets details of the specified example.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists examples in the given app.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the specified example.
close()
Close httplib2 connections.
create(parent, body=None, exampleId=None, x__xgafv=None)
Creates a new example in the given app.
Args:
parent: string, Required. The resource name of the app to create an example in. (required)
body: object, The request body.
The object takes the form of:
{ # An example represents a sample conversation between the user and the agent(s).
"createTime": "A String", # Output only. Timestamp when the example was created.
"description": "A String", # Optional. Human-readable description of the example.
"displayName": "A String", # Required. Display name of the example.
"entryAgent": "A String", # Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
"etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
"invalid": True or False, # Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
"messages": [ # Optional. The collection of messages that make up the conversation.
{ # A message within a conversation.
"chunks": [ # Optional. Content of the message as a series of chunks.
{ # A chunk of content within a message.
"agentTransfer": { # Represents an event indicating the transfer of a conversation to a different agent. # Optional. Agent transfer event.
"displayName": "A String", # Output only. Display name of the agent.
"targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
},
"defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names.
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
"payload": { # Optional. Custom payload data.
"a_key": "", # Properties of the object.
},
"text": "A String", # Optional. Text data.
"toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Tool execution request.
"args": { # Optional. The input parameters and values for the tool in JSON object format.
"a_key": "", # Properties of the object.
},
"displayName": "A String", # Output only. Display name of the tool.
"id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.
"tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
"toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute.
"toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
},
},
"toolResponse": { # The execution result of a specific tool from the client or the agent. # Optional. Tool execution response.
"displayName": "A String", # Output only. Display name of the tool.
"id": "A String", # Optional. The matching ID of the tool call the response is for.
"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
"a_key": "", # Properties of the object.
},
"tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
"toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed.
"toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
},
},
"transcript": "A String", # Optional. Transcript associated with the audio.
"updatedVariables": { # A struct represents variables that were updated in the conversation, keyed by variable names.
"a_key": "", # Properties of the object.
},
},
],
"eventTime": "A String", # Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.
"role": "A String", # Optional. The role within the conversation, e.g., user, agent.
},
],
"name": "A String", # Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`
"updateTime": "A String", # Output only. Timestamp when the example was last updated.
}
exampleId: string, Optional. The ID to use for the example, which will become the final component of the example's resource name. If not provided, a unique ID will be automatically assigned for the example.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An example represents a sample conversation between the user and the agent(s).
"createTime": "A String", # Output only. Timestamp when the example was created.
"description": "A String", # Optional. Human-readable description of the example.
"displayName": "A String", # Required. Display name of the example.
"entryAgent": "A String", # Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
"etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
"invalid": True or False, # Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
"messages": [ # Optional. The collection of messages that make up the conversation.
{ # A message within a conversation.
"chunks": [ # Optional. Content of the message as a series of chunks.
{ # A chunk of content within a message.
"agentTransfer": { # Represents an event indicating the transfer of a conversation to a different agent. # Optional. Agent transfer event.
"displayName": "A String", # Output only. Display name of the agent.
"targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
},
"defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names.
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
"payload": { # Optional. Custom payload data.
"a_key": "", # Properties of the object.
},
"text": "A String", # Optional. Text data.
"toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Tool execution request.
"args": { # Optional. The input parameters and values for the tool in JSON object format.
"a_key": "", # Properties of the object.
},
"displayName": "A String", # Output only. Display name of the tool.
"id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.
"tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
"toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute.
"toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
},
},
"toolResponse": { # The execution result of a specific tool from the client or the agent. # Optional. Tool execution response.
"displayName": "A String", # Output only. Display name of the tool.
"id": "A String", # Optional. The matching ID of the tool call the response is for.
"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
"a_key": "", # Properties of the object.
},
"tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
"toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed.
"toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
},
},
"transcript": "A String", # Optional. Transcript associated with the audio.
"updatedVariables": { # A struct represents variables that were updated in the conversation, keyed by variable names.
"a_key": "", # Properties of the object.
},
},
],
"eventTime": "A String", # Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.
"role": "A String", # Optional. The role within the conversation, e.g., user, agent.
},
],
"name": "A String", # Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`
"updateTime": "A String", # Output only. Timestamp when the example was last updated.
}
delete(name, etag=None, x__xgafv=None)
Deletes the specified example.
Args:
name: string, Required. The resource name of the example to delete. (required)
etag: string, Optional. The current etag of the example. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the example, deletion will be blocked and an ABORTED error will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
Gets details of the specified example.
Args:
name: string, Required. The resource name of the example to retrieve. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An example represents a sample conversation between the user and the agent(s).
"createTime": "A String", # Output only. Timestamp when the example was created.
"description": "A String", # Optional. Human-readable description of the example.
"displayName": "A String", # Required. Display name of the example.
"entryAgent": "A String", # Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
"etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
"invalid": True or False, # Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
"messages": [ # Optional. The collection of messages that make up the conversation.
{ # A message within a conversation.
"chunks": [ # Optional. Content of the message as a series of chunks.
{ # A chunk of content within a message.
"agentTransfer": { # Represents an event indicating the transfer of a conversation to a different agent. # Optional. Agent transfer event.
"displayName": "A String", # Output only. Display name of the agent.
"targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
},
"defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names.
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
"payload": { # Optional. Custom payload data.
"a_key": "", # Properties of the object.
},
"text": "A String", # Optional. Text data.
"toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Tool execution request.
"args": { # Optional. The input parameters and values for the tool in JSON object format.
"a_key": "", # Properties of the object.
},
"displayName": "A String", # Output only. Display name of the tool.
"id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.
"tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
"toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute.
"toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
},
},
"toolResponse": { # The execution result of a specific tool from the client or the agent. # Optional. Tool execution response.
"displayName": "A String", # Output only. Display name of the tool.
"id": "A String", # Optional. The matching ID of the tool call the response is for.
"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
"a_key": "", # Properties of the object.
},
"tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
"toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed.
"toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
},
},
"transcript": "A String", # Optional. Transcript associated with the audio.
"updatedVariables": { # A struct represents variables that were updated in the conversation, keyed by variable names.
"a_key": "", # Properties of the object.
},
},
],
"eventTime": "A String", # Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.
"role": "A String", # Optional. The role within the conversation, e.g., user, agent.
},
],
"name": "A String", # Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`
"updateTime": "A String", # Output only. Timestamp when the example was last updated.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists examples in the given app.
Args:
parent: string, Required. The resource name of the app to list examples from. (required)
filter: string, Optional. Filter to be applied when listing the examples. See https://google.aip.dev/160 for more details.
orderBy: string, Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, Optional. The next_page_token value returned from a previous list AgentService.ListExamples call.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for AgentService.ListExamples.
"examples": [ # The list of examples.
{ # An example represents a sample conversation between the user and the agent(s).
"createTime": "A String", # Output only. Timestamp when the example was created.
"description": "A String", # Optional. Human-readable description of the example.
"displayName": "A String", # Required. Display name of the example.
"entryAgent": "A String", # Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
"etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
"invalid": True or False, # Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
"messages": [ # Optional. The collection of messages that make up the conversation.
{ # A message within a conversation.
"chunks": [ # Optional. Content of the message as a series of chunks.
{ # A chunk of content within a message.
"agentTransfer": { # Represents an event indicating the transfer of a conversation to a different agent. # Optional. Agent transfer event.
"displayName": "A String", # Output only. Display name of the agent.
"targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
},
"defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names.
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
"payload": { # Optional. Custom payload data.
"a_key": "", # Properties of the object.
},
"text": "A String", # Optional. Text data.
"toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Tool execution request.
"args": { # Optional. The input parameters and values for the tool in JSON object format.
"a_key": "", # Properties of the object.
},
"displayName": "A String", # Output only. Display name of the tool.
"id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.
"tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
"toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute.
"toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
},
},
"toolResponse": { # The execution result of a specific tool from the client or the agent. # Optional. Tool execution response.
"displayName": "A String", # Output only. Display name of the tool.
"id": "A String", # Optional. The matching ID of the tool call the response is for.
"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
"a_key": "", # Properties of the object.
},
"tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
"toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed.
"toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
},
},
"transcript": "A String", # Optional. Transcript associated with the audio.
"updatedVariables": { # A struct represents variables that were updated in the conversation, keyed by variable names.
"a_key": "", # Properties of the object.
},
},
],
"eventTime": "A String", # Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.
"role": "A String", # Optional. The role within the conversation, e.g., user, agent.
},
],
"name": "A String", # Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`
"updateTime": "A String", # Output only. Timestamp when the example was last updated.
},
],
"nextPageToken": "A String", # A token that can be sent as ListExamplesRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the specified example.
Args:
name: string, Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}` (required)
body: object, The request body.
The object takes the form of:
{ # An example represents a sample conversation between the user and the agent(s).
"createTime": "A String", # Output only. Timestamp when the example was created.
"description": "A String", # Optional. Human-readable description of the example.
"displayName": "A String", # Required. Display name of the example.
"entryAgent": "A String", # Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
"etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
"invalid": True or False, # Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
"messages": [ # Optional. The collection of messages that make up the conversation.
{ # A message within a conversation.
"chunks": [ # Optional. Content of the message as a series of chunks.
{ # A chunk of content within a message.
"agentTransfer": { # Represents an event indicating the transfer of a conversation to a different agent. # Optional. Agent transfer event.
"displayName": "A String", # Output only. Display name of the agent.
"targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
},
"defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names.
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
"payload": { # Optional. Custom payload data.
"a_key": "", # Properties of the object.
},
"text": "A String", # Optional. Text data.
"toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Tool execution request.
"args": { # Optional. The input parameters and values for the tool in JSON object format.
"a_key": "", # Properties of the object.
},
"displayName": "A String", # Output only. Display name of the tool.
"id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.
"tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
"toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute.
"toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
},
},
"toolResponse": { # The execution result of a specific tool from the client or the agent. # Optional. Tool execution response.
"displayName": "A String", # Output only. Display name of the tool.
"id": "A String", # Optional. The matching ID of the tool call the response is for.
"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
"a_key": "", # Properties of the object.
},
"tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
"toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed.
"toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
},
},
"transcript": "A String", # Optional. Transcript associated with the audio.
"updatedVariables": { # A struct represents variables that were updated in the conversation, keyed by variable names.
"a_key": "", # Properties of the object.
},
},
],
"eventTime": "A String", # Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.
"role": "A String", # Optional. The role within the conversation, e.g., user, agent.
},
],
"name": "A String", # Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`
"updateTime": "A String", # Output only. Timestamp when the example was last updated.
}
updateMask: string, Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An example represents a sample conversation between the user and the agent(s).
"createTime": "A String", # Output only. Timestamp when the example was created.
"description": "A String", # Optional. Human-readable description of the example.
"displayName": "A String", # Required. Display name of the example.
"entryAgent": "A String", # Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
"etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
"invalid": True or False, # Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
"messages": [ # Optional. The collection of messages that make up the conversation.
{ # A message within a conversation.
"chunks": [ # Optional. Content of the message as a series of chunks.
{ # A chunk of content within a message.
"agentTransfer": { # Represents an event indicating the transfer of a conversation to a different agent. # Optional. Agent transfer event.
"displayName": "A String", # Output only. Display name of the agent.
"targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
},
"defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names.
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
"payload": { # Optional. Custom payload data.
"a_key": "", # Properties of the object.
},
"text": "A String", # Optional. Text data.
"toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Tool execution request.
"args": { # Optional. The input parameters and values for the tool in JSON object format.
"a_key": "", # Properties of the object.
},
"displayName": "A String", # Output only. Display name of the tool.
"id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.
"tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
"toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute.
"toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
},
},
"toolResponse": { # The execution result of a specific tool from the client or the agent. # Optional. Tool execution response.
"displayName": "A String", # Output only. Display name of the tool.
"id": "A String", # Optional. The matching ID of the tool call the response is for.
"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
"a_key": "", # Properties of the object.
},
"tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
"toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed.
"toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
},
},
"transcript": "A String", # Optional. Transcript associated with the audio.
"updatedVariables": { # A struct represents variables that were updated in the conversation, keyed by variable names.
"a_key": "", # Properties of the object.
},
},
],
"eventTime": "A String", # Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.
"role": "A String", # Optional. The role within the conversation, e.g., user, agent.
},
],
"name": "A String", # Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`
"updateTime": "A String", # Output only. Timestamp when the example was last updated.
}