Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates an example in the specified playbook.
Deletes the specified example.
Retrieves the specified example.
list(parent, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)
Returns a list of examples in the specified playbook.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Update the specified example.
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates an example in the specified playbook.
Args:
parent: string, Required. The playbook to create an example for. Format: `projects//locations//agents//playbooks/`. (required)
body: object, The request body.
The object takes the form of:
{ # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
"actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
{ # Action performed by end user or Dialogflow agent in the conversation.
"agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
"text": "A String", # Required. Message content in text.
},
"flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow.
"flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
"flowState": "A String", # Required. Flow invocation's output state.
"inputActionParameters": { # Optional. A list of input parameters for the flow.
"a_key": "", # Properties of the object.
},
"outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation.
"a_key": "", # Properties of the object.
},
},
"playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook.
"playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
"playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
"actionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
},
"playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
"actionParameters": { # Optional. A Struct object of output parameters for the action.
"a_key": "", # Properties of the object.
},
"executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
},
"playbookState": "A String", # Required. Playbook invocation's output state.
},
"toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
"action": "A String", # Optional. Name of the action to be called during the tool use.
"inputActionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"outputActionParameters": { # Optional. A list of output parameters generated by the action.
"a_key": "", # Properties of the object.
},
"tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
},
"userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
"text": "A String", # Required. Message content in text.
},
},
],
"conversationState": "A String", # Required. Example's output state.
"createTime": "A String", # Output only. The timestamp of initial example creation.
"description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200.
"displayName": "A String", # Required. The display name of the example.
"languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents.
"name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
"playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example.
"actionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
},
"playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example.
"actionParameters": { # Optional. A Struct object of output parameters for the action.
"a_key": "", # Properties of the object.
},
"executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
},
"tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM.
"updateTime": "A String", # Output only. Last time the example was updated.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
"actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
{ # Action performed by end user or Dialogflow agent in the conversation.
"agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
"text": "A String", # Required. Message content in text.
},
"flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow.
"flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
"flowState": "A String", # Required. Flow invocation's output state.
"inputActionParameters": { # Optional. A list of input parameters for the flow.
"a_key": "", # Properties of the object.
},
"outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation.
"a_key": "", # Properties of the object.
},
},
"playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook.
"playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
"playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
"actionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
},
"playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
"actionParameters": { # Optional. A Struct object of output parameters for the action.
"a_key": "", # Properties of the object.
},
"executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
},
"playbookState": "A String", # Required. Playbook invocation's output state.
},
"toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
"action": "A String", # Optional. Name of the action to be called during the tool use.
"inputActionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"outputActionParameters": { # Optional. A list of output parameters generated by the action.
"a_key": "", # Properties of the object.
},
"tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
},
"userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
"text": "A String", # Required. Message content in text.
},
},
],
"conversationState": "A String", # Required. Example's output state.
"createTime": "A String", # Output only. The timestamp of initial example creation.
"description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200.
"displayName": "A String", # Required. The display name of the example.
"languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents.
"name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
"playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example.
"actionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
},
"playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example.
"actionParameters": { # Optional. A Struct object of output parameters for the action.
"a_key": "", # Properties of the object.
},
"executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
},
"tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM.
"updateTime": "A String", # Output only. Last time the example was updated.
}
delete(name, x__xgafv=None)
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); }
}
get(name, x__xgafv=None)
Retrieves the specified example.
Args:
name: string, Required. The name of the example. Format: `projects//locations//agents//playbooks//examples/`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
"actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
{ # Action performed by end user or Dialogflow agent in the conversation.
"agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
"text": "A String", # Required. Message content in text.
},
"flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow.
"flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
"flowState": "A String", # Required. Flow invocation's output state.
"inputActionParameters": { # Optional. A list of input parameters for the flow.
"a_key": "", # Properties of the object.
},
"outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation.
"a_key": "", # Properties of the object.
},
},
"playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook.
"playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
"playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
"actionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
},
"playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
"actionParameters": { # Optional. A Struct object of output parameters for the action.
"a_key": "", # Properties of the object.
},
"executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
},
"playbookState": "A String", # Required. Playbook invocation's output state.
},
"toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
"action": "A String", # Optional. Name of the action to be called during the tool use.
"inputActionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"outputActionParameters": { # Optional. A list of output parameters generated by the action.
"a_key": "", # Properties of the object.
},
"tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
},
"userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
"text": "A String", # Required. Message content in text.
},
},
],
"conversationState": "A String", # Required. Example's output state.
"createTime": "A String", # Output only. The timestamp of initial example creation.
"description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200.
"displayName": "A String", # Required. The display name of the example.
"languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents.
"name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
"playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example.
"actionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
},
"playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example.
"actionParameters": { # Optional. A Struct object of output parameters for the action.
"a_key": "", # Properties of the object.
},
"executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
},
"tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM.
"updateTime": "A String", # Output only. Last time the example was updated.
}
list(parent, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)
Returns a list of examples in the specified playbook.
Args:
parent: string, Required. The playbook to list the examples from. Format: `projects//locations//agents//playbooks/`. (required)
languageCode: string, Optional. The language to list examples for. If not specified, list all examples under the playbook. Note: languages must be enabled in the agent before they can be used.
pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
pageToken: string, Optional. The next_page_token value returned from a previous list request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for Examples.ListExamples.
"examples": [ # The list of examples. There will be a maximum number of items returned based on the page_size field in the request.
{ # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
"actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
{ # Action performed by end user or Dialogflow agent in the conversation.
"agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
"text": "A String", # Required. Message content in text.
},
"flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow.
"flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
"flowState": "A String", # Required. Flow invocation's output state.
"inputActionParameters": { # Optional. A list of input parameters for the flow.
"a_key": "", # Properties of the object.
},
"outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation.
"a_key": "", # Properties of the object.
},
},
"playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook.
"playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
"playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
"actionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
},
"playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
"actionParameters": { # Optional. A Struct object of output parameters for the action.
"a_key": "", # Properties of the object.
},
"executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
},
"playbookState": "A String", # Required. Playbook invocation's output state.
},
"toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
"action": "A String", # Optional. Name of the action to be called during the tool use.
"inputActionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"outputActionParameters": { # Optional. A list of output parameters generated by the action.
"a_key": "", # Properties of the object.
},
"tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
},
"userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
"text": "A String", # Required. Message content in text.
},
},
],
"conversationState": "A String", # Required. Example's output state.
"createTime": "A String", # Output only. The timestamp of initial example creation.
"description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200.
"displayName": "A String", # Required. The display name of the example.
"languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents.
"name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
"playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example.
"actionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
},
"playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example.
"actionParameters": { # Optional. A Struct object of output parameters for the action.
"a_key": "", # Properties of the object.
},
"executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
},
"tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM.
"updateTime": "A String", # Output only. Last time the example was updated.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Update the specified example.
Args:
name: string, The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. (required)
body: object, The request body.
The object takes the form of:
{ # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
"actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
{ # Action performed by end user or Dialogflow agent in the conversation.
"agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
"text": "A String", # Required. Message content in text.
},
"flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow.
"flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
"flowState": "A String", # Required. Flow invocation's output state.
"inputActionParameters": { # Optional. A list of input parameters for the flow.
"a_key": "", # Properties of the object.
},
"outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation.
"a_key": "", # Properties of the object.
},
},
"playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook.
"playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
"playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
"actionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
},
"playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
"actionParameters": { # Optional. A Struct object of output parameters for the action.
"a_key": "", # Properties of the object.
},
"executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
},
"playbookState": "A String", # Required. Playbook invocation's output state.
},
"toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
"action": "A String", # Optional. Name of the action to be called during the tool use.
"inputActionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"outputActionParameters": { # Optional. A list of output parameters generated by the action.
"a_key": "", # Properties of the object.
},
"tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
},
"userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
"text": "A String", # Required. Message content in text.
},
},
],
"conversationState": "A String", # Required. Example's output state.
"createTime": "A String", # Output only. The timestamp of initial example creation.
"description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200.
"displayName": "A String", # Required. The display name of the example.
"languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents.
"name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
"playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example.
"actionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
},
"playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example.
"actionParameters": { # Optional. A Struct object of output parameters for the action.
"a_key": "", # Properties of the object.
},
"executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
},
"tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM.
"updateTime": "A String", # Output only. Last time the example was updated.
}
updateMask: string, Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
"actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
{ # Action performed by end user or Dialogflow agent in the conversation.
"agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
"text": "A String", # Required. Message content in text.
},
"flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow.
"flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
"flowState": "A String", # Required. Flow invocation's output state.
"inputActionParameters": { # Optional. A list of input parameters for the flow.
"a_key": "", # Properties of the object.
},
"outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation.
"a_key": "", # Properties of the object.
},
},
"playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook.
"playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
"playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
"actionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
},
"playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
"actionParameters": { # Optional. A Struct object of output parameters for the action.
"a_key": "", # Properties of the object.
},
"executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
},
"playbookState": "A String", # Required. Playbook invocation's output state.
},
"toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
"action": "A String", # Optional. Name of the action to be called during the tool use.
"inputActionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"outputActionParameters": { # Optional. A list of output parameters generated by the action.
"a_key": "", # Properties of the object.
},
"tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
},
"userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
"text": "A String", # Required. Message content in text.
},
},
],
"conversationState": "A String", # Required. Example's output state.
"createTime": "A String", # Output only. The timestamp of initial example creation.
"description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200.
"displayName": "A String", # Required. The display name of the example.
"languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents.
"name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
"playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example.
"actionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
},
"playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example.
"actionParameters": { # Optional. A Struct object of output parameters for the action.
"a_key": "", # Properties of the object.
},
"executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
},
"tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM.
"updateTime": "A String", # Output only. Last time the example was updated.
}