| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="ces_v1.html">Gemini Enterprise for Customer Experience API</a> . <a href="ces_v1.projects.html">projects</a> . <a href="ces_v1.projects.locations.html">locations</a> . <a href="ces_v1.projects.locations.apps.html">apps</a> . <a href="ces_v1.projects.locations.apps.conversations.html">conversations</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#batchDelete">batchDelete(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Batch deletes the specified conversations.</p> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, source=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes the specified conversation.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, source=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets details of the specified conversation.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, source=None, sources=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists conversations in the given app.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code> |
| <pre>Batch deletes the specified conversations. |
| |
| Args: |
| parent: string, Required. The resource name of the app to delete conversations from. Format: `projects/{project}/locations/{location}/apps/{app}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for AgentService.BatchDeleteConversations. |
| "conversations": [ # Required. The resource names of the conversations to delete. |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, source=None, x__xgafv=None)</code> |
| <pre>Deletes the specified conversation. |
| |
| Args: |
| name: string, Required. The resource name of the conversation to delete. (required) |
| source: string, Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. |
| Allowed values |
| SOURCE_UNSPECIFIED - Unspecified source. |
| LIVE - The conversation is from the live end user. |
| SIMULATOR - The conversation is from the simulator. |
| EVAL - The conversation is from the evaluation. |
| 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); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, source=None, x__xgafv=None)</code> |
| <pre>Gets details of the specified conversation. |
| |
| Args: |
| name: string, Required. The resource name of the conversation to retrieve. (required) |
| source: string, Optional. Indicate the source of the conversation. If not set, all source will be searched. |
| Allowed values |
| SOURCE_UNSPECIFIED - Unspecified source. |
| LIVE - The conversation is from the live end user. |
| SIMULATOR - The conversation is from the simulator. |
| EVAL - The conversation is from the evaluation. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A conversation represents an interaction between an end user and the CES app. |
| "appVersion": "A String", # Output only. The version of the app used for processing the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` |
| "channelType": "A String", # DEPRECATED. Please use input_types instead. |
| "deployment": "A String", # Output only. The deployment of the app used for processing the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` |
| "endTime": "A String", # Output only. Timestamp when the conversation was completed. |
| "entryAgent": "A String", # Output only. The agent that initially handles the conversation. If not specified, the conversation is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| "inputTypes": [ # Output only. The input types of the conversation. |
| "A String", |
| ], |
| "languageCode": "A String", # Output only. The language code of the conversation. |
| "messages": [ # Deprecated. Use turns instead. |
| { # 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}` |
| }, |
| "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. |
| "data": "A String", # Required. Raw bytes of the blob. |
| "mimeType": "A String", # Required. The IANA standard MIME type of the source data. |
| }, |
| "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 conversation. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}` |
| "source": "A String", # Output only. Indicate the source of the conversation. |
| "startTime": "A String", # Output only. Timestamp when the conversation was created. |
| "turnCount": 42, # Output only. The number of turns in the conversation. |
| "turns": [ # Required. The turns in the conversation. |
| { # All information about a single turn in the conversation. |
| "messages": [ # Optional. List of messages in the conversation turn, including user input, agent responses and intermediate events during the processing. |
| { # 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}` |
| }, |
| "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. |
| "data": "A String", # Required. Raw bytes of the blob. |
| "mimeType": "A String", # Required. The IANA standard MIME type of the source data. |
| }, |
| "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. |
| }, |
| ], |
| "rootSpan": { # A span is a unit of work or a single operation during the request processing. # Optional. The root span of the action processing. |
| "attributes": { # Output only. Key-value attributes associated with the span. |
| "a_key": "", # Properties of the object. |
| }, |
| "childSpans": [ # Output only. The child spans that are nested under this span. |
| # Object with schema name: Span |
| ], |
| "duration": "A String", # Output only. The duration of the span. |
| "endTime": "A String", # Output only. The end time of the span. |
| "name": "A String", # Output only. The name of the span. |
| "startTime": "A String", # Output only. The start time of the span. |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, source=None, sources=None, x__xgafv=None)</code> |
| <pre>Lists conversations in the given app. |
| |
| Args: |
| parent: string, Required. The resource name of the app to list conversations from. (required) |
| filter: string, Optional. Filter to be applied when listing the conversations. See https://google.aip.dev/160 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.ListConversations call. |
| source: string, Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. Will be deprecated in favor of `sources` field. |
| Allowed values |
| SOURCE_UNSPECIFIED - Unspecified source. |
| LIVE - The conversation is from the live end user. |
| SIMULATOR - The conversation is from the simulator. |
| EVAL - The conversation is from the evaluation. |
| sources: string, Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default. (repeated) |
| Allowed values |
| SOURCE_UNSPECIFIED - Unspecified source. |
| LIVE - The conversation is from the live end user. |
| SIMULATOR - The conversation is from the simulator. |
| EVAL - The conversation is from the evaluation. |
| 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.ListConversations. |
| "conversations": [ # The list of conversations. |
| { # A conversation represents an interaction between an end user and the CES app. |
| "appVersion": "A String", # Output only. The version of the app used for processing the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` |
| "channelType": "A String", # DEPRECATED. Please use input_types instead. |
| "deployment": "A String", # Output only. The deployment of the app used for processing the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` |
| "endTime": "A String", # Output only. Timestamp when the conversation was completed. |
| "entryAgent": "A String", # Output only. The agent that initially handles the conversation. If not specified, the conversation is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| "inputTypes": [ # Output only. The input types of the conversation. |
| "A String", |
| ], |
| "languageCode": "A String", # Output only. The language code of the conversation. |
| "messages": [ # Deprecated. Use turns instead. |
| { # 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}` |
| }, |
| "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. |
| "data": "A String", # Required. Raw bytes of the blob. |
| "mimeType": "A String", # Required. The IANA standard MIME type of the source data. |
| }, |
| "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 conversation. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}` |
| "source": "A String", # Output only. Indicate the source of the conversation. |
| "startTime": "A String", # Output only. Timestamp when the conversation was created. |
| "turnCount": 42, # Output only. The number of turns in the conversation. |
| "turns": [ # Required. The turns in the conversation. |
| { # All information about a single turn in the conversation. |
| "messages": [ # Optional. List of messages in the conversation turn, including user input, agent responses and intermediate events during the processing. |
| { # 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}` |
| }, |
| "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. |
| "data": "A String", # Required. Raw bytes of the blob. |
| "mimeType": "A String", # Required. The IANA standard MIME type of the source data. |
| }, |
| "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. |
| }, |
| ], |
| "rootSpan": { # A span is a unit of work or a single operation during the request processing. # Optional. The root span of the action processing. |
| "attributes": { # Output only. Key-value attributes associated with the span. |
| "a_key": "", # Properties of the object. |
| }, |
| "childSpans": [ # Output only. The child spans that are nested under this span. |
| # Object with schema name: Span |
| ], |
| "duration": "A String", # Output only. The duration of the span. |
| "endTime": "A String", # Output only. The end time of the span. |
| "name": "A String", # Output only. The name of the span. |
| "startTime": "A String", # Output only. The start time of the span. |
| }, |
| }, |
| ], |
| }, |
| ], |
| "nextPageToken": "A String", # A token that can be sent as ListConversationsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| </body></html> |
