pulumi-gcp-kotlin/com.pulumi.gcp.diagflow.kotlin/CxAgent

CxAgent

class CxAgent : KotlinCustomResource

Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. To get more information about Agent, see:

Example Usage

Dialogflowcx Agent Full

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.diagflow.CxAgent;
import com.pulumi.gcp.diagflow.CxAgentArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentSpeechToTextSettingsArgs;
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 CxAgent("fullAgent", CxAgentArgs.builder()
            .avatarUri("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png")
            .defaultLanguageCode("en")
            .description("Example description.")
            .displayName("dialogflowcx-agent")
            .enableSpellCorrection(true)
            .enableStackdriverLogging(true)
            .location("global")
            .speechToTextSettings(CxAgentSpeechToTextSettingsArgs.builder()
                .enableSpeechAdaptation(true)
                .build())
            .supportedLanguageCodes(
                "fr",
                "de",
                "es")
            .timeZone("America/New_York")
            .build());
    }
}
Content copied to clipboard

Import

Agent can be imported using any of these accepted formats

$ pulumi import gcp:diagflow/cxAgent:CxAgent default projects/{{project}}/locations/{{location}}/agents/{{name}}
Content copied to clipboard
$ pulumi import gcp:diagflow/cxAgent:CxAgent default {{project}}/{{location}}/{{name}}
Content copied to clipboard
$ pulumi import gcp:diagflow/cxAgent:CxAgent default {{location}}/{{name}}
Content copied to clipboard

Properties

Link copied to clipboard
val avatarUri: Output<String>?

The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

Link copied to clipboard
val defaultLanguageCode: Output<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.

Link copied to clipboard
val description: Output<String>?

The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.

Link copied to clipboard
val displayName: Output<String>

The human-readable name of the agent, unique within the location.

Link copied to clipboard
val enableSpellCorrection: Output<Boolean>?

Indicates if automatic spell correction is enabled in detect intent requests.

Link copied to clipboard
val enableStackdriverLogging: Output<Boolean>?

Determines whether this agent should log conversation queries.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val location: Output<String>

The name of the location this agent is located in.

Link copied to clipboard
val name: Output<String>

The unique identifier of the agent.

Link copied to clipboard
val project: Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val securitySettings: Output<String>?

Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.

Link copied to clipboard
val speechToTextSettings: Output<CxAgentSpeechToTextSettings>?

Settings related to speech recognition. Structure is documented below.

Link copied to clipboard
val startFlow: Output<String>

Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.

Link copied to clipboard
val supportedLanguageCodes: Output<List<String>>?

The list of all languages supported by this agent (except for the default_language_code).

Link copied to clipboard
val timeZone: Output<String>

The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.

Link copied to clipboard
val urn: Output<String>