Console
    Start free

    Google Cloud Ces V1 Client - Class Conversation (0.2.0)

    Reference documentation and code samples for the Google Cloud Ces V1 Client class Conversation.

    A conversation represents an interaction between an end user and the CES app.

    Generated from protobuf message google.cloud.ces.v1.Conversation

    Namespace

    Google \ Cloud \ Ces \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

    Identifier. The unique identifier of the conversation. Format: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}

    ↳ start_time
    Google\Protobuf\Timestamp

    Output only. Timestamp when the conversation was created.

    ↳ end_time
    Google\Protobuf\Timestamp

    Output only. Timestamp when the conversation was completed.

    ↳ turns
    array< Conversation\Turn >

    Required. The turns in the conversation.

    ↳ turn_count
    int

    Output only. The number of turns in the conversation.

    ↳ channel_type
    int

    DEPRECATED. Please use input_types instead.

    ↳ source
    int

    Output only. Indicate the source of the conversation.

    ↳ input_types
    int[]

    Output only. The input types of the conversation.

    ↳ entry_agent
    string

    Output only. The agent that initially handles the conversation. If not specified, the conversation is handled by the root agent. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

    ↳ deployment
    string

    Output only. The deployment of the app used for processing the conversation. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

    ↳ app_version
    string

    Output only. The version of the app used for processing the conversation. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

    ↳ language_code
    string

    Output only. The language code of the conversation.

    ↳ messages
    array< Message >

    Deprecated. Use turns instead.

    getName

    Identifier. The unique identifier of the conversation.

    Format: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}

    Returns
    Type
    Description
    string

    setName

    Identifier. The unique identifier of the conversation.

    Format: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getStartTime

    Output only. Timestamp when the conversation was created.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasStartTime

    clearStartTime

    setStartTime

    Output only. Timestamp when the conversation was created.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getEndTime

    Output only. Timestamp when the conversation was completed.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasEndTime

    clearEndTime

    setEndTime

    Output only. Timestamp when the conversation was completed.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getTurns

    Required. The turns in the conversation.

    Returns
    Type
    Description
    Google\Protobuf\RepeatedField < Conversation\Turn >

    setTurns

    Required. The turns in the conversation.

    Parameter
    Name
    Description
    var
    array< Conversation\Turn >
    Returns
    Type
    Description
    $this

    getTurnCount

    Output only. The number of turns in the conversation.

    Returns
    Type
    Description
    int

    setTurnCount

    Output only. The number of turns in the conversation.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getChannelType

    DEPRECATED. Please use input_types instead.

    Returns
    Type
    Description
    int
    Enum of type ChannelType .

    setChannelType

    DEPRECATED. Please use input_types instead.

    Parameter
    Name
    Description
    var
    int

    Enum of type ChannelType .

    Returns
    Type
    Description
    $this

    getSource

    Output only. Indicate the source of the conversation.

    Returns
    Type
    Description
    int
    Enum of type Source .

    setSource

    Output only. Indicate the source of the conversation.

    Parameter
    Name
    Description
    var
    int

    Enum of type Source .

    Returns
    Type
    Description
    $this

    getInputTypes

    Output only. The input types of the conversation.

    Returns
    Type
    Description
    Google\Protobuf\RepeatedField < int >

    setInputTypes

    Output only. The input types of the conversation.

    Parameter
    Name
    Description
    var
    int[]
    Returns
    Type
    Description
    $this

    getEntryAgent

    Output only. The agent that initially handles the conversation. If not specified, the conversation is handled by the root agent. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

    Returns
    Type
    Description
    string

    setEntryAgent

    Output only. The agent that initially handles the conversation. If not specified, the conversation is handled by the root agent. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDeployment

    Output only. The deployment of the app used for processing the conversation. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

    Returns
    Type
    Description
    string

    setDeployment

    Output only. The deployment of the app used for processing the conversation. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getAppVersion

    Output only. The version of the app used for processing the conversation.

    Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

    Returns
    Type
    Description
    string

    setAppVersion

    Output only. The version of the app used for processing the conversation.

    Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getLanguageCode

    Output only. The language code of the conversation.

    Returns
    Type
    Description
    string

    setLanguageCode

    Output only. The language code of the conversation.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getMessages

    Deprecated. Use turns instead.

    Returns
    Type
    Description
    Google\Protobuf\RepeatedField < Message >

    setMessages

    Deprecated. Use turns instead.

    Parameter
    Name
    Description
    var
    array< Message >
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: