| <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="dialogflow_v3beta1.html">Dialogflow API</a> . <a href="dialogflow_v3beta1.projects.html">projects</a> . <a href="dialogflow_v3beta1.projects.locations.html">locations</a> . <a href="dialogflow_v3beta1.projects.locations.agents.html">agents</a> . <a href="dialogflow_v3beta1.projects.locations.agents.playbooks.html">playbooks</a> . <a href="dialogflow_v3beta1.projects.locations.agents.playbooks.examples.html">examples</a></h1> |
| <h2>Instance Methods</h2> |
| <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="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates an example in the specified playbook.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes the specified example.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves the specified example.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns a list of examples in the specified playbook.</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> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Update the specified example.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| <pre>Creates an example in the specified playbook. |
| |
| Args: |
| parent: string, Required. The playbook to create an example for. Format: `projects//locations//agents//playbooks/`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task. |
| "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent. |
| { # Action performed by end user or Dialogflow agent in the conversation. |
| "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message. |
| "requireGeneration": True or False, # Optional. True if the agent utterance needs to be generated by the LLM. Only used in webhook response to differentiate from empty text. Revisit whether we need this field or mark `text` as optional when we expose webhook interface to customer. |
| "text": "A String", # Required. Message content in text. |
| }, |
| "completeTime": "A String", # Output only. Timestamp of the completion of the agent action. |
| "displayName": "A String", # Output only. The display name of the action. |
| "event": { # Event represents the event sent by the customer. # Optional. The agent received an event from the customer or a system event is emitted. |
| "event": "A String", # Required. Name of the event. |
| "text": "A String", # Optional. Unstructured text payload of the event. |
| }, |
| "flowInvocation": { # Stores metadata of the invocation of a child CX flow. Flow invocation actions enter the child flow. # Optional. Action performed on behalf of the agent by invoking a CX flow. |
| "displayName": "A String", # Output only. The display name of the flow. |
| "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. |
| "flowState": "A String", # Required. Flow invocation's output state. |
| "inputActionParameters": { # Optional. A list of input parameters for the flow. |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowStateUpdate": { # Stores metadata of the state update action, such as a state machine execution in flows. # Optional. Output only. The state machine update in flows. |
| "destination": "A String", # The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`. |
| "eventType": "A String", # The type of the event that triggered the state update. |
| "functionCall": { # Stores the metadata of a function call to execute. # The function call to execute. |
| "name": "A String", # The name of the function call. |
| }, |
| "pageState": { # Stores the state of a page and its flow. # The updated page and flow state. |
| "displayName": "A String", # The display name of the page. |
| "page": "A String", # The ID of the page. Format: `projects//locations//agents//flows//pages/`. |
| "status": "A String", # The status of the page. |
| }, |
| "updatedParameters": { # The updated parameters. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowTransition": { # Stores metadata of the transition to a target CX flow. Flow transition actions exit the caller playbook and enter the child flow. # Optional. Action performed on behalf of the agent by transitioning to a target CX flow. |
| "displayName": "A String", # Output only. The display name of the flow. |
| "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. |
| "inputActionParameters": { # A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "intentMatch": { # Stores metadata of the intent match action. # Optional. Output only. Intent Match in flows. |
| "matchedIntents": [ # The matched intent. |
| { # Stores the matched intent, which is the result of the intent match action. |
| "displayName": "A String", # The display name of the matched intent. |
| "generativeFallback": { # The generative fallback response of the matched intent. |
| "a_key": "", # Properties of the object. |
| }, |
| "intentId": "A String", # The ID of the matched intent. |
| "score": 3.14, # The score of the matched intent. |
| }, |
| ], |
| }, |
| "llmCall": { # Stores metadata of the call of an LLM. # Optional. Output only. LLM call performed by the agent. |
| "model": "A String", # The model of the LLM call. |
| "retrievedExamples": [ # A list of relevant examples used for the LLM prompt. |
| { # Relevant example used for the LLM prompt. |
| "exampleDisplayName": "A String", # The display name of the example. |
| "exampleId": "A String", # The id of the example. |
| "matchedRetrievalLabel": "A String", # Optional. The matched retrieval label of this LLM call. |
| "retrievalStrategy": "A String", # Retrieval strategy of the example. |
| }, |
| ], |
| "temperature": 3.14, # The temperature of the LLM call. |
| "tokenCount": { # Stores token counts of the LLM call. # The token counts of the LLM call. |
| "conversationContextTokenCount": "A String", # The number of tokens used for the conversation history in the prompt. |
| "exampleTokenCount": "A String", # The number of tokens used for the retrieved examples in the prompt. |
| "totalInputTokenCount": "A String", # The total number of tokens used for the input to the LLM call. |
| "totalOutputTokenCount": "A String", # The total number of tokens used for the output of the LLM call. |
| }, |
| }, |
| "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Playbook invocation actions enter the child playbook. # Optional. Action performed on behalf of the agent by invoking a child playbook. |
| "displayName": "A String", # Output only. The display name of the playbook. |
| "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. |
| "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation. |
| "actionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. |
| }, |
| "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation. |
| "actionParameters": { # Optional. A Struct object of output parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. |
| "state": "A String", # End state of the playbook. |
| }, |
| "playbookState": "A String", # Required. Playbook invocation's output state. |
| }, |
| "playbookTransition": { # Stores metadata of the transition to another target playbook. Playbook transition actions exit the caller playbook and enter the target playbook. # Optional. Action performed on behalf of the agent by transitioning to a target playbook. |
| "displayName": "A String", # Output only. The display name of the playbook. |
| "inputActionParameters": { # A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. |
| }, |
| "startTime": "A String", # Output only. Timestamp of the start of the agent action. |
| "status": { # The status of the action. # Optional. Output only. The status of the action. |
| "exception": { # Exception thrown during the execution of an action. # Optional. The exception thrown during the execution of the action. |
| "errorMessage": "A String", # Optional. The error message. |
| }, |
| }, |
| "stt": { # Stores metadata of the Speech-to-Text action. # Optional. Speech-to-text action performed by the agent. |
| }, |
| "subExecutionSteps": [ # Optional. The detailed tracing information for sub execution steps of the action. |
| { # A span represents a sub execution step of an action. |
| "completeTime": "A String", # Timestamp of the completion of the span. |
| "metrics": [ # The unordered collection of metrics in this span. |
| { # A named metric is a metric with name, value and unit. |
| "name": "A String", # The name of the metric. |
| "unit": "A String", # The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard. |
| "value": "", # The value of the metric. |
| }, |
| ], |
| "name": "A String", # The name of the span. |
| "startTime": "A String", # Timestamp of the start of the span. |
| "tags": [ # The metadata tags of the span such as span type. |
| "A String", |
| ], |
| }, |
| ], |
| "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool. |
| "action": "A String", # Optional. Name of the action to be called during the tool use. |
| "dataStoreToolTrace": { # The tracing information for the data store tool. # Optional. Data store tool trace. |
| "dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. |
| "answer": "A String", # Optional. The final compiled answer. |
| "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. |
| "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. |
| "modelOutput": "A String", # Output of the generative model. |
| "renderedPrompt": "A String", # Prompt as sent to the model. |
| }, |
| "answerParts": [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). |
| { # Answer part with citation. |
| "supportingIndices": [ # Citations for this answer part. Indices of `search_snippets`. |
| 42, |
| ], |
| "text": "A String", # Substring of the answer. |
| }, |
| ], |
| "citedSnippets": [ # Optional. Snippets cited by the answer generation model from the most to least relevant. |
| { # Snippet cited by the answer generation model. |
| "searchSnippet": { # Search snippet details. # Details of the snippet. |
| "documentTitle": "A String", # Title of the enclosing document. |
| "documentUri": "A String", # Uri for the document. Present if specified for the document. |
| "metadata": { # Metadata associated with the document. |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", # Text included in the prompt. |
| }, |
| "snippetIndex": 42, # Index of the snippet in `search_snippets` field. |
| }, |
| ], |
| "groundingSignals": { # Grounding signals. # Optional. Grounding signals. |
| "decision": "A String", # Represents the decision of the grounding check. |
| "score": "A String", # Grounding score bucket setting. |
| }, |
| "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. |
| "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. |
| "modelOutput": "A String", # Output of the generative model. |
| "renderedPrompt": "A String", # Prompt as sent to the model. |
| }, |
| "rewrittenQuery": "A String", # Optional. Rewritten string query used for search. |
| "safetySignals": { # Safety check results. # Optional. Safety check result. |
| "bannedPhraseMatch": "A String", # Specifies banned phrase match subject. |
| "decision": "A String", # Safety decision. |
| "matchedBannedPhrase": "A String", # The matched banned phrase if there was a match. |
| }, |
| "searchSnippets": [ # Optional. Search snippets included in the answer generation prompt. |
| { # Search snippet details. |
| "documentTitle": "A String", # Title of the enclosing document. |
| "documentUri": "A String", # Uri for the document. Present if specified for the document. |
| "metadata": { # Metadata associated with the document. |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", # Text included in the prompt. |
| }, |
| ], |
| }, |
| }, |
| "displayName": "A String", # Output only. The display name of the tool. |
| "inputActionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { # Optional. A list of output parameters generated by the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`. |
| "webhookToolTrace": { # The tracing information for the webhook tool. # Optional. Webhook tool trace. |
| "webhookTag": "A String", # Optional. The tag of the webhook. |
| "webhookUri": "A String", # Optional. The url of the webhook. |
| }, |
| }, |
| "tts": { # Stores metadata of the Text-to-Speech action. # Optional. Text-to-speech action performed by the agent. |
| }, |
| "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer. |
| "audio": "A String", # Optional. Audio input. |
| "audioTokens": [ # Optional. Tokens of the audio input. |
| 42, |
| ], |
| "text": "A String", # Required. Message content in text. |
| }, |
| }, |
| ], |
| "conversationState": "A String", # Required. Example's output state. |
| "createTime": "A String", # Output only. The timestamp of initial example creation. |
| "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200. |
| "displayName": "A String", # Required. The display name of the example. |
| "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents. |
| "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. |
| "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example. |
| "actionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. |
| }, |
| "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example. |
| "actionParameters": { # Optional. A Struct object of output parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. |
| "state": "A String", # End state of the playbook. |
| }, |
| "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM. |
| "updateTime": "A String", # Output only. Last time the example was updated. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task. |
| "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent. |
| { # Action performed by end user or Dialogflow agent in the conversation. |
| "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message. |
| "requireGeneration": True or False, # Optional. True if the agent utterance needs to be generated by the LLM. Only used in webhook response to differentiate from empty text. Revisit whether we need this field or mark `text` as optional when we expose webhook interface to customer. |
| "text": "A String", # Required. Message content in text. |
| }, |
| "completeTime": "A String", # Output only. Timestamp of the completion of the agent action. |
| "displayName": "A String", # Output only. The display name of the action. |
| "event": { # Event represents the event sent by the customer. # Optional. The agent received an event from the customer or a system event is emitted. |
| "event": "A String", # Required. Name of the event. |
| "text": "A String", # Optional. Unstructured text payload of the event. |
| }, |
| "flowInvocation": { # Stores metadata of the invocation of a child CX flow. Flow invocation actions enter the child flow. # Optional. Action performed on behalf of the agent by invoking a CX flow. |
| "displayName": "A String", # Output only. The display name of the flow. |
| "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. |
| "flowState": "A String", # Required. Flow invocation's output state. |
| "inputActionParameters": { # Optional. A list of input parameters for the flow. |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowStateUpdate": { # Stores metadata of the state update action, such as a state machine execution in flows. # Optional. Output only. The state machine update in flows. |
| "destination": "A String", # The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`. |
| "eventType": "A String", # The type of the event that triggered the state update. |
| "functionCall": { # Stores the metadata of a function call to execute. # The function call to execute. |
| "name": "A String", # The name of the function call. |
| }, |
| "pageState": { # Stores the state of a page and its flow. # The updated page and flow state. |
| "displayName": "A String", # The display name of the page. |
| "page": "A String", # The ID of the page. Format: `projects//locations//agents//flows//pages/`. |
| "status": "A String", # The status of the page. |
| }, |
| "updatedParameters": { # The updated parameters. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowTransition": { # Stores metadata of the transition to a target CX flow. Flow transition actions exit the caller playbook and enter the child flow. # Optional. Action performed on behalf of the agent by transitioning to a target CX flow. |
| "displayName": "A String", # Output only. The display name of the flow. |
| "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. |
| "inputActionParameters": { # A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "intentMatch": { # Stores metadata of the intent match action. # Optional. Output only. Intent Match in flows. |
| "matchedIntents": [ # The matched intent. |
| { # Stores the matched intent, which is the result of the intent match action. |
| "displayName": "A String", # The display name of the matched intent. |
| "generativeFallback": { # The generative fallback response of the matched intent. |
| "a_key": "", # Properties of the object. |
| }, |
| "intentId": "A String", # The ID of the matched intent. |
| "score": 3.14, # The score of the matched intent. |
| }, |
| ], |
| }, |
| "llmCall": { # Stores metadata of the call of an LLM. # Optional. Output only. LLM call performed by the agent. |
| "model": "A String", # The model of the LLM call. |
| "retrievedExamples": [ # A list of relevant examples used for the LLM prompt. |
| { # Relevant example used for the LLM prompt. |
| "exampleDisplayName": "A String", # The display name of the example. |
| "exampleId": "A String", # The id of the example. |
| "matchedRetrievalLabel": "A String", # Optional. The matched retrieval label of this LLM call. |
| "retrievalStrategy": "A String", # Retrieval strategy of the example. |
| }, |
| ], |
| "temperature": 3.14, # The temperature of the LLM call. |
| "tokenCount": { # Stores token counts of the LLM call. # The token counts of the LLM call. |
| "conversationContextTokenCount": "A String", # The number of tokens used for the conversation history in the prompt. |
| "exampleTokenCount": "A String", # The number of tokens used for the retrieved examples in the prompt. |
| "totalInputTokenCount": "A String", # The total number of tokens used for the input to the LLM call. |
| "totalOutputTokenCount": "A String", # The total number of tokens used for the output of the LLM call. |
| }, |
| }, |
| "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Playbook invocation actions enter the child playbook. # Optional. Action performed on behalf of the agent by invoking a child playbook. |
| "displayName": "A String", # Output only. The display name of the playbook. |
| "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. |
| "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation. |
| "actionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. |
| }, |
| "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation. |
| "actionParameters": { # Optional. A Struct object of output parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. |
| "state": "A String", # End state of the playbook. |
| }, |
| "playbookState": "A String", # Required. Playbook invocation's output state. |
| }, |
| "playbookTransition": { # Stores metadata of the transition to another target playbook. Playbook transition actions exit the caller playbook and enter the target playbook. # Optional. Action performed on behalf of the agent by transitioning to a target playbook. |
| "displayName": "A String", # Output only. The display name of the playbook. |
| "inputActionParameters": { # A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. |
| }, |
| "startTime": "A String", # Output only. Timestamp of the start of the agent action. |
| "status": { # The status of the action. # Optional. Output only. The status of the action. |
| "exception": { # Exception thrown during the execution of an action. # Optional. The exception thrown during the execution of the action. |
| "errorMessage": "A String", # Optional. The error message. |
| }, |
| }, |
| "stt": { # Stores metadata of the Speech-to-Text action. # Optional. Speech-to-text action performed by the agent. |
| }, |
| "subExecutionSteps": [ # Optional. The detailed tracing information for sub execution steps of the action. |
| { # A span represents a sub execution step of an action. |
| "completeTime": "A String", # Timestamp of the completion of the span. |
| "metrics": [ # The unordered collection of metrics in this span. |
| { # A named metric is a metric with name, value and unit. |
| "name": "A String", # The name of the metric. |
| "unit": "A String", # The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard. |
| "value": "", # The value of the metric. |
| }, |
| ], |
| "name": "A String", # The name of the span. |
| "startTime": "A String", # Timestamp of the start of the span. |
| "tags": [ # The metadata tags of the span such as span type. |
| "A String", |
| ], |
| }, |
| ], |
| "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool. |
| "action": "A String", # Optional. Name of the action to be called during the tool use. |
| "dataStoreToolTrace": { # The tracing information for the data store tool. # Optional. Data store tool trace. |
| "dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. |
| "answer": "A String", # Optional. The final compiled answer. |
| "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. |
| "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. |
| "modelOutput": "A String", # Output of the generative model. |
| "renderedPrompt": "A String", # Prompt as sent to the model. |
| }, |
| "answerParts": [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). |
| { # Answer part with citation. |
| "supportingIndices": [ # Citations for this answer part. Indices of `search_snippets`. |
| 42, |
| ], |
| "text": "A String", # Substring of the answer. |
| }, |
| ], |
| "citedSnippets": [ # Optional. Snippets cited by the answer generation model from the most to least relevant. |
| { # Snippet cited by the answer generation model. |
| "searchSnippet": { # Search snippet details. # Details of the snippet. |
| "documentTitle": "A String", # Title of the enclosing document. |
| "documentUri": "A String", # Uri for the document. Present if specified for the document. |
| "metadata": { # Metadata associated with the document. |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", # Text included in the prompt. |
| }, |
| "snippetIndex": 42, # Index of the snippet in `search_snippets` field. |
| }, |
| ], |
| "groundingSignals": { # Grounding signals. # Optional. Grounding signals. |
| "decision": "A String", # Represents the decision of the grounding check. |
| "score": "A String", # Grounding score bucket setting. |
| }, |
| "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. |
| "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. |
| "modelOutput": "A String", # Output of the generative model. |
| "renderedPrompt": "A String", # Prompt as sent to the model. |
| }, |
| "rewrittenQuery": "A String", # Optional. Rewritten string query used for search. |
| "safetySignals": { # Safety check results. # Optional. Safety check result. |
| "bannedPhraseMatch": "A String", # Specifies banned phrase match subject. |
| "decision": "A String", # Safety decision. |
| "matchedBannedPhrase": "A String", # The matched banned phrase if there was a match. |
| }, |
| "searchSnippets": [ # Optional. Search snippets included in the answer generation prompt. |
| { # Search snippet details. |
| "documentTitle": "A String", # Title of the enclosing document. |
| "documentUri": "A String", # Uri for the document. Present if specified for the document. |
| "metadata": { # Metadata associated with the document. |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", # Text included in the prompt. |
| }, |
| ], |
| }, |
| }, |
| "displayName": "A String", # Output only. The display name of the tool. |
| "inputActionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { # Optional. A list of output parameters generated by the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`. |
| "webhookToolTrace": { # The tracing information for the webhook tool. # Optional. Webhook tool trace. |
| "webhookTag": "A String", # Optional. The tag of the webhook. |
| "webhookUri": "A String", # Optional. The url of the webhook. |
| }, |
| }, |
| "tts": { # Stores metadata of the Text-to-Speech action. # Optional. Text-to-speech action performed by the agent. |
| }, |
| "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer. |
| "audio": "A String", # Optional. Audio input. |
| "audioTokens": [ # Optional. Tokens of the audio input. |
| 42, |
| ], |
| "text": "A String", # Required. Message content in text. |
| }, |
| }, |
| ], |
| "conversationState": "A String", # Required. Example's output state. |
| "createTime": "A String", # Output only. The timestamp of initial example creation. |
| "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200. |
| "displayName": "A String", # Required. The display name of the example. |
| "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents. |
| "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. |
| "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example. |
| "actionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. |
| }, |
| "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example. |
| "actionParameters": { # Optional. A Struct object of output parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. |
| "state": "A String", # End state of the playbook. |
| }, |
| "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM. |
| "updateTime": "A String", # Output only. Last time the example was updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes the specified example. |
| |
| Args: |
| name: string, Required. The name of the example to delete. Format: `projects//locations//agents//playbooks//examples/`. (required) |
| 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, x__xgafv=None)</code> |
| <pre>Retrieves the specified example. |
| |
| Args: |
| name: string, Required. The name of the example. Format: `projects//locations//agents//playbooks//examples/`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task. |
| "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent. |
| { # Action performed by end user or Dialogflow agent in the conversation. |
| "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message. |
| "requireGeneration": True or False, # Optional. True if the agent utterance needs to be generated by the LLM. Only used in webhook response to differentiate from empty text. Revisit whether we need this field or mark `text` as optional when we expose webhook interface to customer. |
| "text": "A String", # Required. Message content in text. |
| }, |
| "completeTime": "A String", # Output only. Timestamp of the completion of the agent action. |
| "displayName": "A String", # Output only. The display name of the action. |
| "event": { # Event represents the event sent by the customer. # Optional. The agent received an event from the customer or a system event is emitted. |
| "event": "A String", # Required. Name of the event. |
| "text": "A String", # Optional. Unstructured text payload of the event. |
| }, |
| "flowInvocation": { # Stores metadata of the invocation of a child CX flow. Flow invocation actions enter the child flow. # Optional. Action performed on behalf of the agent by invoking a CX flow. |
| "displayName": "A String", # Output only. The display name of the flow. |
| "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. |
| "flowState": "A String", # Required. Flow invocation's output state. |
| "inputActionParameters": { # Optional. A list of input parameters for the flow. |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowStateUpdate": { # Stores metadata of the state update action, such as a state machine execution in flows. # Optional. Output only. The state machine update in flows. |
| "destination": "A String", # The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`. |
| "eventType": "A String", # The type of the event that triggered the state update. |
| "functionCall": { # Stores the metadata of a function call to execute. # The function call to execute. |
| "name": "A String", # The name of the function call. |
| }, |
| "pageState": { # Stores the state of a page and its flow. # The updated page and flow state. |
| "displayName": "A String", # The display name of the page. |
| "page": "A String", # The ID of the page. Format: `projects//locations//agents//flows//pages/`. |
| "status": "A String", # The status of the page. |
| }, |
| "updatedParameters": { # The updated parameters. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowTransition": { # Stores metadata of the transition to a target CX flow. Flow transition actions exit the caller playbook and enter the child flow. # Optional. Action performed on behalf of the agent by transitioning to a target CX flow. |
| "displayName": "A String", # Output only. The display name of the flow. |
| "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. |
| "inputActionParameters": { # A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "intentMatch": { # Stores metadata of the intent match action. # Optional. Output only. Intent Match in flows. |
| "matchedIntents": [ # The matched intent. |
| { # Stores the matched intent, which is the result of the intent match action. |
| "displayName": "A String", # The display name of the matched intent. |
| "generativeFallback": { # The generative fallback response of the matched intent. |
| "a_key": "", # Properties of the object. |
| }, |
| "intentId": "A String", # The ID of the matched intent. |
| "score": 3.14, # The score of the matched intent. |
| }, |
| ], |
| }, |
| "llmCall": { # Stores metadata of the call of an LLM. # Optional. Output only. LLM call performed by the agent. |
| "model": "A String", # The model of the LLM call. |
| "retrievedExamples": [ # A list of relevant examples used for the LLM prompt. |
| { # Relevant example used for the LLM prompt. |
| "exampleDisplayName": "A String", # The display name of the example. |
| "exampleId": "A String", # The id of the example. |
| "matchedRetrievalLabel": "A String", # Optional. The matched retrieval label of this LLM call. |
| "retrievalStrategy": "A String", # Retrieval strategy of the example. |
| }, |
| ], |
| "temperature": 3.14, # The temperature of the LLM call. |
| "tokenCount": { # Stores token counts of the LLM call. # The token counts of the LLM call. |
| "conversationContextTokenCount": "A String", # The number of tokens used for the conversation history in the prompt. |
| "exampleTokenCount": "A String", # The number of tokens used for the retrieved examples in the prompt. |
| "totalInputTokenCount": "A String", # The total number of tokens used for the input to the LLM call. |
| "totalOutputTokenCount": "A String", # The total number of tokens used for the output of the LLM call. |
| }, |
| }, |
| "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Playbook invocation actions enter the child playbook. # Optional. Action performed on behalf of the agent by invoking a child playbook. |
| "displayName": "A String", # Output only. The display name of the playbook. |
| "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. |
| "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation. |
| "actionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. |
| }, |
| "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation. |
| "actionParameters": { # Optional. A Struct object of output parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. |
| "state": "A String", # End state of the playbook. |
| }, |
| "playbookState": "A String", # Required. Playbook invocation's output state. |
| }, |
| "playbookTransition": { # Stores metadata of the transition to another target playbook. Playbook transition actions exit the caller playbook and enter the target playbook. # Optional. Action performed on behalf of the agent by transitioning to a target playbook. |
| "displayName": "A String", # Output only. The display name of the playbook. |
| "inputActionParameters": { # A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. |
| }, |
| "startTime": "A String", # Output only. Timestamp of the start of the agent action. |
| "status": { # The status of the action. # Optional. Output only. The status of the action. |
| "exception": { # Exception thrown during the execution of an action. # Optional. The exception thrown during the execution of the action. |
| "errorMessage": "A String", # Optional. The error message. |
| }, |
| }, |
| "stt": { # Stores metadata of the Speech-to-Text action. # Optional. Speech-to-text action performed by the agent. |
| }, |
| "subExecutionSteps": [ # Optional. The detailed tracing information for sub execution steps of the action. |
| { # A span represents a sub execution step of an action. |
| "completeTime": "A String", # Timestamp of the completion of the span. |
| "metrics": [ # The unordered collection of metrics in this span. |
| { # A named metric is a metric with name, value and unit. |
| "name": "A String", # The name of the metric. |
| "unit": "A String", # The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard. |
| "value": "", # The value of the metric. |
| }, |
| ], |
| "name": "A String", # The name of the span. |
| "startTime": "A String", # Timestamp of the start of the span. |
| "tags": [ # The metadata tags of the span such as span type. |
| "A String", |
| ], |
| }, |
| ], |
| "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool. |
| "action": "A String", # Optional. Name of the action to be called during the tool use. |
| "dataStoreToolTrace": { # The tracing information for the data store tool. # Optional. Data store tool trace. |
| "dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. |
| "answer": "A String", # Optional. The final compiled answer. |
| "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. |
| "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. |
| "modelOutput": "A String", # Output of the generative model. |
| "renderedPrompt": "A String", # Prompt as sent to the model. |
| }, |
| "answerParts": [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). |
| { # Answer part with citation. |
| "supportingIndices": [ # Citations for this answer part. Indices of `search_snippets`. |
| 42, |
| ], |
| "text": "A String", # Substring of the answer. |
| }, |
| ], |
| "citedSnippets": [ # Optional. Snippets cited by the answer generation model from the most to least relevant. |
| { # Snippet cited by the answer generation model. |
| "searchSnippet": { # Search snippet details. # Details of the snippet. |
| "documentTitle": "A String", # Title of the enclosing document. |
| "documentUri": "A String", # Uri for the document. Present if specified for the document. |
| "metadata": { # Metadata associated with the document. |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", # Text included in the prompt. |
| }, |
| "snippetIndex": 42, # Index of the snippet in `search_snippets` field. |
| }, |
| ], |
| "groundingSignals": { # Grounding signals. # Optional. Grounding signals. |
| "decision": "A String", # Represents the decision of the grounding check. |
| "score": "A String", # Grounding score bucket setting. |
| }, |
| "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. |
| "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. |
| "modelOutput": "A String", # Output of the generative model. |
| "renderedPrompt": "A String", # Prompt as sent to the model. |
| }, |
| "rewrittenQuery": "A String", # Optional. Rewritten string query used for search. |
| "safetySignals": { # Safety check results. # Optional. Safety check result. |
| "bannedPhraseMatch": "A String", # Specifies banned phrase match subject. |
| "decision": "A String", # Safety decision. |
| "matchedBannedPhrase": "A String", # The matched banned phrase if there was a match. |
| }, |
| "searchSnippets": [ # Optional. Search snippets included in the answer generation prompt. |
| { # Search snippet details. |
| "documentTitle": "A String", # Title of the enclosing document. |
| "documentUri": "A String", # Uri for the document. Present if specified for the document. |
| "metadata": { # Metadata associated with the document. |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", # Text included in the prompt. |
| }, |
| ], |
| }, |
| }, |
| "displayName": "A String", # Output only. The display name of the tool. |
| "inputActionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { # Optional. A list of output parameters generated by the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`. |
| "webhookToolTrace": { # The tracing information for the webhook tool. # Optional. Webhook tool trace. |
| "webhookTag": "A String", # Optional. The tag of the webhook. |
| "webhookUri": "A String", # Optional. The url of the webhook. |
| }, |
| }, |
| "tts": { # Stores metadata of the Text-to-Speech action. # Optional. Text-to-speech action performed by the agent. |
| }, |
| "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer. |
| "audio": "A String", # Optional. Audio input. |
| "audioTokens": [ # Optional. Tokens of the audio input. |
| 42, |
| ], |
| "text": "A String", # Required. Message content in text. |
| }, |
| }, |
| ], |
| "conversationState": "A String", # Required. Example's output state. |
| "createTime": "A String", # Output only. The timestamp of initial example creation. |
| "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200. |
| "displayName": "A String", # Required. The display name of the example. |
| "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents. |
| "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. |
| "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example. |
| "actionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. |
| }, |
| "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example. |
| "actionParameters": { # Optional. A Struct object of output parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. |
| "state": "A String", # End state of the playbook. |
| }, |
| "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM. |
| "updateTime": "A String", # Output only. Last time the example was updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Returns a list of examples in the specified playbook. |
| |
| Args: |
| parent: string, Required. The playbook to list the examples from. Format: `projects//locations//agents//playbooks/`. (required) |
| languageCode: string, Optional. The language to list examples for. If not specified, list all examples under the playbook. Note: languages must be enabled in the agent before they can be used. |
| pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. |
| pageToken: string, Optional. The next_page_token value returned from a previous list request. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The response message for Examples.ListExamples. |
| "examples": [ # The list of examples. There will be a maximum number of items returned based on the page_size field in the request. |
| { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task. |
| "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent. |
| { # Action performed by end user or Dialogflow agent in the conversation. |
| "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message. |
| "requireGeneration": True or False, # Optional. True if the agent utterance needs to be generated by the LLM. Only used in webhook response to differentiate from empty text. Revisit whether we need this field or mark `text` as optional when we expose webhook interface to customer. |
| "text": "A String", # Required. Message content in text. |
| }, |
| "completeTime": "A String", # Output only. Timestamp of the completion of the agent action. |
| "displayName": "A String", # Output only. The display name of the action. |
| "event": { # Event represents the event sent by the customer. # Optional. The agent received an event from the customer or a system event is emitted. |
| "event": "A String", # Required. Name of the event. |
| "text": "A String", # Optional. Unstructured text payload of the event. |
| }, |
| "flowInvocation": { # Stores metadata of the invocation of a child CX flow. Flow invocation actions enter the child flow. # Optional. Action performed on behalf of the agent by invoking a CX flow. |
| "displayName": "A String", # Output only. The display name of the flow. |
| "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. |
| "flowState": "A String", # Required. Flow invocation's output state. |
| "inputActionParameters": { # Optional. A list of input parameters for the flow. |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowStateUpdate": { # Stores metadata of the state update action, such as a state machine execution in flows. # Optional. Output only. The state machine update in flows. |
| "destination": "A String", # The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`. |
| "eventType": "A String", # The type of the event that triggered the state update. |
| "functionCall": { # Stores the metadata of a function call to execute. # The function call to execute. |
| "name": "A String", # The name of the function call. |
| }, |
| "pageState": { # Stores the state of a page and its flow. # The updated page and flow state. |
| "displayName": "A String", # The display name of the page. |
| "page": "A String", # The ID of the page. Format: `projects//locations//agents//flows//pages/`. |
| "status": "A String", # The status of the page. |
| }, |
| "updatedParameters": { # The updated parameters. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowTransition": { # Stores metadata of the transition to a target CX flow. Flow transition actions exit the caller playbook and enter the child flow. # Optional. Action performed on behalf of the agent by transitioning to a target CX flow. |
| "displayName": "A String", # Output only. The display name of the flow. |
| "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. |
| "inputActionParameters": { # A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "intentMatch": { # Stores metadata of the intent match action. # Optional. Output only. Intent Match in flows. |
| "matchedIntents": [ # The matched intent. |
| { # Stores the matched intent, which is the result of the intent match action. |
| "displayName": "A String", # The display name of the matched intent. |
| "generativeFallback": { # The generative fallback response of the matched intent. |
| "a_key": "", # Properties of the object. |
| }, |
| "intentId": "A String", # The ID of the matched intent. |
| "score": 3.14, # The score of the matched intent. |
| }, |
| ], |
| }, |
| "llmCall": { # Stores metadata of the call of an LLM. # Optional. Output only. LLM call performed by the agent. |
| "model": "A String", # The model of the LLM call. |
| "retrievedExamples": [ # A list of relevant examples used for the LLM prompt. |
| { # Relevant example used for the LLM prompt. |
| "exampleDisplayName": "A String", # The display name of the example. |
| "exampleId": "A String", # The id of the example. |
| "matchedRetrievalLabel": "A String", # Optional. The matched retrieval label of this LLM call. |
| "retrievalStrategy": "A String", # Retrieval strategy of the example. |
| }, |
| ], |
| "temperature": 3.14, # The temperature of the LLM call. |
| "tokenCount": { # Stores token counts of the LLM call. # The token counts of the LLM call. |
| "conversationContextTokenCount": "A String", # The number of tokens used for the conversation history in the prompt. |
| "exampleTokenCount": "A String", # The number of tokens used for the retrieved examples in the prompt. |
| "totalInputTokenCount": "A String", # The total number of tokens used for the input to the LLM call. |
| "totalOutputTokenCount": "A String", # The total number of tokens used for the output of the LLM call. |
| }, |
| }, |
| "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Playbook invocation actions enter the child playbook. # Optional. Action performed on behalf of the agent by invoking a child playbook. |
| "displayName": "A String", # Output only. The display name of the playbook. |
| "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. |
| "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation. |
| "actionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. |
| }, |
| "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation. |
| "actionParameters": { # Optional. A Struct object of output parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. |
| "state": "A String", # End state of the playbook. |
| }, |
| "playbookState": "A String", # Required. Playbook invocation's output state. |
| }, |
| "playbookTransition": { # Stores metadata of the transition to another target playbook. Playbook transition actions exit the caller playbook and enter the target playbook. # Optional. Action performed on behalf of the agent by transitioning to a target playbook. |
| "displayName": "A String", # Output only. The display name of the playbook. |
| "inputActionParameters": { # A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. |
| }, |
| "startTime": "A String", # Output only. Timestamp of the start of the agent action. |
| "status": { # The status of the action. # Optional. Output only. The status of the action. |
| "exception": { # Exception thrown during the execution of an action. # Optional. The exception thrown during the execution of the action. |
| "errorMessage": "A String", # Optional. The error message. |
| }, |
| }, |
| "stt": { # Stores metadata of the Speech-to-Text action. # Optional. Speech-to-text action performed by the agent. |
| }, |
| "subExecutionSteps": [ # Optional. The detailed tracing information for sub execution steps of the action. |
| { # A span represents a sub execution step of an action. |
| "completeTime": "A String", # Timestamp of the completion of the span. |
| "metrics": [ # The unordered collection of metrics in this span. |
| { # A named metric is a metric with name, value and unit. |
| "name": "A String", # The name of the metric. |
| "unit": "A String", # The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard. |
| "value": "", # The value of the metric. |
| }, |
| ], |
| "name": "A String", # The name of the span. |
| "startTime": "A String", # Timestamp of the start of the span. |
| "tags": [ # The metadata tags of the span such as span type. |
| "A String", |
| ], |
| }, |
| ], |
| "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool. |
| "action": "A String", # Optional. Name of the action to be called during the tool use. |
| "dataStoreToolTrace": { # The tracing information for the data store tool. # Optional. Data store tool trace. |
| "dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. |
| "answer": "A String", # Optional. The final compiled answer. |
| "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. |
| "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. |
| "modelOutput": "A String", # Output of the generative model. |
| "renderedPrompt": "A String", # Prompt as sent to the model. |
| }, |
| "answerParts": [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). |
| { # Answer part with citation. |
| "supportingIndices": [ # Citations for this answer part. Indices of `search_snippets`. |
| 42, |
| ], |
| "text": "A String", # Substring of the answer. |
| }, |
| ], |
| "citedSnippets": [ # Optional. Snippets cited by the answer generation model from the most to least relevant. |
| { # Snippet cited by the answer generation model. |
| "searchSnippet": { # Search snippet details. # Details of the snippet. |
| "documentTitle": "A String", # Title of the enclosing document. |
| "documentUri": "A String", # Uri for the document. Present if specified for the document. |
| "metadata": { # Metadata associated with the document. |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", # Text included in the prompt. |
| }, |
| "snippetIndex": 42, # Index of the snippet in `search_snippets` field. |
| }, |
| ], |
| "groundingSignals": { # Grounding signals. # Optional. Grounding signals. |
| "decision": "A String", # Represents the decision of the grounding check. |
| "score": "A String", # Grounding score bucket setting. |
| }, |
| "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. |
| "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. |
| "modelOutput": "A String", # Output of the generative model. |
| "renderedPrompt": "A String", # Prompt as sent to the model. |
| }, |
| "rewrittenQuery": "A String", # Optional. Rewritten string query used for search. |
| "safetySignals": { # Safety check results. # Optional. Safety check result. |
| "bannedPhraseMatch": "A String", # Specifies banned phrase match subject. |
| "decision": "A String", # Safety decision. |
| "matchedBannedPhrase": "A String", # The matched banned phrase if there was a match. |
| }, |
| "searchSnippets": [ # Optional. Search snippets included in the answer generation prompt. |
| { # Search snippet details. |
| "documentTitle": "A String", # Title of the enclosing document. |
| "documentUri": "A String", # Uri for the document. Present if specified for the document. |
| "metadata": { # Metadata associated with the document. |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", # Text included in the prompt. |
| }, |
| ], |
| }, |
| }, |
| "displayName": "A String", # Output only. The display name of the tool. |
| "inputActionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { # Optional. A list of output parameters generated by the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`. |
| "webhookToolTrace": { # The tracing information for the webhook tool. # Optional. Webhook tool trace. |
| "webhookTag": "A String", # Optional. The tag of the webhook. |
| "webhookUri": "A String", # Optional. The url of the webhook. |
| }, |
| }, |
| "tts": { # Stores metadata of the Text-to-Speech action. # Optional. Text-to-speech action performed by the agent. |
| }, |
| "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer. |
| "audio": "A String", # Optional. Audio input. |
| "audioTokens": [ # Optional. Tokens of the audio input. |
| 42, |
| ], |
| "text": "A String", # Required. Message content in text. |
| }, |
| }, |
| ], |
| "conversationState": "A String", # Required. Example's output state. |
| "createTime": "A String", # Output only. The timestamp of initial example creation. |
| "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200. |
| "displayName": "A String", # Required. The display name of the example. |
| "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents. |
| "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. |
| "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example. |
| "actionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. |
| }, |
| "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example. |
| "actionParameters": { # Optional. A Struct object of output parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. |
| "state": "A String", # End state of the playbook. |
| }, |
| "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM. |
| "updateTime": "A String", # Output only. Last time the example was updated. |
| }, |
| ], |
| "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. |
| }</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> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Update the specified example. |
| |
| Args: |
| name: string, The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task. |
| "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent. |
| { # Action performed by end user or Dialogflow agent in the conversation. |
| "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message. |
| "requireGeneration": True or False, # Optional. True if the agent utterance needs to be generated by the LLM. Only used in webhook response to differentiate from empty text. Revisit whether we need this field or mark `text` as optional when we expose webhook interface to customer. |
| "text": "A String", # Required. Message content in text. |
| }, |
| "completeTime": "A String", # Output only. Timestamp of the completion of the agent action. |
| "displayName": "A String", # Output only. The display name of the action. |
| "event": { # Event represents the event sent by the customer. # Optional. The agent received an event from the customer or a system event is emitted. |
| "event": "A String", # Required. Name of the event. |
| "text": "A String", # Optional. Unstructured text payload of the event. |
| }, |
| "flowInvocation": { # Stores metadata of the invocation of a child CX flow. Flow invocation actions enter the child flow. # Optional. Action performed on behalf of the agent by invoking a CX flow. |
| "displayName": "A String", # Output only. The display name of the flow. |
| "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. |
| "flowState": "A String", # Required. Flow invocation's output state. |
| "inputActionParameters": { # Optional. A list of input parameters for the flow. |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowStateUpdate": { # Stores metadata of the state update action, such as a state machine execution in flows. # Optional. Output only. The state machine update in flows. |
| "destination": "A String", # The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`. |
| "eventType": "A String", # The type of the event that triggered the state update. |
| "functionCall": { # Stores the metadata of a function call to execute. # The function call to execute. |
| "name": "A String", # The name of the function call. |
| }, |
| "pageState": { # Stores the state of a page and its flow. # The updated page and flow state. |
| "displayName": "A String", # The display name of the page. |
| "page": "A String", # The ID of the page. Format: `projects//locations//agents//flows//pages/`. |
| "status": "A String", # The status of the page. |
| }, |
| "updatedParameters": { # The updated parameters. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowTransition": { # Stores metadata of the transition to a target CX flow. Flow transition actions exit the caller playbook and enter the child flow. # Optional. Action performed on behalf of the agent by transitioning to a target CX flow. |
| "displayName": "A String", # Output only. The display name of the flow. |
| "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. |
| "inputActionParameters": { # A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "intentMatch": { # Stores metadata of the intent match action. # Optional. Output only. Intent Match in flows. |
| "matchedIntents": [ # The matched intent. |
| { # Stores the matched intent, which is the result of the intent match action. |
| "displayName": "A String", # The display name of the matched intent. |
| "generativeFallback": { # The generative fallback response of the matched intent. |
| "a_key": "", # Properties of the object. |
| }, |
| "intentId": "A String", # The ID of the matched intent. |
| "score": 3.14, # The score of the matched intent. |
| }, |
| ], |
| }, |
| "llmCall": { # Stores metadata of the call of an LLM. # Optional. Output only. LLM call performed by the agent. |
| "model": "A String", # The model of the LLM call. |
| "retrievedExamples": [ # A list of relevant examples used for the LLM prompt. |
| { # Relevant example used for the LLM prompt. |
| "exampleDisplayName": "A String", # The display name of the example. |
| "exampleId": "A String", # The id of the example. |
| "matchedRetrievalLabel": "A String", # Optional. The matched retrieval label of this LLM call. |
| "retrievalStrategy": "A String", # Retrieval strategy of the example. |
| }, |
| ], |
| "temperature": 3.14, # The temperature of the LLM call. |
| "tokenCount": { # Stores token counts of the LLM call. # The token counts of the LLM call. |
| "conversationContextTokenCount": "A String", # The number of tokens used for the conversation history in the prompt. |
| "exampleTokenCount": "A String", # The number of tokens used for the retrieved examples in the prompt. |
| "totalInputTokenCount": "A String", # The total number of tokens used for the input to the LLM call. |
| "totalOutputTokenCount": "A String", # The total number of tokens used for the output of the LLM call. |
| }, |
| }, |
| "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Playbook invocation actions enter the child playbook. # Optional. Action performed on behalf of the agent by invoking a child playbook. |
| "displayName": "A String", # Output only. The display name of the playbook. |
| "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. |
| "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation. |
| "actionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. |
| }, |
| "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation. |
| "actionParameters": { # Optional. A Struct object of output parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. |
| "state": "A String", # End state of the playbook. |
| }, |
| "playbookState": "A String", # Required. Playbook invocation's output state. |
| }, |
| "playbookTransition": { # Stores metadata of the transition to another target playbook. Playbook transition actions exit the caller playbook and enter the target playbook. # Optional. Action performed on behalf of the agent by transitioning to a target playbook. |
| "displayName": "A String", # Output only. The display name of the playbook. |
| "inputActionParameters": { # A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. |
| }, |
| "startTime": "A String", # Output only. Timestamp of the start of the agent action. |
| "status": { # The status of the action. # Optional. Output only. The status of the action. |
| "exception": { # Exception thrown during the execution of an action. # Optional. The exception thrown during the execution of the action. |
| "errorMessage": "A String", # Optional. The error message. |
| }, |
| }, |
| "stt": { # Stores metadata of the Speech-to-Text action. # Optional. Speech-to-text action performed by the agent. |
| }, |
| "subExecutionSteps": [ # Optional. The detailed tracing information for sub execution steps of the action. |
| { # A span represents a sub execution step of an action. |
| "completeTime": "A String", # Timestamp of the completion of the span. |
| "metrics": [ # The unordered collection of metrics in this span. |
| { # A named metric is a metric with name, value and unit. |
| "name": "A String", # The name of the metric. |
| "unit": "A String", # The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard. |
| "value": "", # The value of the metric. |
| }, |
| ], |
| "name": "A String", # The name of the span. |
| "startTime": "A String", # Timestamp of the start of the span. |
| "tags": [ # The metadata tags of the span such as span type. |
| "A String", |
| ], |
| }, |
| ], |
| "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool. |
| "action": "A String", # Optional. Name of the action to be called during the tool use. |
| "dataStoreToolTrace": { # The tracing information for the data store tool. # Optional. Data store tool trace. |
| "dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. |
| "answer": "A String", # Optional. The final compiled answer. |
| "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. |
| "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. |
| "modelOutput": "A String", # Output of the generative model. |
| "renderedPrompt": "A String", # Prompt as sent to the model. |
| }, |
| "answerParts": [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). |
| { # Answer part with citation. |
| "supportingIndices": [ # Citations for this answer part. Indices of `search_snippets`. |
| 42, |
| ], |
| "text": "A String", # Substring of the answer. |
| }, |
| ], |
| "citedSnippets": [ # Optional. Snippets cited by the answer generation model from the most to least relevant. |
| { # Snippet cited by the answer generation model. |
| "searchSnippet": { # Search snippet details. # Details of the snippet. |
| "documentTitle": "A String", # Title of the enclosing document. |
| "documentUri": "A String", # Uri for the document. Present if specified for the document. |
| "metadata": { # Metadata associated with the document. |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", # Text included in the prompt. |
| }, |
| "snippetIndex": 42, # Index of the snippet in `search_snippets` field. |
| }, |
| ], |
| "groundingSignals": { # Grounding signals. # Optional. Grounding signals. |
| "decision": "A String", # Represents the decision of the grounding check. |
| "score": "A String", # Grounding score bucket setting. |
| }, |
| "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. |
| "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. |
| "modelOutput": "A String", # Output of the generative model. |
| "renderedPrompt": "A String", # Prompt as sent to the model. |
| }, |
| "rewrittenQuery": "A String", # Optional. Rewritten string query used for search. |
| "safetySignals": { # Safety check results. # Optional. Safety check result. |
| "bannedPhraseMatch": "A String", # Specifies banned phrase match subject. |
| "decision": "A String", # Safety decision. |
| "matchedBannedPhrase": "A String", # The matched banned phrase if there was a match. |
| }, |
| "searchSnippets": [ # Optional. Search snippets included in the answer generation prompt. |
| { # Search snippet details. |
| "documentTitle": "A String", # Title of the enclosing document. |
| "documentUri": "A String", # Uri for the document. Present if specified for the document. |
| "metadata": { # Metadata associated with the document. |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", # Text included in the prompt. |
| }, |
| ], |
| }, |
| }, |
| "displayName": "A String", # Output only. The display name of the tool. |
| "inputActionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { # Optional. A list of output parameters generated by the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`. |
| "webhookToolTrace": { # The tracing information for the webhook tool. # Optional. Webhook tool trace. |
| "webhookTag": "A String", # Optional. The tag of the webhook. |
| "webhookUri": "A String", # Optional. The url of the webhook. |
| }, |
| }, |
| "tts": { # Stores metadata of the Text-to-Speech action. # Optional. Text-to-speech action performed by the agent. |
| }, |
| "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer. |
| "audio": "A String", # Optional. Audio input. |
| "audioTokens": [ # Optional. Tokens of the audio input. |
| 42, |
| ], |
| "text": "A String", # Required. Message content in text. |
| }, |
| }, |
| ], |
| "conversationState": "A String", # Required. Example's output state. |
| "createTime": "A String", # Output only. The timestamp of initial example creation. |
| "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200. |
| "displayName": "A String", # Required. The display name of the example. |
| "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents. |
| "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. |
| "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example. |
| "actionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. |
| }, |
| "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example. |
| "actionParameters": { # Optional. A Struct object of output parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. |
| "state": "A String", # End state of the playbook. |
| }, |
| "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM. |
| "updateTime": "A String", # Output only. Last time the example was updated. |
| } |
| |
| updateMask: string, Optional. The mask 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: |
| |
| { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task. |
| "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent. |
| { # Action performed by end user or Dialogflow agent in the conversation. |
| "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message. |
| "requireGeneration": True or False, # Optional. True if the agent utterance needs to be generated by the LLM. Only used in webhook response to differentiate from empty text. Revisit whether we need this field or mark `text` as optional when we expose webhook interface to customer. |
| "text": "A String", # Required. Message content in text. |
| }, |
| "completeTime": "A String", # Output only. Timestamp of the completion of the agent action. |
| "displayName": "A String", # Output only. The display name of the action. |
| "event": { # Event represents the event sent by the customer. # Optional. The agent received an event from the customer or a system event is emitted. |
| "event": "A String", # Required. Name of the event. |
| "text": "A String", # Optional. Unstructured text payload of the event. |
| }, |
| "flowInvocation": { # Stores metadata of the invocation of a child CX flow. Flow invocation actions enter the child flow. # Optional. Action performed on behalf of the agent by invoking a CX flow. |
| "displayName": "A String", # Output only. The display name of the flow. |
| "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. |
| "flowState": "A String", # Required. Flow invocation's output state. |
| "inputActionParameters": { # Optional. A list of input parameters for the flow. |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowStateUpdate": { # Stores metadata of the state update action, such as a state machine execution in flows. # Optional. Output only. The state machine update in flows. |
| "destination": "A String", # The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`. |
| "eventType": "A String", # The type of the event that triggered the state update. |
| "functionCall": { # Stores the metadata of a function call to execute. # The function call to execute. |
| "name": "A String", # The name of the function call. |
| }, |
| "pageState": { # Stores the state of a page and its flow. # The updated page and flow state. |
| "displayName": "A String", # The display name of the page. |
| "page": "A String", # The ID of the page. Format: `projects//locations//agents//flows//pages/`. |
| "status": "A String", # The status of the page. |
| }, |
| "updatedParameters": { # The updated parameters. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowTransition": { # Stores metadata of the transition to a target CX flow. Flow transition actions exit the caller playbook and enter the child flow. # Optional. Action performed on behalf of the agent by transitioning to a target CX flow. |
| "displayName": "A String", # Output only. The display name of the flow. |
| "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. |
| "inputActionParameters": { # A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "intentMatch": { # Stores metadata of the intent match action. # Optional. Output only. Intent Match in flows. |
| "matchedIntents": [ # The matched intent. |
| { # Stores the matched intent, which is the result of the intent match action. |
| "displayName": "A String", # The display name of the matched intent. |
| "generativeFallback": { # The generative fallback response of the matched intent. |
| "a_key": "", # Properties of the object. |
| }, |
| "intentId": "A String", # The ID of the matched intent. |
| "score": 3.14, # The score of the matched intent. |
| }, |
| ], |
| }, |
| "llmCall": { # Stores metadata of the call of an LLM. # Optional. Output only. LLM call performed by the agent. |
| "model": "A String", # The model of the LLM call. |
| "retrievedExamples": [ # A list of relevant examples used for the LLM prompt. |
| { # Relevant example used for the LLM prompt. |
| "exampleDisplayName": "A String", # The display name of the example. |
| "exampleId": "A String", # The id of the example. |
| "matchedRetrievalLabel": "A String", # Optional. The matched retrieval label of this LLM call. |
| "retrievalStrategy": "A String", # Retrieval strategy of the example. |
| }, |
| ], |
| "temperature": 3.14, # The temperature of the LLM call. |
| "tokenCount": { # Stores token counts of the LLM call. # The token counts of the LLM call. |
| "conversationContextTokenCount": "A String", # The number of tokens used for the conversation history in the prompt. |
| "exampleTokenCount": "A String", # The number of tokens used for the retrieved examples in the prompt. |
| "totalInputTokenCount": "A String", # The total number of tokens used for the input to the LLM call. |
| "totalOutputTokenCount": "A String", # The total number of tokens used for the output of the LLM call. |
| }, |
| }, |
| "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Playbook invocation actions enter the child playbook. # Optional. Action performed on behalf of the agent by invoking a child playbook. |
| "displayName": "A String", # Output only. The display name of the playbook. |
| "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. |
| "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation. |
| "actionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. |
| }, |
| "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation. |
| "actionParameters": { # Optional. A Struct object of output parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. |
| "state": "A String", # End state of the playbook. |
| }, |
| "playbookState": "A String", # Required. Playbook invocation's output state. |
| }, |
| "playbookTransition": { # Stores metadata of the transition to another target playbook. Playbook transition actions exit the caller playbook and enter the target playbook. # Optional. Action performed on behalf of the agent by transitioning to a target playbook. |
| "displayName": "A String", # Output only. The display name of the playbook. |
| "inputActionParameters": { # A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. |
| }, |
| "startTime": "A String", # Output only. Timestamp of the start of the agent action. |
| "status": { # The status of the action. # Optional. Output only. The status of the action. |
| "exception": { # Exception thrown during the execution of an action. # Optional. The exception thrown during the execution of the action. |
| "errorMessage": "A String", # Optional. The error message. |
| }, |
| }, |
| "stt": { # Stores metadata of the Speech-to-Text action. # Optional. Speech-to-text action performed by the agent. |
| }, |
| "subExecutionSteps": [ # Optional. The detailed tracing information for sub execution steps of the action. |
| { # A span represents a sub execution step of an action. |
| "completeTime": "A String", # Timestamp of the completion of the span. |
| "metrics": [ # The unordered collection of metrics in this span. |
| { # A named metric is a metric with name, value and unit. |
| "name": "A String", # The name of the metric. |
| "unit": "A String", # The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard. |
| "value": "", # The value of the metric. |
| }, |
| ], |
| "name": "A String", # The name of the span. |
| "startTime": "A String", # Timestamp of the start of the span. |
| "tags": [ # The metadata tags of the span such as span type. |
| "A String", |
| ], |
| }, |
| ], |
| "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool. |
| "action": "A String", # Optional. Name of the action to be called during the tool use. |
| "dataStoreToolTrace": { # The tracing information for the data store tool. # Optional. Data store tool trace. |
| "dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. |
| "answer": "A String", # Optional. The final compiled answer. |
| "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. |
| "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. |
| "modelOutput": "A String", # Output of the generative model. |
| "renderedPrompt": "A String", # Prompt as sent to the model. |
| }, |
| "answerParts": [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). |
| { # Answer part with citation. |
| "supportingIndices": [ # Citations for this answer part. Indices of `search_snippets`. |
| 42, |
| ], |
| "text": "A String", # Substring of the answer. |
| }, |
| ], |
| "citedSnippets": [ # Optional. Snippets cited by the answer generation model from the most to least relevant. |
| { # Snippet cited by the answer generation model. |
| "searchSnippet": { # Search snippet details. # Details of the snippet. |
| "documentTitle": "A String", # Title of the enclosing document. |
| "documentUri": "A String", # Uri for the document. Present if specified for the document. |
| "metadata": { # Metadata associated with the document. |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", # Text included in the prompt. |
| }, |
| "snippetIndex": 42, # Index of the snippet in `search_snippets` field. |
| }, |
| ], |
| "groundingSignals": { # Grounding signals. # Optional. Grounding signals. |
| "decision": "A String", # Represents the decision of the grounding check. |
| "score": "A String", # Grounding score bucket setting. |
| }, |
| "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. |
| "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. |
| "modelOutput": "A String", # Output of the generative model. |
| "renderedPrompt": "A String", # Prompt as sent to the model. |
| }, |
| "rewrittenQuery": "A String", # Optional. Rewritten string query used for search. |
| "safetySignals": { # Safety check results. # Optional. Safety check result. |
| "bannedPhraseMatch": "A String", # Specifies banned phrase match subject. |
| "decision": "A String", # Safety decision. |
| "matchedBannedPhrase": "A String", # The matched banned phrase if there was a match. |
| }, |
| "searchSnippets": [ # Optional. Search snippets included in the answer generation prompt. |
| { # Search snippet details. |
| "documentTitle": "A String", # Title of the enclosing document. |
| "documentUri": "A String", # Uri for the document. Present if specified for the document. |
| "metadata": { # Metadata associated with the document. |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", # Text included in the prompt. |
| }, |
| ], |
| }, |
| }, |
| "displayName": "A String", # Output only. The display name of the tool. |
| "inputActionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { # Optional. A list of output parameters generated by the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`. |
| "webhookToolTrace": { # The tracing information for the webhook tool. # Optional. Webhook tool trace. |
| "webhookTag": "A String", # Optional. The tag of the webhook. |
| "webhookUri": "A String", # Optional. The url of the webhook. |
| }, |
| }, |
| "tts": { # Stores metadata of the Text-to-Speech action. # Optional. Text-to-speech action performed by the agent. |
| }, |
| "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer. |
| "audio": "A String", # Optional. Audio input. |
| "audioTokens": [ # Optional. Tokens of the audio input. |
| 42, |
| ], |
| "text": "A String", # Required. Message content in text. |
| }, |
| }, |
| ], |
| "conversationState": "A String", # Required. Example's output state. |
| "createTime": "A String", # Output only. The timestamp of initial example creation. |
| "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200. |
| "displayName": "A String", # Required. The display name of the example. |
| "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents. |
| "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. |
| "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example. |
| "actionParameters": { # Optional. A list of input parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. |
| }, |
| "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example. |
| "actionParameters": { # Optional. A Struct object of output parameters for the action. |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. |
| "state": "A String", # End state of the playbook. |
| }, |
| "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM. |
| "updateTime": "A String", # Output only. Last time the example was updated. |
| }</pre> |
| </div> |
| |
| </body></html> |
