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_v2.projects.agent.html b/docs/dyn/dialogflow_v2.projects.agent.html
index 5c648f7..6a30246 100644
--- a/docs/dyn/dialogflow_v2.projects.agent.html
+++ b/docs/dyn/dialogflow_v2.projects.agent.html
@@ -110,7 +110,7 @@
<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="#search">search(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#search">search(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the list of agents.</p>
<p class="toc_element">
<code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
@@ -135,7 +135,7 @@
The object takes the form of:
{ # The request message for Agents.ExportAgent.
- "agentUri": "A String", # Required. The [Google Cloud Storage](https://cloud.google.com/storage/docs/)
+ "agentUri": "A String", # Required. 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.
@@ -151,7 +151,16 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "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
@@ -159,37 +168,28 @@
# 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "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.
+ "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).
- "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.
- "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
+ "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.
+ "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>
@@ -210,31 +210,32 @@
An object of the form:
{ # Represents a fulfillment.
- "enabled": True or False, # Optional. Whether fulfillment is enabled.
- "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent.
- "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.
+ "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.
+ "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",
+ },
},
- ],
- "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.
- "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.
- "password": "A String", # Optional. The password for HTTP Basic authentication.
- "uri": "A String", # Required. The fulfillment URI for receiving POST requests.
- "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
- "a_key": "A String",
- },
- },
- "name": "A String", # Required. The unique identifier of the fulfillment.
- # Format: `projects/<Project ID>/agent/fulfillment`.
- }</pre>
+ }</pre>
</div>
<div class="method">
@@ -246,7 +247,7 @@
parent: string, Required. The project that the agent is associated with.
Format: `projects/<Project ID>`. (required)
languageCode: string, Optional. The language for which you want a validation result. If not
-specified, the agent's default language is used. [Many
+specified, the agent's default language is used. [Many
languages](https://cloud.google.com/dialogflow/docs/reference/language)
are supported. Note: languages must be enabled in the agent before they can
be used.
@@ -259,26 +260,26 @@
An object of the form:
{ # Represents the output of agent validation.
- "validationErrors": [ # Contains all validation errors.
+ "validationErrors": [ # Contains all validation errors.
{ # Represents a single validation error.
- "errorMessage": "A String", # The detailed error messsage.
- "severity": "A String", # The severity of the error.
- "entries": [ # The names of the entries that the error is associated with.
+ "severity": "A String", # The severity of the error.
+ "entries": [ # The names of the entries that the error is associated with.
# Format:
#
- # - "projects/<Project ID>/agent", if the error is associated with the entire
+ # - "projects/<Project ID>/agent", if the error is associated with the entire
# agent.
- # - "projects/<Project ID>/agent/intents/<Intent ID>", if the error is
+ # - "projects/<Project ID>/agent/intents/<Intent ID>", if the error is
# associated with certain intents.
- # - "projects/<Project
- # ID>/agent/intents/<Intent Id>/trainingPhrases/<Training Phrase ID>", if the
+ # - "projects/<Project
+ # ID>/agent/intents/<Intent Id>/trainingPhrases/<Training Phrase ID>", if the
# error is associated with certain intent training phrases.
- # - "projects/<Project ID>/agent/intents/<Intent Id>/parameters/<Parameter
- # ID>", if the error is associated with certain intent parameters.
- # - "projects/<Project ID>/agent/entities/<Entity ID>", if the error is
+ # - "projects/<Project ID>/agent/intents/<Intent Id>/parameters/<Parameter
+ # ID>", if the error is associated with certain intent parameters.
+ # - "projects/<Project ID>/agent/entities/<Entity ID>", if the error is
# associated with certain entities.
- "A String",
+ "A String",
],
+ "errorMessage": "A String", # The detailed error messsage.
},
],
}</pre>
@@ -301,9 +302,9 @@
The object takes the form of:
{ # The request message for Agents.ImportAgent.
- "agentUri": "A String", # The URI to a Google Cloud Storage file containing the agent to import.
- # Note: The URI must start with "gs://".
- "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://".
+ "agentContent": "A String", # Zip compressed raw byte content for agent.
}
x__xgafv: string, V1 error format.
@@ -316,7 +317,16 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "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
@@ -324,37 +334,28 @@
# 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "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.
+ "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).
- "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.
- "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
+ "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.
+ "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>
@@ -375,9 +376,9 @@
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.
+ "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 restore.
+ # Note: The URI must start with "gs://".
}
x__xgafv: string, V1 error format.
@@ -390,7 +391,16 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "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
@@ -398,57 +408,48 @@
# 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "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.
+ "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).
- "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.
- "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
+ "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.
+ "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="search">search(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="search">search(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Returns the list of agents.
Since there is at most one conversational agent per project, this method is
useful primarily for listing all agents across projects the caller has
-access to. One can achieve that with a wildcard project collection id "-".
+access to. One can achieve that with a wildcard project collection id "-".
Refer to [List
Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
Args:
parent: string, Required. The project to list agents from.
-Format: `projects/<Project ID or '-'>`. (required)
+Format: `projects/<Project ID or '-'>`. (required)
+ pageToken: string, The next_page_token value returned from a previous list request.
pageSize: integer, Optional. The maximum number of items to return in a single page. By
default 100 and at most 1000.
- pageToken: string, The next_page_token value returned from a previous list request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -458,49 +459,49 @@
An object of the form:
{ # The response message for Agents.SearchAgents.
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
- # more results in the list.
- "agents": [ # The list of agents. There will be a maximum number of items returned based
+ "agents": [ # The list of agents. There will be a maximum number of items returned based
# on the page_size field in the request.
{ # Represents a conversational agent.
- "avatarUri": "A String", # Optional. The URI of the agent's avatar.
- # Avatars are used throughout the Dialogflow console and in the self-hosted
- # [Web
- # Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
- # integration.
- "displayName": "A String", # Required. The name of this agent.
- "description": "A String", # Optional. The description of this agent.
- # The maximum length is 500 characters. If exceeded, the request is rejected.
- "parent": "A String", # Required. The project of this agent.
- # Format: `projects/<Project ID>`.
- "defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See
- # [Language
- # Support](https://cloud.google.com/dialogflow/docs/reference/language)
- # for a list of the currently supported language codes. This field cannot be
- # set by the `Update` method.
- "apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified,
- # V2 API is assumed. Clients are free to query different service endpoints
- # for different API versions. However, bots connectors and webhook calls will
- # follow the specified API version.
- "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
- "matchMode": "A String", # Optional. Determines how intents are detected from user queries.
- "supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the
- # `default_language_code`).
- "A String",
- ],
- "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
- "timeZone": "A String", # Required. The time zone of this agent from the
- # [time zone database](https://www.iana.org/time-zones), e.g.,
- # America/New_York, Europe/Paris.
- "classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in
- # matched natural language inputs for your agent, you can tune the machine
- # learning classification threshold. If the returned score value is less than
- # the threshold value, then a fallback intent will be triggered or, if there
- # are no fallback intents defined, no intent will be triggered. The score
- # values range from 0.0 (completely uncertain) to 1.0 (completely certain).
- # If set to 0.0, the default of 0.3 is used.
- },
+ "timeZone": "A String", # Required. The time zone of this agent from the
+ # [time zone database](https://www.iana.org/time-zones), e.g.,
+ # America/New_York, Europe/Paris.
+ "description": "A String", # Optional. The description of this agent.
+ # The maximum length is 500 characters. If exceeded, the request is rejected.
+ "parent": "A String", # Required. The project of this agent.
+ # Format: `projects/<Project ID>`.
+ "supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the
+ # `default_language_code`).
+ "A String",
+ ],
+ "avatarUri": "A String", # Optional. The URI of the agent's avatar.
+ # Avatars are used throughout the Dialogflow console and in the self-hosted
+ # [Web
+ # Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
+ # integration.
+ "defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See
+ # [Language
+ # Support](https://cloud.google.com/dialogflow/docs/reference/language)
+ # for a list of the currently supported language codes. This field cannot be
+ # set by the `Update` method.
+ "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
+ "displayName": "A String", # Required. The name of this agent.
+ "matchMode": "A String", # Optional. Determines how intents are detected from user queries.
+ "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
+ "apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified,
+ # V2 API is assumed. Clients are free to query different service endpoints
+ # for different API versions. However, bots connectors and webhook calls will
+ # follow the specified API version.
+ "classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in
+ # matched natural language inputs for your agent, you can tune the machine
+ # learning classification threshold. If the returned score value is less than
+ # the threshold value, then a fallback intent will be triggered or, if there
+ # are no fallback intents defined, no intent will be triggered. The score
+ # values range from 0.0 (completely uncertain) to 1.0 (completely certain).
+ # If set to 0.0, the default of 0.3 is used.
+ },
],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
+ # more results in the list.
}</pre>
</div>
@@ -513,7 +514,7 @@
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
+ 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>
@@ -543,7 +544,16 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "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
@@ -551,37 +561,28 @@
# 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "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.
+ "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).
- "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.
- "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
+ "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.
+ "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>
@@ -597,31 +598,32 @@
The object takes the form of:
{ # Represents a fulfillment.
- "enabled": True or False, # Optional. Whether fulfillment is enabled.
- "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent.
- "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.
+ "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.
+ "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",
+ },
},
- ],
- "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.
- "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.
- "password": "A String", # Optional. The password for HTTP Basic authentication.
- "uri": "A String", # Required. The fulfillment URI for receiving POST requests.
- "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
- "a_key": "A String",
- },
- },
- "name": "A String", # Required. The unique identifier of the fulfillment.
- # Format: `projects/<Project ID>/agent/fulfillment`.
-}
+ }
updateMask: string, Required. The mask to control which fields get updated. If the mask is not
present, all fields will be updated.
@@ -634,31 +636,32 @@
An object of the form:
{ # Represents a fulfillment.
- "enabled": True or False, # Optional. Whether fulfillment is enabled.
- "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent.
- "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.
+ "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.
+ "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",
+ },
},
- ],
- "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.
- "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.
- "password": "A String", # Optional. The password for HTTP Basic authentication.
- "uri": "A String", # Required. The fulfillment URI for receiving POST requests.
- "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
- "a_key": "A String",
- },
- },
- "name": "A String", # Required. The unique identifier of the fulfillment.
- # Format: `projects/<Project ID>/agent/fulfillment`.
- }</pre>
+ }</pre>
</div>
</body></html>
\ No newline at end of file