Documentation ¶
Index ¶
- type Agent
- type AgentArgs
- type AgentArray
- type AgentArrayInput
- type AgentArrayOutput
- type AgentInput
- type AgentMap
- type AgentMapInput
- type AgentMapOutput
- type AgentOutput
- func (AgentOutput) ElementType() reflect.Type
- func (o AgentOutput) ToAgentOutput() AgentOutput
- func (o AgentOutput) ToAgentOutputWithContext(ctx context.Context) AgentOutput
- func (o AgentOutput) ToAgentPtrOutput() AgentPtrOutput
- func (o AgentOutput) ToAgentPtrOutputWithContext(ctx context.Context) AgentPtrOutput
- type AgentPtrInput
- type AgentPtrOutput
- type AgentState
- type EntityType
- func (*EntityType) ElementType() reflect.Type
- func (i *EntityType) ToEntityTypeOutput() EntityTypeOutput
- func (i *EntityType) ToEntityTypeOutputWithContext(ctx context.Context) EntityTypeOutput
- func (i *EntityType) ToEntityTypePtrOutput() EntityTypePtrOutput
- func (i *EntityType) ToEntityTypePtrOutputWithContext(ctx context.Context) EntityTypePtrOutput
- type EntityTypeArgs
- type EntityTypeArray
- type EntityTypeArrayInput
- type EntityTypeArrayOutput
- func (EntityTypeArrayOutput) ElementType() reflect.Type
- func (o EntityTypeArrayOutput) Index(i pulumi.IntInput) EntityTypeOutput
- func (o EntityTypeArrayOutput) ToEntityTypeArrayOutput() EntityTypeArrayOutput
- func (o EntityTypeArrayOutput) ToEntityTypeArrayOutputWithContext(ctx context.Context) EntityTypeArrayOutput
- type EntityTypeEntity
- type EntityTypeEntityArgs
- type EntityTypeEntityArray
- type EntityTypeEntityArrayInput
- type EntityTypeEntityArrayOutput
- func (EntityTypeEntityArrayOutput) ElementType() reflect.Type
- func (o EntityTypeEntityArrayOutput) Index(i pulumi.IntInput) EntityTypeEntityOutput
- func (o EntityTypeEntityArrayOutput) ToEntityTypeEntityArrayOutput() EntityTypeEntityArrayOutput
- func (o EntityTypeEntityArrayOutput) ToEntityTypeEntityArrayOutputWithContext(ctx context.Context) EntityTypeEntityArrayOutput
- type EntityTypeEntityInput
- type EntityTypeEntityOutput
- func (EntityTypeEntityOutput) ElementType() reflect.Type
- func (o EntityTypeEntityOutput) Synonyms() pulumi.StringArrayOutput
- func (o EntityTypeEntityOutput) ToEntityTypeEntityOutput() EntityTypeEntityOutput
- func (o EntityTypeEntityOutput) ToEntityTypeEntityOutputWithContext(ctx context.Context) EntityTypeEntityOutput
- func (o EntityTypeEntityOutput) Value() pulumi.StringOutput
- type EntityTypeInput
- type EntityTypeMap
- type EntityTypeMapInput
- type EntityTypeMapOutput
- func (EntityTypeMapOutput) ElementType() reflect.Type
- func (o EntityTypeMapOutput) MapIndex(k pulumi.StringInput) EntityTypeOutput
- func (o EntityTypeMapOutput) ToEntityTypeMapOutput() EntityTypeMapOutput
- func (o EntityTypeMapOutput) ToEntityTypeMapOutputWithContext(ctx context.Context) EntityTypeMapOutput
- type EntityTypeOutput
- func (EntityTypeOutput) ElementType() reflect.Type
- func (o EntityTypeOutput) ToEntityTypeOutput() EntityTypeOutput
- func (o EntityTypeOutput) ToEntityTypeOutputWithContext(ctx context.Context) EntityTypeOutput
- func (o EntityTypeOutput) ToEntityTypePtrOutput() EntityTypePtrOutput
- func (o EntityTypeOutput) ToEntityTypePtrOutputWithContext(ctx context.Context) EntityTypePtrOutput
- type EntityTypePtrInput
- type EntityTypePtrOutput
- type EntityTypeState
- type Fulfillment
- func (*Fulfillment) ElementType() reflect.Type
- func (i *Fulfillment) ToFulfillmentOutput() FulfillmentOutput
- func (i *Fulfillment) ToFulfillmentOutputWithContext(ctx context.Context) FulfillmentOutput
- func (i *Fulfillment) ToFulfillmentPtrOutput() FulfillmentPtrOutput
- func (i *Fulfillment) ToFulfillmentPtrOutputWithContext(ctx context.Context) FulfillmentPtrOutput
- type FulfillmentArgs
- type FulfillmentArray
- type FulfillmentArrayInput
- type FulfillmentArrayOutput
- func (FulfillmentArrayOutput) ElementType() reflect.Type
- func (o FulfillmentArrayOutput) Index(i pulumi.IntInput) FulfillmentOutput
- func (o FulfillmentArrayOutput) ToFulfillmentArrayOutput() FulfillmentArrayOutput
- func (o FulfillmentArrayOutput) ToFulfillmentArrayOutputWithContext(ctx context.Context) FulfillmentArrayOutput
- type FulfillmentFeature
- type FulfillmentFeatureArgs
- type FulfillmentFeatureArray
- type FulfillmentFeatureArrayInput
- type FulfillmentFeatureArrayOutput
- func (FulfillmentFeatureArrayOutput) ElementType() reflect.Type
- func (o FulfillmentFeatureArrayOutput) Index(i pulumi.IntInput) FulfillmentFeatureOutput
- func (o FulfillmentFeatureArrayOutput) ToFulfillmentFeatureArrayOutput() FulfillmentFeatureArrayOutput
- func (o FulfillmentFeatureArrayOutput) ToFulfillmentFeatureArrayOutputWithContext(ctx context.Context) FulfillmentFeatureArrayOutput
- type FulfillmentFeatureInput
- type FulfillmentFeatureOutput
- func (FulfillmentFeatureOutput) ElementType() reflect.Type
- func (o FulfillmentFeatureOutput) ToFulfillmentFeatureOutput() FulfillmentFeatureOutput
- func (o FulfillmentFeatureOutput) ToFulfillmentFeatureOutputWithContext(ctx context.Context) FulfillmentFeatureOutput
- func (o FulfillmentFeatureOutput) Type() pulumi.StringOutput
- type FulfillmentGenericWebService
- type FulfillmentGenericWebServiceArgs
- func (FulfillmentGenericWebServiceArgs) ElementType() reflect.Type
- func (i FulfillmentGenericWebServiceArgs) ToFulfillmentGenericWebServiceOutput() FulfillmentGenericWebServiceOutput
- func (i FulfillmentGenericWebServiceArgs) ToFulfillmentGenericWebServiceOutputWithContext(ctx context.Context) FulfillmentGenericWebServiceOutput
- func (i FulfillmentGenericWebServiceArgs) ToFulfillmentGenericWebServicePtrOutput() FulfillmentGenericWebServicePtrOutput
- func (i FulfillmentGenericWebServiceArgs) ToFulfillmentGenericWebServicePtrOutputWithContext(ctx context.Context) FulfillmentGenericWebServicePtrOutput
- type FulfillmentGenericWebServiceInput
- type FulfillmentGenericWebServiceOutput
- func (FulfillmentGenericWebServiceOutput) ElementType() reflect.Type
- func (o FulfillmentGenericWebServiceOutput) Password() pulumi.StringPtrOutput
- func (o FulfillmentGenericWebServiceOutput) RequestHeaders() pulumi.StringMapOutput
- func (o FulfillmentGenericWebServiceOutput) ToFulfillmentGenericWebServiceOutput() FulfillmentGenericWebServiceOutput
- func (o FulfillmentGenericWebServiceOutput) ToFulfillmentGenericWebServiceOutputWithContext(ctx context.Context) FulfillmentGenericWebServiceOutput
- func (o FulfillmentGenericWebServiceOutput) ToFulfillmentGenericWebServicePtrOutput() FulfillmentGenericWebServicePtrOutput
- func (o FulfillmentGenericWebServiceOutput) ToFulfillmentGenericWebServicePtrOutputWithContext(ctx context.Context) FulfillmentGenericWebServicePtrOutput
- func (o FulfillmentGenericWebServiceOutput) Uri() pulumi.StringOutput
- func (o FulfillmentGenericWebServiceOutput) Username() pulumi.StringPtrOutput
- type FulfillmentGenericWebServicePtrInput
- type FulfillmentGenericWebServicePtrOutput
- func (o FulfillmentGenericWebServicePtrOutput) Elem() FulfillmentGenericWebServiceOutput
- func (FulfillmentGenericWebServicePtrOutput) ElementType() reflect.Type
- func (o FulfillmentGenericWebServicePtrOutput) Password() pulumi.StringPtrOutput
- func (o FulfillmentGenericWebServicePtrOutput) RequestHeaders() pulumi.StringMapOutput
- func (o FulfillmentGenericWebServicePtrOutput) ToFulfillmentGenericWebServicePtrOutput() FulfillmentGenericWebServicePtrOutput
- func (o FulfillmentGenericWebServicePtrOutput) ToFulfillmentGenericWebServicePtrOutputWithContext(ctx context.Context) FulfillmentGenericWebServicePtrOutput
- func (o FulfillmentGenericWebServicePtrOutput) Uri() pulumi.StringPtrOutput
- func (o FulfillmentGenericWebServicePtrOutput) Username() pulumi.StringPtrOutput
- type FulfillmentInput
- type FulfillmentMap
- type FulfillmentMapInput
- type FulfillmentMapOutput
- func (FulfillmentMapOutput) ElementType() reflect.Type
- func (o FulfillmentMapOutput) MapIndex(k pulumi.StringInput) FulfillmentOutput
- func (o FulfillmentMapOutput) ToFulfillmentMapOutput() FulfillmentMapOutput
- func (o FulfillmentMapOutput) ToFulfillmentMapOutputWithContext(ctx context.Context) FulfillmentMapOutput
- type FulfillmentOutput
- func (FulfillmentOutput) ElementType() reflect.Type
- func (o FulfillmentOutput) ToFulfillmentOutput() FulfillmentOutput
- func (o FulfillmentOutput) ToFulfillmentOutputWithContext(ctx context.Context) FulfillmentOutput
- func (o FulfillmentOutput) ToFulfillmentPtrOutput() FulfillmentPtrOutput
- func (o FulfillmentOutput) ToFulfillmentPtrOutputWithContext(ctx context.Context) FulfillmentPtrOutput
- type FulfillmentPtrInput
- type FulfillmentPtrOutput
- type FulfillmentState
- type Intent
- func (*Intent) ElementType() reflect.Type
- func (i *Intent) ToIntentOutput() IntentOutput
- func (i *Intent) ToIntentOutputWithContext(ctx context.Context) IntentOutput
- func (i *Intent) ToIntentPtrOutput() IntentPtrOutput
- func (i *Intent) ToIntentPtrOutputWithContext(ctx context.Context) IntentPtrOutput
- type IntentArgs
- type IntentArray
- type IntentArrayInput
- type IntentArrayOutput
- type IntentFollowupIntentInfo
- type IntentFollowupIntentInfoArgs
- func (IntentFollowupIntentInfoArgs) ElementType() reflect.Type
- func (i IntentFollowupIntentInfoArgs) ToIntentFollowupIntentInfoOutput() IntentFollowupIntentInfoOutput
- func (i IntentFollowupIntentInfoArgs) ToIntentFollowupIntentInfoOutputWithContext(ctx context.Context) IntentFollowupIntentInfoOutput
- type IntentFollowupIntentInfoArray
- func (IntentFollowupIntentInfoArray) ElementType() reflect.Type
- func (i IntentFollowupIntentInfoArray) ToIntentFollowupIntentInfoArrayOutput() IntentFollowupIntentInfoArrayOutput
- func (i IntentFollowupIntentInfoArray) ToIntentFollowupIntentInfoArrayOutputWithContext(ctx context.Context) IntentFollowupIntentInfoArrayOutput
- type IntentFollowupIntentInfoArrayInput
- type IntentFollowupIntentInfoArrayOutput
- func (IntentFollowupIntentInfoArrayOutput) ElementType() reflect.Type
- func (o IntentFollowupIntentInfoArrayOutput) Index(i pulumi.IntInput) IntentFollowupIntentInfoOutput
- func (o IntentFollowupIntentInfoArrayOutput) ToIntentFollowupIntentInfoArrayOutput() IntentFollowupIntentInfoArrayOutput
- func (o IntentFollowupIntentInfoArrayOutput) ToIntentFollowupIntentInfoArrayOutputWithContext(ctx context.Context) IntentFollowupIntentInfoArrayOutput
- type IntentFollowupIntentInfoInput
- type IntentFollowupIntentInfoOutput
- func (IntentFollowupIntentInfoOutput) ElementType() reflect.Type
- func (o IntentFollowupIntentInfoOutput) FollowupIntentName() pulumi.StringPtrOutput
- func (o IntentFollowupIntentInfoOutput) ParentFollowupIntentName() pulumi.StringPtrOutput
- func (o IntentFollowupIntentInfoOutput) ToIntentFollowupIntentInfoOutput() IntentFollowupIntentInfoOutput
- func (o IntentFollowupIntentInfoOutput) ToIntentFollowupIntentInfoOutputWithContext(ctx context.Context) IntentFollowupIntentInfoOutput
- type IntentInput
- type IntentMap
- type IntentMapInput
- type IntentMapOutput
- type IntentOutput
- func (IntentOutput) ElementType() reflect.Type
- func (o IntentOutput) ToIntentOutput() IntentOutput
- func (o IntentOutput) ToIntentOutputWithContext(ctx context.Context) IntentOutput
- func (o IntentOutput) ToIntentPtrOutput() IntentPtrOutput
- func (o IntentOutput) ToIntentPtrOutputWithContext(ctx context.Context) IntentPtrOutput
- type IntentPtrInput
- type IntentPtrOutput
- type IntentState
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
- [Official Documentation](https://cloud.google.com/dialogflow/docs/)
## Example Usage ### Dialogflow Agent Full
```go package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v5/go/gcp/diagflow" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := diagflow.NewAgent(ctx, "fullAgent", &diagflow.AgentArgs{ ApiVersion: pulumi.String("API_VERSION_V2_BETA_1"), AvatarUri: pulumi.String("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png"), ClassificationThreshold: pulumi.Float64(0.3), DefaultLanguageCode: pulumi.String("en"), Description: pulumi.String("Example description."), DisplayName: pulumi.String("dialogflow-agent"), EnableLogging: pulumi.Bool(true), MatchMode: pulumi.String("MATCH_MODE_ML_ONLY"), SupportedLanguageCodes: pulumi.StringArray{ pulumi.String("fr"), pulumi.String("de"), pulumi.String("es"), }, Tier: pulumi.String("TIER_STANDARD"), TimeZone: pulumi.String("America/New_York"), }) if err != nil { return err } return nil }) }
```
## Import
Agent can be imported using any of these accepted formats ¶
```sh
$ pulumi import gcp:diagflow/agent:Agent default {{project}}
```
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.
func (*Agent) ElementType ¶
func (*Agent) ToAgentOutput ¶
func (i *Agent) ToAgentOutput() AgentOutput
func (*Agent) ToAgentOutputWithContext ¶
func (i *Agent) ToAgentOutputWithContext(ctx context.Context) AgentOutput
func (*Agent) ToAgentPtrOutput ¶
func (i *Agent) ToAgentPtrOutput() AgentPtrOutput
func (*Agent) ToAgentPtrOutputWithContext ¶
func (i *Agent) ToAgentPtrOutputWithContext(ctx context.Context) AgentPtrOutput
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 ¶
type AgentArray ¶
type AgentArray []AgentInput
func (AgentArray) ElementType ¶
func (AgentArray) ElementType() reflect.Type
func (AgentArray) ToAgentArrayOutput ¶
func (i AgentArray) ToAgentArrayOutput() AgentArrayOutput
func (AgentArray) ToAgentArrayOutputWithContext ¶
func (i AgentArray) ToAgentArrayOutputWithContext(ctx context.Context) AgentArrayOutput
type AgentArrayInput ¶
type AgentArrayInput interface { pulumi.Input ToAgentArrayOutput() AgentArrayOutput ToAgentArrayOutputWithContext(context.Context) AgentArrayOutput }
AgentArrayInput is an input type that accepts AgentArray and AgentArrayOutput values. You can construct a concrete instance of `AgentArrayInput` via:
AgentArray{ AgentArgs{...} }
type AgentArrayOutput ¶
type AgentArrayOutput struct{ *pulumi.OutputState }
func (AgentArrayOutput) ElementType ¶
func (AgentArrayOutput) ElementType() reflect.Type
func (AgentArrayOutput) Index ¶
func (o AgentArrayOutput) Index(i pulumi.IntInput) AgentOutput
func (AgentArrayOutput) ToAgentArrayOutput ¶
func (o AgentArrayOutput) ToAgentArrayOutput() AgentArrayOutput
func (AgentArrayOutput) ToAgentArrayOutputWithContext ¶
func (o AgentArrayOutput) ToAgentArrayOutputWithContext(ctx context.Context) AgentArrayOutput
type AgentInput ¶
type AgentInput interface { pulumi.Input ToAgentOutput() AgentOutput ToAgentOutputWithContext(ctx context.Context) AgentOutput }
type AgentMap ¶
type AgentMap map[string]AgentInput
func (AgentMap) ElementType ¶
func (AgentMap) ToAgentMapOutput ¶
func (i AgentMap) ToAgentMapOutput() AgentMapOutput
func (AgentMap) ToAgentMapOutputWithContext ¶
func (i AgentMap) ToAgentMapOutputWithContext(ctx context.Context) AgentMapOutput
type AgentMapInput ¶
type AgentMapInput interface { pulumi.Input ToAgentMapOutput() AgentMapOutput ToAgentMapOutputWithContext(context.Context) AgentMapOutput }
AgentMapInput is an input type that accepts AgentMap and AgentMapOutput values. You can construct a concrete instance of `AgentMapInput` via:
AgentMap{ "key": AgentArgs{...} }
type AgentMapOutput ¶
type AgentMapOutput struct{ *pulumi.OutputState }
func (AgentMapOutput) ElementType ¶
func (AgentMapOutput) ElementType() reflect.Type
func (AgentMapOutput) MapIndex ¶
func (o AgentMapOutput) MapIndex(k pulumi.StringInput) AgentOutput
func (AgentMapOutput) ToAgentMapOutput ¶
func (o AgentMapOutput) ToAgentMapOutput() AgentMapOutput
func (AgentMapOutput) ToAgentMapOutputWithContext ¶
func (o AgentMapOutput) ToAgentMapOutputWithContext(ctx context.Context) AgentMapOutput
type AgentOutput ¶
type AgentOutput struct {
*pulumi.OutputState
}
func (AgentOutput) ElementType ¶
func (AgentOutput) ElementType() reflect.Type
func (AgentOutput) ToAgentOutput ¶
func (o AgentOutput) ToAgentOutput() AgentOutput
func (AgentOutput) ToAgentOutputWithContext ¶
func (o AgentOutput) ToAgentOutputWithContext(ctx context.Context) AgentOutput
func (AgentOutput) ToAgentPtrOutput ¶
func (o AgentOutput) ToAgentPtrOutput() AgentPtrOutput
func (AgentOutput) ToAgentPtrOutputWithContext ¶
func (o AgentOutput) ToAgentPtrOutputWithContext(ctx context.Context) AgentPtrOutput
type AgentPtrInput ¶
type AgentPtrInput interface { pulumi.Input ToAgentPtrOutput() AgentPtrOutput ToAgentPtrOutputWithContext(ctx context.Context) AgentPtrOutput }
type AgentPtrOutput ¶
type AgentPtrOutput struct {
*pulumi.OutputState
}
func (AgentPtrOutput) ElementType ¶
func (AgentPtrOutput) ElementType() reflect.Type
func (AgentPtrOutput) ToAgentPtrOutput ¶
func (o AgentPtrOutput) ToAgentPtrOutput() AgentPtrOutput
func (AgentPtrOutput) ToAgentPtrOutputWithContext ¶
func (o AgentPtrOutput) ToAgentPtrOutputWithContext(ctx context.Context) AgentPtrOutput
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 ¶
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
- [Official Documentation](https://cloud.google.com/dialogflow/docs/)
## Example Usage ### Dialogflow Entity Type Basic
```go package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v5/go/gcp/diagflow" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { basicAgent, err := diagflow.NewAgent(ctx, "basicAgent", &diagflow.AgentArgs{ DisplayName: pulumi.String("example_agent"), DefaultLanguageCode: pulumi.String("en"), TimeZone: pulumi.String("America/New_York"), }) if err != nil { return err } _, err = diagflow.NewEntityType(ctx, "basicEntityType", &diagflow.EntityTypeArgs{ DisplayName: pulumi.String(""), Kind: pulumi.String("KIND_MAP"), Entities: diagflow.EntityTypeEntityArray{ &diagflow.EntityTypeEntityArgs{ Value: pulumi.String("value1"), Synonyms: pulumi.StringArray{ pulumi.String("synonym1"), pulumi.String("synonym2"), }, }, &diagflow.EntityTypeEntityArgs{ Value: pulumi.String("value2"), Synonyms: pulumi.StringArray{ pulumi.String("synonym3"), pulumi.String("synonym4"), }, }, }, }, pulumi.DependsOn([]pulumi.Resource{ basicAgent, })) if err != nil { return err } return nil }) }
```
## Import
EntityType can be imported using any of these accepted formats ¶
```sh
$ pulumi import gcp:diagflow/entityType:EntityType default {{name}}
```
func GetEntityType ¶
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 ¶
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.
func (*EntityType) ElementType ¶
func (*EntityType) ElementType() reflect.Type
func (*EntityType) ToEntityTypeOutput ¶
func (i *EntityType) ToEntityTypeOutput() EntityTypeOutput
func (*EntityType) ToEntityTypeOutputWithContext ¶
func (i *EntityType) ToEntityTypeOutputWithContext(ctx context.Context) EntityTypeOutput
func (*EntityType) ToEntityTypePtrOutput ¶
func (i *EntityType) ToEntityTypePtrOutput() EntityTypePtrOutput
func (*EntityType) ToEntityTypePtrOutputWithContext ¶
func (i *EntityType) ToEntityTypePtrOutputWithContext(ctx context.Context) EntityTypePtrOutput
type EntityTypeArgs ¶
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 ¶
func (EntityTypeArgs) ElementType() reflect.Type
type EntityTypeArray ¶
type EntityTypeArray []EntityTypeInput
func (EntityTypeArray) ElementType ¶
func (EntityTypeArray) ElementType() reflect.Type
func (EntityTypeArray) ToEntityTypeArrayOutput ¶
func (i EntityTypeArray) ToEntityTypeArrayOutput() EntityTypeArrayOutput
func (EntityTypeArray) ToEntityTypeArrayOutputWithContext ¶
func (i EntityTypeArray) ToEntityTypeArrayOutputWithContext(ctx context.Context) EntityTypeArrayOutput
type EntityTypeArrayInput ¶
type EntityTypeArrayInput interface { pulumi.Input ToEntityTypeArrayOutput() EntityTypeArrayOutput ToEntityTypeArrayOutputWithContext(context.Context) EntityTypeArrayOutput }
EntityTypeArrayInput is an input type that accepts EntityTypeArray and EntityTypeArrayOutput values. You can construct a concrete instance of `EntityTypeArrayInput` via:
EntityTypeArray{ EntityTypeArgs{...} }
type EntityTypeArrayOutput ¶
type EntityTypeArrayOutput struct{ *pulumi.OutputState }
func (EntityTypeArrayOutput) ElementType ¶
func (EntityTypeArrayOutput) ElementType() reflect.Type
func (EntityTypeArrayOutput) Index ¶
func (o EntityTypeArrayOutput) Index(i pulumi.IntInput) EntityTypeOutput
func (EntityTypeArrayOutput) ToEntityTypeArrayOutput ¶
func (o EntityTypeArrayOutput) ToEntityTypeArrayOutput() EntityTypeArrayOutput
func (EntityTypeArrayOutput) ToEntityTypeArrayOutputWithContext ¶
func (o EntityTypeArrayOutput) ToEntityTypeArrayOutputWithContext(ctx context.Context) EntityTypeArrayOutput
type EntityTypeEntity ¶
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 ¶
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 ¶
func (EntityTypeEntityArgs) ElementType() reflect.Type
func (EntityTypeEntityArgs) ToEntityTypeEntityOutput ¶
func (i EntityTypeEntityArgs) ToEntityTypeEntityOutput() EntityTypeEntityOutput
func (EntityTypeEntityArgs) ToEntityTypeEntityOutputWithContext ¶
func (i EntityTypeEntityArgs) ToEntityTypeEntityOutputWithContext(ctx context.Context) EntityTypeEntityOutput
type EntityTypeEntityArray ¶
type EntityTypeEntityArray []EntityTypeEntityInput
func (EntityTypeEntityArray) ElementType ¶
func (EntityTypeEntityArray) ElementType() reflect.Type
func (EntityTypeEntityArray) ToEntityTypeEntityArrayOutput ¶
func (i EntityTypeEntityArray) ToEntityTypeEntityArrayOutput() EntityTypeEntityArrayOutput
func (EntityTypeEntityArray) ToEntityTypeEntityArrayOutputWithContext ¶
func (i EntityTypeEntityArray) ToEntityTypeEntityArrayOutputWithContext(ctx context.Context) EntityTypeEntityArrayOutput
type EntityTypeEntityArrayInput ¶
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 ¶
type EntityTypeEntityArrayOutput struct{ *pulumi.OutputState }
func (EntityTypeEntityArrayOutput) ElementType ¶
func (EntityTypeEntityArrayOutput) ElementType() reflect.Type
func (EntityTypeEntityArrayOutput) Index ¶
func (o EntityTypeEntityArrayOutput) Index(i pulumi.IntInput) EntityTypeEntityOutput
func (EntityTypeEntityArrayOutput) ToEntityTypeEntityArrayOutput ¶
func (o EntityTypeEntityArrayOutput) ToEntityTypeEntityArrayOutput() EntityTypeEntityArrayOutput
func (EntityTypeEntityArrayOutput) ToEntityTypeEntityArrayOutputWithContext ¶
func (o EntityTypeEntityArrayOutput) ToEntityTypeEntityArrayOutputWithContext(ctx context.Context) EntityTypeEntityArrayOutput
type EntityTypeEntityInput ¶
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 ¶
type EntityTypeEntityOutput struct{ *pulumi.OutputState }
func (EntityTypeEntityOutput) ElementType ¶
func (EntityTypeEntityOutput) ElementType() reflect.Type
func (EntityTypeEntityOutput) Synonyms ¶
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 ¶
func (o EntityTypeEntityOutput) ToEntityTypeEntityOutput() EntityTypeEntityOutput
func (EntityTypeEntityOutput) ToEntityTypeEntityOutputWithContext ¶
func (o EntityTypeEntityOutput) ToEntityTypeEntityOutputWithContext(ctx context.Context) EntityTypeEntityOutput
func (EntityTypeEntityOutput) Value ¶
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 EntityTypeInput ¶
type EntityTypeInput interface { pulumi.Input ToEntityTypeOutput() EntityTypeOutput ToEntityTypeOutputWithContext(ctx context.Context) EntityTypeOutput }
type EntityTypeMap ¶
type EntityTypeMap map[string]EntityTypeInput
func (EntityTypeMap) ElementType ¶
func (EntityTypeMap) ElementType() reflect.Type
func (EntityTypeMap) ToEntityTypeMapOutput ¶
func (i EntityTypeMap) ToEntityTypeMapOutput() EntityTypeMapOutput
func (EntityTypeMap) ToEntityTypeMapOutputWithContext ¶
func (i EntityTypeMap) ToEntityTypeMapOutputWithContext(ctx context.Context) EntityTypeMapOutput
type EntityTypeMapInput ¶
type EntityTypeMapInput interface { pulumi.Input ToEntityTypeMapOutput() EntityTypeMapOutput ToEntityTypeMapOutputWithContext(context.Context) EntityTypeMapOutput }
EntityTypeMapInput is an input type that accepts EntityTypeMap and EntityTypeMapOutput values. You can construct a concrete instance of `EntityTypeMapInput` via:
EntityTypeMap{ "key": EntityTypeArgs{...} }
type EntityTypeMapOutput ¶
type EntityTypeMapOutput struct{ *pulumi.OutputState }
func (EntityTypeMapOutput) ElementType ¶
func (EntityTypeMapOutput) ElementType() reflect.Type
func (EntityTypeMapOutput) MapIndex ¶
func (o EntityTypeMapOutput) MapIndex(k pulumi.StringInput) EntityTypeOutput
func (EntityTypeMapOutput) ToEntityTypeMapOutput ¶
func (o EntityTypeMapOutput) ToEntityTypeMapOutput() EntityTypeMapOutput
func (EntityTypeMapOutput) ToEntityTypeMapOutputWithContext ¶
func (o EntityTypeMapOutput) ToEntityTypeMapOutputWithContext(ctx context.Context) EntityTypeMapOutput
type EntityTypeOutput ¶
type EntityTypeOutput struct {
*pulumi.OutputState
}
func (EntityTypeOutput) ElementType ¶
func (EntityTypeOutput) ElementType() reflect.Type
func (EntityTypeOutput) ToEntityTypeOutput ¶
func (o EntityTypeOutput) ToEntityTypeOutput() EntityTypeOutput
func (EntityTypeOutput) ToEntityTypeOutputWithContext ¶
func (o EntityTypeOutput) ToEntityTypeOutputWithContext(ctx context.Context) EntityTypeOutput
func (EntityTypeOutput) ToEntityTypePtrOutput ¶
func (o EntityTypeOutput) ToEntityTypePtrOutput() EntityTypePtrOutput
func (EntityTypeOutput) ToEntityTypePtrOutputWithContext ¶
func (o EntityTypeOutput) ToEntityTypePtrOutputWithContext(ctx context.Context) EntityTypePtrOutput
type EntityTypePtrInput ¶
type EntityTypePtrInput interface { pulumi.Input ToEntityTypePtrOutput() EntityTypePtrOutput ToEntityTypePtrOutputWithContext(ctx context.Context) EntityTypePtrOutput }
type EntityTypePtrOutput ¶
type EntityTypePtrOutput struct {
*pulumi.OutputState
}
func (EntityTypePtrOutput) ElementType ¶
func (EntityTypePtrOutput) ElementType() reflect.Type
func (EntityTypePtrOutput) ToEntityTypePtrOutput ¶
func (o EntityTypePtrOutput) ToEntityTypePtrOutput() EntityTypePtrOutput
func (EntityTypePtrOutput) ToEntityTypePtrOutputWithContext ¶
func (o EntityTypePtrOutput) ToEntityTypePtrOutputWithContext(ctx context.Context) EntityTypePtrOutput
type EntityTypeState ¶
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 ¶
func (EntityTypeState) ElementType() reflect.Type
type Fulfillment ¶ added in v5.8.0
type Fulfillment struct { pulumi.CustomResourceState // The human-readable name of the fulfillment, unique within the agent. DisplayName pulumi.StringOutput `pulumi:"displayName"` // Whether fulfillment is enabled. Enabled pulumi.BoolPtrOutput `pulumi:"enabled"` // The field defines whether the fulfillment is enabled for certain features. // Structure is documented below. Features FulfillmentFeatureArrayOutput `pulumi:"features"` // Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. // Structure is documented below. GenericWebService FulfillmentGenericWebServicePtrOutput `pulumi:"genericWebService"` // The unique identifier of the fulfillment. Format: projects/<Project ID>/agent/fulfillment - projects/<Project // ID>/locations/<Location ID>/agent/fulfillment 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"` }
By default, your agent responds to a matched intent with a static response. If you're using one of the integration options, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday.
To get more information about Fulfillment, see:
* [API documentation](https://cloud.google.com/dialogflow/es/docs/reference/rest/v2/projects.agent/getFulfillment) * How-to Guides
- [Official Documentation](https://cloud.google.com/dialogflow/es/docs/fulfillment-overview)
## Example Usage ### Dialogflow Fulfillment Basic
```go package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v5/go/gcp/diagflow" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { basicAgent, err := diagflow.NewAgent(ctx, "basicAgent", &diagflow.AgentArgs{ DisplayName: pulumi.String("example_agent"), DefaultLanguageCode: pulumi.String("en"), TimeZone: pulumi.String("America/New_York"), }) if err != nil { return err } _, err = diagflow.NewFulfillment(ctx, "basicFulfillment", &diagflow.FulfillmentArgs{ DisplayName: pulumi.String("basic-fulfillment"), Enabled: pulumi.Bool(true), GenericWebService: &diagflow.FulfillmentGenericWebServiceArgs{ Uri: pulumi.String("https://google.com"), Username: pulumi.String("admin"), Password: pulumi.String("password"), RequestHeaders: pulumi.StringMap{ "name": pulumi.String("wrench"), }, }, }, pulumi.DependsOn([]pulumi.Resource{ basicAgent, })) if err != nil { return err } return nil }) }
```
## Import
Fulfillment can be imported using any of these accepted formats ¶
```sh
$ pulumi import gcp:diagflow/fulfillment:Fulfillment default {{name}}
```
func GetFulfillment ¶ added in v5.8.0
func GetFulfillment(ctx *pulumi.Context, name string, id pulumi.IDInput, state *FulfillmentState, opts ...pulumi.ResourceOption) (*Fulfillment, error)
GetFulfillment gets an existing Fulfillment 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 NewFulfillment ¶ added in v5.8.0
func NewFulfillment(ctx *pulumi.Context, name string, args *FulfillmentArgs, opts ...pulumi.ResourceOption) (*Fulfillment, error)
NewFulfillment registers a new resource with the given unique name, arguments, and options.
func (*Fulfillment) ElementType ¶ added in v5.8.0
func (*Fulfillment) ElementType() reflect.Type
func (*Fulfillment) ToFulfillmentOutput ¶ added in v5.8.0
func (i *Fulfillment) ToFulfillmentOutput() FulfillmentOutput
func (*Fulfillment) ToFulfillmentOutputWithContext ¶ added in v5.8.0
func (i *Fulfillment) ToFulfillmentOutputWithContext(ctx context.Context) FulfillmentOutput
func (*Fulfillment) ToFulfillmentPtrOutput ¶ added in v5.8.0
func (i *Fulfillment) ToFulfillmentPtrOutput() FulfillmentPtrOutput
func (*Fulfillment) ToFulfillmentPtrOutputWithContext ¶ added in v5.8.0
func (i *Fulfillment) ToFulfillmentPtrOutputWithContext(ctx context.Context) FulfillmentPtrOutput
type FulfillmentArgs ¶ added in v5.8.0
type FulfillmentArgs struct { // The human-readable name of the fulfillment, unique within the agent. DisplayName pulumi.StringInput // Whether fulfillment is enabled. Enabled pulumi.BoolPtrInput // The field defines whether the fulfillment is enabled for certain features. // Structure is documented below. Features FulfillmentFeatureArrayInput // Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. // Structure is documented below. GenericWebService FulfillmentGenericWebServicePtrInput // 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 Fulfillment resource.
func (FulfillmentArgs) ElementType ¶ added in v5.8.0
func (FulfillmentArgs) ElementType() reflect.Type
type FulfillmentArray ¶ added in v5.8.0
type FulfillmentArray []FulfillmentInput
func (FulfillmentArray) ElementType ¶ added in v5.8.0
func (FulfillmentArray) ElementType() reflect.Type
func (FulfillmentArray) ToFulfillmentArrayOutput ¶ added in v5.8.0
func (i FulfillmentArray) ToFulfillmentArrayOutput() FulfillmentArrayOutput
func (FulfillmentArray) ToFulfillmentArrayOutputWithContext ¶ added in v5.8.0
func (i FulfillmentArray) ToFulfillmentArrayOutputWithContext(ctx context.Context) FulfillmentArrayOutput
type FulfillmentArrayInput ¶ added in v5.8.0
type FulfillmentArrayInput interface { pulumi.Input ToFulfillmentArrayOutput() FulfillmentArrayOutput ToFulfillmentArrayOutputWithContext(context.Context) FulfillmentArrayOutput }
FulfillmentArrayInput is an input type that accepts FulfillmentArray and FulfillmentArrayOutput values. You can construct a concrete instance of `FulfillmentArrayInput` via:
FulfillmentArray{ FulfillmentArgs{...} }
type FulfillmentArrayOutput ¶ added in v5.8.0
type FulfillmentArrayOutput struct{ *pulumi.OutputState }
func (FulfillmentArrayOutput) ElementType ¶ added in v5.8.0
func (FulfillmentArrayOutput) ElementType() reflect.Type
func (FulfillmentArrayOutput) Index ¶ added in v5.8.0
func (o FulfillmentArrayOutput) Index(i pulumi.IntInput) FulfillmentOutput
func (FulfillmentArrayOutput) ToFulfillmentArrayOutput ¶ added in v5.8.0
func (o FulfillmentArrayOutput) ToFulfillmentArrayOutput() FulfillmentArrayOutput
func (FulfillmentArrayOutput) ToFulfillmentArrayOutputWithContext ¶ added in v5.8.0
func (o FulfillmentArrayOutput) ToFulfillmentArrayOutputWithContext(ctx context.Context) FulfillmentArrayOutput
type FulfillmentFeature ¶ added in v5.8.0
type FulfillmentFeature struct { // The type of the feature that enabled for fulfillment. // * SMALLTALK: Fulfillment is enabled for SmallTalk. // Possible values are `SMALLTALK`. Type string `pulumi:"type"` }
type FulfillmentFeatureArgs ¶ added in v5.8.0
type FulfillmentFeatureArgs struct { // The type of the feature that enabled for fulfillment. // * SMALLTALK: Fulfillment is enabled for SmallTalk. // Possible values are `SMALLTALK`. Type pulumi.StringInput `pulumi:"type"` }
func (FulfillmentFeatureArgs) ElementType ¶ added in v5.8.0
func (FulfillmentFeatureArgs) ElementType() reflect.Type
func (FulfillmentFeatureArgs) ToFulfillmentFeatureOutput ¶ added in v5.8.0
func (i FulfillmentFeatureArgs) ToFulfillmentFeatureOutput() FulfillmentFeatureOutput
func (FulfillmentFeatureArgs) ToFulfillmentFeatureOutputWithContext ¶ added in v5.8.0
func (i FulfillmentFeatureArgs) ToFulfillmentFeatureOutputWithContext(ctx context.Context) FulfillmentFeatureOutput
type FulfillmentFeatureArray ¶ added in v5.8.0
type FulfillmentFeatureArray []FulfillmentFeatureInput
func (FulfillmentFeatureArray) ElementType ¶ added in v5.8.0
func (FulfillmentFeatureArray) ElementType() reflect.Type
func (FulfillmentFeatureArray) ToFulfillmentFeatureArrayOutput ¶ added in v5.8.0
func (i FulfillmentFeatureArray) ToFulfillmentFeatureArrayOutput() FulfillmentFeatureArrayOutput
func (FulfillmentFeatureArray) ToFulfillmentFeatureArrayOutputWithContext ¶ added in v5.8.0
func (i FulfillmentFeatureArray) ToFulfillmentFeatureArrayOutputWithContext(ctx context.Context) FulfillmentFeatureArrayOutput
type FulfillmentFeatureArrayInput ¶ added in v5.8.0
type FulfillmentFeatureArrayInput interface { pulumi.Input ToFulfillmentFeatureArrayOutput() FulfillmentFeatureArrayOutput ToFulfillmentFeatureArrayOutputWithContext(context.Context) FulfillmentFeatureArrayOutput }
FulfillmentFeatureArrayInput is an input type that accepts FulfillmentFeatureArray and FulfillmentFeatureArrayOutput values. You can construct a concrete instance of `FulfillmentFeatureArrayInput` via:
FulfillmentFeatureArray{ FulfillmentFeatureArgs{...} }
type FulfillmentFeatureArrayOutput ¶ added in v5.8.0
type FulfillmentFeatureArrayOutput struct{ *pulumi.OutputState }
func (FulfillmentFeatureArrayOutput) ElementType ¶ added in v5.8.0
func (FulfillmentFeatureArrayOutput) ElementType() reflect.Type
func (FulfillmentFeatureArrayOutput) Index ¶ added in v5.8.0
func (o FulfillmentFeatureArrayOutput) Index(i pulumi.IntInput) FulfillmentFeatureOutput
func (FulfillmentFeatureArrayOutput) ToFulfillmentFeatureArrayOutput ¶ added in v5.8.0
func (o FulfillmentFeatureArrayOutput) ToFulfillmentFeatureArrayOutput() FulfillmentFeatureArrayOutput
func (FulfillmentFeatureArrayOutput) ToFulfillmentFeatureArrayOutputWithContext ¶ added in v5.8.0
func (o FulfillmentFeatureArrayOutput) ToFulfillmentFeatureArrayOutputWithContext(ctx context.Context) FulfillmentFeatureArrayOutput
type FulfillmentFeatureInput ¶ added in v5.8.0
type FulfillmentFeatureInput interface { pulumi.Input ToFulfillmentFeatureOutput() FulfillmentFeatureOutput ToFulfillmentFeatureOutputWithContext(context.Context) FulfillmentFeatureOutput }
FulfillmentFeatureInput is an input type that accepts FulfillmentFeatureArgs and FulfillmentFeatureOutput values. You can construct a concrete instance of `FulfillmentFeatureInput` via:
FulfillmentFeatureArgs{...}
type FulfillmentFeatureOutput ¶ added in v5.8.0
type FulfillmentFeatureOutput struct{ *pulumi.OutputState }
func (FulfillmentFeatureOutput) ElementType ¶ added in v5.8.0
func (FulfillmentFeatureOutput) ElementType() reflect.Type
func (FulfillmentFeatureOutput) ToFulfillmentFeatureOutput ¶ added in v5.8.0
func (o FulfillmentFeatureOutput) ToFulfillmentFeatureOutput() FulfillmentFeatureOutput
func (FulfillmentFeatureOutput) ToFulfillmentFeatureOutputWithContext ¶ added in v5.8.0
func (o FulfillmentFeatureOutput) ToFulfillmentFeatureOutputWithContext(ctx context.Context) FulfillmentFeatureOutput
func (FulfillmentFeatureOutput) Type ¶ added in v5.8.0
func (o FulfillmentFeatureOutput) Type() pulumi.StringOutput
The type of the feature that enabled for fulfillment.
- SMALLTALK: Fulfillment is enabled for SmallTalk. Possible values are `SMALLTALK`.
type FulfillmentGenericWebService ¶ added in v5.8.0
type FulfillmentGenericWebService struct { // The password for HTTP Basic authentication. Password *string `pulumi:"password"` // The HTTP request headers to send together with fulfillment requests. RequestHeaders map[string]string `pulumi:"requestHeaders"` // The fulfillment URI for receiving POST requests. It must use https protocol. Uri string `pulumi:"uri"` // The user name for HTTP Basic authentication. Username *string `pulumi:"username"` }
type FulfillmentGenericWebServiceArgs ¶ added in v5.8.0
type FulfillmentGenericWebServiceArgs struct { // The password for HTTP Basic authentication. Password pulumi.StringPtrInput `pulumi:"password"` // The HTTP request headers to send together with fulfillment requests. RequestHeaders pulumi.StringMapInput `pulumi:"requestHeaders"` // The fulfillment URI for receiving POST requests. It must use https protocol. Uri pulumi.StringInput `pulumi:"uri"` // The user name for HTTP Basic authentication. Username pulumi.StringPtrInput `pulumi:"username"` }
func (FulfillmentGenericWebServiceArgs) ElementType ¶ added in v5.8.0
func (FulfillmentGenericWebServiceArgs) ElementType() reflect.Type
func (FulfillmentGenericWebServiceArgs) ToFulfillmentGenericWebServiceOutput ¶ added in v5.8.0
func (i FulfillmentGenericWebServiceArgs) ToFulfillmentGenericWebServiceOutput() FulfillmentGenericWebServiceOutput
func (FulfillmentGenericWebServiceArgs) ToFulfillmentGenericWebServiceOutputWithContext ¶ added in v5.8.0
func (i FulfillmentGenericWebServiceArgs) ToFulfillmentGenericWebServiceOutputWithContext(ctx context.Context) FulfillmentGenericWebServiceOutput
func (FulfillmentGenericWebServiceArgs) ToFulfillmentGenericWebServicePtrOutput ¶ added in v5.8.0
func (i FulfillmentGenericWebServiceArgs) ToFulfillmentGenericWebServicePtrOutput() FulfillmentGenericWebServicePtrOutput
func (FulfillmentGenericWebServiceArgs) ToFulfillmentGenericWebServicePtrOutputWithContext ¶ added in v5.8.0
func (i FulfillmentGenericWebServiceArgs) ToFulfillmentGenericWebServicePtrOutputWithContext(ctx context.Context) FulfillmentGenericWebServicePtrOutput
type FulfillmentGenericWebServiceInput ¶ added in v5.8.0
type FulfillmentGenericWebServiceInput interface { pulumi.Input ToFulfillmentGenericWebServiceOutput() FulfillmentGenericWebServiceOutput ToFulfillmentGenericWebServiceOutputWithContext(context.Context) FulfillmentGenericWebServiceOutput }
FulfillmentGenericWebServiceInput is an input type that accepts FulfillmentGenericWebServiceArgs and FulfillmentGenericWebServiceOutput values. You can construct a concrete instance of `FulfillmentGenericWebServiceInput` via:
FulfillmentGenericWebServiceArgs{...}
type FulfillmentGenericWebServiceOutput ¶ added in v5.8.0
type FulfillmentGenericWebServiceOutput struct{ *pulumi.OutputState }
func (FulfillmentGenericWebServiceOutput) ElementType ¶ added in v5.8.0
func (FulfillmentGenericWebServiceOutput) ElementType() reflect.Type
func (FulfillmentGenericWebServiceOutput) Password ¶ added in v5.8.0
func (o FulfillmentGenericWebServiceOutput) Password() pulumi.StringPtrOutput
The password for HTTP Basic authentication.
func (FulfillmentGenericWebServiceOutput) RequestHeaders ¶ added in v5.8.0
func (o FulfillmentGenericWebServiceOutput) RequestHeaders() pulumi.StringMapOutput
The HTTP request headers to send together with fulfillment requests.
func (FulfillmentGenericWebServiceOutput) ToFulfillmentGenericWebServiceOutput ¶ added in v5.8.0
func (o FulfillmentGenericWebServiceOutput) ToFulfillmentGenericWebServiceOutput() FulfillmentGenericWebServiceOutput
func (FulfillmentGenericWebServiceOutput) ToFulfillmentGenericWebServiceOutputWithContext ¶ added in v5.8.0
func (o FulfillmentGenericWebServiceOutput) ToFulfillmentGenericWebServiceOutputWithContext(ctx context.Context) FulfillmentGenericWebServiceOutput
func (FulfillmentGenericWebServiceOutput) ToFulfillmentGenericWebServicePtrOutput ¶ added in v5.8.0
func (o FulfillmentGenericWebServiceOutput) ToFulfillmentGenericWebServicePtrOutput() FulfillmentGenericWebServicePtrOutput
func (FulfillmentGenericWebServiceOutput) ToFulfillmentGenericWebServicePtrOutputWithContext ¶ added in v5.8.0
func (o FulfillmentGenericWebServiceOutput) ToFulfillmentGenericWebServicePtrOutputWithContext(ctx context.Context) FulfillmentGenericWebServicePtrOutput
func (FulfillmentGenericWebServiceOutput) Uri ¶ added in v5.8.0
func (o FulfillmentGenericWebServiceOutput) Uri() pulumi.StringOutput
The fulfillment URI for receiving POST requests. It must use https protocol.
func (FulfillmentGenericWebServiceOutput) Username ¶ added in v5.8.0
func (o FulfillmentGenericWebServiceOutput) Username() pulumi.StringPtrOutput
The user name for HTTP Basic authentication.
type FulfillmentGenericWebServicePtrInput ¶ added in v5.8.0
type FulfillmentGenericWebServicePtrInput interface { pulumi.Input ToFulfillmentGenericWebServicePtrOutput() FulfillmentGenericWebServicePtrOutput ToFulfillmentGenericWebServicePtrOutputWithContext(context.Context) FulfillmentGenericWebServicePtrOutput }
FulfillmentGenericWebServicePtrInput is an input type that accepts FulfillmentGenericWebServiceArgs, FulfillmentGenericWebServicePtr and FulfillmentGenericWebServicePtrOutput values. You can construct a concrete instance of `FulfillmentGenericWebServicePtrInput` via:
FulfillmentGenericWebServiceArgs{...} or: nil
func FulfillmentGenericWebServicePtr ¶ added in v5.8.0
func FulfillmentGenericWebServicePtr(v *FulfillmentGenericWebServiceArgs) FulfillmentGenericWebServicePtrInput
type FulfillmentGenericWebServicePtrOutput ¶ added in v5.8.0
type FulfillmentGenericWebServicePtrOutput struct{ *pulumi.OutputState }
func (FulfillmentGenericWebServicePtrOutput) ElementType ¶ added in v5.8.0
func (FulfillmentGenericWebServicePtrOutput) ElementType() reflect.Type
func (FulfillmentGenericWebServicePtrOutput) Password ¶ added in v5.8.0
func (o FulfillmentGenericWebServicePtrOutput) Password() pulumi.StringPtrOutput
The password for HTTP Basic authentication.
func (FulfillmentGenericWebServicePtrOutput) RequestHeaders ¶ added in v5.8.0
func (o FulfillmentGenericWebServicePtrOutput) RequestHeaders() pulumi.StringMapOutput
The HTTP request headers to send together with fulfillment requests.
func (FulfillmentGenericWebServicePtrOutput) ToFulfillmentGenericWebServicePtrOutput ¶ added in v5.8.0
func (o FulfillmentGenericWebServicePtrOutput) ToFulfillmentGenericWebServicePtrOutput() FulfillmentGenericWebServicePtrOutput
func (FulfillmentGenericWebServicePtrOutput) ToFulfillmentGenericWebServicePtrOutputWithContext ¶ added in v5.8.0
func (o FulfillmentGenericWebServicePtrOutput) ToFulfillmentGenericWebServicePtrOutputWithContext(ctx context.Context) FulfillmentGenericWebServicePtrOutput
func (FulfillmentGenericWebServicePtrOutput) Uri ¶ added in v5.8.0
func (o FulfillmentGenericWebServicePtrOutput) Uri() pulumi.StringPtrOutput
The fulfillment URI for receiving POST requests. It must use https protocol.
func (FulfillmentGenericWebServicePtrOutput) Username ¶ added in v5.8.0
func (o FulfillmentGenericWebServicePtrOutput) Username() pulumi.StringPtrOutput
The user name for HTTP Basic authentication.
type FulfillmentInput ¶ added in v5.8.0
type FulfillmentInput interface { pulumi.Input ToFulfillmentOutput() FulfillmentOutput ToFulfillmentOutputWithContext(ctx context.Context) FulfillmentOutput }
type FulfillmentMap ¶ added in v5.8.0
type FulfillmentMap map[string]FulfillmentInput
func (FulfillmentMap) ElementType ¶ added in v5.8.0
func (FulfillmentMap) ElementType() reflect.Type
func (FulfillmentMap) ToFulfillmentMapOutput ¶ added in v5.8.0
func (i FulfillmentMap) ToFulfillmentMapOutput() FulfillmentMapOutput
func (FulfillmentMap) ToFulfillmentMapOutputWithContext ¶ added in v5.8.0
func (i FulfillmentMap) ToFulfillmentMapOutputWithContext(ctx context.Context) FulfillmentMapOutput
type FulfillmentMapInput ¶ added in v5.8.0
type FulfillmentMapInput interface { pulumi.Input ToFulfillmentMapOutput() FulfillmentMapOutput ToFulfillmentMapOutputWithContext(context.Context) FulfillmentMapOutput }
FulfillmentMapInput is an input type that accepts FulfillmentMap and FulfillmentMapOutput values. You can construct a concrete instance of `FulfillmentMapInput` via:
FulfillmentMap{ "key": FulfillmentArgs{...} }
type FulfillmentMapOutput ¶ added in v5.8.0
type FulfillmentMapOutput struct{ *pulumi.OutputState }
func (FulfillmentMapOutput) ElementType ¶ added in v5.8.0
func (FulfillmentMapOutput) ElementType() reflect.Type
func (FulfillmentMapOutput) MapIndex ¶ added in v5.8.0
func (o FulfillmentMapOutput) MapIndex(k pulumi.StringInput) FulfillmentOutput
func (FulfillmentMapOutput) ToFulfillmentMapOutput ¶ added in v5.8.0
func (o FulfillmentMapOutput) ToFulfillmentMapOutput() FulfillmentMapOutput
func (FulfillmentMapOutput) ToFulfillmentMapOutputWithContext ¶ added in v5.8.0
func (o FulfillmentMapOutput) ToFulfillmentMapOutputWithContext(ctx context.Context) FulfillmentMapOutput
type FulfillmentOutput ¶ added in v5.8.0
type FulfillmentOutput struct {
*pulumi.OutputState
}
func (FulfillmentOutput) ElementType ¶ added in v5.8.0
func (FulfillmentOutput) ElementType() reflect.Type
func (FulfillmentOutput) ToFulfillmentOutput ¶ added in v5.8.0
func (o FulfillmentOutput) ToFulfillmentOutput() FulfillmentOutput
func (FulfillmentOutput) ToFulfillmentOutputWithContext ¶ added in v5.8.0
func (o FulfillmentOutput) ToFulfillmentOutputWithContext(ctx context.Context) FulfillmentOutput
func (FulfillmentOutput) ToFulfillmentPtrOutput ¶ added in v5.8.0
func (o FulfillmentOutput) ToFulfillmentPtrOutput() FulfillmentPtrOutput
func (FulfillmentOutput) ToFulfillmentPtrOutputWithContext ¶ added in v5.8.0
func (o FulfillmentOutput) ToFulfillmentPtrOutputWithContext(ctx context.Context) FulfillmentPtrOutput
type FulfillmentPtrInput ¶ added in v5.8.0
type FulfillmentPtrInput interface { pulumi.Input ToFulfillmentPtrOutput() FulfillmentPtrOutput ToFulfillmentPtrOutputWithContext(ctx context.Context) FulfillmentPtrOutput }
type FulfillmentPtrOutput ¶ added in v5.8.0
type FulfillmentPtrOutput struct {
*pulumi.OutputState
}
func (FulfillmentPtrOutput) ElementType ¶ added in v5.8.0
func (FulfillmentPtrOutput) ElementType() reflect.Type
func (FulfillmentPtrOutput) ToFulfillmentPtrOutput ¶ added in v5.8.0
func (o FulfillmentPtrOutput) ToFulfillmentPtrOutput() FulfillmentPtrOutput
func (FulfillmentPtrOutput) ToFulfillmentPtrOutputWithContext ¶ added in v5.8.0
func (o FulfillmentPtrOutput) ToFulfillmentPtrOutputWithContext(ctx context.Context) FulfillmentPtrOutput
type FulfillmentState ¶ added in v5.8.0
type FulfillmentState struct { // The human-readable name of the fulfillment, unique within the agent. DisplayName pulumi.StringPtrInput // Whether fulfillment is enabled. Enabled pulumi.BoolPtrInput // The field defines whether the fulfillment is enabled for certain features. // Structure is documented below. Features FulfillmentFeatureArrayInput // Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. // Structure is documented below. GenericWebService FulfillmentGenericWebServicePtrInput // The unique identifier of the fulfillment. Format: projects/<Project ID>/agent/fulfillment - projects/<Project // ID>/locations/<Location ID>/agent/fulfillment 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 (FulfillmentState) ElementType ¶ added in v5.8.0
func (FulfillmentState) ElementType() reflect.Type
type Intent ¶
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
- [Official Documentation](https://cloud.google.com/dialogflow/docs/)
## Example Usage ### Dialogflow Intent Basic
```go package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v5/go/gcp/diagflow" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { basicAgent, err := diagflow.NewAgent(ctx, "basicAgent", &diagflow.AgentArgs{ DisplayName: pulumi.String("example_agent"), DefaultLanguageCode: pulumi.String("en"), TimeZone: pulumi.String("America/New_York"), }) if err != nil { return err } _, err = diagflow.NewIntent(ctx, "basicIntent", &diagflow.IntentArgs{ DisplayName: pulumi.String("basic-intent"), }, pulumi.DependsOn([]pulumi.Resource{ basicAgent, })) if err != nil { return err } return nil }) }
```
## Import
Intent can be imported using any of these accepted formats ¶
```sh
$ pulumi import gcp:diagflow/intent:Intent default {{name}}
```
func GetIntent ¶
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 ¶
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.
func (*Intent) ElementType ¶
func (*Intent) ToIntentOutput ¶
func (i *Intent) ToIntentOutput() IntentOutput
func (*Intent) ToIntentOutputWithContext ¶
func (i *Intent) ToIntentOutputWithContext(ctx context.Context) IntentOutput
func (*Intent) ToIntentPtrOutput ¶
func (i *Intent) ToIntentPtrOutput() IntentPtrOutput
func (*Intent) ToIntentPtrOutputWithContext ¶
func (i *Intent) ToIntentPtrOutputWithContext(ctx context.Context) IntentPtrOutput
type IntentArgs ¶
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 ¶
func (IntentArgs) ElementType() reflect.Type
type IntentArray ¶
type IntentArray []IntentInput
func (IntentArray) ElementType ¶
func (IntentArray) ElementType() reflect.Type
func (IntentArray) ToIntentArrayOutput ¶
func (i IntentArray) ToIntentArrayOutput() IntentArrayOutput
func (IntentArray) ToIntentArrayOutputWithContext ¶
func (i IntentArray) ToIntentArrayOutputWithContext(ctx context.Context) IntentArrayOutput
type IntentArrayInput ¶
type IntentArrayInput interface { pulumi.Input ToIntentArrayOutput() IntentArrayOutput ToIntentArrayOutputWithContext(context.Context) IntentArrayOutput }
IntentArrayInput is an input type that accepts IntentArray and IntentArrayOutput values. You can construct a concrete instance of `IntentArrayInput` via:
IntentArray{ IntentArgs{...} }
type IntentArrayOutput ¶
type IntentArrayOutput struct{ *pulumi.OutputState }
func (IntentArrayOutput) ElementType ¶
func (IntentArrayOutput) ElementType() reflect.Type
func (IntentArrayOutput) Index ¶
func (o IntentArrayOutput) Index(i pulumi.IntInput) IntentOutput
func (IntentArrayOutput) ToIntentArrayOutput ¶
func (o IntentArrayOutput) ToIntentArrayOutput() IntentArrayOutput
func (IntentArrayOutput) ToIntentArrayOutputWithContext ¶
func (o IntentArrayOutput) ToIntentArrayOutputWithContext(ctx context.Context) IntentArrayOutput
type IntentFollowupIntentInfo ¶
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 ¶
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 ¶
func (IntentFollowupIntentInfoArgs) ElementType() reflect.Type
func (IntentFollowupIntentInfoArgs) ToIntentFollowupIntentInfoOutput ¶
func (i IntentFollowupIntentInfoArgs) ToIntentFollowupIntentInfoOutput() IntentFollowupIntentInfoOutput
func (IntentFollowupIntentInfoArgs) ToIntentFollowupIntentInfoOutputWithContext ¶
func (i IntentFollowupIntentInfoArgs) ToIntentFollowupIntentInfoOutputWithContext(ctx context.Context) IntentFollowupIntentInfoOutput
type IntentFollowupIntentInfoArray ¶
type IntentFollowupIntentInfoArray []IntentFollowupIntentInfoInput
func (IntentFollowupIntentInfoArray) ElementType ¶
func (IntentFollowupIntentInfoArray) ElementType() reflect.Type
func (IntentFollowupIntentInfoArray) ToIntentFollowupIntentInfoArrayOutput ¶
func (i IntentFollowupIntentInfoArray) ToIntentFollowupIntentInfoArrayOutput() IntentFollowupIntentInfoArrayOutput
func (IntentFollowupIntentInfoArray) ToIntentFollowupIntentInfoArrayOutputWithContext ¶
func (i IntentFollowupIntentInfoArray) ToIntentFollowupIntentInfoArrayOutputWithContext(ctx context.Context) IntentFollowupIntentInfoArrayOutput
type IntentFollowupIntentInfoArrayInput ¶
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 ¶
type IntentFollowupIntentInfoArrayOutput struct{ *pulumi.OutputState }
func (IntentFollowupIntentInfoArrayOutput) ElementType ¶
func (IntentFollowupIntentInfoArrayOutput) ElementType() reflect.Type
func (IntentFollowupIntentInfoArrayOutput) Index ¶
func (o IntentFollowupIntentInfoArrayOutput) Index(i pulumi.IntInput) IntentFollowupIntentInfoOutput
func (IntentFollowupIntentInfoArrayOutput) ToIntentFollowupIntentInfoArrayOutput ¶
func (o IntentFollowupIntentInfoArrayOutput) ToIntentFollowupIntentInfoArrayOutput() IntentFollowupIntentInfoArrayOutput
func (IntentFollowupIntentInfoArrayOutput) ToIntentFollowupIntentInfoArrayOutputWithContext ¶
func (o IntentFollowupIntentInfoArrayOutput) ToIntentFollowupIntentInfoArrayOutputWithContext(ctx context.Context) IntentFollowupIntentInfoArrayOutput
type IntentFollowupIntentInfoInput ¶
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 ¶
type IntentFollowupIntentInfoOutput struct{ *pulumi.OutputState }
func (IntentFollowupIntentInfoOutput) ElementType ¶
func (IntentFollowupIntentInfoOutput) ElementType() reflect.Type
func (IntentFollowupIntentInfoOutput) FollowupIntentName ¶
func (o IntentFollowupIntentInfoOutput) FollowupIntentName() pulumi.StringPtrOutput
func (IntentFollowupIntentInfoOutput) ParentFollowupIntentName ¶
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 ¶
func (o IntentFollowupIntentInfoOutput) ToIntentFollowupIntentInfoOutput() IntentFollowupIntentInfoOutput
func (IntentFollowupIntentInfoOutput) ToIntentFollowupIntentInfoOutputWithContext ¶
func (o IntentFollowupIntentInfoOutput) ToIntentFollowupIntentInfoOutputWithContext(ctx context.Context) IntentFollowupIntentInfoOutput
type IntentInput ¶
type IntentInput interface { pulumi.Input ToIntentOutput() IntentOutput ToIntentOutputWithContext(ctx context.Context) IntentOutput }
type IntentMap ¶
type IntentMap map[string]IntentInput
func (IntentMap) ElementType ¶
func (IntentMap) ToIntentMapOutput ¶
func (i IntentMap) ToIntentMapOutput() IntentMapOutput
func (IntentMap) ToIntentMapOutputWithContext ¶
func (i IntentMap) ToIntentMapOutputWithContext(ctx context.Context) IntentMapOutput
type IntentMapInput ¶
type IntentMapInput interface { pulumi.Input ToIntentMapOutput() IntentMapOutput ToIntentMapOutputWithContext(context.Context) IntentMapOutput }
IntentMapInput is an input type that accepts IntentMap and IntentMapOutput values. You can construct a concrete instance of `IntentMapInput` via:
IntentMap{ "key": IntentArgs{...} }
type IntentMapOutput ¶
type IntentMapOutput struct{ *pulumi.OutputState }
func (IntentMapOutput) ElementType ¶
func (IntentMapOutput) ElementType() reflect.Type
func (IntentMapOutput) MapIndex ¶
func (o IntentMapOutput) MapIndex(k pulumi.StringInput) IntentOutput
func (IntentMapOutput) ToIntentMapOutput ¶
func (o IntentMapOutput) ToIntentMapOutput() IntentMapOutput
func (IntentMapOutput) ToIntentMapOutputWithContext ¶
func (o IntentMapOutput) ToIntentMapOutputWithContext(ctx context.Context) IntentMapOutput
type IntentOutput ¶
type IntentOutput struct {
*pulumi.OutputState
}
func (IntentOutput) ElementType ¶
func (IntentOutput) ElementType() reflect.Type
func (IntentOutput) ToIntentOutput ¶
func (o IntentOutput) ToIntentOutput() IntentOutput
func (IntentOutput) ToIntentOutputWithContext ¶
func (o IntentOutput) ToIntentOutputWithContext(ctx context.Context) IntentOutput
func (IntentOutput) ToIntentPtrOutput ¶
func (o IntentOutput) ToIntentPtrOutput() IntentPtrOutput
func (IntentOutput) ToIntentPtrOutputWithContext ¶
func (o IntentOutput) ToIntentPtrOutputWithContext(ctx context.Context) IntentPtrOutput
type IntentPtrInput ¶
type IntentPtrInput interface { pulumi.Input ToIntentPtrOutput() IntentPtrOutput ToIntentPtrOutputWithContext(ctx context.Context) IntentPtrOutput }
type IntentPtrOutput ¶
type IntentPtrOutput struct {
*pulumi.OutputState
}
func (IntentPtrOutput) ElementType ¶
func (IntentPtrOutput) ElementType() reflect.Type
func (IntentPtrOutput) ToIntentPtrOutput ¶
func (o IntentPtrOutput) ToIntentPtrOutput() IntentPtrOutput
func (IntentPtrOutput) ToIntentPtrOutputWithContext ¶
func (o IntentPtrOutput) ToIntentPtrOutputWithContext(ctx context.Context) IntentPtrOutput
type IntentState ¶
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 ¶
func (IntentState) ElementType() reflect.Type