google_api_dialogflow v0.38.0 GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent View Source

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.

Attributes

  • action (type: String.t, default: nil) - Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.

  • defaultResponsePlatforms (type: list(String.t), default: nil) - Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

  • displayName (type: String.t, default: nil) - Required. The name of this intent.

  • events (type: list(String.t), default: nil) - Optional. 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. Event names are limited to 150 characters.

  • followupIntentInfo (type: list(GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2IntentFollowupIntentInfo.t), default: nil) - Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

  • inputContextNames (type: list(String.t), default: nil) - Optional. The list of context names required for this intent to be triggered. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

  • isFallback (type: boolean(), default: nil) - Optional. Indicates whether this is a fallback intent.

  • messages (type: list(GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2IntentMessage.t), default: nil) - Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

  • mlDisabled (type: boolean(), default: nil) - Optional. Indicates whether Machine Learning is disabled for the intent. Note: If ml_disabled 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.

  • name (type: String.t, default: nil) - Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: projects/<Project ID>/agent/intents/<Intent ID>.

  • outputContexts (type: list(GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t), default: nil) - Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

  • parameters (type: list(GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2IntentParameter.t), default: nil) - Optional. The collection of parameters associated with the intent.

  • parentFollowupIntentName (type: String.t, default: nil) - 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: projects/<Project ID>/agent/intents/<Intent ID>.

  • priority (type: integer(), default: nil) - Optional. 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.
  • resetContexts (type: boolean(), default: nil) - Optional. Indicates whether to delete all contexts in the current session when this intent is matched.

  • rootFollowupIntentName (type: String.t, default: nil) - 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: projects/<Project ID>/agent/intents/<Intent ID>.

  • trainingPhrases (type: list(GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2IntentTrainingPhrase.t), default: nil) - Optional. The collection of examples that the agent is trained on.

  • webhookState (type: String.t, default: nil) - Optional. Indicates whether webhooks are enabled for the intent.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

View Source
t() :: %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent{
  action: String.t(),
  defaultResponsePlatforms: [String.t()],
  displayName: String.t(),
  events: [String.t()],
  followupIntentInfo: [
    GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2IntentFollowupIntentInfo.t()
  ],
  inputContextNames: [String.t()],
  isFallback: boolean(),
  messages: [
    GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2IntentMessage.t()
  ],
  mlDisabled: boolean(),
  name: String.t(),
  outputContexts: [
    GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t()
  ],
  parameters: [
    GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2IntentParameter.t()
  ],
  parentFollowupIntentName: String.t(),
  priority: integer(),
  resetContexts: boolean(),
  rootFollowupIntentName: String.t(),
  trainingPhrases: [
    GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2IntentTrainingPhrase.t()
  ],
  webhookState: String.t()
}

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.