diagflow

package
v3.25.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 22, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Agent 

type Agent struct {
	pulumi.CustomResourceState

	// 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.
	// * API_VERSION_V1: Legacy V1 API.
	// * API_VERSION_V2: V2 API.
	// * API_VERSION_V2_BETA_1: V2beta1 API.
	//   Possible values are `API_VERSION_V1`, `API_VERSION_V2`, and `API_VERSION_V2_BETA_1`.
	ApiVersion pulumi.StringOutput `pulumi:"apiVersion"`
	// The URI of the agent's avatar, which are used throughout the Dialogflow console. When an image URL is entered
	// into this field, the Dialogflow will save the image in the backend. The address of the backend image returned
	// from the API will be shown in the [avatarUriBackend] field.
	AvatarUri pulumi.StringPtrOutput `pulumi:"avatarUri"`
	// The URI of the agent's avatar as returned from the API. Output only. To provide an image URL for the agent avatar, the
	// [avatarUri] field can be used.
	AvatarUriBackend pulumi.StringOutput `pulumi:"avatarUriBackend"`
	// 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.
	ClassificationThreshold pulumi.Float64PtrOutput `pulumi:"classificationThreshold"`
	// 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 updated after creation.
	DefaultLanguageCode pulumi.StringOutput `pulumi:"defaultLanguageCode"`
	// The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The name of this agent.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// Determines whether this agent should log conversation queries.
	EnableLogging pulumi.BoolPtrOutput `pulumi:"enableLogging"`
	// Determines how intents are detected from user queries.
	// * MATCH_MODE_HYBRID: Best for agents with a small number of examples in intents and/or wide use of templates
	//   syntax and composite entities.
	// * MATCH_MODE_ML_ONLY: Can be used for agents with a large number of examples in intents, especially the ones
	//   using @sys.any or very large developer entities.
	//   Possible values are `MATCH_MODE_HYBRID` and `MATCH_MODE_ML_ONLY`.
	MatchMode pulumi.StringOutput `pulumi:"matchMode"`
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringOutput `pulumi:"project"`
	// The list of all languages supported by this agent (except for the defaultLanguageCode).
	SupportedLanguageCodes pulumi.StringArrayOutput `pulumi:"supportedLanguageCodes"`
	// The agent tier. If not specified, TIER_STANDARD is assumed.
	// * TIER_STANDARD: Standard tier.
	// * TIER_ENTERPRISE: Enterprise tier (Essentials).
	// * TIER_ENTERPRISE_PLUS: Enterprise tier (Plus).
	//   NOTE: Due to consistency issues, the provider will not read this field from the API. Drift is possible between
	//   the the provider state and Dialogflow if the agent tier is changed outside of the provider.
	Tier pulumi.StringPtrOutput `pulumi:"tier"`
	// The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York,
	// Europe/Paris.
	TimeZone pulumi.StringOutput `pulumi:"timeZone"`
}

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.

To get more information about Agent, see:

* [API documentation](https://cloud.google.com/dialogflow/docs/reference/rest/v2/projects/agent) * How-to Guides

## Example Usage

func GetAgent 

func GetAgent(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AgentState, opts ...pulumi.ResourceOption) (*Agent, error)

GetAgent gets an existing Agent resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAgent 

func NewAgent(ctx *pulumi.Context,
	name string, args *AgentArgs, opts ...pulumi.ResourceOption) (*Agent, error)

NewAgent registers a new resource with the given unique name, arguments, and options.

type AgentArgs 

type AgentArgs struct {
	// 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.
	// * API_VERSION_V1: Legacy V1 API.
	// * API_VERSION_V2: V2 API.
	// * API_VERSION_V2_BETA_1: V2beta1 API.
	//   Possible values are `API_VERSION_V1`, `API_VERSION_V2`, and `API_VERSION_V2_BETA_1`.
	ApiVersion pulumi.StringPtrInput
	// The URI of the agent's avatar, which are used throughout the Dialogflow console. When an image URL is entered
	// into this field, the Dialogflow will save the image in the backend. The address of the backend image returned
	// from the API will be shown in the [avatarUriBackend] field.
	AvatarUri pulumi.StringPtrInput
	// 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.
	ClassificationThreshold pulumi.Float64PtrInput
	// 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 updated after creation.
	DefaultLanguageCode pulumi.StringInput
	// The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
	Description pulumi.StringPtrInput
	// The name of this agent.
	DisplayName pulumi.StringInput
	// Determines whether this agent should log conversation queries.
	EnableLogging pulumi.BoolPtrInput
	// Determines how intents are detected from user queries.
	// * MATCH_MODE_HYBRID: Best for agents with a small number of examples in intents and/or wide use of templates
	//   syntax and composite entities.
	// * MATCH_MODE_ML_ONLY: Can be used for agents with a large number of examples in intents, especially the ones
	//   using @sys.any or very large developer entities.
	//   Possible values are `MATCH_MODE_HYBRID` and `MATCH_MODE_ML_ONLY`.
	MatchMode pulumi.StringPtrInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// The list of all languages supported by this agent (except for the defaultLanguageCode).
	SupportedLanguageCodes pulumi.StringArrayInput
	// The agent tier. If not specified, TIER_STANDARD is assumed.
	// * TIER_STANDARD: Standard tier.
	// * TIER_ENTERPRISE: Enterprise tier (Essentials).
	// * TIER_ENTERPRISE_PLUS: Enterprise tier (Plus).
	//   NOTE: Due to consistency issues, the provider will not read this field from the API. Drift is possible between
	//   the the provider state and Dialogflow if the agent tier is changed outside of the provider.
	Tier pulumi.StringPtrInput
	// The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York,
	// Europe/Paris.
	TimeZone pulumi.StringInput
}

The set of arguments for constructing a Agent resource.

func (AgentArgs) ElementType 

func (AgentArgs) ElementType() reflect.Type

type AgentState 

type AgentState struct {
	// 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.
	// * API_VERSION_V1: Legacy V1 API.
	// * API_VERSION_V2: V2 API.
	// * API_VERSION_V2_BETA_1: V2beta1 API.
	//   Possible values are `API_VERSION_V1`, `API_VERSION_V2`, and `API_VERSION_V2_BETA_1`.
	ApiVersion pulumi.StringPtrInput
	// The URI of the agent's avatar, which are used throughout the Dialogflow console. When an image URL is entered
	// into this field, the Dialogflow will save the image in the backend. The address of the backend image returned
	// from the API will be shown in the [avatarUriBackend] field.
	AvatarUri pulumi.StringPtrInput
	// The URI of the agent's avatar as returned from the API. Output only. To provide an image URL for the agent avatar, the
	// [avatarUri] field can be used.
	AvatarUriBackend pulumi.StringPtrInput
	// 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.
	ClassificationThreshold pulumi.Float64PtrInput
	// 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 updated after creation.
	DefaultLanguageCode pulumi.StringPtrInput
	// The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
	Description pulumi.StringPtrInput
	// The name of this agent.
	DisplayName pulumi.StringPtrInput
	// Determines whether this agent should log conversation queries.
	EnableLogging pulumi.BoolPtrInput
	// Determines how intents are detected from user queries.
	// * MATCH_MODE_HYBRID: Best for agents with a small number of examples in intents and/or wide use of templates
	//   syntax and composite entities.
	// * MATCH_MODE_ML_ONLY: Can be used for agents with a large number of examples in intents, especially the ones
	//   using @sys.any or very large developer entities.
	//   Possible values are `MATCH_MODE_HYBRID` and `MATCH_MODE_ML_ONLY`.
	MatchMode pulumi.StringPtrInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// The list of all languages supported by this agent (except for the defaultLanguageCode).
	SupportedLanguageCodes pulumi.StringArrayInput
	// The agent tier. If not specified, TIER_STANDARD is assumed.
	// * TIER_STANDARD: Standard tier.
	// * TIER_ENTERPRISE: Enterprise tier (Essentials).
	// * TIER_ENTERPRISE_PLUS: Enterprise tier (Plus).
	//   NOTE: Due to consistency issues, the provider will not read this field from the API. Drift is possible between
	//   the the provider state and Dialogflow if the agent tier is changed outside of the provider.
	Tier pulumi.StringPtrInput
	// The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York,
	// Europe/Paris.
	TimeZone pulumi.StringPtrInput
}

func (AgentState) ElementType 

func (AgentState) ElementType() reflect.Type

type EntityType added in v3.6.0 

type EntityType struct {
	pulumi.CustomResourceState

	// The name of this entity type to be displayed on the console.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// Enables fuzzy entity extraction during classification.
	EnableFuzzyExtraction pulumi.BoolPtrOutput `pulumi:"enableFuzzyExtraction"`
	// The collection of entity entries associated with the entity type.
	// Structure is documented below.
	Entities EntityTypeEntityArrayOutput `pulumi:"entities"`
	// Indicates the kind of entity type.
	// * KIND_MAP: Map entity types allow mapping of a group of synonyms to a reference value.
	// * KIND_LIST: List entity types contain a set of entries that do not map to reference values. However, list entity
	//   types can contain references to other entity types (with or without aliases).
	// * KIND_REGEXP: Regexp entity types allow to specify regular expressions in entries values.
	//   Possible values are `KIND_MAP`, `KIND_LIST`, and `KIND_REGEXP`.
	Kind pulumi.StringOutput `pulumi:"kind"`
	// The unique identifier of the entity type. Format: projects/<Project ID>/agent/entityTypes/<Entity type ID>.
	Name pulumi.StringOutput `pulumi:"name"`
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringOutput `pulumi:"project"`
}

Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries.

To get more information about EntityType, see:

* [API documentation](https://cloud.google.com/dialogflow/docs/reference/rest/v2/projects.agent.entityTypes) * How-to Guides

## Example Usage

func GetEntityType added in v3.6.0 

func GetEntityType(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *EntityTypeState, opts ...pulumi.ResourceOption) (*EntityType, error)

GetEntityType gets an existing EntityType resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewEntityType added in v3.6.0 

func NewEntityType(ctx *pulumi.Context,
	name string, args *EntityTypeArgs, opts ...pulumi.ResourceOption) (*EntityType, error)

NewEntityType registers a new resource with the given unique name, arguments, and options.

type EntityTypeArgs added in v3.6.0 

type EntityTypeArgs struct {
	// The name of this entity type to be displayed on the console.
	DisplayName pulumi.StringInput
	// Enables fuzzy entity extraction during classification.
	EnableFuzzyExtraction pulumi.BoolPtrInput
	// The collection of entity entries associated with the entity type.
	// Structure is documented below.
	Entities EntityTypeEntityArrayInput
	// Indicates the kind of entity type.
	// * KIND_MAP: Map entity types allow mapping of a group of synonyms to a reference value.
	// * KIND_LIST: List entity types contain a set of entries that do not map to reference values. However, list entity
	//   types can contain references to other entity types (with or without aliases).
	// * KIND_REGEXP: Regexp entity types allow to specify regular expressions in entries values.
	//   Possible values are `KIND_MAP`, `KIND_LIST`, and `KIND_REGEXP`.
	Kind pulumi.StringInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
}

The set of arguments for constructing a EntityType resource.

func (EntityTypeArgs) ElementType added in v3.6.0 

func (EntityTypeArgs) ElementType() reflect.Type

type EntityTypeEntity added in v3.6.0 

type EntityTypeEntity struct {
	// A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym
	// could be green onions.
	// For KIND_LIST entity types:
	// * This collection must contain exactly one synonym equal to value.
	Synonyms []string `pulumi:"synonyms"`
	// The primary value associated with this entity entry. For example, if the entity type is vegetable, the value
	// could be scallions.
	// For KIND_MAP entity types:
	// * A reference value to be used in place of synonyms.
	//   For KIND_LIST entity types:
	// * A string that can contain references to other entity types (with or without aliases).
	Value string `pulumi:"value"`
}

type EntityTypeEntityArgs added in v3.6.0 

type EntityTypeEntityArgs struct {
	// A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym
	// could be green onions.
	// For KIND_LIST entity types:
	// * This collection must contain exactly one synonym equal to value.
	Synonyms pulumi.StringArrayInput `pulumi:"synonyms"`
	// The primary value associated with this entity entry. For example, if the entity type is vegetable, the value
	// could be scallions.
	// For KIND_MAP entity types:
	// * A reference value to be used in place of synonyms.
	//   For KIND_LIST entity types:
	// * A string that can contain references to other entity types (with or without aliases).
	Value pulumi.StringInput `pulumi:"value"`
}

func (EntityTypeEntityArgs) ElementType added in v3.6.0 

func (EntityTypeEntityArgs) ElementType() reflect.Type

func (EntityTypeEntityArgs) ToEntityTypeEntityOutput added in v3.6.0 

func (i EntityTypeEntityArgs) ToEntityTypeEntityOutput() EntityTypeEntityOutput

func (EntityTypeEntityArgs) ToEntityTypeEntityOutputWithContext added in v3.6.0 

func (i EntityTypeEntityArgs) ToEntityTypeEntityOutputWithContext(ctx context.Context) EntityTypeEntityOutput

type EntityTypeEntityArray added in v3.6.0 

type EntityTypeEntityArray []EntityTypeEntityInput

func (EntityTypeEntityArray) ElementType added in v3.6.0 

func (EntityTypeEntityArray) ElementType() reflect.Type

func (EntityTypeEntityArray) ToEntityTypeEntityArrayOutput added in v3.6.0 

func (i EntityTypeEntityArray) ToEntityTypeEntityArrayOutput() EntityTypeEntityArrayOutput

func (EntityTypeEntityArray) ToEntityTypeEntityArrayOutputWithContext added in v3.6.0 

func (i EntityTypeEntityArray) ToEntityTypeEntityArrayOutputWithContext(ctx context.Context) EntityTypeEntityArrayOutput

type EntityTypeEntityArrayInput added in v3.6.0 

type EntityTypeEntityArrayInput interface {
	pulumi.Input

	ToEntityTypeEntityArrayOutput() EntityTypeEntityArrayOutput
	ToEntityTypeEntityArrayOutputWithContext(context.Context) EntityTypeEntityArrayOutput
}

EntityTypeEntityArrayInput is an input type that accepts EntityTypeEntityArray and EntityTypeEntityArrayOutput values. You can construct a concrete instance of `EntityTypeEntityArrayInput` via: 

EntityTypeEntityArray{ EntityTypeEntityArgs{...} }

type EntityTypeEntityArrayOutput added in v3.6.0 

type EntityTypeEntityArrayOutput struct{ *pulumi.OutputState }

func (EntityTypeEntityArrayOutput) ElementType added in v3.6.0 

func (EntityTypeEntityArrayOutput) ElementType() reflect.Type

func (EntityTypeEntityArrayOutput) Index added in v3.6.0 

func (o EntityTypeEntityArrayOutput) Index(i pulumi.IntInput) EntityTypeEntityOutput

func (EntityTypeEntityArrayOutput) ToEntityTypeEntityArrayOutput added in v3.6.0 

func (o EntityTypeEntityArrayOutput) ToEntityTypeEntityArrayOutput() EntityTypeEntityArrayOutput

func (EntityTypeEntityArrayOutput) ToEntityTypeEntityArrayOutputWithContext added in v3.6.0 

func (o EntityTypeEntityArrayOutput) ToEntityTypeEntityArrayOutputWithContext(ctx context.Context) EntityTypeEntityArrayOutput

type EntityTypeEntityInput added in v3.6.0 

type EntityTypeEntityInput interface {
	pulumi.Input

	ToEntityTypeEntityOutput() EntityTypeEntityOutput
	ToEntityTypeEntityOutputWithContext(context.Context) EntityTypeEntityOutput
}

EntityTypeEntityInput is an input type that accepts EntityTypeEntityArgs and EntityTypeEntityOutput values. You can construct a concrete instance of `EntityTypeEntityInput` via: 

EntityTypeEntityArgs{...}

type EntityTypeEntityOutput added in v3.6.0 

type EntityTypeEntityOutput struct{ *pulumi.OutputState }

func (EntityTypeEntityOutput) ElementType added in v3.6.0 

func (EntityTypeEntityOutput) ElementType() reflect.Type

func (EntityTypeEntityOutput) Synonyms added in v3.6.0 

func (o EntityTypeEntityOutput) Synonyms() pulumi.StringArrayOutput

A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions. For KIND_LIST entity types: * This collection must contain exactly one synonym equal to value.

func (EntityTypeEntityOutput) ToEntityTypeEntityOutput added in v3.6.0 

func (o EntityTypeEntityOutput) ToEntityTypeEntityOutput() EntityTypeEntityOutput

func (EntityTypeEntityOutput) ToEntityTypeEntityOutputWithContext added in v3.6.0 

func (o EntityTypeEntityOutput) ToEntityTypeEntityOutputWithContext(ctx context.Context) EntityTypeEntityOutput

func (EntityTypeEntityOutput) Value added in v3.6.0 

func (o EntityTypeEntityOutput) Value() pulumi.StringOutput

The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions. For KIND_MAP entity types:

  • A reference value to be used in place of synonyms. For KIND_LIST entity types:
  • A string that can contain references to other entity types (with or without aliases).

type EntityTypeState added in v3.6.0 

type EntityTypeState struct {
	// The name of this entity type to be displayed on the console.
	DisplayName pulumi.StringPtrInput
	// Enables fuzzy entity extraction during classification.
	EnableFuzzyExtraction pulumi.BoolPtrInput
	// The collection of entity entries associated with the entity type.
	// Structure is documented below.
	Entities EntityTypeEntityArrayInput
	// Indicates the kind of entity type.
	// * KIND_MAP: Map entity types allow mapping of a group of synonyms to a reference value.
	// * KIND_LIST: List entity types contain a set of entries that do not map to reference values. However, list entity
	//   types can contain references to other entity types (with or without aliases).
	// * KIND_REGEXP: Regexp entity types allow to specify regular expressions in entries values.
	//   Possible values are `KIND_MAP`, `KIND_LIST`, and `KIND_REGEXP`.
	Kind pulumi.StringPtrInput
	// The unique identifier of the entity type. Format: projects/<Project ID>/agent/entityTypes/<Entity type ID>.
	Name pulumi.StringPtrInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
}

func (EntityTypeState) ElementType added in v3.6.0 

func (EntityTypeState) ElementType() reflect.Type

type Intent added in v3.1.0 

type Intent struct {
	pulumi.CustomResourceState

	// The name of the action associated with the intent.
	// Note: The action name must not contain whitespaces.
	Action pulumi.StringOutput `pulumi:"action"`
	// The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED
	// (i.e. default platform).
	// Each value may be one of `FACEBOOK`, `SLACK`, `TELEGRAM`, `KIK`, `SKYPE`, `LINE`, `VIBER`, `ACTIONS_ON_GOOGLE`, and `GOOGLE_HANGOUTS`.
	DefaultResponsePlatforms pulumi.StringArrayOutput `pulumi:"defaultResponsePlatforms"`
	// The name of this intent to be displayed on the console.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// 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.
	Events pulumi.StringArrayOutput `pulumi:"events"`
	// Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only
	// in the output.
	FollowupIntentInfos IntentFollowupIntentInfoArrayOutput `pulumi:"followupIntentInfos"`
	// The list of context names required for this intent to be triggered.
	// Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.
	InputContextNames pulumi.StringArrayOutput `pulumi:"inputContextNames"`
	// Indicates whether this is a fallback intent.
	IsFallback pulumi.BoolOutput `pulumi:"isFallback"`
	// 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.
	MlDisabled pulumi.BoolOutput `pulumi:"mlDisabled"`
	// The unique identifier of this intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.
	Name pulumi.StringOutput `pulumi:"name"`
	// The unique identifier of the parent intent in the chain of followup intents.
	// Format: projects/<Project ID>/agent/intents/<Intent ID>.
	ParentFollowupIntentName pulumi.StringOutput `pulumi:"parentFollowupIntentName"`
	// 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.
	Priority pulumi.IntOutput `pulumi:"priority"`
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringOutput `pulumi:"project"`
	// Indicates whether to delete all contexts in the current session when this intent is matched.
	ResetContexts pulumi.BoolOutput `pulumi:"resetContexts"`
	// 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>.
	RootFollowupIntentName pulumi.StringOutput `pulumi:"rootFollowupIntentName"`
	// 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.
	//   Possible values are `WEBHOOK_STATE_ENABLED` and `WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING`.
	WebhookState pulumi.StringOutput `pulumi:"webhookState"`
}

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.

To get more information about Intent, see:

* [API documentation](https://cloud.google.com/dialogflow/docs/reference/rest/v2/projects.agent.intents) * How-to Guides

## Example Usage

func GetIntent added in v3.1.0 

func GetIntent(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *IntentState, opts ...pulumi.ResourceOption) (*Intent, error)

GetIntent gets an existing Intent resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewIntent added in v3.1.0 

func NewIntent(ctx *pulumi.Context,
	name string, args *IntentArgs, opts ...pulumi.ResourceOption) (*Intent, error)

NewIntent registers a new resource with the given unique name, arguments, and options.

type IntentArgs added in v3.1.0 

type IntentArgs struct {
	// The name of the action associated with the intent.
	// Note: The action name must not contain whitespaces.
	Action pulumi.StringPtrInput
	// The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED
	// (i.e. default platform).
	// Each value may be one of `FACEBOOK`, `SLACK`, `TELEGRAM`, `KIK`, `SKYPE`, `LINE`, `VIBER`, `ACTIONS_ON_GOOGLE`, and `GOOGLE_HANGOUTS`.
	DefaultResponsePlatforms pulumi.StringArrayInput
	// The name of this intent to be displayed on the console.
	DisplayName pulumi.StringInput
	// 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.
	Events pulumi.StringArrayInput
	// The list of context names required for this intent to be triggered.
	// Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.
	InputContextNames pulumi.StringArrayInput
	// Indicates whether this is a fallback intent.
	IsFallback pulumi.BoolPtrInput
	// 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.
	MlDisabled pulumi.BoolPtrInput
	// The unique identifier of the parent intent in the chain of followup intents.
	// Format: projects/<Project ID>/agent/intents/<Intent ID>.
	ParentFollowupIntentName pulumi.StringPtrInput
	// 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.
	Priority pulumi.IntPtrInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// Indicates whether to delete all contexts in the current session when this intent is matched.
	ResetContexts pulumi.BoolPtrInput
	// 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.
	//   Possible values are `WEBHOOK_STATE_ENABLED` and `WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING`.
	WebhookState pulumi.StringPtrInput
}

The set of arguments for constructing a Intent resource.

func (IntentArgs) ElementType added in v3.1.0 

func (IntentArgs) ElementType() reflect.Type

type IntentFollowupIntentInfo added in v3.1.0 

type IntentFollowupIntentInfo struct {
	FollowupIntentName *string `pulumi:"followupIntentName"`
	// The unique identifier of the parent intent in the chain of followup intents.
	// Format: projects/<Project ID>/agent/intents/<Intent ID>.
	ParentFollowupIntentName *string `pulumi:"parentFollowupIntentName"`
}

type IntentFollowupIntentInfoArgs added in v3.1.0 

type IntentFollowupIntentInfoArgs struct {
	FollowupIntentName pulumi.StringPtrInput `pulumi:"followupIntentName"`
	// The unique identifier of the parent intent in the chain of followup intents.
	// Format: projects/<Project ID>/agent/intents/<Intent ID>.
	ParentFollowupIntentName pulumi.StringPtrInput `pulumi:"parentFollowupIntentName"`
}

func (IntentFollowupIntentInfoArgs) ElementType added in v3.1.0 

func (IntentFollowupIntentInfoArgs) ElementType() reflect.Type

func (IntentFollowupIntentInfoArgs) ToIntentFollowupIntentInfoOutput added in v3.1.0 

func (i IntentFollowupIntentInfoArgs) ToIntentFollowupIntentInfoOutput() IntentFollowupIntentInfoOutput

func (IntentFollowupIntentInfoArgs) ToIntentFollowupIntentInfoOutputWithContext added in v3.1.0 

func (i IntentFollowupIntentInfoArgs) ToIntentFollowupIntentInfoOutputWithContext(ctx context.Context) IntentFollowupIntentInfoOutput

type IntentFollowupIntentInfoArray added in v3.1.0 

type IntentFollowupIntentInfoArray []IntentFollowupIntentInfoInput

func (IntentFollowupIntentInfoArray) ElementType added in v3.1.0 

func (IntentFollowupIntentInfoArray) ElementType() reflect.Type

func (IntentFollowupIntentInfoArray) ToIntentFollowupIntentInfoArrayOutput added in v3.1.0 

func (i IntentFollowupIntentInfoArray) ToIntentFollowupIntentInfoArrayOutput() IntentFollowupIntentInfoArrayOutput

func (IntentFollowupIntentInfoArray) ToIntentFollowupIntentInfoArrayOutputWithContext added in v3.1.0 

func (i IntentFollowupIntentInfoArray) ToIntentFollowupIntentInfoArrayOutputWithContext(ctx context.Context) IntentFollowupIntentInfoArrayOutput

type IntentFollowupIntentInfoArrayInput added in v3.1.0 

type IntentFollowupIntentInfoArrayInput interface {
	pulumi.Input

	ToIntentFollowupIntentInfoArrayOutput() IntentFollowupIntentInfoArrayOutput
	ToIntentFollowupIntentInfoArrayOutputWithContext(context.Context) IntentFollowupIntentInfoArrayOutput
}

IntentFollowupIntentInfoArrayInput is an input type that accepts IntentFollowupIntentInfoArray and IntentFollowupIntentInfoArrayOutput values. You can construct a concrete instance of `IntentFollowupIntentInfoArrayInput` via: 

IntentFollowupIntentInfoArray{ IntentFollowupIntentInfoArgs{...} }

type IntentFollowupIntentInfoArrayOutput added in v3.1.0 

type IntentFollowupIntentInfoArrayOutput struct{ *pulumi.OutputState }

func (IntentFollowupIntentInfoArrayOutput) ElementType added in v3.1.0 

func (IntentFollowupIntentInfoArrayOutput) ElementType() reflect.Type

func (IntentFollowupIntentInfoArrayOutput) Index added in v3.1.0 

func (o IntentFollowupIntentInfoArrayOutput) Index(i pulumi.IntInput) IntentFollowupIntentInfoOutput

func (IntentFollowupIntentInfoArrayOutput) ToIntentFollowupIntentInfoArrayOutput added in v3.1.0 

func (o IntentFollowupIntentInfoArrayOutput) ToIntentFollowupIntentInfoArrayOutput() IntentFollowupIntentInfoArrayOutput

func (IntentFollowupIntentInfoArrayOutput) ToIntentFollowupIntentInfoArrayOutputWithContext added in v3.1.0 

func (o IntentFollowupIntentInfoArrayOutput) ToIntentFollowupIntentInfoArrayOutputWithContext(ctx context.Context) IntentFollowupIntentInfoArrayOutput

type IntentFollowupIntentInfoInput added in v3.1.0 

type IntentFollowupIntentInfoInput interface {
	pulumi.Input

	ToIntentFollowupIntentInfoOutput() IntentFollowupIntentInfoOutput
	ToIntentFollowupIntentInfoOutputWithContext(context.Context) IntentFollowupIntentInfoOutput
}

IntentFollowupIntentInfoInput is an input type that accepts IntentFollowupIntentInfoArgs and IntentFollowupIntentInfoOutput values. You can construct a concrete instance of `IntentFollowupIntentInfoInput` via: 

IntentFollowupIntentInfoArgs{...}

type IntentFollowupIntentInfoOutput added in v3.1.0 

type IntentFollowupIntentInfoOutput struct{ *pulumi.OutputState }

func (IntentFollowupIntentInfoOutput) ElementType added in v3.1.0 

func (IntentFollowupIntentInfoOutput) ElementType() reflect.Type

func (IntentFollowupIntentInfoOutput) FollowupIntentName added in v3.1.0 

func (o IntentFollowupIntentInfoOutput) FollowupIntentName() pulumi.StringPtrOutput

func (IntentFollowupIntentInfoOutput) ParentFollowupIntentName added in v3.1.0 

func (o IntentFollowupIntentInfoOutput) ParentFollowupIntentName() pulumi.StringPtrOutput

The unique identifier of the parent intent in the chain of followup intents. Format: projects/<Project ID>/agent/intents/<Intent ID>.

func (IntentFollowupIntentInfoOutput) ToIntentFollowupIntentInfoOutput added in v3.1.0 

func (o IntentFollowupIntentInfoOutput) ToIntentFollowupIntentInfoOutput() IntentFollowupIntentInfoOutput

func (IntentFollowupIntentInfoOutput) ToIntentFollowupIntentInfoOutputWithContext added in v3.1.0 

func (o IntentFollowupIntentInfoOutput) ToIntentFollowupIntentInfoOutputWithContext(ctx context.Context) IntentFollowupIntentInfoOutput

type IntentState added in v3.1.0 

type IntentState struct {
	// The name of the action associated with the intent.
	// Note: The action name must not contain whitespaces.
	Action pulumi.StringPtrInput
	// The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED
	// (i.e. default platform).
	// Each value may be one of `FACEBOOK`, `SLACK`, `TELEGRAM`, `KIK`, `SKYPE`, `LINE`, `VIBER`, `ACTIONS_ON_GOOGLE`, and `GOOGLE_HANGOUTS`.
	DefaultResponsePlatforms pulumi.StringArrayInput
	// The name of this intent to be displayed on the console.
	DisplayName pulumi.StringPtrInput
	// 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.
	Events pulumi.StringArrayInput
	// Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only
	// in the output.
	FollowupIntentInfos IntentFollowupIntentInfoArrayInput
	// The list of context names required for this intent to be triggered.
	// Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.
	InputContextNames pulumi.StringArrayInput
	// Indicates whether this is a fallback intent.
	IsFallback pulumi.BoolPtrInput
	// 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.
	MlDisabled pulumi.BoolPtrInput
	// The unique identifier of this intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.
	Name pulumi.StringPtrInput
	// The unique identifier of the parent intent in the chain of followup intents.
	// Format: projects/<Project ID>/agent/intents/<Intent ID>.
	ParentFollowupIntentName pulumi.StringPtrInput
	// 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.
	Priority pulumi.IntPtrInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// Indicates whether to delete all contexts in the current session when this intent is matched.
	ResetContexts pulumi.BoolPtrInput
	// 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>.
	RootFollowupIntentName pulumi.StringPtrInput
	// 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.
	//   Possible values are `WEBHOOK_STATE_ENABLED` and `WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING`.
	WebhookState pulumi.StringPtrInput
}

func (IntentState) ElementType added in v3.1.0 

func (IntentState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.