Console
    Contact Us Start free

    Google Cloud Dialogflow V2 Client - Class DetectIntentRequest (2.1.2)

    Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class DetectIntentRequest.

    The request to detect user's intent.

    Generated from protobuf message google.cloud.dialogflow.v2.DetectIntentRequest

    Namespace

    Google \ Cloud \ Dialogflow \ V2

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ session
    string

    Required. The name of the session this query is sent to. Format: projects/<Project ID>/agent/sessions/<Session ID> , or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID> . If Environment ID is not specified, we assume default 'draft' environment ( Environment ID might be referred to as environment name at some places). If User ID is not specified, we are using "-". It's up to the API caller to choose an appropriate Session ID and User Id . They can be a random number or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters. For more information, see the API interactions guide . Note: Always use agent versions for production traffic. See Versions and environments .

    ↳ query_params
    QueryParameters

    The parameters of this query.

    ↳ query_input
    QueryInput

    Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger.

    ↳ output_audio_config
    OutputAudioConfig

    Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.

    ↳ output_audio_config_mask
    Google\Protobuf\FieldMask

    Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level. If unspecified or empty, output_audio_config replaces the agent-level config in its entirety.

    ↳ input_audio
    string

    The natural language speech audio to be processed. This field should be populated iff query_input is set to an input audio config. A single request can contain up to 1 minute of speech audio data.

    getSession

    Required. The name of the session this query is sent to. Format: projects/<Project ID>/agent/sessions/<Session ID> , or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID> . If Environment ID is not specified, we assume default 'draft' environment ( Environment ID might be referred to as environment name at some places). If User ID is not specified, we are using "-". It's up to the API caller to choose an appropriate Session ID and User Id . They can be a random number or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters.

    For more information, see the API interactions guide . Note: Always use agent versions for production traffic. See Versions and environments .

    Returns
    Type
    Description
    string

    setSession

    Required. The name of the session this query is sent to. Format: projects/<Project ID>/agent/sessions/<Session ID> , or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID> . If Environment ID is not specified, we assume default 'draft' environment ( Environment ID might be referred to as environment name at some places). If User ID is not specified, we are using "-". It's up to the API caller to choose an appropriate Session ID and User Id . They can be a random number or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters.

    For more information, see the API interactions guide . Note: Always use agent versions for production traffic. See Versions and environments .

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getQueryParams

    The parameters of this query.

    Returns
    Type
    Description
    QueryParameters |null

    hasQueryParams

    clearQueryParams

    setQueryParams

    The parameters of this query.

    Parameter
    Name
    Description
    var
    QueryParameters
    Returns
    Type
    Description
    $this

    getQueryInput

    Required. The input specification. It can be set to:

    1. an audio config which instructs the speech recognizer how to process the speech audio,
    2. a conversational query in the form of text, or
    3. an event that specifies which intent to trigger.
    Returns
    Type
    Description
    QueryInput |null

    hasQueryInput

    clearQueryInput

    setQueryInput

    Required. The input specification. It can be set to:

    1. an audio config which instructs the speech recognizer how to process the speech audio,
    2. a conversational query in the form of text, or
    3. an event that specifies which intent to trigger.
    Parameter
    Name
    Description
    var
    QueryInput
    Returns
    Type
    Description
    $this

    getOutputAudioConfig

    Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.

    Returns
    Type
    Description
    OutputAudioConfig |null

    hasOutputAudioConfig

    clearOutputAudioConfig

    setOutputAudioConfig

    Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.

    Parameter
    Name
    Description
    var
    OutputAudioConfig
    Returns
    Type
    Description
    $this

    getOutputAudioConfigMask

    Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level.

    If unspecified or empty, output_audio_config replaces the agent-level config in its entirety.

    Returns
    Type
    Description
    Google\Protobuf\FieldMask |null

    hasOutputAudioConfigMask

    clearOutputAudioConfigMask

    setOutputAudioConfigMask

    Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level.

    If unspecified or empty, output_audio_config replaces the agent-level config in its entirety.

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

    getInputAudio

    The natural language speech audio to be processed. This field should be populated iff query_input is set to an input audio config.

    A single request can contain up to 1 minute of speech audio data.

    Returns
    Type
    Description
    string

    setInputAudio

    The natural language speech audio to be processed. This field should be populated iff query_input is set to an input audio config.

    A single request can contain up to 1 minute of speech audio data.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    static::build

    Parameters
    Name
    Description
    session
    string

    Required. The name of the session this query is sent to. Format: projects/<Project ID>/agent/sessions/<Session ID> , or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID> . If Environment ID is not specified, we assume default 'draft' environment ( Environment ID might be referred to as environment name at some places). If User ID is not specified, we are using "-". It's up to the API caller to choose an appropriate Session ID and User Id . They can be a random number or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters.

    For more information, see the API interactions guide .

    Note: Always use agent versions for production traffic. See Versions and environments . Please see SessionsClient::sessionName() for help formatting this field.

    queryInput
    QueryInput

    Required. The input specification. It can be set to:

    1. an audio config which instructs the speech recognizer how to process the speech audio,

    2. a conversational query in the form of text, or

    3. an event that specifies which intent to trigger.

    Returns
    Type
    Description
    DetectIntentRequest
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: