docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.html b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.html
new file mode 100644
index 0000000..5b7a59c
--- /dev/null
+++ b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.html
@@ -0,0 +1,531 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="dialogflow_v2beta1.html">Dialogflow API</a> . <a href="dialogflow_v2beta1.projects.html">projects</a> . <a href="dialogflow_v2beta1.projects.locations.html">locations</a> . <a href="dialogflow_v2beta1.projects.locations.agent.html">agent</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="dialogflow_v2beta1.projects.locations.agent.entityTypes.html">entityTypes()</a></code>
+</p>
+<p class="firstline">Returns the entityTypes Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dialogflow_v2beta1.projects.locations.agent.environments.html">environments()</a></code>
+</p>
+<p class="firstline">Returns the environments Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dialogflow_v2beta1.projects.locations.agent.intents.html">intents()</a></code>
+</p>
+<p class="firstline">Returns the intents Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dialogflow_v2beta1.projects.locations.agent.sessions.html">sessions()</a></code>
+</p>
+<p class="firstline">Returns the sessions Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#export">export(parent, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Exports the specified agent to a ZIP file.</p>
+<p class="toc_element">
+ <code><a href="#fulfillment">fulfillment(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates the fulfillment.</p>
+<p class="toc_element">
+ <code><a href="#getFulfillment">getFulfillment(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Retrieves the fulfillment.</p>
+<p class="toc_element">
+ <code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Imports the specified agent from a ZIP file.</p>
+<p class="toc_element">
+ <code><a href="#restore">restore(parent, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Restores the specified agent from a ZIP file.</p>
+<p class="toc_element">
+ <code><a href="#train">train(parent, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Trains the specified agent.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="export">export(parent, body=None, x__xgafv=None)</code>
+ <pre>Exports the specified agent to a ZIP file.
+
+
+Operation <response: ExportAgentResponse>
+
+Args:
+ parent: string, Required. The project that the agent to export is associated with.
+Format: `projects/<Project ID>`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request message for Agents.ExportAgent.
+ "agentUri": "A String", # Optional. The
+ # [Google Cloud Storage](https://cloud.google.com/storage/docs/)
+ # URI to export the agent to.
+ # The format of this URI must be `gs://<bucket-name>/<object-name>`.
+ # If left unspecified, the serialized agent is returned inline.
+ }
+
+ 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.
+ "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.
+ },
+ "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.
+ "response": { # The normal response of the operation in case of success. 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.
+ },
+ "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}`.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="fulfillment">fulfillment(name, body=None, updateMask=None, x__xgafv=None)</code>
+ <pre>Updates the fulfillment.
+
+Args:
+ name: string, Required. The unique identifier of the fulfillment.
+Format: `projects/<Project ID>/agent/fulfillment`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a fulfillment.
+ "genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.
+ # Dialogflow supports two mechanisms for authentications:
+ # - Basic authentication with username and password.
+ # - Authentication with additional authentication headers.
+ # More information could be found at:
+ # https://cloud.google.com/dialogflow/docs/fulfillment-configure.
+ "uri": "A String", # Required. The fulfillment URI for receiving POST requests.
+ # It must use https protocol.
+ "password": "A String", # Optional. The password for HTTP Basic authentication.
+ "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions
+ # integration. Defaults to false.
+ "username": "A String", # Optional. The user name for HTTP Basic authentication.
+ "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
+ "a_key": "A String",
+ },
+ },
+ "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
+ { # Whether fulfillment is enabled for the specific feature.
+ "type": "A String", # The type of the feature that enabled for fulfillment.
+ },
+ ],
+ "name": "A String", # Required. The unique identifier of the fulfillment.
+ # Format: `projects/<Project ID>/agent/fulfillment`.
+ "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent.
+ "enabled": True or False, # Optional. Whether fulfillment is enabled.
+}
+
+ updateMask: string, Required. The mask to control which fields get updated. If the mask is not
+present, all fields will be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a fulfillment.
+ "genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.
+ # Dialogflow supports two mechanisms for authentications:
+ # - Basic authentication with username and password.
+ # - Authentication with additional authentication headers.
+ # More information could be found at:
+ # https://cloud.google.com/dialogflow/docs/fulfillment-configure.
+ "uri": "A String", # Required. The fulfillment URI for receiving POST requests.
+ # It must use https protocol.
+ "password": "A String", # Optional. The password for HTTP Basic authentication.
+ "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions
+ # integration. Defaults to false.
+ "username": "A String", # Optional. The user name for HTTP Basic authentication.
+ "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
+ "a_key": "A String",
+ },
+ },
+ "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
+ { # Whether fulfillment is enabled for the specific feature.
+ "type": "A String", # The type of the feature that enabled for fulfillment.
+ },
+ ],
+ "name": "A String", # Required. The unique identifier of the fulfillment.
+ # Format: `projects/<Project ID>/agent/fulfillment`.
+ "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent.
+ "enabled": True or False, # Optional. Whether fulfillment is enabled.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getFulfillment">getFulfillment(name, x__xgafv=None)</code>
+ <pre>Retrieves the fulfillment.
+
+Args:
+ name: string, Required. The name of the fulfillment.
+Format: `projects/<Project ID>/agent/fulfillment`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a fulfillment.
+ "genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.
+ # Dialogflow supports two mechanisms for authentications:
+ # - Basic authentication with username and password.
+ # - Authentication with additional authentication headers.
+ # More information could be found at:
+ # https://cloud.google.com/dialogflow/docs/fulfillment-configure.
+ "uri": "A String", # Required. The fulfillment URI for receiving POST requests.
+ # It must use https protocol.
+ "password": "A String", # Optional. The password for HTTP Basic authentication.
+ "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions
+ # integration. Defaults to false.
+ "username": "A String", # Optional. The user name for HTTP Basic authentication.
+ "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
+ "a_key": "A String",
+ },
+ },
+ "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
+ { # Whether fulfillment is enabled for the specific feature.
+ "type": "A String", # The type of the feature that enabled for fulfillment.
+ },
+ ],
+ "name": "A String", # Required. The unique identifier of the fulfillment.
+ # Format: `projects/<Project ID>/agent/fulfillment`.
+ "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent.
+ "enabled": True or False, # Optional. Whether fulfillment is enabled.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code>
+ <pre>Imports the specified agent from a ZIP file.
+
+Uploads new intents and entity types without deleting the existing ones.
+Intents and entity types with the same name are replaced with the new
+versions from ImportAgentRequest.
+
+
+Operation <response: google.protobuf.Empty>
+
+Args:
+ parent: string, Required. The project that the agent to import is associated with.
+Format: `projects/<Project ID>`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request message for Agents.ImportAgent.
+ "agentContent": "A String", # Zip compressed raw byte content for agent.
+ "agentUri": "A String", # The URI to a Google Cloud Storage file containing the agent to import.
+ # Note: The URI must start with "gs://".
+ }
+
+ 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.
+ "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.
+ },
+ "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.
+ "response": { # The normal response of the operation in case of success. 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.
+ },
+ "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}`.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="restore">restore(parent, body=None, x__xgafv=None)</code>
+ <pre>Restores the specified agent from a ZIP file.
+
+Replaces the current agent version with a new one. All the intents and
+entity types in the older version are deleted.
+
+
+Operation <response: google.protobuf.Empty>
+
+Args:
+ parent: string, Required. The project that the agent to restore is associated with.
+Format: `projects/<Project ID>`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request message for Agents.RestoreAgent.
+ "agentUri": "A String", # The URI to a Google Cloud Storage file containing the agent to restore.
+ # Note: The URI must start with "gs://".
+ "agentContent": "A String", # Zip compressed raw byte content for agent.
+ }
+
+ 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.
+ "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.
+ },
+ "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.
+ "response": { # The normal response of the operation in case of success. 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.
+ },
+ "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}`.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="train">train(parent, body=None, x__xgafv=None)</code>
+ <pre>Trains the specified agent.
+
+
+Operation <response: google.protobuf.Empty>
+
+Args:
+ parent: string, Required. The project that the agent to train is associated with.
+Format: `projects/<Project ID>`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request message for Agents.TrainAgent.
+ }
+
+ 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.
+ "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.
+ },
+ "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.
+ "response": { # The normal response of the operation in case of success. 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.
+ },
+ "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}`.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
+ },
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file