diff --git a/docs/dyn/dialogflow_v2.projects.locations.operations.html b/docs/dyn/dialogflow_v2.projects.locations.operations.html index 66d18c4e21..bc806f58f7 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.operations.html +++ b/docs/dyn/dialogflow_v2.projects.locations.operations.html @@ -76,7 +76,7 @@
cancel(name, x__xgafv=None)
-Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Close httplib2 connections.
@@ -92,7 +92,7 @@cancel(name, x__xgafv=None)
- Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. +Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. Args: name: string, The name of the operation resource to be cancelled. (required) diff --git a/docs/dyn/dialogflow_v2.projects.operations.html b/docs/dyn/dialogflow_v2.projects.operations.html index 3fc5576f2d..bf79df4a80 100644 --- a/docs/dyn/dialogflow_v2.projects.operations.html +++ b/docs/dyn/dialogflow_v2.projects.operations.html @@ -76,7 +76,7 @@Dialogflow API .
cancel(name, x__xgafv=None)
-Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Close httplib2 connections.
@@ -92,7 +92,7 @@Instance Methods
Method Details
cancel(name, x__xgafv=None)
-Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. +Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. Args: name: string, The name of the operation resource to be cancelled. (required) diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.operations.html b/docs/dyn/dialogflow_v2beta1.projects.locations.operations.html index 5a99aa533f..0f9c3b1cca 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.operations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.operations.html @@ -76,7 +76,7 @@Dialogflow API .
cancel(name, x__xgafv=None)
-Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Close httplib2 connections.
@@ -92,7 +92,7 @@Instance Methods
Method Details
cancel(name, x__xgafv=None)
-Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. +Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. Args: name: string, The name of the operation resource to be cancelled. (required) diff --git a/docs/dyn/dialogflow_v2beta1.projects.operations.html b/docs/dyn/dialogflow_v2beta1.projects.operations.html index fa56532e9c..1e2abd3d29 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.operations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.operations.html @@ -76,7 +76,7 @@Dialogflow API .
cancel(name, x__xgafv=None)
-Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Close httplib2 connections.
@@ -92,7 +92,7 @@Instance Methods
Method Details
cancel(name, x__xgafv=None)
-Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. +Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. Args: name: string, The name of the operation resource to be cancelled. (required) diff --git a/docs/dyn/dialogflow_v3.projects.locations.operations.html b/docs/dyn/dialogflow_v3.projects.locations.operations.html index 1e2c5a76d7..ccff492925 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.operations.html +++ b/docs/dyn/dialogflow_v3.projects.locations.operations.html @@ -76,7 +76,7 @@Dialogflow API .
cancel(name, x__xgafv=None)
-Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Close httplib2 connections.
@@ -92,7 +92,7 @@Instance Methods
Method Details
cancel(name, x__xgafv=None)
-Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. +Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. Args: name: string, The name of the operation resource to be cancelled. (required) diff --git a/docs/dyn/dialogflow_v3.projects.operations.html b/docs/dyn/dialogflow_v3.projects.operations.html index b312b39e21..44b6a7e8f1 100644 --- a/docs/dyn/dialogflow_v3.projects.operations.html +++ b/docs/dyn/dialogflow_v3.projects.operations.html @@ -76,7 +76,7 @@Dialogflow API .
cancel(name, x__xgafv=None)
-Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Close httplib2 connections.
@@ -92,7 +92,7 @@Instance Methods
Method Details
+cancel(name, x__xgafv=None)
-Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. +Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. Args: name: string, The name of the operation resource to be cancelled. (required) diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html index 1d8000b721..99d9a3225a 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html @@ -809,6 +809,16 @@Method Details
], "interactions": [ # Interactions of the conversation. Only populated for `GetConversation` and empty for `ListConversations`. { # Represents an interaction between an end user and a Dialogflow CX agent using V3 (Streaming)DetectIntent API, or an interaction between an end user and a Dialogflow CX agent using V2 (Streaming)AnalyzeContent API. + "answerFeedback": { # Stores information about feedback provided by users about a response. # Answer feedback for the final response. + "customRating": "A String", # Optional. Custom rating from the user about the provided answer, with maximum length of 1024 characters. For example, client could use a customized JSON object to indicate the rating. + "rating": "A String", # Optional. Rating from user for the specific Dialogflow response. + "ratingReason": { # Stores extra information about why users provided thumbs down rating. # Optional. In case of thumbs down rating provided, users can optionally provide context about the rating. + "feedback": "A String", # Optional. Additional feedback about the rating. This field can be populated without choosing a predefined `reason`. + "reasonLabels": [ # Optional. Custom reason labels for thumbs down rating provided by the user. The maximum number of labels allowed is 10 and the maximum length of a single label is 128 characters. + "A String", + ], + }, + }, "createTime": "A String", # The time that the interaction was created. "missingTransition": { # Information collected for DF CX agents in case NLU predicted an intent that was filtered out as being inactive which may indicate a missing transition and/or absent functionality. # Missing transition predicted for the interaction. This field is set only if the interaction match type was no-match. "intentDisplayName": "A String", # Name of the intent that could have triggered. @@ -2559,6 +2569,7 @@Method Details
"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. @@ -2569,6 +2580,7 @@Method Details
}, }, "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. @@ -2586,6 +2598,7 @@Method Details
}, "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. }, @@ -4689,6 +4702,7 @@Method Details
"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. @@ -4699,6 +4713,7 @@Method Details
}, }, "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. @@ -4716,6 +4731,7 @@Method Details
}, "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. }, @@ -6739,6 +6755,16 @@Method Details
], "interactions": [ # Interactions of the conversation. Only populated for `GetConversation` and empty for `ListConversations`. { # Represents an interaction between an end user and a Dialogflow CX agent using V3 (Streaming)DetectIntent API, or an interaction between an end user and a Dialogflow CX agent using V2 (Streaming)AnalyzeContent API. + "answerFeedback": { # Stores information about feedback provided by users about a response. # Answer feedback for the final response. + "customRating": "A String", # Optional. Custom rating from the user about the provided answer, with maximum length of 1024 characters. For example, client could use a customized JSON object to indicate the rating. + "rating": "A String", # Optional. Rating from user for the specific Dialogflow response. + "ratingReason": { # Stores extra information about why users provided thumbs down rating. # Optional. In case of thumbs down rating provided, users can optionally provide context about the rating. + "feedback": "A String", # Optional. Additional feedback about the rating. This field can be populated without choosing a predefined `reason`. + "reasonLabels": [ # Optional. Custom reason labels for thumbs down rating provided by the user. The maximum number of labels allowed is 10 and the maximum length of a single label is 128 characters. + "A String", + ], + }, + }, "createTime": "A String", # The time that the interaction was created. "missingTransition": { # Information collected for DF CX agents in case NLU predicted an intent that was filtered out as being inactive which may indicate a missing transition and/or absent functionality. # Missing transition predicted for the interaction. This field is set only if the interaction match type was no-match. "intentDisplayName": "A String", # Name of the intent that could have triggered. @@ -8489,6 +8515,7 @@Method Details
"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. @@ -8499,6 +8526,7 @@Method Details
}, }, "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. @@ -8516,6 +8544,7 @@Method Details
}, "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. }, @@ -10619,6 +10648,7 @@Method Details
"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. @@ -10629,6 +10659,7 @@Method Details
}, }, "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. @@ -10646,6 +10677,7 @@Method Details
}, "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. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html index 7c9f935703..232681f668 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html @@ -2011,6 +2011,7 @@Method Details
"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. @@ -2021,6 +2022,7 @@Method Details
}, }, "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. @@ -2038,6 +2040,7 @@Method Details
}, "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. }, @@ -4199,6 +4202,7 @@Method Details
"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. @@ -4209,6 +4213,7 @@Method Details
}, }, "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. @@ -4226,6 +4231,7 @@Method Details
}, "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. }, @@ -7623,6 +7629,7 @@Method Details
"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. @@ -7633,6 +7640,7 @@Method Details
}, }, "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. @@ -7650,6 +7658,7 @@Method Details
}, "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. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.examples.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.examples.html index 0baa3e97f9..25fa3c4746 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.examples.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.examples.html @@ -117,6 +117,7 @@Method Details
"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. @@ -127,6 +128,7 @@Method Details
}, }, "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. @@ -144,6 +146,7 @@Method Details
}, "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. }, @@ -194,6 +197,7 @@Method Details
"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. @@ -204,6 +208,7 @@Method Details
}, }, "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. @@ -221,6 +226,7 @@Method Details
}, "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. }, @@ -296,6 +302,7 @@Method Details
"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. @@ -306,6 +313,7 @@Method Details
}, }, "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. @@ -323,6 +331,7 @@Method Details
}, "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. }, @@ -385,6 +394,7 @@Method Details
"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. @@ -395,6 +405,7 @@Method Details
}, }, "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. @@ -412,6 +423,7 @@Method Details
}, "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. }, @@ -481,6 +493,7 @@Method Details
"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. @@ -491,6 +504,7 @@Method Details
}, }, "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. @@ -508,6 +522,7 @@Method Details
}, "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. }, @@ -559,6 +574,7 @@Method Details
"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. @@ -569,6 +585,7 @@Method Details
}, }, "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. @@ -586,6 +603,7 @@Method Details
}, "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. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html index f28a1d0162..4385f50710 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html @@ -93,9 +93,15 @@Instance Methods
Deletes a specified playbook.
++
+export(name, body=None, x__xgafv=None)
Exports the specified playbook to a binary file. Note that resources (e.g. examples, tools) that the playbook references will also be exported.
Retrieves the specified Playbook.
++
+import_(parent, body=None, x__xgafv=None)
Imports the specified playbook to the specified agent from a binary file.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns a list of playbooks in the specified agent.
@@ -279,6 +285,49 @@Method Details
}++export(name, body=None, x__xgafv=None)
+Exports the specified playbook to a binary file. Note that resources (e.g. examples, tools) that the playbook references will also be exported. + +Args: + name: string, Required. The name of the playbook to export. Format: `projects//locations//agents//playbooks/`. (required) + body: object, The request body. + The object takes the form of: + +{ # The request message for Playbooks.ExportPlaybook. + "dataFormat": "A String", # Optional. The data format of the exported agent. If not specified, `BLOB` is assumed. + "playbookUri": "A String", # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the playbook to. The format of this URI must be `gs:///`. If left unspecified, the serialized playbook is returned inline. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # This resource represents a long-running operation that is the result of a network API call. + "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, +}++get(name, x__xgafv=None)
Retrieves the specified Playbook. @@ -360,6 +409,54 @@Method Details
}++import_(parent, body=None, x__xgafv=None)
+Imports the specified playbook to the specified agent from a binary file. + +Args: + parent: string, Required. The agent to import the playbook into. Format: `projects//locations//agents/`. (required) + body: object, The request body. + The object takes the form of: + +{ # The request message for Playbooks.ImportPlaybook. + "importStrategy": { # The playbook import strategy used for resource conflict resolution associated with an ImportPlaybookRequest. # Optional. Specifies the import strategy used when resolving resource conflicts. + "mainPlaybookImportStrategy": "A String", # Optional. Specifies the import strategy used when resolving conflicts with the main playbook. If not specified, 'CREATE_NEW' is assumed. + "nestedResourceImportStrategy": "A String", # Optional. Specifies the import strategy used when resolving referenced playbook/flow conflicts. If not specified, 'CREATE_NEW' is assumed. + "toolImportStrategy": "A String", # Optional. Specifies the import strategy used when resolving tool conflicts. If not specified, 'CREATE_NEW' is assumed. This will be applied after the main playbook and nested resource import strategies, meaning if the playbook that references the tool is skipped, the tool will also be skipped. + }, + "playbookContent": "A String", # Uncompressed raw byte content for playbook. + "playbookUri": "A String", # [Dialogflow access control] (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # This resource represents a long-running operation that is the result of a network API call. + "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, +}+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns a list of playbooks in the specified agent. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html index 02476bdd3a..e3cb21d96c 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html @@ -92,6 +92,9 @@Instance Methods
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.
Method Details
+close()
@@ -117,6 +120,7 @@Method Details
"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. @@ -127,6 +131,7 @@Method Details
}, }, "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. @@ -144,6 +149,7 @@Method Details
}, "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. }, @@ -266,6 +272,7 @@Method Details
"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. @@ -276,6 +283,7 @@Method Details
}, }, "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. @@ -293,6 +301,7 @@Method Details
}, "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. }, @@ -440,6 +449,7 @@Method Details
"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. @@ -450,6 +460,7 @@Method Details
}, }, "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. @@ -467,6 +478,7 @@Method Details
}, "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. }, @@ -601,6 +613,7 @@Method Details
"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. @@ -611,6 +624,7 @@Method Details
}, }, "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. @@ -628,6 +642,7 @@Method Details
}, "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. }, @@ -749,4 +764,93 @@Method Details
++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. + }, +}+