Intent.yaml

# Copyright 2024 Google Inc.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

---
name: 'Intent'
description: |
  Represents a Dialogflow 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.
references:
  guides:
    'Official Documentation': 'https://cloud.google.com/dialogflow/docs/'
  api: 'https://cloud.google.com/dialogflow/docs/reference/rest/v2/projects.agent.intents'
docs:
id_format: '{{name}}'
base_url: 'projects/{{project}}/agent/intents/'
self_link: '{{name}}'
update_verb: 'PATCH'
import_format:
  - '{{name}}'
timeouts:
  insert_minutes: 20
  update_minutes: 20
  delete_minutes: 20
custom_code:
  custom_import: 'templates/terraform/custom_import/self_link_as_name_set_project.go.tmpl'
# Skip sweeper gen since this is a child resource.
exclude_sweeper: true
examples:
  - name: 'dialogflow_intent_basic'
    primary_resource_id: 'basic_intent'
    vars:
      intent_name: 'basic-intent'
    exclude_test: true
  - name: 'dialogflow_intent_full'
    primary_resource_id: 'full_intent'
    vars:
      project_id: 'my-project'
      account_id: 'my-account'
      intent_name: 'full-intent'
    test_env_vars:
      org_id: 'ORG_ID'
parameters:
properties:
  - name: 'name'
    type: String
    description: |
      The unique identifier of this intent.
      Format: projects/<Project ID>/agent/intents/<Intent ID>.
    output: true
  - name: 'displayName'
    type: String
    description: |
      The name of this intent to be displayed on the console.
    required: true
  - name: 'webhookState'
    type: Enum
    description: |
      Indicates whether webhooks are enabled for the intent.
      * WEBHOOK_STATE_ENABLED: Webhook is enabled in the agent and in the intent.
      * WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING: Webhook is enabled in the agent and in the intent. Also, each slot
      filling prompt is forwarded to the webhook.
    default_from_api: true
    enum_values:
      - 'WEBHOOK_STATE_ENABLED'
      - 'WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING'
  - name: 'priority'
    type: Integer
    description: |
      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.
    default_from_api: true
  - name: 'isFallback'
    type: Boolean
    description: |
      Indicates whether this is a fallback intent.
    default_from_api: true
  - name: 'mlDisabled'
    type: Boolean
    description: |
      Indicates whether Machine Learning is disabled for the intent.
      Note: If mlDisabled setting is set to true, then this intent is not taken into account during inference in ML
      ONLY match mode. Also, auto-markup in the UI is turned off.
    default_from_api: true
  - name: 'inputContextNames'
    type: Array
    description: |
      The list of context names required for this intent to be triggered.
      Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.
    item_type:
      type: String
  - name: 'events'
    type: Array
    description: |
      The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of
      the contexts must be present in the active user session for an event to trigger this intent. See the
      [events reference](https://cloud.google.com/dialogflow/docs/events-overview) for more details.
    item_type:
      type: String
  - name: 'action'
    type: String
    description: |
      The name of the action associated with the intent.
      Note: The action name must not contain whitespaces.
    default_from_api: true
  - name: 'resetContexts'
    type: Boolean
    description: |
      Indicates whether to delete all contexts in the current session when this intent is matched.
    default_from_api: true
  - name: 'defaultResponsePlatforms'
    type: Array
    description: |
      The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED
      (i.e. default platform).
    item_type:
      type: Enum
      description: |
        Represents different platforms that a rich message can be intended for.
      enum_values:
        - 'FACEBOOK'
        - 'SLACK'
        - 'TELEGRAM'
        - 'KIK'
        - 'SKYPE'
        - 'LINE'
        - 'VIBER'
        - 'ACTIONS_ON_GOOGLE'
        - 'GOOGLE_HANGOUTS'
  - name: 'rootFollowupIntentName'
    type: String
    description: |
      The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup
      intents chain for this intent.
      Format: projects/<Project ID>/agent/intents/<Intent ID>.
    output: true
  - name: 'parentFollowupIntentName'
    type: String
    description: |
      The unique identifier of the parent intent in the chain of followup intents.
      Format: projects/<Project ID>/agent/intents/<Intent ID>.
    immutable: true
    default_from_api: true
  - name: 'followupIntentInfo'
    type: Array
    description: |
      Information about all followup intents that have this intent as a direct or indirect parent. We populate this field
      only in the output.
    output: true
    item_type:
      type: NestedObject
      properties:
        - name: 'followupIntentName'
          type: String
          description: |
            The unique identifier of the followup intent.
            Format: projects/<Project ID>/agent/intents/<Intent ID>.
        - name: 'parentFollowupIntentName'
          type: String
          description: |
            The unique identifier of the followup intent's parent.
            Format: projects/<Project ID>/agent/intents/<Intent ID>.