AT&T API Platform SDK for Microsoft®  2.3.3
Wrapper classes that allow developers to build robust applications using .NET
 All Classes Namespaces Functions Enumerations Properties
ATT_MSSDK.Speechv3.XArgs Class Reference

XArgs structure. The X-Arg header is a meta parameter that can be used to define multiple parameter name/value pairs. More...

List of all members.

Public Member Functions

 XArgs ()
 Initializes a new instance of the XArgs class.
override string ToString ()
 Returns the string format of the properties.

Properties

string ClientApp [get, set]
 Gets or sets the ClientApp. The application name.
string ClientVersion [get, set]
 Gets or sets the ClientVersion. A version id for the app.
string ClientScreen [get, set]
 Gets or sets the ClientScreen. A string representing the application's focus UI screen/widget for this request.
string ClientSdk [get, set]
 Gets or sets the ClientSdk. The syntax for the parameter is library-platform-version.
string DeviceType [get, set]
 Gets or sets the DeviceType. The device name, preferably from a standard API on the device itself (e.g. "iPhone4,1", "SGHT999", "SAMSUNG-SGH-I897", etc.)
string DeviceOs [get, set]
 Gets or sets the DeviceOs. The version string of the OS for the device type, preferably from a standard API on the device or autofilled by an SDK.
string DeviceTime [get, set]
 Gets or sets the DeviceTime. The local device time at the time of the request. Format "YYYY-MMDD< space>HH:MM:SS<space>TZ".
bool ShowWordTokens [get, set]
 Gets or sets the value of ShowWordTokens. Control output detail. If the packages have formatting applied to the ResultText field, this flag generates additional detail to show the named entities and the words from which those entities were derived. If no formatting is applied the output still shows the derivation from the spoken Hypothesis field, but the correspondence is one-to-one with the ResultText.
string ContentLanguage [get, set]
 Gets or sets the ContentLanguage. For Generic Context only. Specifies the language of the submitted audio with one of the following two choices: ‘en-US’ (English - United States) and ‘es-US’ (Spanish - United States). If Content-Language is not specified, the default will be en-us.
string Microphone [get, set]
 Gets or sets the value of Microphone. Specifies the acoustic model to be used during processing with one of the following two choices: ‘smartphone’ and ‘farfield’
bool HasMultipleNBest [get, set]
 Gets or sets the value of HasMultipleNBest. Specifies whether multiple NBest elements should be returned with output parameters. • 'true' - Send multiple NBest elements • 'false' - Send a single NBest element Default value is false.
bool PunctuateFlag [get, set]
 Gets or sets the value of PunctuateFlag. Gaming Chat sub-context only. Only for en-US output. Default value is true. Automatic Punctuation. “true” for On and “false” for Off to disable the automatic punctuation of the text in the JSON ResultText.
bool FormatFlag [get, set]
 Gets or sets the value of FormatFlag. Gaming Chat sub-context only. Only for en-US output. Default value is true. Automatic text formatting (for example, numbers, times, and so forth) “true” for On and “false” for Off to disable the automatic formatting markup of the text in the JSON ResultText. Only.
TVXArgs TVXArgParams [get, set]
 Gets or sets TVXArgParams.
SocialMediaXArgs SocialMediaXArgParams [get, set]
 Gets or sets SocialMediaXArgParams.

Detailed Description

XArgs structure. The X-Arg header is a meta parameter that can be used to define multiple parameter name/value pairs.


Constructor & Destructor Documentation

Initializes a new instance of the XArgs class.


Member Function Documentation

override string ATT_MSSDK.Speechv3.XArgs.ToString ( )

Returns the string format of the properties.

Returns:
Returns the string format of the properties.

Property Documentation

Gets or sets the ClientApp. The application name.

Gets or sets the ClientScreen. A string representing the application's focus UI screen/widget for this request.

Gets or sets the ClientSdk. The syntax for the parameter is library-platform-version.

Gets or sets the ClientVersion. A version id for the app.

Gets or sets the ContentLanguage. For Generic Context only. Specifies the language of the submitted audio with one of the following two choices: ‘en-US’ (English - United States) and ‘es-US’ (Spanish - United States). If Content-Language is not specified, the default will be en-us.

Gets or sets the DeviceOs. The version string of the OS for the device type, preferably from a standard API on the device or autofilled by an SDK.

Gets or sets the DeviceTime. The local device time at the time of the request. Format "YYYY-MMDD< space>HH:MM:SS<space>TZ".

Gets or sets the DeviceType. The device name, preferably from a standard API on the device itself (e.g. "iPhone4,1", "SGHT999", "SAMSUNG-SGH-I897", etc.)

Gets or sets the value of FormatFlag. Gaming Chat sub-context only. Only for en-US output. Default value is true. Automatic text formatting (for example, numbers, times, and so forth) “true” for On and “false” for Off to disable the automatic formatting markup of the text in the JSON ResultText. Only.

Gets or sets the value of HasMultipleNBest. Specifies whether multiple NBest elements should be returned with output parameters. • 'true' - Send multiple NBest elements • 'false' - Send a single NBest element Default value is false.

Gets or sets the value of Microphone. Specifies the acoustic model to be used during processing with one of the following two choices: ‘smartphone’ and ‘farfield’

Gets or sets the value of PunctuateFlag. Gaming Chat sub-context only. Only for en-US output. Default value is true. Automatic Punctuation. “true” for On and “false” for Off to disable the automatic punctuation of the text in the JSON ResultText.

Gets or sets the value of ShowWordTokens. Control output detail. If the packages have formatting applied to the ResultText field, this flag generates additional detail to show the named entities and the words from which those entities were derived. If no formatting is applied the output still shows the derivation from the spoken Hypothesis field, but the correspondence is one-to-one with the ResultText.

Gets or sets SocialMediaXArgParams.

Gets or sets TVXArgParams.