docs: update generated docs (#981)
diff --git a/docs/dyn/dialogflow_v2beta1.projects.agent.html b/docs/dyn/dialogflow_v2beta1.projects.agent.html
index dc04c32..d5a2342 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.agent.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.agent.html
@@ -115,7 +115,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, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#search">search(parent, pageSize=None, pageToken=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>
@@ -161,33 +161,6 @@
"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).
- "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.
- "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.
- },
- "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
@@ -198,6 +171,33 @@
# `TakeSnapshotResponse`.
"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.
+ "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).
+ "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.
+ },
}</pre>
</div>
@@ -216,32 +216,41 @@
Returns:
An object of the form:
- { # Represents a fulfillment.
+ { # By default, your agent responds to a matched intent with a static response.
+ # As an alternative, you can provide a more dynamic response by using
+ # fulfillment. When you enable fulfillment for an intent, Dialogflow responds
+ # to that intent by calling a service that you define. For example, if an
+ # end-user wants to schedule a haircut on Friday, your service can check your
+ # database and respond to the end-user with availability information for
+ # Friday.
+ #
+ # For more information, see the [fulfillment
+ # guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).
"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",
},
+ "uri": "A String", # Required. The fulfillment URI for receiving POST requests.
+ # It must use https protocol.
+ "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.
},
+ "enabled": True or False, # Optional. Whether fulfillment is enabled.
+ "name": "A String", # Required. The unique identifier of the fulfillment.
+ # Format: `projects/<Project ID>/agent/fulfillment`.
}</pre>
</div>
@@ -269,6 +278,7 @@
{ # Represents the output of agent validation.
"validationErrors": [ # Contains all validation errors.
{ # Represents a single validation error.
+ "severity": "A String", # The severity of the error.
"entries": [ # The names of the entries that the error is associated with.
# Format:
#
@@ -286,7 +296,6 @@
"A String",
],
"errorMessage": "A String", # The detailed error messsage.
- "severity": "A String", # The severity of the error.
},
],
}</pre>
@@ -298,10 +307,16 @@
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.
+versions from ImportAgentRequest. After the import, the imported draft
+agent will be trained automatically (unless disabled in agent settings).
+However, once the import is done, training may not be completed yet. Please
+call TrainAgent and wait for the operation it returns in order to train
+explicitly.
Operation <response: google.protobuf.Empty>
+An operation which tracks when importing is complete. It only tracks
+when the draft agent is updated not when it is done training.
Args:
parent: string, Required. The project that the agent to import is associated with.
@@ -328,33 +343,6 @@
"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).
- "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.
- "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.
- },
- "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
@@ -365,6 +353,33 @@
# `TakeSnapshotResponse`.
"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.
+ "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).
+ "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.
+ },
}</pre>
</div>
@@ -373,10 +388,16 @@
<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.
+entity types in the older version are deleted. After the restore, the
+restored draft agent will be trained automatically (unless disabled in
+agent settings). However, once the restore is done, training may not be
+completed yet. Please call TrainAgent and wait for the operation it
+returns in order to train explicitly.
Operation <response: google.protobuf.Empty>
+An operation which tracks when restoring is complete. It only tracks
+when the draft agent is updated not when it is done training.
Args:
parent: string, Required. The project that the agent to restore is associated with.
@@ -403,33 +424,6 @@
"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).
- "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.
- "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.
- },
- "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
@@ -440,11 +434,38 @@
# `TakeSnapshotResponse`.
"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.
+ "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).
+ "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.
+ },
}</pre>
</div>
<div class="method">
- <code class="details" id="search">search(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="search">search(parent, pageSize=None, pageToken=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
@@ -455,9 +476,9 @@
Args:
parent: string, Required. The project to list agents from.
Format: `projects/<Project ID or '-'>`. (required)
- pageToken: string, Optional. 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, Optional. The next_page_token value returned from a previous list request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -467,49 +488,57 @@
An object of the form:
{ # The response message for Agents.SearchAgents.
- "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.
- "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.
+ "agents": [ # The list of agents. There will be a maximum number of items returned based
+ # on the page_size field in the request.
+ { # A Dialogflow agent is a virtual agent that handles conversations with your
+ # end-users. It is a natural language understanding module that understands the
+ # nuances of human language. Dialogflow translates end-user text or audio
+ # during a conversation to structured data that your apps and services can
+ # understand. You design and build a Dialogflow agent to handle the types of
+ # conversations required for your system.
+ #
+ # For more information about agents, see the
+ # [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).
+ "displayName": "A String", # Required. The name of this agent.
+ "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.
+ "parent": "A String", # Required. The project of this agent.
+ # Format: `projects/<Project ID>`.
+ "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.
+ "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.
+ "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
+ "description": "A String", # Optional. The description of this agent.
+ # The maximum length is 500 characters. If exceeded, the request is rejected.
+ "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.
+ "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
+ "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.
+ "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",
+ ],
+ },
+ ],
}</pre>
</div>
@@ -556,33 +585,6 @@
"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).
- "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.
- "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.
- },
- "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
@@ -593,6 +595,33 @@
# `TakeSnapshotResponse`.
"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.
+ "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).
+ "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.
+ },
}</pre>
</div>
@@ -606,32 +635,41 @@
body: object, The request body.
The object takes the form of:
-{ # Represents a fulfillment.
+{ # By default, your agent responds to a matched intent with a static response.
+ # As an alternative, you can provide a more dynamic response by using
+ # fulfillment. When you enable fulfillment for an intent, Dialogflow responds
+ # to that intent by calling a service that you define. For example, if an
+ # end-user wants to schedule a haircut on Friday, your service can check your
+ # database and respond to the end-user with availability information for
+ # Friday.
+ #
+ # For more information, see the [fulfillment
+ # guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).
"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",
},
+ "uri": "A String", # Required. The fulfillment URI for receiving POST requests.
+ # It must use https protocol.
+ "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.
},
+ "enabled": True or False, # Optional. Whether fulfillment is enabled.
+ "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
@@ -644,32 +682,41 @@
Returns:
An object of the form:
- { # Represents a fulfillment.
+ { # By default, your agent responds to a matched intent with a static response.
+ # As an alternative, you can provide a more dynamic response by using
+ # fulfillment. When you enable fulfillment for an intent, Dialogflow responds
+ # to that intent by calling a service that you define. For example, if an
+ # end-user wants to schedule a haircut on Friday, your service can check your
+ # database and respond to the end-user with availability information for
+ # Friday.
+ #
+ # For more information, see the [fulfillment
+ # guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).
"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",
},
+ "uri": "A String", # Required. The fulfillment URI for receiving POST requests.
+ # It must use https protocol.
+ "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.
},
+ "enabled": True or False, # Optional. Whether fulfillment is enabled.
+ "name": "A String", # Required. The unique identifier of the fulfillment.
+ # Format: `projects/<Project ID>/agent/fulfillment`.
}</pre>
</div>