| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="integrations_v1.html">Application Integration API</a> . <a href="integrations_v1.projects.html">projects</a> . <a href="integrations_v1.projects.locations.html">locations</a> . <a href="integrations_v1.projects.locations.collections.html">collections</a> . <a href="integrations_v1.projects.locations.collections.engines.html">engines</a> . <a href="integrations_v1.projects.locations.collections.engines.assistants.html">assistants</a> . <a href="integrations_v1.projects.locations.collections.engines.assistants.agentFlows.html">agentFlows</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Request to create a new AgentFlow with user-provided flow configuration.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes an existing AgentFlow.</p> |
| <p class="toc_element"> |
| <code><a href="#generate">generate(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Uses Natural Language (NL) to generate an AgentFlow configuration and create a new AgentFlow.</p> |
| <p class="toc_element"> |
| <code><a href="#generateAndUpdate">generateAndUpdate(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Uses Natural Language (NL) to generate an AgentFlow configuration and update an existing AgentFlow.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets an existing AgentFlow.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists all AgentFlows.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates an existing AgentFlow.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| <pre>Request to create a new AgentFlow with user-provided flow configuration. |
| |
| Args: |
| parent: string, Required. Parent resource name where this AgentFlow will be created. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # AgentFlow configurations. |
| "createTime": "A String", # Output only. The timestamp when the agent flow was created. |
| "creator": "A String", # Output only. The user who created the agent flow. |
| "description": "A String", # Optional. Description of the agent flow. |
| "displayName": "A String", # Optional. Display name of the agent flow. |
| "flowConfig": "A String", # Required. The flow configuration, represented as a string. |
| "name": "A String", # Required. Resource name of the agent flow. |
| "noCodeAgent": "A String", # Optional. Name of the NoCodeAgent. |
| "updateTime": "A String", # Output only. The timestamp when the agent flow was last updated. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # AgentFlow configurations. |
| "createTime": "A String", # Output only. The timestamp when the agent flow was created. |
| "creator": "A String", # Output only. The user who created the agent flow. |
| "description": "A String", # Optional. Description of the agent flow. |
| "displayName": "A String", # Optional. Display name of the agent flow. |
| "flowConfig": "A String", # Required. The flow configuration, represented as a string. |
| "name": "A String", # Required. Resource name of the agent flow. |
| "noCodeAgent": "A String", # Optional. Name of the NoCodeAgent. |
| "updateTime": "A String", # Output only. The timestamp when the agent flow was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes an existing AgentFlow. |
| |
| Args: |
| name: string, Required. The resource name of the AgentFlow to delete. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="generate">generate(parent, body=None, x__xgafv=None)</code> |
| <pre>Uses Natural Language (NL) to generate an AgentFlow configuration and create a new AgentFlow. |
| |
| Args: |
| parent: string, Required. Parent resource name where this AgentFlow will be created. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for GenerateAgentFlow. |
| "creator": "A String", # Optional. The creator id; |
| "description": "A String", # Optional. The description of the AgentFlow to be generated. |
| "displayName": "A String", # Optional. The display name of the AgentFlow to be generated. |
| "intent": "A String", # Required. The intent, described in natural language, for the AgentFlow to generate. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for GenerateAgentFlow. |
| "agentFlow": { # AgentFlow configurations. # Output only. AgentFlow that gets generated. |
| "createTime": "A String", # Output only. The timestamp when the agent flow was created. |
| "creator": "A String", # Output only. The user who created the agent flow. |
| "description": "A String", # Optional. Description of the agent flow. |
| "displayName": "A String", # Optional. Display name of the agent flow. |
| "flowConfig": "A String", # Required. The flow configuration, represented as a string. |
| "name": "A String", # Required. Resource name of the agent flow. |
| "noCodeAgent": "A String", # Optional. Name of the NoCodeAgent. |
| "updateTime": "A String", # Output only. The timestamp when the agent flow was last updated. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="generateAndUpdate">generateAndUpdate(name, body=None, x__xgafv=None)</code> |
| <pre>Uses Natural Language (NL) to generate an AgentFlow configuration and update an existing AgentFlow. |
| |
| Args: |
| name: string, Required. The resource name of the AgentFlow to update. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for GenerateAndUpdateAgentFlow. |
| "intent": "A String", # Required. The intent, described in natural language, for the AgentFlow to update. |
| "updater": "A String", # Optional. The updater id; |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for GenerateAndUpdateAgentFlow. |
| "agentFlow": { # AgentFlow configurations. # Output only. AgentFlow that gets updated. |
| "createTime": "A String", # Output only. The timestamp when the agent flow was created. |
| "creator": "A String", # Output only. The user who created the agent flow. |
| "description": "A String", # Optional. Description of the agent flow. |
| "displayName": "A String", # Optional. Display name of the agent flow. |
| "flowConfig": "A String", # Required. The flow configuration, represented as a string. |
| "name": "A String", # Required. Resource name of the agent flow. |
| "noCodeAgent": "A String", # Optional. Name of the NoCodeAgent. |
| "updateTime": "A String", # Output only. The timestamp when the agent flow was last updated. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets an existing AgentFlow. |
| |
| Args: |
| name: string, Required. The resource name of the AgentFlow to get. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # AgentFlow configurations. |
| "createTime": "A String", # Output only. The timestamp when the agent flow was created. |
| "creator": "A String", # Output only. The user who created the agent flow. |
| "description": "A String", # Optional. Description of the agent flow. |
| "displayName": "A String", # Optional. Display name of the agent flow. |
| "flowConfig": "A String", # Required. The flow configuration, represented as a string. |
| "name": "A String", # Required. Resource name of the agent flow. |
| "noCodeAgent": "A String", # Optional. Name of the NoCodeAgent. |
| "updateTime": "A String", # Output only. The timestamp when the agent flow was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</code> |
| <pre>Lists all AgentFlows. |
| |
| Args: |
| parent: string, Required. The parent resource where this AgentFlow was created. (required) |
| filter: string, Optional. Standard filter field. Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters. |
| orderBy: string, Optional. The results would be returned in order specified here. Currently supported sort keys are: Descending sort order for "create_time", "update_time". Ascending sort order for "agent_flow_id", "display_name". |
| pageSize: integer, Optional. The maximum number of AgentFlows to return. The service may return fewer than this value. If unspecified, at most 100 AgentFlows will be returned. |
| pageToken: string, Optional. A page token, received from a previous `ListAgentFlows` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAgentFlows` must match the call that provided the page token. |
| readMask: string, Optional. The mask which specifies fields that need to be returned in the AgentFlow's response. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response for ListAgentFlows. |
| "agentFlows": [ # Output only. The AgentFlows from the specified collection. |
| { # AgentFlow configurations. |
| "createTime": "A String", # Output only. The timestamp when the agent flow was created. |
| "creator": "A String", # Output only. The user who created the agent flow. |
| "description": "A String", # Optional. Description of the agent flow. |
| "displayName": "A String", # Optional. Display name of the agent flow. |
| "flowConfig": "A String", # Required. The flow configuration, represented as a string. |
| "name": "A String", # Required. Resource name of the agent flow. |
| "noCodeAgent": "A String", # Optional. Name of the NoCodeAgent. |
| "updateTime": "A String", # Output only. The timestamp when the agent flow was last updated. |
| }, |
| ], |
| "nextPageToken": "A String", # Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates an existing AgentFlow. |
| |
| Args: |
| name: string, Required. Resource name of the agent flow. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # AgentFlow configurations. |
| "createTime": "A String", # Output only. The timestamp when the agent flow was created. |
| "creator": "A String", # Output only. The user who created the agent flow. |
| "description": "A String", # Optional. Description of the agent flow. |
| "displayName": "A String", # Optional. Display name of the agent flow. |
| "flowConfig": "A String", # Required. The flow configuration, represented as a string. |
| "name": "A String", # Required. Resource name of the agent flow. |
| "noCodeAgent": "A String", # Optional. Name of the NoCodeAgent. |
| "updateTime": "A String", # Output only. The timestamp when the agent flow was last updated. |
| } |
| |
| updateMask: string, Optional. Field mask specifying the fields in the above AgentFlow that have been modified and need to be updated. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # AgentFlow configurations. |
| "createTime": "A String", # Output only. The timestamp when the agent flow was created. |
| "creator": "A String", # Output only. The user who created the agent flow. |
| "description": "A String", # Optional. Description of the agent flow. |
| "displayName": "A String", # Optional. Display name of the agent flow. |
| "flowConfig": "A String", # Required. The flow configuration, represented as a string. |
| "name": "A String", # Required. Resource name of the agent flow. |
| "noCodeAgent": "A String", # Optional. Name of the NoCodeAgent. |
| "updateTime": "A String", # Output only. The timestamp when the agent flow was last updated. |
| }</pre> |
| </div> |
| |
| </body></html> |
