Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a version for the specified Playbook.
Deletes the specified version of the Playbook.
Retrieves the specified version of the Playbook.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists versions for the specified Playbook.
Retrieves the next page of results.
restore(name, body=None, x__xgafv=None)
Retrieves the specified version of the Playbook and stores it as the current playbook draft, returning the playbook with resources updated.
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a version for the specified Playbook.
Args:
parent: string, Required. The playbook to create a version for. Format: `projects//locations//agents//playbooks/`. (required)
body: object, The request body.
The object takes the form of:
{ # Playbook version is a snapshot of the playbook at certain timestamp.
"description": "A String", # Optional. The description of the playbook version.
"examples": [ # Output only. Snapshot of the examples belonging to the playbook when the playbook version is created.
{ # 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. # Optional. Action performed on behalf of the agent by invoking a CX flow.
"displayName": "A String", # Output only. The display name of the flow.
"flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents//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. # Optional. Action performed on behalf of the agent by invoking a child playbook.
"displayName": "A String", # Output only. The display name of the playbook.
"playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
"playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
"actionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
},
"playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
"actionParameters": { # Optional. A Struct object of output parameters for the action.
"a_key": "", # Properties of the object.
},
"executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
},
"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.
"displayName": "A String", # Output only. The display name of the tool.
"inputActionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"outputActionParameters": { # Optional. A list of output parameters generated by the action.
"a_key": "", # Properties of the object.
},
"tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
},
"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.
},
],
"name": "A String", # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
"playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
"createTime": "A String", # Output only. The timestamp of initial playbook creation.
"displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
"goal": "A String", # Required. High level description of the goal the playbook intend to accomplish.
"inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
{ # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
"description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
"name": "A String", # Required. Name of parameter.
"type": "A String", # Type of parameter.
"typeSchema": { # Encapsulates different type schema variations: either a reference to an a schema that's already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
"inlineSchema": { # A type schema object that's specified inline. # Set if this is an inline schema definition.
"items": # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
"type": "A String", # Data type of the schema.
},
"schemaReference": { # A reference to the schema of an existing tool. # Set if this is a schema reference.
"schema": "A String", # The name of the schema.
"tool": "A String", # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
},
},
},
],
"instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
"steps": [ # Ordered list of step by step execution instructions to accomplish target goal.
{ # Message of single step execution.
"steps": [ # Sub-processing needed to execute the current step.
# Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
],
"text": "A String", # Step instruction in text format.
},
],
},
"llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook.
"model": "A String", # The selected LLM model.
"promptText": "A String", # The custom prompt to use.
},
"name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
"outputParameterDefinitions": [ # Optional. Defined structured output parameters for this playbook.
{ # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
"description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
"name": "A String", # Required. Name of parameter.
"type": "A String", # Type of parameter.
"typeSchema": { # Encapsulates different type schema variations: either a reference to an a schema that's already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
"inlineSchema": { # A type schema object that's specified inline. # Set if this is an inline schema definition.
"items": # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
"type": "A String", # Data type of the schema.
},
"schemaReference": { # A reference to the schema of an existing tool. # Set if this is a schema reference.
"schema": "A String", # The name of the schema.
"tool": "A String", # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
},
},
},
],
"referencedFlows": [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
"A String",
],
"referencedPlaybooks": [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
"A String",
],
"referencedTools": [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
"A String",
],
"tokenCount": "A String", # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
"updateTime": "A String", # Output only. Last time the playbook version was updated.
},
"updateTime": "A String", # Output only. Last time the playbook version was created or modified.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Playbook version is a snapshot of the playbook at certain timestamp.
"description": "A String", # Optional. The description of the playbook version.
"examples": [ # Output only. Snapshot of the examples belonging to the playbook when the playbook version is created.
{ # 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. # Optional. Action performed on behalf of the agent by invoking a CX flow.
"displayName": "A String", # Output only. The display name of the flow.
"flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents//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. # Optional. Action performed on behalf of the agent by invoking a child playbook.
"displayName": "A String", # Output only. The display name of the playbook.
"playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
"playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
"actionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
},
"playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
"actionParameters": { # Optional. A Struct object of output parameters for the action.
"a_key": "", # Properties of the object.
},
"executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
},
"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.
"displayName": "A String", # Output only. The display name of the tool.
"inputActionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"outputActionParameters": { # Optional. A list of output parameters generated by the action.
"a_key": "", # Properties of the object.
},
"tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
},
"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.
},
],
"name": "A String", # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
"playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
"createTime": "A String", # Output only. The timestamp of initial playbook creation.
"displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
"goal": "A String", # Required. High level description of the goal the playbook intend to accomplish.
"inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
{ # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
"description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
"name": "A String", # Required. Name of parameter.
"type": "A String", # Type of parameter.
"typeSchema": { # Encapsulates different type schema variations: either a reference to an a schema that's already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
"inlineSchema": { # A type schema object that's specified inline. # Set if this is an inline schema definition.
"items": # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
"type": "A String", # Data type of the schema.
},
"schemaReference": { # A reference to the schema of an existing tool. # Set if this is a schema reference.
"schema": "A String", # The name of the schema.
"tool": "A String", # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
},
},
},
],
"instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
"steps": [ # Ordered list of step by step execution instructions to accomplish target goal.
{ # Message of single step execution.
"steps": [ # Sub-processing needed to execute the current step.
# Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
],
"text": "A String", # Step instruction in text format.
},
],
},
"llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook.
"model": "A String", # The selected LLM model.
"promptText": "A String", # The custom prompt to use.
},
"name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
"outputParameterDefinitions": [ # Optional. Defined structured output parameters for this playbook.
{ # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
"description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
"name": "A String", # Required. Name of parameter.
"type": "A String", # Type of parameter.
"typeSchema": { # Encapsulates different type schema variations: either a reference to an a schema that's already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
"inlineSchema": { # A type schema object that's specified inline. # Set if this is an inline schema definition.
"items": # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
"type": "A String", # Data type of the schema.
},
"schemaReference": { # A reference to the schema of an existing tool. # Set if this is a schema reference.
"schema": "A String", # The name of the schema.
"tool": "A String", # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
},
},
},
],
"referencedFlows": [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
"A String",
],
"referencedPlaybooks": [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
"A String",
],
"referencedTools": [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
"A String",
],
"tokenCount": "A String", # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
"updateTime": "A String", # Output only. Last time the playbook version was updated.
},
"updateTime": "A String", # Output only. Last time the playbook version was created or modified.
}
delete(name, x__xgafv=None)
Deletes the specified version of the Playbook.
Args:
name: string, Required. The name of the playbook version to delete. Format: `projects//locations//agents//playbooks//versions/`. (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 version of the Playbook.
Args:
name: string, Required. The name of the playbook version. Format: `projects//locations//agents//playbooks//versions/`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Playbook version is a snapshot of the playbook at certain timestamp.
"description": "A String", # Optional. The description of the playbook version.
"examples": [ # Output only. Snapshot of the examples belonging to the playbook when the playbook version is created.
{ # 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. # Optional. Action performed on behalf of the agent by invoking a CX flow.
"displayName": "A String", # Output only. The display name of the flow.
"flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents//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. # Optional. Action performed on behalf of the agent by invoking a child playbook.
"displayName": "A String", # Output only. The display name of the playbook.
"playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
"playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
"actionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
},
"playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
"actionParameters": { # Optional. A Struct object of output parameters for the action.
"a_key": "", # Properties of the object.
},
"executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
},
"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.
"displayName": "A String", # Output only. The display name of the tool.
"inputActionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"outputActionParameters": { # Optional. A list of output parameters generated by the action.
"a_key": "", # Properties of the object.
},
"tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
},
"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.
},
],
"name": "A String", # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
"playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
"createTime": "A String", # Output only. The timestamp of initial playbook creation.
"displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
"goal": "A String", # Required. High level description of the goal the playbook intend to accomplish.
"inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
{ # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
"description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
"name": "A String", # Required. Name of parameter.
"type": "A String", # Type of parameter.
"typeSchema": { # Encapsulates different type schema variations: either a reference to an a schema that's already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
"inlineSchema": { # A type schema object that's specified inline. # Set if this is an inline schema definition.
"items": # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
"type": "A String", # Data type of the schema.
},
"schemaReference": { # A reference to the schema of an existing tool. # Set if this is a schema reference.
"schema": "A String", # The name of the schema.
"tool": "A String", # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
},
},
},
],
"instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
"steps": [ # Ordered list of step by step execution instructions to accomplish target goal.
{ # Message of single step execution.
"steps": [ # Sub-processing needed to execute the current step.
# Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
],
"text": "A String", # Step instruction in text format.
},
],
},
"llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook.
"model": "A String", # The selected LLM model.
"promptText": "A String", # The custom prompt to use.
},
"name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
"outputParameterDefinitions": [ # Optional. Defined structured output parameters for this playbook.
{ # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
"description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
"name": "A String", # Required. Name of parameter.
"type": "A String", # Type of parameter.
"typeSchema": { # Encapsulates different type schema variations: either a reference to an a schema that's already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
"inlineSchema": { # A type schema object that's specified inline. # Set if this is an inline schema definition.
"items": # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
"type": "A String", # Data type of the schema.
},
"schemaReference": { # A reference to the schema of an existing tool. # Set if this is a schema reference.
"schema": "A String", # The name of the schema.
"tool": "A String", # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
},
},
},
],
"referencedFlows": [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
"A String",
],
"referencedPlaybooks": [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
"A String",
],
"referencedTools": [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
"A String",
],
"tokenCount": "A String", # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
"updateTime": "A String", # Output only. Last time the playbook version was updated.
},
"updateTime": "A String", # Output only. Last time the playbook version was created or modified.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists versions for the specified Playbook.
Args:
parent: string, Required. The playbook to list versions for. Format: `projects//locations//agents//playbooks/`. (required)
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 Playbooks.ListPlaybookVersions.
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
"playbookVersions": [ # The list of playbook version. There will be a maximum number of items returned based on the page_size field in the request.
{ # Playbook version is a snapshot of the playbook at certain timestamp.
"description": "A String", # Optional. The description of the playbook version.
"examples": [ # Output only. Snapshot of the examples belonging to the playbook when the playbook version is created.
{ # 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. # Optional. Action performed on behalf of the agent by invoking a CX flow.
"displayName": "A String", # Output only. The display name of the flow.
"flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents//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. # Optional. Action performed on behalf of the agent by invoking a child playbook.
"displayName": "A String", # Output only. The display name of the playbook.
"playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
"playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
"actionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
},
"playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
"actionParameters": { # Optional. A Struct object of output parameters for the action.
"a_key": "", # Properties of the object.
},
"executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
},
"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.
"displayName": "A String", # Output only. The display name of the tool.
"inputActionParameters": { # Optional. A list of input parameters for the action.
"a_key": "", # Properties of the object.
},
"outputActionParameters": { # Optional. A list of output parameters generated by the action.
"a_key": "", # Properties of the object.
},
"tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
},
"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.
},
],
"name": "A String", # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
"playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
"createTime": "A String", # Output only. The timestamp of initial playbook creation.
"displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
"goal": "A String", # Required. High level description of the goal the playbook intend to accomplish.
"inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
{ # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
"description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
"name": "A String", # Required. Name of parameter.
"type": "A String", # Type of parameter.
"typeSchema": { # Encapsulates different type schema variations: either a reference to an a schema that's already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
"inlineSchema": { # A type schema object that's specified inline. # Set if this is an inline schema definition.
"items": # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
"type": "A String", # Data type of the schema.
},
"schemaReference": { # A reference to the schema of an existing tool. # Set if this is a schema reference.
"schema": "A String", # The name of the schema.
"tool": "A String", # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
},
},
},
],
"instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
"steps": [ # Ordered list of step by step execution instructions to accomplish target goal.
{ # Message of single step execution.
"steps": [ # Sub-processing needed to execute the current step.
# Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
],
"text": "A String", # Step instruction in text format.
},
],
},
"llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook.
"model": "A String", # The selected LLM model.
"promptText": "A String", # The custom prompt to use.
},
"name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
"outputParameterDefinitions": [ # Optional. Defined structured output parameters for this playbook.
{ # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
"description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
"name": "A String", # Required. Name of parameter.
"type": "A String", # Type of parameter.
"typeSchema": { # Encapsulates different type schema variations: either a reference to an a schema that's already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
"inlineSchema": { # A type schema object that's specified inline. # Set if this is an inline schema definition.
"items": # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
"type": "A String", # Data type of the schema.
},
"schemaReference": { # A reference to the schema of an existing tool. # Set if this is a schema reference.
"schema": "A String", # The name of the schema.
"tool": "A String", # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
},
},
},
],
"referencedFlows": [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
"A String",
],
"referencedPlaybooks": [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
"A String",
],
"referencedTools": [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
"A String",
],
"tokenCount": "A String", # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
"updateTime": "A String", # Output only. Last time the playbook version was updated.
},
"updateTime": "A String", # Output only. Last time the playbook version was created or modified.
},
],
}
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.
restore(name, body=None, x__xgafv=None)
Retrieves the specified version of the Playbook and stores it as the current playbook draft, returning the playbook with resources updated.
Args:
name: string, Required. The name of the playbook version. Format: `projects//locations//agents//playbooks//versions/`. (required)
body: object, The request body.
The object takes the form of:
{ # The request message for Playbooks.RestorePlaybookVersion.
}
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 Playbooks.RestorePlaybookVersion.
"playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # The updated playbook.
"createTime": "A String", # Output only. The timestamp of initial playbook creation.
"displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
"goal": "A String", # Required. High level description of the goal the playbook intend to accomplish.
"inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
{ # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
"description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
"name": "A String", # Required. Name of parameter.
"type": "A String", # Type of parameter.
"typeSchema": { # Encapsulates different type schema variations: either a reference to an a schema that's already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
"inlineSchema": { # A type schema object that's specified inline. # Set if this is an inline schema definition.
"items": # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
"type": "A String", # Data type of the schema.
},
"schemaReference": { # A reference to the schema of an existing tool. # Set if this is a schema reference.
"schema": "A String", # The name of the schema.
"tool": "A String", # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
},
},
},
],
"instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
"steps": [ # Ordered list of step by step execution instructions to accomplish target goal.
{ # Message of single step execution.
"steps": [ # Sub-processing needed to execute the current step.
# Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
],
"text": "A String", # Step instruction in text format.
},
],
},
"llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook.
"model": "A String", # The selected LLM model.
"promptText": "A String", # The custom prompt to use.
},
"name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
"outputParameterDefinitions": [ # Optional. Defined structured output parameters for this playbook.
{ # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
"description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
"name": "A String", # Required. Name of parameter.
"type": "A String", # Type of parameter.
"typeSchema": { # Encapsulates different type schema variations: either a reference to an a schema that's already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
"inlineSchema": { # A type schema object that's specified inline. # Set if this is an inline schema definition.
"items": # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
"type": "A String", # Data type of the schema.
},
"schemaReference": { # A reference to the schema of an existing tool. # Set if this is a schema reference.
"schema": "A String", # The name of the schema.
"tool": "A String", # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
},
},
},
],
"referencedFlows": [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
"A String",
],
"referencedPlaybooks": [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
"A String",
],
"referencedTools": [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
"A String",
],
"tokenCount": "A String", # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
"updateTime": "A String", # Output only. Last time the playbook version was updated.
},
}