Batch Update
|
|||||
|
|
Updates/Creates multiple intents in the specified agent.
Operation <response: BatchUpdateIntentsResponse>
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View, manage and query your Dialogflow agents
Input
This building block consumes 25 input parameters
Name | Format | Description |
---|---|---|
parent Required |
STRING |
Required. The name of the agent to update or create intents in.
Format: |
intentBatchUri |
STRING |
The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://" |
intentView |
ENUMERATION |
Optional. The resource view to apply to the returned intent |
intentBatchInline |
OBJECT |
This message is a wrapper around a collection of intents |
intentBatchInline.intents[] |
OBJECT |
Represents an intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics |
intentBatchInline.intents[].outputContexts[] |
OBJECT |
Represents a context |
intentBatchInline.intents[].defaultResponsePlatforms[] |
ENUMERATION |
|
intentBatchInline.intents[].action |
STRING |
Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces |
intentBatchInline.intents[].name |
STRING |
The unique identifier of this intent.
Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
methods.
Format: |
intentBatchInline.intents[].messages[] |
OBJECT |
Corresponds to the |
intentBatchInline.intents[].inputContextNames[] |
STRING |
|
intentBatchInline.intents[].webhookState |
ENUMERATION |
Optional. Indicates whether webhooks are enabled for the intent |
intentBatchInline.intents[].followupIntentInfo[] |
OBJECT |
Represents a single followup intent in the chain |
intentBatchInline.intents[].displayName |
STRING |
Required. The name of this intent |
intentBatchInline.intents[].rootFollowupIntentName |
STRING |
Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output. Format: |
intentBatchInline.intents[].mlDisabled |
BOOLEAN |
Optional. Indicates whether Machine Learning is disabled for the intent.
Note: If |
intentBatchInline.intents[].isFallback |
BOOLEAN |
Optional. Indicates whether this is a fallback intent |
intentBatchInline.intents[].parameters[] |
OBJECT |
Represents intent parameters |
intentBatchInline.intents[].resetContexts |
BOOLEAN |
Optional. Indicates whether to delete all contexts in the current session when this intent is matched |
intentBatchInline.intents[].trainingPhrases[] |
OBJECT |
Represents an example that the agent is trained on |
intentBatchInline.intents[].parentFollowupIntentName |
STRING |
Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent.
Format: |
intentBatchInline.intents[].events[] |
STRING |
|
intentBatchInline.intents[].priority |
INTEGER |
Optional. The priority of this intent. Higher numbers represent higher priorities. If this is zero or unspecified, we use the default priority 500000. Negative numbers mean that the intent is disabled |
languageCode |
STRING |
Optional. The language of training phrases, parameters and rich messages
defined in |
updateMask |
ANY |
Optional. The mask to control which fields get updated |
= Parameter name
= Format
parent STRING Required Required. The name of the agent to update or create intents in.
Format: |
intentBatchUri STRING The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://" |
intentView ENUMERATION Optional. The resource view to apply to the returned intent |
intentBatchInline OBJECT This message is a wrapper around a collection of intents |
intentBatchInline.intents[] OBJECT Represents an intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics |
intentBatchInline.intents[].outputContexts[] OBJECT Represents a context |
intentBatchInline.intents[].defaultResponsePlatforms[] ENUMERATION |
intentBatchInline.intents[].action STRING Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces |
intentBatchInline.intents[].name STRING The unique identifier of this intent.
Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
methods.
Format: |
intentBatchInline.intents[].messages[] OBJECT Corresponds to the |
intentBatchInline.intents[].inputContextNames[] STRING |
intentBatchInline.intents[].webhookState ENUMERATION Optional. Indicates whether webhooks are enabled for the intent |
intentBatchInline.intents[].followupIntentInfo[] OBJECT Represents a single followup intent in the chain |
intentBatchInline.intents[].displayName STRING Required. The name of this intent |
intentBatchInline.intents[].rootFollowupIntentName STRING Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output. Format: |
intentBatchInline.intents[].mlDisabled BOOLEAN Optional. Indicates whether Machine Learning is disabled for the intent.
Note: If |
intentBatchInline.intents[].isFallback BOOLEAN Optional. Indicates whether this is a fallback intent |
intentBatchInline.intents[].parameters[] OBJECT Represents intent parameters |
intentBatchInline.intents[].resetContexts BOOLEAN Optional. Indicates whether to delete all contexts in the current session when this intent is matched |
intentBatchInline.intents[].trainingPhrases[] OBJECT Represents an example that the agent is trained on |
intentBatchInline.intents[].parentFollowupIntentName STRING Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent.
Format: |
intentBatchInline.intents[].events[] STRING |
intentBatchInline.intents[].priority INTEGER Optional. The priority of this intent. Higher numbers represent higher priorities. If this is zero or unspecified, we use the default priority 500000. Negative numbers mean that the intent is disabled |
languageCode STRING Optional. The language of training phrases, parameters and rich messages
defined in |
updateMask ANY Optional. The mask to control which fields get updated |
Output
This building block provides 11 output parameters
Name | Format | Description |
---|---|---|
response |
OBJECT |
The normal response of the operation in case of success. If the original
method returns no data on success, such as |
response.customKey.value |
ANY |
The normal response of the operation in case of success. If the original
method returns no data on success, such as |
name |
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
|
error |
OBJECT |
The You can find out more about this error model and how to work with it in the API Design Guide |
error.code |
INTEGER |
The status code, which should be an enum value of google.rpc.Code |
error.message |
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 |
error.details[] |
OBJECT |
|
error.details[].customKey.value |
ANY |
|
metadata |
OBJECT |
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 |
metadata.customKey.value |
ANY |
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 |
done |
BOOLEAN |
If the value is |
= Parameter name
= Format
response OBJECT The normal response of the operation in case of success. If the original
method returns no data on success, such as |
response.customKey.value ANY The normal response of the operation in case of success. If the original
method returns no data on success, such as |
name 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
|
error OBJECT The You can find out more about this error model and how to work with it in the API Design Guide |
error.code INTEGER The status code, which should be an enum value of google.rpc.Code |
error.message 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 |
error.details[] OBJECT |
error.details[].customKey.value ANY |
metadata OBJECT 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 |
metadata.customKey.value ANY 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 |
done BOOLEAN If the value is |