1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. diagflow
  5. Agent
Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

gcp.diagflow.Agent

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

    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:

    Example Usage

    Dialogflow Agent Full

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const fullAgent = new gcp.diagflow.Agent("full_agent", {
        displayName: "dialogflow-agent",
        defaultLanguageCode: "en",
        supportedLanguageCodes: [
            "fr",
            "de",
            "es",
        ],
        timeZone: "America/New_York",
        description: "Example description.",
        avatarUri: "https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
        enableLogging: true,
        matchMode: "MATCH_MODE_ML_ONLY",
        classificationThreshold: 0.3,
        apiVersion: "API_VERSION_V2_BETA_1",
        tier: "TIER_STANDARD",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    full_agent = gcp.diagflow.Agent("full_agent",
        display_name="dialogflow-agent",
        default_language_code="en",
        supported_language_codes=[
            "fr",
            "de",
            "es",
        ],
        time_zone="America/New_York",
        description="Example description.",
        avatar_uri="https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
        enable_logging=True,
        match_mode="MATCH_MODE_ML_ONLY",
        classification_threshold=0.3,
        api_version="API_VERSION_V2_BETA_1",
        tier="TIER_STANDARD")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/diagflow"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := diagflow.NewAgent(ctx, "full_agent", &diagflow.AgentArgs{
    			DisplayName:         pulumi.String("dialogflow-agent"),
    			DefaultLanguageCode: pulumi.String("en"),
    			SupportedLanguageCodes: pulumi.StringArray{
    				pulumi.String("fr"),
    				pulumi.String("de"),
    				pulumi.String("es"),
    			},
    			TimeZone:                pulumi.String("America/New_York"),
    			Description:             pulumi.String("Example description."),
    			AvatarUri:               pulumi.String("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png"),
    			EnableLogging:           pulumi.Bool(true),
    			MatchMode:               pulumi.String("MATCH_MODE_ML_ONLY"),
    			ClassificationThreshold: pulumi.Float64(0.3),
    			ApiVersion:              pulumi.String("API_VERSION_V2_BETA_1"),
    			Tier:                    pulumi.String("TIER_STANDARD"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var fullAgent = new Gcp.Diagflow.Agent("full_agent", new()
        {
            DisplayName = "dialogflow-agent",
            DefaultLanguageCode = "en",
            SupportedLanguageCodes = new[]
            {
                "fr",
                "de",
                "es",
            },
            TimeZone = "America/New_York",
            Description = "Example description.",
            AvatarUri = "https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
            EnableLogging = true,
            MatchMode = "MATCH_MODE_ML_ONLY",
            ClassificationThreshold = 0.3,
            ApiVersion = "API_VERSION_V2_BETA_1",
            Tier = "TIER_STANDARD",
        });
    
    });
    
    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()        
                .displayName("dialogflow-agent")
                .defaultLanguageCode("en")
                .supportedLanguageCodes(            
                    "fr",
                    "de",
                    "es")
                .timeZone("America/New_York")
                .description("Example description.")
                .avatarUri("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png")
                .enableLogging(true)
                .matchMode("MATCH_MODE_ML_ONLY")
                .classificationThreshold(0.3)
                .apiVersion("API_VERSION_V2_BETA_1")
                .tier("TIER_STANDARD")
                .build());
    
        }
    }
    
    resources:
      fullAgent:
        type: gcp:diagflow:Agent
        name: full_agent
        properties:
          displayName: dialogflow-agent
          defaultLanguageCode: en
          supportedLanguageCodes:
            - fr
            - de
            - es
          timeZone: America/New_York
          description: Example description.
          avatarUri: https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png
          enableLogging: true
          matchMode: MATCH_MODE_ML_ONLY
          classificationThreshold: 0.3
          apiVersion: API_VERSION_V2_BETA_1
          tier: TIER_STANDARD
    

    Create Agent Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Agent(name: string, args: AgentArgs, opts?: CustomResourceOptions);
    @overload
    def Agent(resource_name: str,
              args: AgentArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Agent(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              default_language_code: Optional[str] = None,
              display_name: Optional[str] = None,
              time_zone: Optional[str] = None,
              api_version: Optional[str] = None,
              avatar_uri: Optional[str] = None,
              classification_threshold: Optional[float] = None,
              description: 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)
    func NewAgent(ctx *Context, name string, args AgentArgs, opts ...ResourceOption) (*Agent, error)
    public Agent(string name, AgentArgs args, CustomResourceOptions? opts = null)
    public Agent(String name, AgentArgs args)
    public Agent(String name, AgentArgs args, CustomResourceOptions options)
    
    type: gcp:diagflow:Agent
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    var agentResource = new Gcp.Diagflow.Agent("agentResource", new()
    {
        DefaultLanguageCode = "string",
        DisplayName = "string",
        TimeZone = "string",
        ApiVersion = "string",
        AvatarUri = "string",
        ClassificationThreshold = 0,
        Description = "string",
        EnableLogging = false,
        MatchMode = "string",
        Project = "string",
        SupportedLanguageCodes = new[]
        {
            "string",
        },
        Tier = "string",
    });
    
    example, err := diagflow.NewAgent(ctx, "agentResource", &diagflow.AgentArgs{
    	DefaultLanguageCode:     pulumi.String("string"),
    	DisplayName:             pulumi.String("string"),
    	TimeZone:                pulumi.String("string"),
    	ApiVersion:              pulumi.String("string"),
    	AvatarUri:               pulumi.String("string"),
    	ClassificationThreshold: pulumi.Float64(0),
    	Description:             pulumi.String("string"),
    	EnableLogging:           pulumi.Bool(false),
    	MatchMode:               pulumi.String("string"),
    	Project:                 pulumi.String("string"),
    	SupportedLanguageCodes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Tier: pulumi.String("string"),
    })
    
    var agentResource = new Agent("agentResource", AgentArgs.builder()        
        .defaultLanguageCode("string")
        .displayName("string")
        .timeZone("string")
        .apiVersion("string")
        .avatarUri("string")
        .classificationThreshold(0)
        .description("string")
        .enableLogging(false)
        .matchMode("string")
        .project("string")
        .supportedLanguageCodes("string")
        .tier("string")
        .build());
    
    agent_resource = gcp.diagflow.Agent("agentResource",
        default_language_code="string",
        display_name="string",
        time_zone="string",
        api_version="string",
        avatar_uri="string",
        classification_threshold=0,
        description="string",
        enable_logging=False,
        match_mode="string",
        project="string",
        supported_language_codes=["string"],
        tier="string")
    
    const agentResource = new gcp.diagflow.Agent("agentResource", {
        defaultLanguageCode: "string",
        displayName: "string",
        timeZone: "string",
        apiVersion: "string",
        avatarUri: "string",
        classificationThreshold: 0,
        description: "string",
        enableLogging: false,
        matchMode: "string",
        project: "string",
        supportedLanguageCodes: ["string"],
        tier: "string",
    });
    
    type: gcp:diagflow:Agent
    properties:
        apiVersion: string
        avatarUri: string
        classificationThreshold: 0
        defaultLanguageCode: string
        description: string
        displayName: string
        enableLogging: false
        matchMode: string
        project: string
        supportedLanguageCodes:
            - string
        tier: string
        timeZone: string
    

    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:

    DefaultLanguageCode string
    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.
    DisplayName string
    The name of this agent.
    TimeZone string
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.


    ApiVersion 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.
    AvatarUri 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.
    ClassificationThreshold 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.
    EnableLogging bool
    Determines whether this agent should log conversation queries.
    MatchMode 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.
    SupportedLanguageCodes List<string>
    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.
    DefaultLanguageCode string
    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.
    DisplayName string
    The name of this agent.
    TimeZone string
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.


    ApiVersion 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.
    AvatarUri 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.
    ClassificationThreshold 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.
    EnableLogging bool
    Determines whether this agent should log conversation queries.
    MatchMode 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.
    SupportedLanguageCodes []string
    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.
    defaultLanguageCode String
    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.
    displayName String
    The name of this agent.
    timeZone String
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.


    apiVersion 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.
    avatarUri 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.
    classificationThreshold 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.
    enableLogging Boolean
    Determines whether this agent should log conversation queries.
    matchMode 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.
    supportedLanguageCodes List<String>
    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.
    defaultLanguageCode string
    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.
    displayName string
    The name of this agent.
    timeZone string
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.


    apiVersion 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.
    avatarUri 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.
    classificationThreshold 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.
    enableLogging boolean
    Determines whether this agent should log conversation queries.
    matchMode 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.
    supportedLanguageCodes string[]
    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_code str
    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_codes Sequence[str]
    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.
    defaultLanguageCode String
    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.
    displayName String
    The name of this agent.
    timeZone String
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.


    apiVersion 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.
    avatarUri 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.
    classificationThreshold 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.
    enableLogging Boolean
    Determines whether this agent should log conversation queries.
    matchMode 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.
    supportedLanguageCodes List<String>
    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:

    AvatarUriBackend string
    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.
    AvatarUriBackend string
    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.
    avatarUriBackend String
    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.
    avatarUriBackend string
    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_backend str
    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.
    avatarUriBackend String
    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.
    The following state arguments are supported:
    ApiVersion 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.
    AvatarUri 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.
    AvatarUriBackend string
    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.
    ClassificationThreshold 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.
    DefaultLanguageCode string
    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.
    DisplayName string
    The name of this agent.
    EnableLogging bool
    Determines whether this agent should log conversation queries.
    MatchMode 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.
    SupportedLanguageCodes List<string>
    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.
    TimeZone string
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.


    ApiVersion 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.
    AvatarUri 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.
    AvatarUriBackend string
    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.
    ClassificationThreshold 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.
    DefaultLanguageCode string
    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.
    DisplayName string
    The name of this agent.
    EnableLogging bool
    Determines whether this agent should log conversation queries.
    MatchMode 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.
    SupportedLanguageCodes []string
    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.
    TimeZone string
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.


    apiVersion 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.
    avatarUri 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.
    avatarUriBackend String
    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.
    classificationThreshold 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.
    defaultLanguageCode String
    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.
    displayName String
    The name of this agent.
    enableLogging Boolean
    Determines whether this agent should log conversation queries.
    matchMode 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.
    supportedLanguageCodes List<String>
    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.
    timeZone String
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.


    apiVersion 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.
    avatarUri 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.
    avatarUriBackend string
    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.
    classificationThreshold 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.
    defaultLanguageCode string
    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.
    displayName string
    The name of this agent.
    enableLogging boolean
    Determines whether this agent should log conversation queries.
    matchMode 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.
    supportedLanguageCodes string[]
    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.
    timeZone 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_backend str
    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_code str
    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_codes Sequence[str]
    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.


    apiVersion 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.
    avatarUri 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.
    avatarUriBackend String
    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.
    classificationThreshold 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.
    defaultLanguageCode String
    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.
    displayName String
    The name of this agent.
    enableLogging Boolean
    Determines whether this agent should log conversation queries.
    matchMode 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.
    supportedLanguageCodes List<String>
    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.
    timeZone 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:

    • {{project}}

    When using the pulumi import command, Agent can be imported using one of the formats above. For example:

    $ pulumi import gcp:diagflow/agent:Agent default {{project}}
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.
    gcp logo
    Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi