Google Cloud Dialogflow v2beta1 API - Class DetectIntentRequest (1.0.0-beta15)

public sealed class DetectIntentRequest : IMessage<DetectIntentRequest>, IEquatable<DetectIntentRequest>, IDeepCloneable<DetectIntentRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Dialogflow v2beta1 API class DetectIntentRequest.

The request to detect user's intent.

Inheritance

object > DetectIntentRequest

Namespace

Google.Cloud.Dialogflow.V2Beta1

Assembly

Google.Cloud.Dialogflow.V2Beta1.dll

Constructors

DetectIntentRequest()

public DetectIntentRequest()

DetectIntentRequest(DetectIntentRequest)

public DetectIntentRequest(DetectIntentRequest other)
Parameter
NameDescription
otherDetectIntentRequest

Properties

InputAudio

public ByteString InputAudio { get; set; }

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.

Property Value
TypeDescription
ByteString

OutputAudioConfig

public OutputAudioConfig OutputAudioConfig { get; set; }

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.

Property Value
TypeDescription
OutputAudioConfig

OutputAudioConfigMask

public FieldMask OutputAudioConfigMask { get; set; }

Mask for [output_audio_config][google.cloud.dialogflow.v2beta1.DetectIntentRequest.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][google.cloud.dialogflow.v2beta1.DetectIntentRequest.output_audio_config] replaces the agent-level config in its entirety.

Property Value
TypeDescription
FieldMask

QueryInput

public QueryInput QueryInput { get; set; }

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.

Property Value
TypeDescription
QueryInput

QueryParams

public QueryParameters QueryParams { get; set; }

The parameters of this query.

Property Value
TypeDescription
QueryParameters

Session

public string Session { get; set; }

Required. The name of the session this query is sent to. Supported formats:

  • `projects/<Project ID>/agent/sessions/<Session ID>,
  • projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>,
  • projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,
  • projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,

If Location ID is not specified we assume default 'us' location. 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.

Property Value
TypeDescription
string

SessionAsSessionName

public SessionName SessionAsSessionName { get; set; }

SessionName-typed view over the Session resource name property.

Property Value
TypeDescription
SessionName