gcp.diagflow.Agent
Explore with Pulumi AI
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
- How-to Guides
Example Usage
Dialogflow Agent Full
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var fullAgent = new Gcp.Diagflow.Agent("fullAgent", new()
{
ApiVersion = "API_VERSION_V2_BETA_1",
AvatarUri = "https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
ClassificationThreshold = 0.3,
DefaultLanguageCode = "en",
Description = "Example description.",
DisplayName = "dialogflow-agent",
EnableLogging = true,
MatchMode = "MATCH_MODE_ML_ONLY",
SupportedLanguageCodes = new[]
{
"fr",
"de",
"es",
},
Tier = "TIER_STANDARD",
TimeZone = "America/New_York",
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/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
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.diagflow.Agent;
import com.pulumi.gcp.diagflow.AgentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var fullAgent = new Agent("fullAgent", AgentArgs.builder()
.apiVersion("API_VERSION_V2_BETA_1")
.avatarUri("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png")
.classificationThreshold(0.3)
.defaultLanguageCode("en")
.description("Example description.")
.displayName("dialogflow-agent")
.enableLogging(true)
.matchMode("MATCH_MODE_ML_ONLY")
.supportedLanguageCodes(
"fr",
"de",
"es")
.tier("TIER_STANDARD")
.timeZone("America/New_York")
.build());
}
}
import pulumi
import pulumi_gcp as gcp
full_agent = gcp.diagflow.Agent("fullAgent",
api_version="API_VERSION_V2_BETA_1",
avatar_uri="https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
classification_threshold=0.3,
default_language_code="en",
description="Example description.",
display_name="dialogflow-agent",
enable_logging=True,
match_mode="MATCH_MODE_ML_ONLY",
supported_language_codes=[
"fr",
"de",
"es",
],
tier="TIER_STANDARD",
time_zone="America/New_York")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const fullAgent = new gcp.diagflow.Agent("fullAgent", {
apiVersion: "API_VERSION_V2_BETA_1",
avatarUri: "https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
classificationThreshold: 0.3,
defaultLanguageCode: "en",
description: "Example description.",
displayName: "dialogflow-agent",
enableLogging: true,
matchMode: "MATCH_MODE_ML_ONLY",
supportedLanguageCodes: [
"fr",
"de",
"es",
],
tier: "TIER_STANDARD",
timeZone: "America/New_York",
});
resources:
fullAgent:
type: gcp:diagflow:Agent
properties:
apiVersion: API_VERSION_V2_BETA_1
avatarUri: https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png
classificationThreshold: 0.3
defaultLanguageCode: en
description: Example description.
displayName: dialogflow-agent
enableLogging: true
matchMode: MATCH_MODE_ML_ONLY
supportedLanguageCodes:
- fr
- de
- es
tier: TIER_STANDARD
timeZone: America/New_York
Create Agent Resource
new Agent(name: string, args: AgentArgs, opts?: CustomResourceOptions);
@overload
def Agent(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_version: Optional[str] = None,
avatar_uri: Optional[str] = None,
classification_threshold: Optional[float] = None,
default_language_code: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
enable_logging: Optional[bool] = None,
match_mode: Optional[str] = None,
project: Optional[str] = None,
supported_language_codes: Optional[Sequence[str]] = None,
tier: Optional[str] = None,
time_zone: Optional[str] = None)
@overload
def Agent(resource_name: str,
args: AgentArgs,
opts: Optional[ResourceOptions] = None)
func NewAgent(ctx *Context, name string, args AgentArgs, opts ...ResourceOption) (*Agent, error)
public Agent(string name, AgentArgs args, CustomResourceOptions? opts = null)
type: gcp:diagflow:Agent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AgentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AgentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AgentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AgentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AgentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Agent Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Agent resource accepts the following input properties:
- Default
Language stringCode The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
- Display
Name string The name of this agent.
- Time
Zone string The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- Api
Version string 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
,API_VERSION_V2_BETA_1
.
- Avatar
Uri string 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.
- Classification
Threshold double 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.
- Description string
The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
- Enable
Logging bool Determines whether this agent should log conversation queries.
- Match
Mode string 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
,MATCH_MODE_ML_ONLY
.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Supported
Language List<string>Codes The list of all languages supported by this agent (except for the defaultLanguageCode).
- Tier string
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.
- Default
Language stringCode The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
- Display
Name string The name of this agent.
- Time
Zone string The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- Api
Version string 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
,API_VERSION_V2_BETA_1
.
- Avatar
Uri string 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.
- Classification
Threshold float64 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.
- Description string
The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
- Enable
Logging bool Determines whether this agent should log conversation queries.
- Match
Mode string 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
,MATCH_MODE_ML_ONLY
.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Supported
Language []stringCodes The list of all languages supported by this agent (except for the defaultLanguageCode).
- Tier string
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.
- default
Language StringCode The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
- display
Name String The name of this agent.
- time
Zone String The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- api
Version String 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
,API_VERSION_V2_BETA_1
.
- avatar
Uri String 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.
- classification
Threshold Double 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.
- description String
The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
- enable
Logging Boolean Determines whether this agent should log conversation queries.
- match
Mode String 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
,MATCH_MODE_ML_ONLY
.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- supported
Language List<String>Codes The list of all languages supported by this agent (except for the defaultLanguageCode).
- tier String
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.
- default
Language stringCode The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
- display
Name string The name of this agent.
- time
Zone string The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- api
Version string 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
,API_VERSION_V2_BETA_1
.
- avatar
Uri string 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.
- classification
Threshold number 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.
- description string
The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
- enable
Logging boolean Determines whether this agent should log conversation queries.
- match
Mode string 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
,MATCH_MODE_ML_ONLY
.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- supported
Language string[]Codes The list of all languages supported by this agent (except for the defaultLanguageCode).
- tier string
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.
- default_
language_ strcode The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
- display_
name str The name of this agent.
- time_
zone str The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- api_
version str 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
,API_VERSION_V2_BETA_1
.
- avatar_
uri str 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.
- classification_
threshold float 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.
- description str
The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
- enable_
logging bool Determines whether this agent should log conversation queries.
- match_
mode str 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
,MATCH_MODE_ML_ONLY
.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- supported_
language_ Sequence[str]codes The list of all languages supported by this agent (except for the defaultLanguageCode).
- tier str
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.
- default
Language StringCode The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
- display
Name String The name of this agent.
- time
Zone String The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- api
Version String 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
,API_VERSION_V2_BETA_1
.
- avatar
Uri String 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.
- classification
Threshold Number 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.
- description String
The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
- enable
Logging Boolean Determines whether this agent should log conversation queries.
- match
Mode String 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
,MATCH_MODE_ML_ONLY
.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- supported
Language List<String>Codes The list of all languages supported by this agent (except for the defaultLanguageCode).
- tier String
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.
Outputs
All input properties are implicitly available as output properties. Additionally, the Agent resource produces the following output properties:
- Avatar
Uri stringBackend 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.
- Id string
The provider-assigned unique ID for this managed resource.
- Avatar
Uri stringBackend 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.
- Id string
The provider-assigned unique ID for this managed resource.
- avatar
Uri StringBackend 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.
- id String
The provider-assigned unique ID for this managed resource.
- avatar
Uri stringBackend 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.
- id string
The provider-assigned unique ID for this managed resource.
- avatar_
uri_ strbackend 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.
- id str
The provider-assigned unique ID for this managed resource.
- avatar
Uri StringBackend 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.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing Agent Resource
Get an existing Agent resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AgentState, opts?: CustomResourceOptions): Agent
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_version: Optional[str] = None,
avatar_uri: Optional[str] = None,
avatar_uri_backend: Optional[str] = None,
classification_threshold: Optional[float] = None,
default_language_code: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
enable_logging: Optional[bool] = None,
match_mode: Optional[str] = None,
project: Optional[str] = None,
supported_language_codes: Optional[Sequence[str]] = None,
tier: Optional[str] = None,
time_zone: Optional[str] = None) -> Agent
func GetAgent(ctx *Context, name string, id IDInput, state *AgentState, opts ...ResourceOption) (*Agent, error)
public static Agent Get(string name, Input<string> id, AgentState? state, CustomResourceOptions? opts = null)
public static Agent get(String name, Output<String> id, AgentState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Api
Version string 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
,API_VERSION_V2_BETA_1
.
- Avatar
Uri string 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.
- Avatar
Uri stringBackend 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.
- Classification
Threshold double 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.
- Default
Language stringCode The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
- Description string
The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
- Display
Name string The name of this agent.
- Enable
Logging bool Determines whether this agent should log conversation queries.
- Match
Mode string 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
,MATCH_MODE_ML_ONLY
.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Supported
Language List<string>Codes The list of all languages supported by this agent (except for the defaultLanguageCode).
- Tier string
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.
- Time
Zone string The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- Api
Version string 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
,API_VERSION_V2_BETA_1
.
- Avatar
Uri string 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.
- Avatar
Uri stringBackend 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.
- Classification
Threshold float64 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.
- Default
Language stringCode The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
- Description string
The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
- Display
Name string The name of this agent.
- Enable
Logging bool Determines whether this agent should log conversation queries.
- Match
Mode string 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
,MATCH_MODE_ML_ONLY
.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Supported
Language []stringCodes The list of all languages supported by this agent (except for the defaultLanguageCode).
- Tier string
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.
- Time
Zone string The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- api
Version String 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
,API_VERSION_V2_BETA_1
.
- avatar
Uri String 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.
- avatar
Uri StringBackend 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.
- classification
Threshold Double 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.
- default
Language StringCode The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
- description String
The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
- display
Name String The name of this agent.
- enable
Logging Boolean Determines whether this agent should log conversation queries.
- match
Mode String 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
,MATCH_MODE_ML_ONLY
.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- supported
Language List<String>Codes The list of all languages supported by this agent (except for the defaultLanguageCode).
- tier String
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.
- time
Zone String The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- api
Version string 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
,API_VERSION_V2_BETA_1
.
- avatar
Uri string 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.
- avatar
Uri stringBackend 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.
- classification
Threshold number 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.
- default
Language stringCode The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
- description string
The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
- display
Name string The name of this agent.
- enable
Logging boolean Determines whether this agent should log conversation queries.
- match
Mode string 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
,MATCH_MODE_ML_ONLY
.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- supported
Language string[]Codes The list of all languages supported by this agent (except for the defaultLanguageCode).
- tier string
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.
- time
Zone string The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- api_
version str 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
,API_VERSION_V2_BETA_1
.
- avatar_
uri str 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.
- avatar_
uri_ strbackend 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.
- classification_
threshold float 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.
- default_
language_ strcode The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
- description str
The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
- display_
name str The name of this agent.
- enable_
logging bool Determines whether this agent should log conversation queries.
- match_
mode str 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
,MATCH_MODE_ML_ONLY
.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- supported_
language_ Sequence[str]codes The list of all languages supported by this agent (except for the defaultLanguageCode).
- tier str
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.
- time_
zone str The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- api
Version String 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
,API_VERSION_V2_BETA_1
.
- avatar
Uri String 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.
- avatar
Uri StringBackend 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.
- classification
Threshold Number 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.
- default
Language StringCode The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
- description String
The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
- display
Name String The name of this agent.
- enable
Logging Boolean Determines whether this agent should log conversation queries.
- match
Mode String 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
,MATCH_MODE_ML_ONLY
.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- supported
Language List<String>Codes The list of all languages supported by this agent (except for the defaultLanguageCode).
- tier String
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.
- time
Zone String The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
Import
Agent can be imported using any of these accepted formats:
$ pulumi import gcp:diagflow/agent:Agent default {{project}}
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-beta
Terraform Provider.