Interface SayAsOptions

Configuration options for say-as elements.

Controls interpretation and pronunciation of formatted text like dates, numbers, currency, and other specialized content.

Example

// Date interpretation
const date: SayAsOptions = {
  interpretAs: 'date',
  format: 'ymd'  // Year-month-day
};

// Currency with detail
const currency: SayAsOptions = {
  interpretAs: 'currency',
  detail: 'USD'
};

See

https://docs.microsoft.com/azure/cognitive-services/speech-service/speech-synthesis-markup#say-as-element Say-As Documentation

interface SayAsOptions {
    detail?: string;
    format?: string;
    interpretAs: SayAsInterpretAs;
}

Index

Properties

detail? format? interpretAs

Properties

`Optional`detail

detail?: string

Additional detail for interpretation.

Provides extra context for certain interpretAs types:

For currency: ISO currency code (USD, EUR, GBP, etc.)
For other types: Additional pronunciation hints

Example

"USD" - US Dollars

Example

"EUR" - Euros

Example

"JPY" - Japanese Yen

`Optional`format

format?: string

Format hint for interpretation.

Provides additional formatting information. Available formats depend on interpretAs value:

For dates:

"mdy": Month-day-year
"dmy": Day-month-year
"ymd": Year-month-day
"md": Month-day
"dm": Day-month
"ym": Year-month
"my": Month-year
"d": Day only
"m": Month only
"y": Year only

For time:

"hms12": 12-hour format with seconds
"hms24": 24-hour format with seconds

Example

"ymd" - For date: 2025-12-31

Example

"hms24" - For time: 14:30:00

interpretAs

interpretAs: SayAsInterpretAs

How to interpret the text content. (Required)

Determines the pronunciation rules applied to the text. Each type has specific formatting requirements.

Example

"date" - For dates

Example

"cardinal" - For numbers

Example

"telephone" - For phone numbers

Example

"currency" - For money

See

SayAsInterpretAs type for full list

Interface SayAsOptions

Example

See

Index

Properties

Properties

`Optional`detail

Example

Example

Example

`Optional`format

Example

Example

interpretAs

Example

Example

Example

Example

See

Settings

On This Page

Interface SayAsOptions

Example

See

Index

Properties

Properties

Optionaldetail

Example

Example

Example

Optionalformat

Example

Example

interpretAs

Example

Example

Example

Example

See

Settings

On This Page

`Optional`detail

`Optional`format