intents

Creates, updates, deletes, gets or lists a intents resource.

Overview

Name	intents
Type	Resource
Id	google.dialogflow.intents

Fields

Name	Datatype	Description
name	string	The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects//locations//agents//intents/.
description	string	Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
displayName	string	Required. The human-readable name of the intent, unique within the agent.
isFallback	boolean	Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
labels	object	The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: sys-head sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent.
parameters	array	The collection of parameters associated with the intent.
priority	integer	The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.
trainingPhrases	array	The collection of training phrases the agent is trained on to identify the intent.

Methods

Name	Accessible by	Required Params	Description
projects_locations_agents_intents_get	SELECT	agentsId, intentsId, locationsId, projectsId	Retrieves the specified intent.
projects_locations_agents_intents_list	SELECT	agentsId, locationsId, projectsId	Returns the list of all intents in the specified agent.
projects_locations_agents_intents_create	INSERT	agentsId, locationsId, projectsId	Creates an intent in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.
projects_locations_agents_intents_delete	DELETE	agentsId, intentsId, locationsId, projectsId	Deletes the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation.
projects_locations_agents_intents_patch	UPDATE	agentsId, intentsId, locationsId, projectsId	Updates the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation.
projects_locations_agents_intents_export	EXEC	agentsId, locationsId, projectsId	Exports the selected intents. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ExportIntentsMetadata - response: ExportIntentsResponse
projects_locations_agents_intents_import	EXEC	agentsId, locationsId, projectsId	Imports the specified intents into the agent. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ImportIntentsMetadata - response: ImportIntentsResponse

SELECT examples

Returns the list of all intents in the specified agent.

SELECT
name,
description,
displayName,
isFallback,
labels,
parameters,
priority,
trainingPhrases
FROM google.dialogflow.intents
WHERE agentsId = '{{ agentsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new intents resource.

All Properties

/*+ create */
INSERT INTO google.dialogflow.intents (
agentsId,
locationsId,
projectsId,
name,
displayName,
trainingPhrases,
parameters,
priority,
isFallback,
labels,
description
)
SELECT 
'{{ agentsId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ displayName }}',
'{{ trainingPhrases }}',
'{{ parameters }}',
'{{ priority }}',
{{ isFallback }},
'{{ labels }}',
'{{ description }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: trainingPhrases
      value:
        - - name: id
            value: string
          - name: parts
            value:
              - - name: text
                  value: string
                - name: parameterId
                  value: string
          - name: repeatCount
            value: integer
    - name: parameters
      value:
        - - name: id
            value: string
          - name: entityType
            value: string
          - name: isList
            value: boolean
          - name: redact
            value: boolean
    - name: priority
      value: integer
    - name: isFallback
      value: boolean
    - name: labels
      value: object
    - name: description
      value: string

UPDATE example

Updates a intents resource.

/*+ update */
UPDATE google.dialogflow.intents
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
trainingPhrases = '{{ trainingPhrases }}',
parameters = '{{ parameters }}',
priority = '{{ priority }}',
isFallback = true|false,
labels = '{{ labels }}',
description = '{{ description }}'
WHERE 
agentsId = '{{ agentsId }}'
AND intentsId = '{{ intentsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified intents resource.

/*+ delete */
DELETE FROM google.dialogflow.intents
WHERE agentsId = '{{ agentsId }}'
AND intentsId = '{{ intentsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';