File: dialogflow_v3beta1.projects.locations.agents.playbooks.examples.html

package info (click to toggle)
python-googleapi 2.180.0-1
links: PTS
area: main
in suites: forky, sid
size: 527,124 kB
sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (1597 lines) | stat: -rw-r--r-- 124,757 bytes
<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.
  &quot;actions&quot;: [ # 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.
      &quot;agentUtterance&quot;: { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
        &quot;requireGeneration&quot;: 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.
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
      &quot;completeTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the completion of the agent action.
      &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the action.
      &quot;event&quot;: { # Event represents the event sent by the customer. # Optional. The agent received an event from the customer or a system event is emitted.
        &quot;event&quot;: &quot;A String&quot;, # Required. Name of the event.
        &quot;text&quot;: &quot;A String&quot;, # Optional. Unstructured text payload of the event.
      },
      &quot;flowInvocation&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
        &quot;flowState&quot;: &quot;A String&quot;, # Required. Flow invocation&#x27;s output state.
        &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the flow.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the flow invocation.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
      },
      &quot;flowStateUpdate&quot;: { # Stores metadata of the state update action, such as a state machine execution in flows. # Optional. Output only. The state machine update in flows.
        &quot;destination&quot;: &quot;A String&quot;, # The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`.
        &quot;eventType&quot;: &quot;A String&quot;, # The type of the event that triggered the state update.
        &quot;functionCall&quot;: { # Stores the metadata of a function call to execute. # The function call to execute.
          &quot;name&quot;: &quot;A String&quot;, # The name of the function call.
        },
        &quot;pageState&quot;: { # Stores the state of a page and its flow. # The updated page and flow state.
          &quot;displayName&quot;: &quot;A String&quot;, # The display name of the page.
          &quot;page&quot;: &quot;A String&quot;, # The ID of the page. Format: `projects//locations//agents//flows//pages/`.
          &quot;status&quot;: &quot;A String&quot;, # The status of the page.
        },
        &quot;updatedParameters&quot;: { # The updated parameters.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
      },
      &quot;flowTransition&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
        &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
      },
      &quot;intentMatch&quot;: { # Stores metadata of the intent match action. # Optional. Output only. Intent Match in flows.
        &quot;matchedIntents&quot;: [ # The matched intent.
          { # Stores the matched intent, which is the result of the intent match action.
            &quot;displayName&quot;: &quot;A String&quot;, # The display name of the matched intent.
            &quot;generativeFallback&quot;: { # The generative fallback response of the matched intent.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;intentId&quot;: &quot;A String&quot;, # The ID of the matched intent.
            &quot;score&quot;: 3.14, # The score of the matched intent.
          },
        ],
      },
      &quot;llmCall&quot;: { # Stores metadata of the call of an LLM. # Optional. Output only. LLM call performed by the agent.
        &quot;model&quot;: &quot;A String&quot;, # The model of the LLM call.
        &quot;retrievedExamples&quot;: [ # A list of relevant examples used for the LLM prompt.
          { # Relevant example used for the LLM prompt.
            &quot;exampleDisplayName&quot;: &quot;A String&quot;, # The display name of the example.
            &quot;exampleId&quot;: &quot;A String&quot;, # The id of the example.
            &quot;matchedRetrievalLabel&quot;: &quot;A String&quot;, # Optional. The matched retrieval label of this LLM call.
            &quot;retrievalStrategy&quot;: &quot;A String&quot;, # Retrieval strategy of the example.
          },
        ],
        &quot;temperature&quot;: 3.14, # The temperature of the LLM call.
        &quot;tokenCount&quot;: { # Stores token counts of the LLM call. # The token counts of the LLM call.
          &quot;conversationContextTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the conversation history in the prompt.
          &quot;exampleTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the retrieved examples in the prompt.
          &quot;totalInputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the input to the LLM call.
          &quot;totalOutputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the output of the LLM call.
        },
      },
      &quot;playbookInvocation&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
        &quot;playbookInput&quot;: { # Input of the playbook. # Optional. Input of the child playbook invocation.
          &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
          },
          &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
        },
        &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. Output of the child playbook invocation.
          &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
          },
          &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
          &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
        },
        &quot;playbookState&quot;: &quot;A String&quot;, # Required. Playbook invocation&#x27;s output state.
      },
      &quot;playbookTransition&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
      },
      &quot;startTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the start of the agent action.
      &quot;status&quot;: { # The status of the action. # Optional. Output only. The status of the action.
        &quot;exception&quot;: { # Exception thrown during the execution of an action. # Optional. The exception thrown during the execution of the action.
          &quot;errorMessage&quot;: &quot;A String&quot;, # Optional. The error message.
        },
      },
      &quot;stt&quot;: { # Stores metadata of the Speech-to-Text action. # Optional. Speech-to-text action performed by the agent.
      },
      &quot;subExecutionSteps&quot;: [ # Optional. The detailed tracing information for sub execution steps of the action.
        { # A span represents a sub execution step of an action.
          &quot;completeTime&quot;: &quot;A String&quot;, # Timestamp of the completion of the span.
          &quot;metrics&quot;: [ # The unordered collection of metrics in this span.
            { # A named metric is a metric with name, value and unit.
              &quot;name&quot;: &quot;A String&quot;, # The name of the metric.
              &quot;unit&quot;: &quot;A String&quot;, # The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard.
              &quot;value&quot;: &quot;&quot;, # The value of the metric.
            },
          ],
          &quot;name&quot;: &quot;A String&quot;, # The name of the span.
          &quot;startTime&quot;: &quot;A String&quot;, # Timestamp of the start of the span.
          &quot;tags&quot;: [ # The metadata tags of the span such as span type.
            &quot;A String&quot;,
          ],
        },
      ],
      &quot;toolUse&quot;: { # 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.
        &quot;action&quot;: &quot;A String&quot;, # Optional. Name of the action to be called during the tool use.
        &quot;dataStoreToolTrace&quot;: { # The tracing information for the data store tool. # Optional. Data store tool trace.
          &quot;dataStoreConnectionSignals&quot;: { # 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.
            &quot;answer&quot;: &quot;A String&quot;, # Optional. The final compiled answer.
            &quot;answerGenerationModelCallSignals&quot;: { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call.
              &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
              &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
              &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
            },
            &quot;answerParts&quot;: [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces).
              { # Answer part with citation.
                &quot;supportingIndices&quot;: [ # Citations for this answer part. Indices of `search_snippets`.
                  42,
                ],
                &quot;text&quot;: &quot;A String&quot;, # Substring of the answer.
              },
            ],
            &quot;citedSnippets&quot;: [ # Optional. Snippets cited by the answer generation model from the most to least relevant.
              { # Snippet cited by the answer generation model.
                &quot;searchSnippet&quot;: { # Search snippet details. # Details of the snippet.
                  &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                  &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                  &quot;metadata&quot;: { # Metadata associated with the document.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                  &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
                },
                &quot;snippetIndex&quot;: 42, # Index of the snippet in `search_snippets` field.
              },
            ],
            &quot;groundingSignals&quot;: { # Grounding signals. # Optional. Grounding signals.
              &quot;decision&quot;: &quot;A String&quot;, # Represents the decision of the grounding check.
              &quot;score&quot;: &quot;A String&quot;, # Grounding score bucket setting.
            },
            &quot;rewriterModelCallSignals&quot;: { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call.
              &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
              &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
              &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
            },
            &quot;rewrittenQuery&quot;: &quot;A String&quot;, # Optional. Rewritten string query used for search.
            &quot;safetySignals&quot;: { # Safety check results. # Optional. Safety check result.
              &quot;bannedPhraseMatch&quot;: &quot;A String&quot;, # Specifies banned phrase match subject.
              &quot;decision&quot;: &quot;A String&quot;, # Safety decision.
              &quot;matchedBannedPhrase&quot;: &quot;A String&quot;, # The matched banned phrase if there was a match.
            },
            &quot;searchSnippets&quot;: [ # Optional. Search snippets included in the answer generation prompt.
              { # Search snippet details.
                &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                &quot;metadata&quot;: { # Metadata associated with the document.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
              },
            ],
          },
        },
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool.
        &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;tool&quot;: &quot;A String&quot;, # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
        &quot;webhookToolTrace&quot;: { # The tracing information for the webhook tool. # Optional. Webhook tool trace.
          &quot;webhookTag&quot;: &quot;A String&quot;, # Optional. The tag of the webhook.
          &quot;webhookUri&quot;: &quot;A String&quot;, # Optional. The url of the webhook.
        },
      },
      &quot;tts&quot;: { # Stores metadata of the Text-to-Speech action. # Optional. Text-to-speech action performed by the agent.
      },
      &quot;userUtterance&quot;: { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
        &quot;audio&quot;: &quot;A String&quot;, # Optional. Audio input.
        &quot;audioTokens&quot;: [ # Optional. Tokens of the audio input.
          42,
        ],
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
    },
  ],
  &quot;conversationState&quot;: &quot;A String&quot;, # Required. Example&#x27;s output state.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial example creation.
  &quot;description&quot;: &quot;A String&quot;, # Optional. The high level concise description of the example. The max number of characters is 200.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the example.
  &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code of the example. If not specified, the agent&#x27;s default language is used. Note: languages must be enabled in the agent before they can be used. Note: example&#x27;s language code is not currently used in dialogflow agents.
  &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
  &quot;playbookInput&quot;: { # Input of the playbook. # Optional. The input to the playbook in the example.
    &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
    },
    &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
  },
  &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. The output of the playbook in the example.
    &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
    },
    &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
    &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
  },
  &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current example takes when sent to the LLM.
  &quot;updateTime&quot;: &quot;A String&quot;, # 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.
  &quot;actions&quot;: [ # 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.
      &quot;agentUtterance&quot;: { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
        &quot;requireGeneration&quot;: 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.
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
      &quot;completeTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the completion of the agent action.
      &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the action.
      &quot;event&quot;: { # Event represents the event sent by the customer. # Optional. The agent received an event from the customer or a system event is emitted.
        &quot;event&quot;: &quot;A String&quot;, # Required. Name of the event.
        &quot;text&quot;: &quot;A String&quot;, # Optional. Unstructured text payload of the event.
      },
      &quot;flowInvocation&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
        &quot;flowState&quot;: &quot;A String&quot;, # Required. Flow invocation&#x27;s output state.
        &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the flow.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the flow invocation.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
      },
      &quot;flowStateUpdate&quot;: { # Stores metadata of the state update action, such as a state machine execution in flows. # Optional. Output only. The state machine update in flows.
        &quot;destination&quot;: &quot;A String&quot;, # The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`.
        &quot;eventType&quot;: &quot;A String&quot;, # The type of the event that triggered the state update.
        &quot;functionCall&quot;: { # Stores the metadata of a function call to execute. # The function call to execute.
          &quot;name&quot;: &quot;A String&quot;, # The name of the function call.
        },
        &quot;pageState&quot;: { # Stores the state of a page and its flow. # The updated page and flow state.
          &quot;displayName&quot;: &quot;A String&quot;, # The display name of the page.
          &quot;page&quot;: &quot;A String&quot;, # The ID of the page. Format: `projects//locations//agents//flows//pages/`.
          &quot;status&quot;: &quot;A String&quot;, # The status of the page.
        },
        &quot;updatedParameters&quot;: { # The updated parameters.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
      },
      &quot;flowTransition&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
        &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
      },
      &quot;intentMatch&quot;: { # Stores metadata of the intent match action. # Optional. Output only. Intent Match in flows.
        &quot;matchedIntents&quot;: [ # The matched intent.
          { # Stores the matched intent, which is the result of the intent match action.
            &quot;displayName&quot;: &quot;A String&quot;, # The display name of the matched intent.
            &quot;generativeFallback&quot;: { # The generative fallback response of the matched intent.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;intentId&quot;: &quot;A String&quot;, # The ID of the matched intent.
            &quot;score&quot;: 3.14, # The score of the matched intent.
          },
        ],
      },
      &quot;llmCall&quot;: { # Stores metadata of the call of an LLM. # Optional. Output only. LLM call performed by the agent.
        &quot;model&quot;: &quot;A String&quot;, # The model of the LLM call.
        &quot;retrievedExamples&quot;: [ # A list of relevant examples used for the LLM prompt.
          { # Relevant example used for the LLM prompt.
            &quot;exampleDisplayName&quot;: &quot;A String&quot;, # The display name of the example.
            &quot;exampleId&quot;: &quot;A String&quot;, # The id of the example.
            &quot;matchedRetrievalLabel&quot;: &quot;A String&quot;, # Optional. The matched retrieval label of this LLM call.
            &quot;retrievalStrategy&quot;: &quot;A String&quot;, # Retrieval strategy of the example.
          },
        ],
        &quot;temperature&quot;: 3.14, # The temperature of the LLM call.
        &quot;tokenCount&quot;: { # Stores token counts of the LLM call. # The token counts of the LLM call.
          &quot;conversationContextTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the conversation history in the prompt.
          &quot;exampleTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the retrieved examples in the prompt.
          &quot;totalInputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the input to the LLM call.
          &quot;totalOutputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the output of the LLM call.
        },
      },
      &quot;playbookInvocation&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
        &quot;playbookInput&quot;: { # Input of the playbook. # Optional. Input of the child playbook invocation.
          &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
          },
          &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
        },
        &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. Output of the child playbook invocation.
          &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
          },
          &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
          &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
        },
        &quot;playbookState&quot;: &quot;A String&quot;, # Required. Playbook invocation&#x27;s output state.
      },
      &quot;playbookTransition&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
      },
      &quot;startTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the start of the agent action.
      &quot;status&quot;: { # The status of the action. # Optional. Output only. The status of the action.
        &quot;exception&quot;: { # Exception thrown during the execution of an action. # Optional. The exception thrown during the execution of the action.
          &quot;errorMessage&quot;: &quot;A String&quot;, # Optional. The error message.
        },
      },
      &quot;stt&quot;: { # Stores metadata of the Speech-to-Text action. # Optional. Speech-to-text action performed by the agent.
      },
      &quot;subExecutionSteps&quot;: [ # Optional. The detailed tracing information for sub execution steps of the action.
        { # A span represents a sub execution step of an action.
          &quot;completeTime&quot;: &quot;A String&quot;, # Timestamp of the completion of the span.
          &quot;metrics&quot;: [ # The unordered collection of metrics in this span.
            { # A named metric is a metric with name, value and unit.
              &quot;name&quot;: &quot;A String&quot;, # The name of the metric.
              &quot;unit&quot;: &quot;A String&quot;, # The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard.
              &quot;value&quot;: &quot;&quot;, # The value of the metric.
            },
          ],
          &quot;name&quot;: &quot;A String&quot;, # The name of the span.
          &quot;startTime&quot;: &quot;A String&quot;, # Timestamp of the start of the span.
          &quot;tags&quot;: [ # The metadata tags of the span such as span type.
            &quot;A String&quot;,
          ],
        },
      ],
      &quot;toolUse&quot;: { # 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.
        &quot;action&quot;: &quot;A String&quot;, # Optional. Name of the action to be called during the tool use.
        &quot;dataStoreToolTrace&quot;: { # The tracing information for the data store tool. # Optional. Data store tool trace.
          &quot;dataStoreConnectionSignals&quot;: { # 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.
            &quot;answer&quot;: &quot;A String&quot;, # Optional. The final compiled answer.
            &quot;answerGenerationModelCallSignals&quot;: { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call.
              &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
              &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
              &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
            },
            &quot;answerParts&quot;: [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces).
              { # Answer part with citation.
                &quot;supportingIndices&quot;: [ # Citations for this answer part. Indices of `search_snippets`.
                  42,
                ],
                &quot;text&quot;: &quot;A String&quot;, # Substring of the answer.
              },
            ],
            &quot;citedSnippets&quot;: [ # Optional. Snippets cited by the answer generation model from the most to least relevant.
              { # Snippet cited by the answer generation model.
                &quot;searchSnippet&quot;: { # Search snippet details. # Details of the snippet.
                  &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                  &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                  &quot;metadata&quot;: { # Metadata associated with the document.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                  &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
                },
                &quot;snippetIndex&quot;: 42, # Index of the snippet in `search_snippets` field.
              },
            ],
            &quot;groundingSignals&quot;: { # Grounding signals. # Optional. Grounding signals.
              &quot;decision&quot;: &quot;A String&quot;, # Represents the decision of the grounding check.
              &quot;score&quot;: &quot;A String&quot;, # Grounding score bucket setting.
            },
            &quot;rewriterModelCallSignals&quot;: { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call.
              &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
              &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
              &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
            },
            &quot;rewrittenQuery&quot;: &quot;A String&quot;, # Optional. Rewritten string query used for search.
            &quot;safetySignals&quot;: { # Safety check results. # Optional. Safety check result.
              &quot;bannedPhraseMatch&quot;: &quot;A String&quot;, # Specifies banned phrase match subject.
              &quot;decision&quot;: &quot;A String&quot;, # Safety decision.
              &quot;matchedBannedPhrase&quot;: &quot;A String&quot;, # The matched banned phrase if there was a match.
            },
            &quot;searchSnippets&quot;: [ # Optional. Search snippets included in the answer generation prompt.
              { # Search snippet details.
                &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                &quot;metadata&quot;: { # Metadata associated with the document.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
              },
            ],
          },
        },
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool.
        &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;tool&quot;: &quot;A String&quot;, # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
        &quot;webhookToolTrace&quot;: { # The tracing information for the webhook tool. # Optional. Webhook tool trace.
          &quot;webhookTag&quot;: &quot;A String&quot;, # Optional. The tag of the webhook.
          &quot;webhookUri&quot;: &quot;A String&quot;, # Optional. The url of the webhook.
        },
      },
      &quot;tts&quot;: { # Stores metadata of the Text-to-Speech action. # Optional. Text-to-speech action performed by the agent.
      },
      &quot;userUtterance&quot;: { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
        &quot;audio&quot;: &quot;A String&quot;, # Optional. Audio input.
        &quot;audioTokens&quot;: [ # Optional. Tokens of the audio input.
          42,
        ],
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
    },
  ],
  &quot;conversationState&quot;: &quot;A String&quot;, # Required. Example&#x27;s output state.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial example creation.
  &quot;description&quot;: &quot;A String&quot;, # Optional. The high level concise description of the example. The max number of characters is 200.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the example.
  &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code of the example. If not specified, the agent&#x27;s default language is used. Note: languages must be enabled in the agent before they can be used. Note: example&#x27;s language code is not currently used in dialogflow agents.
  &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
  &quot;playbookInput&quot;: { # Input of the playbook. # Optional. The input to the playbook in the example.
    &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
    },
    &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
  },
  &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. The output of the playbook in the example.
    &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
    },
    &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
    &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
  },
  &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current example takes when sent to the LLM.
  &quot;updateTime&quot;: &quot;A String&quot;, # 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.
  &quot;actions&quot;: [ # 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.
      &quot;agentUtterance&quot;: { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
        &quot;requireGeneration&quot;: 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.
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
      &quot;completeTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the completion of the agent action.
      &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the action.
      &quot;event&quot;: { # Event represents the event sent by the customer. # Optional. The agent received an event from the customer or a system event is emitted.
        &quot;event&quot;: &quot;A String&quot;, # Required. Name of the event.
        &quot;text&quot;: &quot;A String&quot;, # Optional. Unstructured text payload of the event.
      },
      &quot;flowInvocation&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
        &quot;flowState&quot;: &quot;A String&quot;, # Required. Flow invocation&#x27;s output state.
        &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the flow.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the flow invocation.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
      },
      &quot;flowStateUpdate&quot;: { # Stores metadata of the state update action, such as a state machine execution in flows. # Optional. Output only. The state machine update in flows.
        &quot;destination&quot;: &quot;A String&quot;, # The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`.
        &quot;eventType&quot;: &quot;A String&quot;, # The type of the event that triggered the state update.
        &quot;functionCall&quot;: { # Stores the metadata of a function call to execute. # The function call to execute.
          &quot;name&quot;: &quot;A String&quot;, # The name of the function call.
        },
        &quot;pageState&quot;: { # Stores the state of a page and its flow. # The updated page and flow state.
          &quot;displayName&quot;: &quot;A String&quot;, # The display name of the page.
          &quot;page&quot;: &quot;A String&quot;, # The ID of the page. Format: `projects//locations//agents//flows//pages/`.
          &quot;status&quot;: &quot;A String&quot;, # The status of the page.
        },
        &quot;updatedParameters&quot;: { # The updated parameters.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
      },
      &quot;flowTransition&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
        &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
      },
      &quot;intentMatch&quot;: { # Stores metadata of the intent match action. # Optional. Output only. Intent Match in flows.
        &quot;matchedIntents&quot;: [ # The matched intent.
          { # Stores the matched intent, which is the result of the intent match action.
            &quot;displayName&quot;: &quot;A String&quot;, # The display name of the matched intent.
            &quot;generativeFallback&quot;: { # The generative fallback response of the matched intent.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;intentId&quot;: &quot;A String&quot;, # The ID of the matched intent.
            &quot;score&quot;: 3.14, # The score of the matched intent.
          },
        ],
      },
      &quot;llmCall&quot;: { # Stores metadata of the call of an LLM. # Optional. Output only. LLM call performed by the agent.
        &quot;model&quot;: &quot;A String&quot;, # The model of the LLM call.
        &quot;retrievedExamples&quot;: [ # A list of relevant examples used for the LLM prompt.
          { # Relevant example used for the LLM prompt.
            &quot;exampleDisplayName&quot;: &quot;A String&quot;, # The display name of the example.
            &quot;exampleId&quot;: &quot;A String&quot;, # The id of the example.
            &quot;matchedRetrievalLabel&quot;: &quot;A String&quot;, # Optional. The matched retrieval label of this LLM call.
            &quot;retrievalStrategy&quot;: &quot;A String&quot;, # Retrieval strategy of the example.
          },
        ],
        &quot;temperature&quot;: 3.14, # The temperature of the LLM call.
        &quot;tokenCount&quot;: { # Stores token counts of the LLM call. # The token counts of the LLM call.
          &quot;conversationContextTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the conversation history in the prompt.
          &quot;exampleTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the retrieved examples in the prompt.
          &quot;totalInputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the input to the LLM call.
          &quot;totalOutputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the output of the LLM call.
        },
      },
      &quot;playbookInvocation&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
        &quot;playbookInput&quot;: { # Input of the playbook. # Optional. Input of the child playbook invocation.
          &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
          },
          &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
        },
        &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. Output of the child playbook invocation.
          &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
          },
          &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
          &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
        },
        &quot;playbookState&quot;: &quot;A String&quot;, # Required. Playbook invocation&#x27;s output state.
      },
      &quot;playbookTransition&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
      },
      &quot;startTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the start of the agent action.
      &quot;status&quot;: { # The status of the action. # Optional. Output only. The status of the action.
        &quot;exception&quot;: { # Exception thrown during the execution of an action. # Optional. The exception thrown during the execution of the action.
          &quot;errorMessage&quot;: &quot;A String&quot;, # Optional. The error message.
        },
      },
      &quot;stt&quot;: { # Stores metadata of the Speech-to-Text action. # Optional. Speech-to-text action performed by the agent.
      },
      &quot;subExecutionSteps&quot;: [ # Optional. The detailed tracing information for sub execution steps of the action.
        { # A span represents a sub execution step of an action.
          &quot;completeTime&quot;: &quot;A String&quot;, # Timestamp of the completion of the span.
          &quot;metrics&quot;: [ # The unordered collection of metrics in this span.
            { # A named metric is a metric with name, value and unit.
              &quot;name&quot;: &quot;A String&quot;, # The name of the metric.
              &quot;unit&quot;: &quot;A String&quot;, # The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard.
              &quot;value&quot;: &quot;&quot;, # The value of the metric.
            },
          ],
          &quot;name&quot;: &quot;A String&quot;, # The name of the span.
          &quot;startTime&quot;: &quot;A String&quot;, # Timestamp of the start of the span.
          &quot;tags&quot;: [ # The metadata tags of the span such as span type.
            &quot;A String&quot;,
          ],
        },
      ],
      &quot;toolUse&quot;: { # 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.
        &quot;action&quot;: &quot;A String&quot;, # Optional. Name of the action to be called during the tool use.
        &quot;dataStoreToolTrace&quot;: { # The tracing information for the data store tool. # Optional. Data store tool trace.
          &quot;dataStoreConnectionSignals&quot;: { # 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.
            &quot;answer&quot;: &quot;A String&quot;, # Optional. The final compiled answer.
            &quot;answerGenerationModelCallSignals&quot;: { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call.
              &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
              &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
              &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
            },
            &quot;answerParts&quot;: [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces).
              { # Answer part with citation.
                &quot;supportingIndices&quot;: [ # Citations for this answer part. Indices of `search_snippets`.
                  42,
                ],
                &quot;text&quot;: &quot;A String&quot;, # Substring of the answer.
              },
            ],
            &quot;citedSnippets&quot;: [ # Optional. Snippets cited by the answer generation model from the most to least relevant.
              { # Snippet cited by the answer generation model.
                &quot;searchSnippet&quot;: { # Search snippet details. # Details of the snippet.
                  &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                  &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                  &quot;metadata&quot;: { # Metadata associated with the document.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                  &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
                },
                &quot;snippetIndex&quot;: 42, # Index of the snippet in `search_snippets` field.
              },
            ],
            &quot;groundingSignals&quot;: { # Grounding signals. # Optional. Grounding signals.
              &quot;decision&quot;: &quot;A String&quot;, # Represents the decision of the grounding check.
              &quot;score&quot;: &quot;A String&quot;, # Grounding score bucket setting.
            },
            &quot;rewriterModelCallSignals&quot;: { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call.
              &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
              &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
              &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
            },
            &quot;rewrittenQuery&quot;: &quot;A String&quot;, # Optional. Rewritten string query used for search.
            &quot;safetySignals&quot;: { # Safety check results. # Optional. Safety check result.
              &quot;bannedPhraseMatch&quot;: &quot;A String&quot;, # Specifies banned phrase match subject.
              &quot;decision&quot;: &quot;A String&quot;, # Safety decision.
              &quot;matchedBannedPhrase&quot;: &quot;A String&quot;, # The matched banned phrase if there was a match.
            },
            &quot;searchSnippets&quot;: [ # Optional. Search snippets included in the answer generation prompt.
              { # Search snippet details.
                &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                &quot;metadata&quot;: { # Metadata associated with the document.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
              },
            ],
          },
        },
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool.
        &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;tool&quot;: &quot;A String&quot;, # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
        &quot;webhookToolTrace&quot;: { # The tracing information for the webhook tool. # Optional. Webhook tool trace.
          &quot;webhookTag&quot;: &quot;A String&quot;, # Optional. The tag of the webhook.
          &quot;webhookUri&quot;: &quot;A String&quot;, # Optional. The url of the webhook.
        },
      },
      &quot;tts&quot;: { # Stores metadata of the Text-to-Speech action. # Optional. Text-to-speech action performed by the agent.
      },
      &quot;userUtterance&quot;: { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
        &quot;audio&quot;: &quot;A String&quot;, # Optional. Audio input.
        &quot;audioTokens&quot;: [ # Optional. Tokens of the audio input.
          42,
        ],
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
    },
  ],
  &quot;conversationState&quot;: &quot;A String&quot;, # Required. Example&#x27;s output state.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial example creation.
  &quot;description&quot;: &quot;A String&quot;, # Optional. The high level concise description of the example. The max number of characters is 200.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the example.
  &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code of the example. If not specified, the agent&#x27;s default language is used. Note: languages must be enabled in the agent before they can be used. Note: example&#x27;s language code is not currently used in dialogflow agents.
  &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
  &quot;playbookInput&quot;: { # Input of the playbook. # Optional. The input to the playbook in the example.
    &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
    },
    &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
  },
  &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. The output of the playbook in the example.
    &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
    },
    &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
    &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
  },
  &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current example takes when sent to the LLM.
  &quot;updateTime&quot;: &quot;A String&quot;, # 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.
  &quot;examples&quot;: [ # 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.
      &quot;actions&quot;: [ # 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.
          &quot;agentUtterance&quot;: { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
            &quot;requireGeneration&quot;: 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.
            &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
          },
          &quot;completeTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the completion of the agent action.
          &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the action.
          &quot;event&quot;: { # Event represents the event sent by the customer. # Optional. The agent received an event from the customer or a system event is emitted.
            &quot;event&quot;: &quot;A String&quot;, # Required. Name of the event.
            &quot;text&quot;: &quot;A String&quot;, # Optional. Unstructured text payload of the event.
          },
          &quot;flowInvocation&quot;: { # 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.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
            &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
            &quot;flowState&quot;: &quot;A String&quot;, # Required. Flow invocation&#x27;s output state.
            &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the flow.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the flow invocation.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
          },
          &quot;flowStateUpdate&quot;: { # Stores metadata of the state update action, such as a state machine execution in flows. # Optional. Output only. The state machine update in flows.
            &quot;destination&quot;: &quot;A String&quot;, # The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`.
            &quot;eventType&quot;: &quot;A String&quot;, # The type of the event that triggered the state update.
            &quot;functionCall&quot;: { # Stores the metadata of a function call to execute. # The function call to execute.
              &quot;name&quot;: &quot;A String&quot;, # The name of the function call.
            },
            &quot;pageState&quot;: { # Stores the state of a page and its flow. # The updated page and flow state.
              &quot;displayName&quot;: &quot;A String&quot;, # The display name of the page.
              &quot;page&quot;: &quot;A String&quot;, # The ID of the page. Format: `projects//locations//agents//flows//pages/`.
              &quot;status&quot;: &quot;A String&quot;, # The status of the page.
            },
            &quot;updatedParameters&quot;: { # The updated parameters.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
          },
          &quot;flowTransition&quot;: { # 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.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
            &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
            &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
          },
          &quot;intentMatch&quot;: { # Stores metadata of the intent match action. # Optional. Output only. Intent Match in flows.
            &quot;matchedIntents&quot;: [ # The matched intent.
              { # Stores the matched intent, which is the result of the intent match action.
                &quot;displayName&quot;: &quot;A String&quot;, # The display name of the matched intent.
                &quot;generativeFallback&quot;: { # The generative fallback response of the matched intent.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;intentId&quot;: &quot;A String&quot;, # The ID of the matched intent.
                &quot;score&quot;: 3.14, # The score of the matched intent.
              },
            ],
          },
          &quot;llmCall&quot;: { # Stores metadata of the call of an LLM. # Optional. Output only. LLM call performed by the agent.
            &quot;model&quot;: &quot;A String&quot;, # The model of the LLM call.
            &quot;retrievedExamples&quot;: [ # A list of relevant examples used for the LLM prompt.
              { # Relevant example used for the LLM prompt.
                &quot;exampleDisplayName&quot;: &quot;A String&quot;, # The display name of the example.
                &quot;exampleId&quot;: &quot;A String&quot;, # The id of the example.
                &quot;matchedRetrievalLabel&quot;: &quot;A String&quot;, # Optional. The matched retrieval label of this LLM call.
                &quot;retrievalStrategy&quot;: &quot;A String&quot;, # Retrieval strategy of the example.
              },
            ],
            &quot;temperature&quot;: 3.14, # The temperature of the LLM call.
            &quot;tokenCount&quot;: { # Stores token counts of the LLM call. # The token counts of the LLM call.
              &quot;conversationContextTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the conversation history in the prompt.
              &quot;exampleTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the retrieved examples in the prompt.
              &quot;totalInputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the input to the LLM call.
              &quot;totalOutputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the output of the LLM call.
            },
          },
          &quot;playbookInvocation&quot;: { # 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.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
            &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
            &quot;playbookInput&quot;: { # Input of the playbook. # Optional. Input of the child playbook invocation.
              &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
                &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
              },
              &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
            },
            &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. Output of the child playbook invocation.
              &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
                &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
              },
              &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
              &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
            },
            &quot;playbookState&quot;: &quot;A String&quot;, # Required. Playbook invocation&#x27;s output state.
          },
          &quot;playbookTransition&quot;: { # 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.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
            &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
          },
          &quot;startTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the start of the agent action.
          &quot;status&quot;: { # The status of the action. # Optional. Output only. The status of the action.
            &quot;exception&quot;: { # Exception thrown during the execution of an action. # Optional. The exception thrown during the execution of the action.
              &quot;errorMessage&quot;: &quot;A String&quot;, # Optional. The error message.
            },
          },
          &quot;stt&quot;: { # Stores metadata of the Speech-to-Text action. # Optional. Speech-to-text action performed by the agent.
          },
          &quot;subExecutionSteps&quot;: [ # Optional. The detailed tracing information for sub execution steps of the action.
            { # A span represents a sub execution step of an action.
              &quot;completeTime&quot;: &quot;A String&quot;, # Timestamp of the completion of the span.
              &quot;metrics&quot;: [ # The unordered collection of metrics in this span.
                { # A named metric is a metric with name, value and unit.
                  &quot;name&quot;: &quot;A String&quot;, # The name of the metric.
                  &quot;unit&quot;: &quot;A String&quot;, # The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard.
                  &quot;value&quot;: &quot;&quot;, # The value of the metric.
                },
              ],
              &quot;name&quot;: &quot;A String&quot;, # The name of the span.
              &quot;startTime&quot;: &quot;A String&quot;, # Timestamp of the start of the span.
              &quot;tags&quot;: [ # The metadata tags of the span such as span type.
                &quot;A String&quot;,
              ],
            },
          ],
          &quot;toolUse&quot;: { # 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.
            &quot;action&quot;: &quot;A String&quot;, # Optional. Name of the action to be called during the tool use.
            &quot;dataStoreToolTrace&quot;: { # The tracing information for the data store tool. # Optional. Data store tool trace.
              &quot;dataStoreConnectionSignals&quot;: { # 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.
                &quot;answer&quot;: &quot;A String&quot;, # Optional. The final compiled answer.
                &quot;answerGenerationModelCallSignals&quot;: { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call.
                  &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
                  &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
                  &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
                },
                &quot;answerParts&quot;: [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces).
                  { # Answer part with citation.
                    &quot;supportingIndices&quot;: [ # Citations for this answer part. Indices of `search_snippets`.
                      42,
                    ],
                    &quot;text&quot;: &quot;A String&quot;, # Substring of the answer.
                  },
                ],
                &quot;citedSnippets&quot;: [ # Optional. Snippets cited by the answer generation model from the most to least relevant.
                  { # Snippet cited by the answer generation model.
                    &quot;searchSnippet&quot;: { # Search snippet details. # Details of the snippet.
                      &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                      &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                      &quot;metadata&quot;: { # Metadata associated with the document.
                        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                      },
                      &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
                    },
                    &quot;snippetIndex&quot;: 42, # Index of the snippet in `search_snippets` field.
                  },
                ],
                &quot;groundingSignals&quot;: { # Grounding signals. # Optional. Grounding signals.
                  &quot;decision&quot;: &quot;A String&quot;, # Represents the decision of the grounding check.
                  &quot;score&quot;: &quot;A String&quot;, # Grounding score bucket setting.
                },
                &quot;rewriterModelCallSignals&quot;: { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call.
                  &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
                  &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
                  &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
                },
                &quot;rewrittenQuery&quot;: &quot;A String&quot;, # Optional. Rewritten string query used for search.
                &quot;safetySignals&quot;: { # Safety check results. # Optional. Safety check result.
                  &quot;bannedPhraseMatch&quot;: &quot;A String&quot;, # Specifies banned phrase match subject.
                  &quot;decision&quot;: &quot;A String&quot;, # Safety decision.
                  &quot;matchedBannedPhrase&quot;: &quot;A String&quot;, # The matched banned phrase if there was a match.
                },
                &quot;searchSnippets&quot;: [ # Optional. Search snippets included in the answer generation prompt.
                  { # Search snippet details.
                    &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                    &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                    &quot;metadata&quot;: { # Metadata associated with the document.
                      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                    },
                    &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
                  },
                ],
              },
            },
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool.
            &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;tool&quot;: &quot;A String&quot;, # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
            &quot;webhookToolTrace&quot;: { # The tracing information for the webhook tool. # Optional. Webhook tool trace.
              &quot;webhookTag&quot;: &quot;A String&quot;, # Optional. The tag of the webhook.
              &quot;webhookUri&quot;: &quot;A String&quot;, # Optional. The url of the webhook.
            },
          },
          &quot;tts&quot;: { # Stores metadata of the Text-to-Speech action. # Optional. Text-to-speech action performed by the agent.
          },
          &quot;userUtterance&quot;: { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
            &quot;audio&quot;: &quot;A String&quot;, # Optional. Audio input.
            &quot;audioTokens&quot;: [ # Optional. Tokens of the audio input.
              42,
            ],
            &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
          },
        },
      ],
      &quot;conversationState&quot;: &quot;A String&quot;, # Required. Example&#x27;s output state.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial example creation.
      &quot;description&quot;: &quot;A String&quot;, # Optional. The high level concise description of the example. The max number of characters is 200.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the example.
      &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code of the example. If not specified, the agent&#x27;s default language is used. Note: languages must be enabled in the agent before they can be used. Note: example&#x27;s language code is not currently used in dialogflow agents.
      &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
      &quot;playbookInput&quot;: { # Input of the playbook. # Optional. The input to the playbook in the example.
        &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
      },
      &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. The output of the playbook in the example.
        &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
        &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
      },
      &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current example takes when sent to the LLM.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the example was updated.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # 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 &#x27;execute()&#x27; 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.
  &quot;actions&quot;: [ # 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.
      &quot;agentUtterance&quot;: { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
        &quot;requireGeneration&quot;: 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.
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
      &quot;completeTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the completion of the agent action.
      &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the action.
      &quot;event&quot;: { # Event represents the event sent by the customer. # Optional. The agent received an event from the customer or a system event is emitted.
        &quot;event&quot;: &quot;A String&quot;, # Required. Name of the event.
        &quot;text&quot;: &quot;A String&quot;, # Optional. Unstructured text payload of the event.
      },
      &quot;flowInvocation&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
        &quot;flowState&quot;: &quot;A String&quot;, # Required. Flow invocation&#x27;s output state.
        &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the flow.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the flow invocation.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
      },
      &quot;flowStateUpdate&quot;: { # Stores metadata of the state update action, such as a state machine execution in flows. # Optional. Output only. The state machine update in flows.
        &quot;destination&quot;: &quot;A String&quot;, # The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`.
        &quot;eventType&quot;: &quot;A String&quot;, # The type of the event that triggered the state update.
        &quot;functionCall&quot;: { # Stores the metadata of a function call to execute. # The function call to execute.
          &quot;name&quot;: &quot;A String&quot;, # The name of the function call.
        },
        &quot;pageState&quot;: { # Stores the state of a page and its flow. # The updated page and flow state.
          &quot;displayName&quot;: &quot;A String&quot;, # The display name of the page.
          &quot;page&quot;: &quot;A String&quot;, # The ID of the page. Format: `projects//locations//agents//flows//pages/`.
          &quot;status&quot;: &quot;A String&quot;, # The status of the page.
        },
        &quot;updatedParameters&quot;: { # The updated parameters.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
      },
      &quot;flowTransition&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
        &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
      },
      &quot;intentMatch&quot;: { # Stores metadata of the intent match action. # Optional. Output only. Intent Match in flows.
        &quot;matchedIntents&quot;: [ # The matched intent.
          { # Stores the matched intent, which is the result of the intent match action.
            &quot;displayName&quot;: &quot;A String&quot;, # The display name of the matched intent.
            &quot;generativeFallback&quot;: { # The generative fallback response of the matched intent.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;intentId&quot;: &quot;A String&quot;, # The ID of the matched intent.
            &quot;score&quot;: 3.14, # The score of the matched intent.
          },
        ],
      },
      &quot;llmCall&quot;: { # Stores metadata of the call of an LLM. # Optional. Output only. LLM call performed by the agent.
        &quot;model&quot;: &quot;A String&quot;, # The model of the LLM call.
        &quot;retrievedExamples&quot;: [ # A list of relevant examples used for the LLM prompt.
          { # Relevant example used for the LLM prompt.
            &quot;exampleDisplayName&quot;: &quot;A String&quot;, # The display name of the example.
            &quot;exampleId&quot;: &quot;A String&quot;, # The id of the example.
            &quot;matchedRetrievalLabel&quot;: &quot;A String&quot;, # Optional. The matched retrieval label of this LLM call.
            &quot;retrievalStrategy&quot;: &quot;A String&quot;, # Retrieval strategy of the example.
          },
        ],
        &quot;temperature&quot;: 3.14, # The temperature of the LLM call.
        &quot;tokenCount&quot;: { # Stores token counts of the LLM call. # The token counts of the LLM call.
          &quot;conversationContextTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the conversation history in the prompt.
          &quot;exampleTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the retrieved examples in the prompt.
          &quot;totalInputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the input to the LLM call.
          &quot;totalOutputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the output of the LLM call.
        },
      },
      &quot;playbookInvocation&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
        &quot;playbookInput&quot;: { # Input of the playbook. # Optional. Input of the child playbook invocation.
          &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
          },
          &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
        },
        &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. Output of the child playbook invocation.
          &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
          },
          &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
          &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
        },
        &quot;playbookState&quot;: &quot;A String&quot;, # Required. Playbook invocation&#x27;s output state.
      },
      &quot;playbookTransition&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
      },
      &quot;startTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the start of the agent action.
      &quot;status&quot;: { # The status of the action. # Optional. Output only. The status of the action.
        &quot;exception&quot;: { # Exception thrown during the execution of an action. # Optional. The exception thrown during the execution of the action.
          &quot;errorMessage&quot;: &quot;A String&quot;, # Optional. The error message.
        },
      },
      &quot;stt&quot;: { # Stores metadata of the Speech-to-Text action. # Optional. Speech-to-text action performed by the agent.
      },
      &quot;subExecutionSteps&quot;: [ # Optional. The detailed tracing information for sub execution steps of the action.
        { # A span represents a sub execution step of an action.
          &quot;completeTime&quot;: &quot;A String&quot;, # Timestamp of the completion of the span.
          &quot;metrics&quot;: [ # The unordered collection of metrics in this span.
            { # A named metric is a metric with name, value and unit.
              &quot;name&quot;: &quot;A String&quot;, # The name of the metric.
              &quot;unit&quot;: &quot;A String&quot;, # The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard.
              &quot;value&quot;: &quot;&quot;, # The value of the metric.
            },
          ],
          &quot;name&quot;: &quot;A String&quot;, # The name of the span.
          &quot;startTime&quot;: &quot;A String&quot;, # Timestamp of the start of the span.
          &quot;tags&quot;: [ # The metadata tags of the span such as span type.
            &quot;A String&quot;,
          ],
        },
      ],
      &quot;toolUse&quot;: { # 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.
        &quot;action&quot;: &quot;A String&quot;, # Optional. Name of the action to be called during the tool use.
        &quot;dataStoreToolTrace&quot;: { # The tracing information for the data store tool. # Optional. Data store tool trace.
          &quot;dataStoreConnectionSignals&quot;: { # 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.
            &quot;answer&quot;: &quot;A String&quot;, # Optional. The final compiled answer.
            &quot;answerGenerationModelCallSignals&quot;: { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call.
              &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
              &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
              &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
            },
            &quot;answerParts&quot;: [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces).
              { # Answer part with citation.
                &quot;supportingIndices&quot;: [ # Citations for this answer part. Indices of `search_snippets`.
                  42,
                ],
                &quot;text&quot;: &quot;A String&quot;, # Substring of the answer.
              },
            ],
            &quot;citedSnippets&quot;: [ # Optional. Snippets cited by the answer generation model from the most to least relevant.
              { # Snippet cited by the answer generation model.
                &quot;searchSnippet&quot;: { # Search snippet details. # Details of the snippet.
                  &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                  &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                  &quot;metadata&quot;: { # Metadata associated with the document.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                  &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
                },
                &quot;snippetIndex&quot;: 42, # Index of the snippet in `search_snippets` field.
              },
            ],
            &quot;groundingSignals&quot;: { # Grounding signals. # Optional. Grounding signals.
              &quot;decision&quot;: &quot;A String&quot;, # Represents the decision of the grounding check.
              &quot;score&quot;: &quot;A String&quot;, # Grounding score bucket setting.
            },
            &quot;rewriterModelCallSignals&quot;: { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call.
              &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
              &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
              &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
            },
            &quot;rewrittenQuery&quot;: &quot;A String&quot;, # Optional. Rewritten string query used for search.
            &quot;safetySignals&quot;: { # Safety check results. # Optional. Safety check result.
              &quot;bannedPhraseMatch&quot;: &quot;A String&quot;, # Specifies banned phrase match subject.
              &quot;decision&quot;: &quot;A String&quot;, # Safety decision.
              &quot;matchedBannedPhrase&quot;: &quot;A String&quot;, # The matched banned phrase if there was a match.
            },
            &quot;searchSnippets&quot;: [ # Optional. Search snippets included in the answer generation prompt.
              { # Search snippet details.
                &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                &quot;metadata&quot;: { # Metadata associated with the document.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
              },
            ],
          },
        },
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool.
        &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;tool&quot;: &quot;A String&quot;, # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
        &quot;webhookToolTrace&quot;: { # The tracing information for the webhook tool. # Optional. Webhook tool trace.
          &quot;webhookTag&quot;: &quot;A String&quot;, # Optional. The tag of the webhook.
          &quot;webhookUri&quot;: &quot;A String&quot;, # Optional. The url of the webhook.
        },
      },
      &quot;tts&quot;: { # Stores metadata of the Text-to-Speech action. # Optional. Text-to-speech action performed by the agent.
      },
      &quot;userUtterance&quot;: { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
        &quot;audio&quot;: &quot;A String&quot;, # Optional. Audio input.
        &quot;audioTokens&quot;: [ # Optional. Tokens of the audio input.
          42,
        ],
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
    },
  ],
  &quot;conversationState&quot;: &quot;A String&quot;, # Required. Example&#x27;s output state.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial example creation.
  &quot;description&quot;: &quot;A String&quot;, # Optional. The high level concise description of the example. The max number of characters is 200.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the example.
  &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code of the example. If not specified, the agent&#x27;s default language is used. Note: languages must be enabled in the agent before they can be used. Note: example&#x27;s language code is not currently used in dialogflow agents.
  &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
  &quot;playbookInput&quot;: { # Input of the playbook. # Optional. The input to the playbook in the example.
    &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
    },
    &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
  },
  &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. The output of the playbook in the example.
    &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
    },
    &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
    &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
  },
  &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current example takes when sent to the LLM.
  &quot;updateTime&quot;: &quot;A String&quot;, # 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.
  &quot;actions&quot;: [ # 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.
      &quot;agentUtterance&quot;: { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
        &quot;requireGeneration&quot;: 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.
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
      &quot;completeTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the completion of the agent action.
      &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the action.
      &quot;event&quot;: { # Event represents the event sent by the customer. # Optional. The agent received an event from the customer or a system event is emitted.
        &quot;event&quot;: &quot;A String&quot;, # Required. Name of the event.
        &quot;text&quot;: &quot;A String&quot;, # Optional. Unstructured text payload of the event.
      },
      &quot;flowInvocation&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
        &quot;flowState&quot;: &quot;A String&quot;, # Required. Flow invocation&#x27;s output state.
        &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the flow.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the flow invocation.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
      },
      &quot;flowStateUpdate&quot;: { # Stores metadata of the state update action, such as a state machine execution in flows. # Optional. Output only. The state machine update in flows.
        &quot;destination&quot;: &quot;A String&quot;, # The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`.
        &quot;eventType&quot;: &quot;A String&quot;, # The type of the event that triggered the state update.
        &quot;functionCall&quot;: { # Stores the metadata of a function call to execute. # The function call to execute.
          &quot;name&quot;: &quot;A String&quot;, # The name of the function call.
        },
        &quot;pageState&quot;: { # Stores the state of a page and its flow. # The updated page and flow state.
          &quot;displayName&quot;: &quot;A String&quot;, # The display name of the page.
          &quot;page&quot;: &quot;A String&quot;, # The ID of the page. Format: `projects//locations//agents//flows//pages/`.
          &quot;status&quot;: &quot;A String&quot;, # The status of the page.
        },
        &quot;updatedParameters&quot;: { # The updated parameters.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
      },
      &quot;flowTransition&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
        &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
      },
      &quot;intentMatch&quot;: { # Stores metadata of the intent match action. # Optional. Output only. Intent Match in flows.
        &quot;matchedIntents&quot;: [ # The matched intent.
          { # Stores the matched intent, which is the result of the intent match action.
            &quot;displayName&quot;: &quot;A String&quot;, # The display name of the matched intent.
            &quot;generativeFallback&quot;: { # The generative fallback response of the matched intent.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;intentId&quot;: &quot;A String&quot;, # The ID of the matched intent.
            &quot;score&quot;: 3.14, # The score of the matched intent.
          },
        ],
      },
      &quot;llmCall&quot;: { # Stores metadata of the call of an LLM. # Optional. Output only. LLM call performed by the agent.
        &quot;model&quot;: &quot;A String&quot;, # The model of the LLM call.
        &quot;retrievedExamples&quot;: [ # A list of relevant examples used for the LLM prompt.
          { # Relevant example used for the LLM prompt.
            &quot;exampleDisplayName&quot;: &quot;A String&quot;, # The display name of the example.
            &quot;exampleId&quot;: &quot;A String&quot;, # The id of the example.
            &quot;matchedRetrievalLabel&quot;: &quot;A String&quot;, # Optional. The matched retrieval label of this LLM call.
            &quot;retrievalStrategy&quot;: &quot;A String&quot;, # Retrieval strategy of the example.
          },
        ],
        &quot;temperature&quot;: 3.14, # The temperature of the LLM call.
        &quot;tokenCount&quot;: { # Stores token counts of the LLM call. # The token counts of the LLM call.
          &quot;conversationContextTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the conversation history in the prompt.
          &quot;exampleTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the retrieved examples in the prompt.
          &quot;totalInputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the input to the LLM call.
          &quot;totalOutputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the output of the LLM call.
        },
      },
      &quot;playbookInvocation&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
        &quot;playbookInput&quot;: { # Input of the playbook. # Optional. Input of the child playbook invocation.
          &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
          },
          &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
        },
        &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. Output of the child playbook invocation.
          &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
          },
          &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
          &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
        },
        &quot;playbookState&quot;: &quot;A String&quot;, # Required. Playbook invocation&#x27;s output state.
      },
      &quot;playbookTransition&quot;: { # 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.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
      },
      &quot;startTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the start of the agent action.
      &quot;status&quot;: { # The status of the action. # Optional. Output only. The status of the action.
        &quot;exception&quot;: { # Exception thrown during the execution of an action. # Optional. The exception thrown during the execution of the action.
          &quot;errorMessage&quot;: &quot;A String&quot;, # Optional. The error message.
        },
      },
      &quot;stt&quot;: { # Stores metadata of the Speech-to-Text action. # Optional. Speech-to-text action performed by the agent.
      },
      &quot;subExecutionSteps&quot;: [ # Optional. The detailed tracing information for sub execution steps of the action.
        { # A span represents a sub execution step of an action.
          &quot;completeTime&quot;: &quot;A String&quot;, # Timestamp of the completion of the span.
          &quot;metrics&quot;: [ # The unordered collection of metrics in this span.
            { # A named metric is a metric with name, value and unit.
              &quot;name&quot;: &quot;A String&quot;, # The name of the metric.
              &quot;unit&quot;: &quot;A String&quot;, # The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard.
              &quot;value&quot;: &quot;&quot;, # The value of the metric.
            },
          ],
          &quot;name&quot;: &quot;A String&quot;, # The name of the span.
          &quot;startTime&quot;: &quot;A String&quot;, # Timestamp of the start of the span.
          &quot;tags&quot;: [ # The metadata tags of the span such as span type.
            &quot;A String&quot;,
          ],
        },
      ],
      &quot;toolUse&quot;: { # 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.
        &quot;action&quot;: &quot;A String&quot;, # Optional. Name of the action to be called during the tool use.
        &quot;dataStoreToolTrace&quot;: { # The tracing information for the data store tool. # Optional. Data store tool trace.
          &quot;dataStoreConnectionSignals&quot;: { # 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.
            &quot;answer&quot;: &quot;A String&quot;, # Optional. The final compiled answer.
            &quot;answerGenerationModelCallSignals&quot;: { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call.
              &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
              &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
              &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
            },
            &quot;answerParts&quot;: [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces).
              { # Answer part with citation.
                &quot;supportingIndices&quot;: [ # Citations for this answer part. Indices of `search_snippets`.
                  42,
                ],
                &quot;text&quot;: &quot;A String&quot;, # Substring of the answer.
              },
            ],
            &quot;citedSnippets&quot;: [ # Optional. Snippets cited by the answer generation model from the most to least relevant.
              { # Snippet cited by the answer generation model.
                &quot;searchSnippet&quot;: { # Search snippet details. # Details of the snippet.
                  &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                  &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                  &quot;metadata&quot;: { # Metadata associated with the document.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                  &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
                },
                &quot;snippetIndex&quot;: 42, # Index of the snippet in `search_snippets` field.
              },
            ],
            &quot;groundingSignals&quot;: { # Grounding signals. # Optional. Grounding signals.
              &quot;decision&quot;: &quot;A String&quot;, # Represents the decision of the grounding check.
              &quot;score&quot;: &quot;A String&quot;, # Grounding score bucket setting.
            },
            &quot;rewriterModelCallSignals&quot;: { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call.
              &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
              &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
              &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
            },
            &quot;rewrittenQuery&quot;: &quot;A String&quot;, # Optional. Rewritten string query used for search.
            &quot;safetySignals&quot;: { # Safety check results. # Optional. Safety check result.
              &quot;bannedPhraseMatch&quot;: &quot;A String&quot;, # Specifies banned phrase match subject.
              &quot;decision&quot;: &quot;A String&quot;, # Safety decision.
              &quot;matchedBannedPhrase&quot;: &quot;A String&quot;, # The matched banned phrase if there was a match.
            },
            &quot;searchSnippets&quot;: [ # Optional. Search snippets included in the answer generation prompt.
              { # Search snippet details.
                &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                &quot;metadata&quot;: { # Metadata associated with the document.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
              },
            ],
          },
        },
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool.
        &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;tool&quot;: &quot;A String&quot;, # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
        &quot;webhookToolTrace&quot;: { # The tracing information for the webhook tool. # Optional. Webhook tool trace.
          &quot;webhookTag&quot;: &quot;A String&quot;, # Optional. The tag of the webhook.
          &quot;webhookUri&quot;: &quot;A String&quot;, # Optional. The url of the webhook.
        },
      },
      &quot;tts&quot;: { # Stores metadata of the Text-to-Speech action. # Optional. Text-to-speech action performed by the agent.
      },
      &quot;userUtterance&quot;: { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
        &quot;audio&quot;: &quot;A String&quot;, # Optional. Audio input.
        &quot;audioTokens&quot;: [ # Optional. Tokens of the audio input.
          42,
        ],
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
    },
  ],
  &quot;conversationState&quot;: &quot;A String&quot;, # Required. Example&#x27;s output state.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial example creation.
  &quot;description&quot;: &quot;A String&quot;, # Optional. The high level concise description of the example. The max number of characters is 200.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the example.
  &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code of the example. If not specified, the agent&#x27;s default language is used. Note: languages must be enabled in the agent before they can be used. Note: example&#x27;s language code is not currently used in dialogflow agents.
  &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
  &quot;playbookInput&quot;: { # Input of the playbook. # Optional. The input to the playbook in the example.
    &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
    },
    &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
  },
  &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. The output of the playbook in the example.
    &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
    },
    &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
    &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
  },
  &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current example takes when sent to the LLM.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the example was updated.
}</pre>
</div>

</body></html>