CxVersion
You can create multiple versions of your agent flows and deploy them to separate serving environments. When you edit a flow, you are editing a draft flow. At any point, you can save a draft flow as a flow version. A flow version is an immutable snapshot of your flow data and associated agent data like intents, entities, webhooks, pages, route groups, etc.
To get more information about Version, see:
- API documentation
- How-to Guides
Example Usage
Dialogflowcx Version Full
using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var agent = new Gcp.Diagflow.CxAgent("agent", new()
{
DisplayName = "dialogflowcx-agent",
Location = "global",
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",
EnableStackdriverLogging = true,
EnableSpellCorrection = true,
SpeechToTextSettings = new Gcp.Diagflow.Inputs.CxAgentSpeechToTextSettingsArgs
{
EnableSpeechAdaptation = true,
},
});
var version1 = new Gcp.Diagflow.CxVersion("version1", new()
{
Parent = agent.StartFlow,
DisplayName = "1.0.0",
Description = "version 1.0.0",
});
});
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 {
agent, err := diagflow.NewCxAgent(ctx, "agent", &diagflow.CxAgentArgs{
DisplayName: pulumi.String("dialogflowcx-agent"),
Location: pulumi.String("global"),
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"),
EnableStackdriverLogging: pulumi.Bool(true),
EnableSpellCorrection: pulumi.Bool(true),
SpeechToTextSettings: &diagflow.CxAgentSpeechToTextSettingsArgs{
EnableSpeechAdaptation: pulumi.Bool(true),
},
})
if err != nil {
return err
}
_, err = diagflow.NewCxVersion(ctx, "version1", &diagflow.CxVersionArgs{
Parent: agent.StartFlow,
DisplayName: pulumi.String("1.0.0"),
Description: pulumi.String("version 1.0.0"),
})
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.CxAgent;
import com.pulumi.gcp.diagflow.CxAgentArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentSpeechToTextSettingsArgs;
import com.pulumi.gcp.diagflow.CxVersion;
import com.pulumi.gcp.diagflow.CxVersionArgs;
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 agent = new CxAgent("agent", CxAgentArgs.builder()
.displayName("dialogflowcx-agent")
.location("global")
.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")
.enableStackdriverLogging(true)
.enableSpellCorrection(true)
.speechToTextSettings(CxAgentSpeechToTextSettingsArgs.builder()
.enableSpeechAdaptation(true)
.build())
.build());
var version1 = new CxVersion("version1", CxVersionArgs.builder()
.parent(agent.startFlow())
.displayName("1.0.0")
.description("version 1.0.0")
.build());
}
}
import pulumi
import pulumi_gcp as gcp
agent = gcp.diagflow.CxAgent("agent",
display_name="dialogflowcx-agent",
location="global",
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_stackdriver_logging=True,
enable_spell_correction=True,
speech_to_text_settings=gcp.diagflow.CxAgentSpeechToTextSettingsArgs(
enable_speech_adaptation=True,
))
version1 = gcp.diagflow.CxVersion("version1",
parent=agent.start_flow,
display_name="1.0.0",
description="version 1.0.0")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const agent = new gcp.diagflow.CxAgent("agent", {
displayName: "dialogflowcx-agent",
location: "global",
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",
enableStackdriverLogging: true,
enableSpellCorrection: true,
speechToTextSettings: {
enableSpeechAdaptation: true,
},
});
const version1 = new gcp.diagflow.CxVersion("version1", {
parent: agent.startFlow,
displayName: "1.0.0",
description: "version 1.0.0",
});
resources:
agent:
type: gcp:diagflow:CxAgent
properties:
displayName: dialogflowcx-agent
location: global
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
enableStackdriverLogging: true
enableSpellCorrection: true
speechToTextSettings:
enableSpeechAdaptation: true
version1:
type: gcp:diagflow:CxVersion
properties:
parent: ${agent.startFlow}
displayName: 1.0.0
description: version 1.0.0
Create CxVersion Resource
new CxVersion(name: string, args: CxVersionArgs, opts?: CustomResourceOptions);@overload
def CxVersion(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
parent: Optional[str] = None)
@overload
def CxVersion(resource_name: str,
args: CxVersionArgs,
opts: Optional[ResourceOptions] = None)func NewCxVersion(ctx *Context, name string, args CxVersionArgs, opts ...ResourceOption) (*CxVersion, error)public CxVersion(string name, CxVersionArgs args, CustomResourceOptions? opts = null)
public CxVersion(String name, CxVersionArgs args)
public CxVersion(String name, CxVersionArgs args, CustomResourceOptions options)
type: gcp:diagflow:CxVersion
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CxVersionArgs
- 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 CxVersionArgs
- 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 CxVersionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CxVersionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CxVersionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
CxVersion 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 CxVersion resource accepts the following input properties:
- Display
Name string The human-readable name of the version. Limit of 64 characters.
- Description string
The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected.
- Parent string
The Flow to create an Version for. Format: projects//locations//agents//flows/.
- Display
Name string The human-readable name of the version. Limit of 64 characters.
- Description string
The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected.
- Parent string
The Flow to create an Version for. Format: projects//locations//agents//flows/.
- display
Name String The human-readable name of the version. Limit of 64 characters.
- description String
The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected.
- parent String
The Flow to create an Version for. Format: projects//locations//agents//flows/.
- display
Name string The human-readable name of the version. Limit of 64 characters.
- description string
The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected.
- parent string
The Flow to create an Version for. Format: projects//locations//agents//flows/.
- display_
name str The human-readable name of the version. Limit of 64 characters.
- description str
The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected.
- parent str
The Flow to create an Version for. Format: projects//locations//agents//flows/.
- display
Name String The human-readable name of the version. Limit of 64 characters.
- description String
The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected.
- parent String
The Flow to create an Version for. Format: projects//locations//agents//flows/.
Outputs
All input properties are implicitly available as output properties. Additionally, the CxVersion resource produces the following output properties:
- Create
Time string A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
- Id string
The provider-assigned unique ID for this managed resource.
- Name string
Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.
- Nlu
Settings List<CxVersion Nlu Setting> The NLU settings of the flow at version creation.
- State string
The state of this version. * RUNNING: Version is not ready to serve (e.g. training is running). * SUCCEEDED: Training has succeeded and this version is ready to serve. * FAILED: Version training failed.
- Create
Time string A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
- Id string
The provider-assigned unique ID for this managed resource.
- Name string
Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.
- Nlu
Settings []CxVersion Nlu Setting The NLU settings of the flow at version creation.
- State string
The state of this version. * RUNNING: Version is not ready to serve (e.g. training is running). * SUCCEEDED: Training has succeeded and this version is ready to serve. * FAILED: Version training failed.
- create
Time String A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
- id String
The provider-assigned unique ID for this managed resource.
- name String
Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.
- nlu
Settings List<CxVersion Nlu Setting> The NLU settings of the flow at version creation.
- state String
The state of this version. * RUNNING: Version is not ready to serve (e.g. training is running). * SUCCEEDED: Training has succeeded and this version is ready to serve. * FAILED: Version training failed.
- create
Time string A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
- id string
The provider-assigned unique ID for this managed resource.
- name string
Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.
- nlu
Settings CxVersion Nlu Setting[] The NLU settings of the flow at version creation.
- state string
The state of this version. * RUNNING: Version is not ready to serve (e.g. training is running). * SUCCEEDED: Training has succeeded and this version is ready to serve. * FAILED: Version training failed.
- create_
time str A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
- id str
The provider-assigned unique ID for this managed resource.
- name str
Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.
- nlu_
settings Sequence[CxVersion Nlu Setting] The NLU settings of the flow at version creation.
- state str
The state of this version. * RUNNING: Version is not ready to serve (e.g. training is running). * SUCCEEDED: Training has succeeded and this version is ready to serve. * FAILED: Version training failed.
- create
Time String A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
- id String
The provider-assigned unique ID for this managed resource.
- name String
Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.
- nlu
Settings List<Property Map> The NLU settings of the flow at version creation.
- state String
The state of this version. * RUNNING: Version is not ready to serve (e.g. training is running). * SUCCEEDED: Training has succeeded and this version is ready to serve. * FAILED: Version training failed.
Look up Existing CxVersion Resource
Get an existing CxVersion 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?: CxVersionState, opts?: CustomResourceOptions): CxVersion@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
create_time: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
name: Optional[str] = None,
nlu_settings: Optional[Sequence[CxVersionNluSettingArgs]] = None,
parent: Optional[str] = None,
state: Optional[str] = None) -> CxVersionfunc GetCxVersion(ctx *Context, name string, id IDInput, state *CxVersionState, opts ...ResourceOption) (*CxVersion, error)public static CxVersion Get(string name, Input<string> id, CxVersionState? state, CustomResourceOptions? opts = null)public static CxVersion get(String name, Output<String> id, CxVersionState 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.
- Create
Time string A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
- Description string
The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected.
- Display
Name string The human-readable name of the version. Limit of 64 characters.
- Name string
Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.
- Nlu
Settings List<CxVersion Nlu Setting Args> The NLU settings of the flow at version creation.
- Parent string
The Flow to create an Version for. Format: projects//locations//agents//flows/.
- State string
The state of this version. * RUNNING: Version is not ready to serve (e.g. training is running). * SUCCEEDED: Training has succeeded and this version is ready to serve. * FAILED: Version training failed.
- Create
Time string A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
- Description string
The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected.
- Display
Name string The human-readable name of the version. Limit of 64 characters.
- Name string
Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.
- Nlu
Settings []CxVersion Nlu Setting Args The NLU settings of the flow at version creation.
- Parent string
The Flow to create an Version for. Format: projects//locations//agents//flows/.
- State string
The state of this version. * RUNNING: Version is not ready to serve (e.g. training is running). * SUCCEEDED: Training has succeeded and this version is ready to serve. * FAILED: Version training failed.
- create
Time String A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
- description String
The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected.
- display
Name String The human-readable name of the version. Limit of 64 characters.
- name String
Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.
- nlu
Settings List<CxVersion Nlu Setting Args> The NLU settings of the flow at version creation.
- parent String
The Flow to create an Version for. Format: projects//locations//agents//flows/.
- state String
The state of this version. * RUNNING: Version is not ready to serve (e.g. training is running). * SUCCEEDED: Training has succeeded and this version is ready to serve. * FAILED: Version training failed.
- create
Time string A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
- description string
The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected.
- display
Name string The human-readable name of the version. Limit of 64 characters.
- name string
Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.
- nlu
Settings CxVersion Nlu Setting Args[] The NLU settings of the flow at version creation.
- parent string
The Flow to create an Version for. Format: projects//locations//agents//flows/.
- state string
The state of this version. * RUNNING: Version is not ready to serve (e.g. training is running). * SUCCEEDED: Training has succeeded and this version is ready to serve. * FAILED: Version training failed.
- create_
time str A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
- description str
The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected.
- display_
name str The human-readable name of the version. Limit of 64 characters.
- name str
Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.
- nlu_
settings Sequence[CxVersion Nlu Setting Args] The NLU settings of the flow at version creation.
- parent str
The Flow to create an Version for. Format: projects//locations//agents//flows/.
- state str
The state of this version. * RUNNING: Version is not ready to serve (e.g. training is running). * SUCCEEDED: Training has succeeded and this version is ready to serve. * FAILED: Version training failed.
- create
Time String A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
- description String
The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected.
- display
Name String The human-readable name of the version. Limit of 64 characters.
- name String
Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.
- nlu
Settings List<Property Map> The NLU settings of the flow at version creation.
- parent String
The Flow to create an Version for. Format: projects//locations//agents//flows/.
- state String
The state of this version. * RUNNING: Version is not ready to serve (e.g. training is running). * SUCCEEDED: Training has succeeded and this version is ready to serve. * FAILED: Version training failed.
Supporting Types
CxVersionNluSetting
- Classification
Threshold double - Model
Training stringMode - Model
Type string
- Classification
Threshold float64 - Model
Training stringMode - Model
Type string
- classification
Threshold Double - model
Training StringMode - model
Type String
- classification
Threshold number - model
Training stringMode - model
Type string
- classification_
threshold float - model_
training_ strmode - model_
type str
- classification
Threshold Number - model
Training StringMode - model
Type String
Import
Version can be imported using any of these accepted formats
$ pulumi import gcp:diagflow/cxVersion:CxVersion default {{parent}}/versions/{{name}}
$ pulumi import gcp:diagflow/cxVersion:CxVersion default {{parent}}/{{name}}
Package Details
- Repository
- https://github.com/pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-betaTerraform Provider.