diagflow

package
v3.0.0-beta.1 Latest Latest
Warning

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

 Go to latest Published: Apr 2, 2020 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

nolint: lll

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.
	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.
	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 Terraform state and Dialogflow if the
	// agent tier is changed outside of Terraform.
	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

> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/dialogflow_agent.html.markdown.

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.
	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.
	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 Terraform state and Dialogflow if the
	// agent tier is changed outside of Terraform.
	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.
	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.
	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 Terraform state and Dialogflow if the
	// agent tier is changed outside of Terraform.
	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

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.