1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v2
  6. Conversation

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.dialogflow/v2.Conversation

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Creates a new conversation. Conversations are auto-completed after 24 hours. Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage. For Automated Agent Stage, there will be a dialogflow agent responding to user queries. For Assist Stage, there’s no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation. If Conversation.conversation_profile is configured for a dialogflow agent, conversation will start from Automated Agent Stage, otherwise, it will start from Assist Stage. And during Automated Agent Stage, once an Intent with Intent.live_agent_handoff is triggered, conversation will transfer to Assist Stage. Auto-naming is currently not supported for this resource. Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

    Create Conversation Resource

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

    Constructor syntax

    new Conversation(name: string, args: ConversationArgs, opts?: CustomResourceOptions);
    @overload
    def Conversation(resource_name: str,
                     args: ConversationArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def Conversation(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     conversation_profile: Optional[str] = None,
                     conversation_id: Optional[str] = None,
                     conversation_stage: Optional[ConversationConversationStage] = None,
                     location: Optional[str] = None,
                     project: Optional[str] = None)
    func NewConversation(ctx *Context, name string, args ConversationArgs, opts ...ResourceOption) (*Conversation, error)
    public Conversation(string name, ConversationArgs args, CustomResourceOptions? opts = null)
    public Conversation(String name, ConversationArgs args)
    public Conversation(String name, ConversationArgs args, CustomResourceOptions options)
    
    type: google-native:dialogflow/v2:Conversation
    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 ConversationArgs
    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 ConversationArgs
    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 ConversationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConversationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConversationArgs
    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 google_nativeConversationResource = new GoogleNative.Dialogflow.V2.Conversation("google-nativeConversationResource", new()
    {
        ConversationProfile = "string",
        ConversationId = "string",
        ConversationStage = GoogleNative.Dialogflow.V2.ConversationConversationStage.ConversationStageUnspecified,
        Location = "string",
        Project = "string",
    });
    
    example, err := dialogflow.NewConversation(ctx, "google-nativeConversationResource", &dialogflow.ConversationArgs{
    ConversationProfile: pulumi.String("string"),
    ConversationId: pulumi.String("string"),
    ConversationStage: dialogflow.ConversationConversationStageConversationStageUnspecified,
    Location: pulumi.String("string"),
    Project: pulumi.String("string"),
    })
    
    var google_nativeConversationResource = new Conversation("google-nativeConversationResource", ConversationArgs.builder()
        .conversationProfile("string")
        .conversationId("string")
        .conversationStage("CONVERSATION_STAGE_UNSPECIFIED")
        .location("string")
        .project("string")
        .build());
    
    google_native_conversation_resource = google_native.dialogflow.v2.Conversation("google-nativeConversationResource",
        conversation_profile="string",
        conversation_id="string",
        conversation_stage=google_native.dialogflow.v2.ConversationConversationStage.CONVERSATION_STAGE_UNSPECIFIED,
        location="string",
        project="string")
    
    const google_nativeConversationResource = new google_native.dialogflow.v2.Conversation("google-nativeConversationResource", {
        conversationProfile: "string",
        conversationId: "string",
        conversationStage: google_native.dialogflow.v2.ConversationConversationStage.ConversationStageUnspecified,
        location: "string",
        project: "string",
    });
    
    type: google-native:dialogflow/v2:Conversation
    properties:
        conversationId: string
        conversationProfile: string
        conversationStage: CONVERSATION_STAGE_UNSPECIFIED
        location: string
        project: string
    

    Conversation 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 Conversation resource accepts the following input properties:

    ConversationProfile string
    The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: projects//locations//conversationProfiles/.
    ConversationId string
    Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula a-zA-Z* with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.
    ConversationStage Pulumi.GoogleNative.Dialogflow.V2.ConversationConversationStage
    The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.
    Location string
    Project string
    ConversationProfile string
    The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: projects//locations//conversationProfiles/.
    ConversationId string
    Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula a-zA-Z* with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.
    ConversationStage ConversationConversationStage
    The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.
    Location string
    Project string
    conversationProfile String
    The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: projects//locations//conversationProfiles/.
    conversationId String
    Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula a-zA-Z* with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.
    conversationStage ConversationConversationStage
    The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.
    location String
    project String
    conversationProfile string
    The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: projects//locations//conversationProfiles/.
    conversationId string
    Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula a-zA-Z* with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.
    conversationStage ConversationConversationStage
    The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.
    location string
    project string
    conversation_profile str
    The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: projects//locations//conversationProfiles/.
    conversation_id str
    Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula a-zA-Z* with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.
    conversation_stage ConversationConversationStage
    The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.
    location str
    project str
    conversationProfile String
    The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: projects//locations//conversationProfiles/.
    conversationId String
    Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula a-zA-Z* with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.
    conversationStage "CONVERSATION_STAGE_UNSPECIFIED" | "VIRTUAL_AGENT_STAGE" | "HUMAN_ASSIST_STAGE"
    The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.
    location String
    project String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Conversation resource produces the following output properties:

    EndTime string
    The time the conversation was finished.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleState string
    The current state of the Conversation.
    Name string
    The unique identifier of this conversation. Format: projects//locations//conversations/.
    PhoneNumber Pulumi.GoogleNative.Dialogflow.V2.Outputs.GoogleCloudDialogflowV2ConversationPhoneNumberResponse
    It will not be empty if the conversation is to be connected over telephony.
    StartTime string
    The time the conversation was started.
    EndTime string
    The time the conversation was finished.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleState string
    The current state of the Conversation.
    Name string
    The unique identifier of this conversation. Format: projects//locations//conversations/.
    PhoneNumber GoogleCloudDialogflowV2ConversationPhoneNumberResponse
    It will not be empty if the conversation is to be connected over telephony.
    StartTime string
    The time the conversation was started.
    endTime String
    The time the conversation was finished.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleState String
    The current state of the Conversation.
    name String
    The unique identifier of this conversation. Format: projects//locations//conversations/.
    phoneNumber GoogleCloudDialogflowV2ConversationPhoneNumberResponse
    It will not be empty if the conversation is to be connected over telephony.
    startTime String
    The time the conversation was started.
    endTime string
    The time the conversation was finished.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleState string
    The current state of the Conversation.
    name string
    The unique identifier of this conversation. Format: projects//locations//conversations/.
    phoneNumber GoogleCloudDialogflowV2ConversationPhoneNumberResponse
    It will not be empty if the conversation is to be connected over telephony.
    startTime string
    The time the conversation was started.
    end_time str
    The time the conversation was finished.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_state str
    The current state of the Conversation.
    name str
    The unique identifier of this conversation. Format: projects//locations//conversations/.
    phone_number GoogleCloudDialogflowV2ConversationPhoneNumberResponse
    It will not be empty if the conversation is to be connected over telephony.
    start_time str
    The time the conversation was started.
    endTime String
    The time the conversation was finished.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleState String
    The current state of the Conversation.
    name String
    The unique identifier of this conversation. Format: projects//locations//conversations/.
    phoneNumber Property Map
    It will not be empty if the conversation is to be connected over telephony.
    startTime String
    The time the conversation was started.

    Supporting Types

    ConversationConversationStage, ConversationConversationStageArgs

    ConversationStageUnspecified
    CONVERSATION_STAGE_UNSPECIFIEDUnknown. Should never be used after a conversation is successfully created.
    VirtualAgentStage
    VIRTUAL_AGENT_STAGEThe conversation should return virtual agent responses into the conversation.
    HumanAssistStage
    HUMAN_ASSIST_STAGEThe conversation should not provide responses, just listen and provide suggestions.
    ConversationConversationStageConversationStageUnspecified
    CONVERSATION_STAGE_UNSPECIFIEDUnknown. Should never be used after a conversation is successfully created.
    ConversationConversationStageVirtualAgentStage
    VIRTUAL_AGENT_STAGEThe conversation should return virtual agent responses into the conversation.
    ConversationConversationStageHumanAssistStage
    HUMAN_ASSIST_STAGEThe conversation should not provide responses, just listen and provide suggestions.
    ConversationStageUnspecified
    CONVERSATION_STAGE_UNSPECIFIEDUnknown. Should never be used after a conversation is successfully created.
    VirtualAgentStage
    VIRTUAL_AGENT_STAGEThe conversation should return virtual agent responses into the conversation.
    HumanAssistStage
    HUMAN_ASSIST_STAGEThe conversation should not provide responses, just listen and provide suggestions.
    ConversationStageUnspecified
    CONVERSATION_STAGE_UNSPECIFIEDUnknown. Should never be used after a conversation is successfully created.
    VirtualAgentStage
    VIRTUAL_AGENT_STAGEThe conversation should return virtual agent responses into the conversation.
    HumanAssistStage
    HUMAN_ASSIST_STAGEThe conversation should not provide responses, just listen and provide suggestions.
    CONVERSATION_STAGE_UNSPECIFIED
    CONVERSATION_STAGE_UNSPECIFIEDUnknown. Should never be used after a conversation is successfully created.
    VIRTUAL_AGENT_STAGE
    VIRTUAL_AGENT_STAGEThe conversation should return virtual agent responses into the conversation.
    HUMAN_ASSIST_STAGE
    HUMAN_ASSIST_STAGEThe conversation should not provide responses, just listen and provide suggestions.
    "CONVERSATION_STAGE_UNSPECIFIED"
    CONVERSATION_STAGE_UNSPECIFIEDUnknown. Should never be used after a conversation is successfully created.
    "VIRTUAL_AGENT_STAGE"
    VIRTUAL_AGENT_STAGEThe conversation should return virtual agent responses into the conversation.
    "HUMAN_ASSIST_STAGE"
    HUMAN_ASSIST_STAGEThe conversation should not provide responses, just listen and provide suggestions.

    GoogleCloudDialogflowV2ConversationPhoneNumberResponse, GoogleCloudDialogflowV2ConversationPhoneNumberResponseArgs

    PhoneNumber string
    The phone number to connect to this conversation.
    PhoneNumber string
    The phone number to connect to this conversation.
    phoneNumber String
    The phone number to connect to this conversation.
    phoneNumber string
    The phone number to connect to this conversation.
    phone_number str
    The phone number to connect to this conversation.
    phoneNumber String
    The phone number to connect to this conversation.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi