dist¶

Interfaces¶

AzurePushAudioInputStream¶

Methods¶

close()¶

close(): void;

Returns¶

void

write()¶

write(buffer): void;

Parameters¶

Parameter	Type
`buffer`	`ArrayBuffer`

Returns¶

void

AzureSpeechClient¶

Properties¶

createSpeechConfig¶

createSpeechConfig: AzureSpeechConfigFactory;

handlers¶

handlers: AzureSpeechOperationHandlers;

rawHandles¶

rawHandles: AzureSpeechRawConfigHandles;

rawSdk¶

rawSdk: AzureSpeechSdk;

Methods¶

execute()¶

execute<K>(alias, input): Promise<AzureSpeechOperationOutputMap[K]>;

Type Parameters¶

Type Parameter
`K` extends `AzureSpeechOperationAlias`

Parameters¶

Parameter	Type
`alias`	`K`
`input`	`AzureSpeechOperationInputMap`[`K`]

Returns¶

Promise\<AzureSpeechOperationOutputMap[K]>

synthesizeSpeech()¶

synthesizeSpeech(input): Promise<ArrayBuffer>;

Parameters¶

Parameter	Type
`input`	`AzureTextToSpeechInput`

Returns¶

Promise\<ArrayBuffer>

transcribeSpeech()¶

transcribeSpeech(input): Promise<AzureSpeechToTextResult>;

Parameters¶

Parameter	Type
`input`	`AzureSpeechToTextInput`

Returns¶

Promise\<AzureSpeechToTextResult>

AzureSpeechClientOptions¶

Properties¶

createSpeechConfig?¶

optional createSpeechConfig?: AzureSpeechConfigFactory;

region¶

region: string;

sdk?¶

optional sdk?: AzureSpeechSdk;

speechKey¶

speechKey: string;

AzureSpeechConfig¶

Properties¶

speechRecognitionLanguage?¶

optional speechRecognitionLanguage?: string;

speechSynthesisLanguage?¶

optional speechSynthesisLanguage?: string;

speechSynthesisOutputFormat?¶

optional speechSynthesisOutputFormat?: AzureSpeechSynthesisOutputFormat;

speechSynthesisVoiceName?¶

optional speechSynthesisVoiceName?: string;

AzureSpeechCredentialStatusInput¶

Properties¶

region?¶

optional region?: string;

speechKey?¶

optional speechKey?: string;

AzureSpeechIntegrationOptions¶

Extends¶

Partial\<AzureSpeechClientOptions>

Properties¶

client?¶

optional client?: AzureSpeechClient;

createSpeechConfig?¶

optional createSpeechConfig?: AzureSpeechConfigFactory;

Inherited from¶

AzureSpeechClientOptions.createSpeechConfig

region?¶

optional region?: string;

Inherited from¶

AzureSpeechClientOptions.region

sdk?¶

optional sdk?: AzureSpeechSdk;

Inherited from¶

AzureSpeechClientOptions.sdk

speechKey?¶

optional speechKey?: string;

Inherited from¶

AzureSpeechClientOptions.speechKey

AzureSpeechOperationInputMap¶

Properties¶

voice.session.start¶

voice.session.start: AzureSpeechToTextInput;

voice.speak¶

voice.speak: AzureTextToSpeechInput;

voice.turn.finalize¶

voice.turn.finalize: AzureSpeechToTextInput;

AzureSpeechOperationOutputMap¶

Properties¶

voice.session.start¶

voice.session.start: AzureSpeechToTextResult;

voice.speak¶

voice.speak: ArrayBuffer;

voice.turn.finalize¶

voice.turn.finalize: AzureSpeechToTextResult;

AzureSpeechRawConfigHandles¶

Properties¶

createSpeechConfig¶

createSpeechConfig: AzureSpeechConfigFactory;

sdk¶

sdk: AzureSpeechSdk;

AzureSpeechRecognitionResult¶

Extends¶

Partial\<Pick\<MicrosoftSpeechSdk.SpeechRecognitionResult, "text" | "reason" | "duration" | "offset" | "errorDetails">>

AzureSpeechRecognizer¶

Methods¶

close()?¶

optional close(success?, error?): void;

Parameters¶

Parameter	Type
`success?`	() => `void`
`error?`	(`error`) => `void`

Returns¶

void

recognizeOnceAsync()¶

recognizeOnceAsync(success, error): void;

Parameters¶

Parameter	Type
`success`	(`result`) => `void`
`error`	(`error`) => `void`

Returns¶

void

AzureSpeechSdk¶

Properties¶

AudioConfig¶

AudioConfig: {
  fromStreamInput: AzureAudioConfig;
};

fromStreamInput()¶

fromStreamInput(stream): AzureAudioConfig;

Parameters¶

Parameter	Type
`stream`	`AzurePushAudioInputStream`

Returns¶

AzureAudioConfig

AudioInputStream¶

AudioInputStream: {
  createPushStream: AzurePushAudioInputStream;
};

createPushStream()¶

createPushStream(format?): AzurePushAudioInputStream;

Parameters¶

Parameter	Type
`format?`	`unknown`

Returns¶

AzurePushAudioInputStream

AudioStreamFormat¶

AudioStreamFormat: {
  getWaveFormatPCM: unknown;
};

getWaveFormatPCM()¶

getWaveFormatPCM(
   samplesPerSec,
   bitsPerSample,
   channels): unknown;

Parameters¶

Parameter	Type
`samplesPerSec`	`number`
`bitsPerSample`	`number`
`channels`	`number`

Returns¶

unknown

ResultReason?¶

optional ResultReason?: Record<string, number | string | undefined>;

SpeechConfig¶

SpeechConfig: {
  fromSubscription: AzureSpeechConfig;
};

fromSubscription()¶

fromSubscription(speechKey, region): AzureSpeechConfig;

Parameters¶

Parameter	Type
`speechKey`	`string`
`region`	`string`

Returns¶

AzureSpeechConfig

SpeechRecognizer¶

SpeechRecognizer: (speechConfig, audioConfig?) => AzureSpeechRecognizer;

Parameters¶

Parameter	Type
`speechConfig`	`AzureSpeechConfig`
`audioConfig?`	`AzureAudioConfig`

Returns¶

AzureSpeechRecognizer

SpeechSynthesisOutputFormat¶

SpeechSynthesisOutputFormat: Partial<Record<
  | "Raw8Khz8BitMonoMULaw"
  | "Riff16Khz16KbpsMonoSiren"
  | "Audio16Khz16KbpsMonoSiren"
  | "Audio16Khz32KBitRateMonoMp3"
  | "Audio16Khz128KBitRateMonoMp3"
  | "Audio16Khz64KBitRateMonoMp3"
  | "Audio24Khz48KBitRateMonoMp3"
  | "Audio24Khz96KBitRateMonoMp3"
  | "Audio24Khz160KBitRateMonoMp3"
  | "Raw16Khz16BitMonoTrueSilk"
  | "Riff16Khz16BitMonoPcm"
  | "Riff8Khz16BitMonoPcm"
  | "Riff24Khz16BitMonoPcm"
  | "Riff8Khz8BitMonoMULaw"
  | "Raw16Khz16BitMonoPcm"
  | "Raw24Khz16BitMonoPcm"
  | "Raw8Khz16BitMonoPcm"
  | "Ogg16Khz16BitMonoOpus"
  | "Ogg24Khz16BitMonoOpus"
  | "Raw48Khz16BitMonoPcm"
  | "Riff48Khz16BitMonoPcm"
  | "Audio48Khz96KBitRateMonoMp3"
  | "Audio48Khz192KBitRateMonoMp3"
  | "Ogg48Khz16BitMonoOpus"
  | "Webm16Khz16BitMonoOpus"
  | "Webm24Khz16BitMonoOpus"
  | "Raw24Khz16BitMonoTrueSilk"
  | "Raw8Khz8BitMonoALaw"
  | "Riff8Khz8BitMonoALaw"
  | "Webm24Khz16Bit24KbpsMonoOpus"
  | "Audio16Khz16Bit32KbpsMonoOpus"
  | "Audio24Khz16Bit48KbpsMonoOpus"
  | "Audio24Khz16Bit24KbpsMonoOpus"
  | "Raw22050Hz16BitMonoPcm"
  | "Riff22050Hz16BitMonoPcm"
  | "Raw44100Hz16BitMonoPcm"
  | "Riff44100Hz16BitMonoPcm"
  | "AmrWb16000Hz"
| "G72216Khz64Kbps", SpeechSynthesisOutputFormat>> & Record<string, string | number>;

SpeechSynthesizer¶

SpeechSynthesizer: (speechConfig, audioConfig?) => AzureSpeechSynthesizer;

Parameters¶

Parameter	Type
`speechConfig`	`AzureSpeechConfig`
`audioConfig?`	`AzureAudioConfig`

Returns¶

AzureSpeechSynthesizer

AzureSpeechSynthesisResult¶

Extends¶

Partial\<Pick\<MicrosoftSpeechSdk.SpeechSynthesisResult, "audioData" | "reason" | "errorDetails">>

AzureSpeechSynthesizer¶

Methods¶

close()?¶

optional close(success?, error?): void;

Parameters¶

Parameter	Type
`success?`	() => `void`
`error?`	(`error`) => `void`

Returns¶

void

speakTextAsync()¶

speakTextAsync(
   text,
   success,
   error): void;

Parameters¶

Parameter	Type
`text`	`string`
`success`	(`result`) => `void`
`error`	(`error`) => `void`

Returns¶

void

AzureSpeechToTextInput¶

Properties¶

audio¶

audio: Uint8Array;

language?¶

optional language?: string;

sampleRate?¶

optional sampleRate?: number;

signal?¶

optional signal?: AbortSignal;

AzureSpeechToTextResult¶

Properties¶

duration?¶

optional duration?: number;

offset?¶

optional offset?: number;

raw?¶

optional raw?: unknown;

recognitionStatus?¶

optional recognitionStatus?: string;

text¶

text: string;

AzureSpeechVoiceProviderOptions¶

Extends¶

Omit\<Partial\<SpeechPipelineVoiceProviderOptions>, "provider" | "transcriptionSource" | "transcribe" | "synthesize">

Properties¶

client?¶

optional client?: AzureSpeechClient;

endSilenceMs?¶

optional endSilenceMs?: number;

Inherited from¶

Omit.endSilenceMs

id?¶

optional id?: string;

Inherited from¶

Omit.id

language?¶

optional language?: string;

maxSpeechMs?¶

optional maxSpeechMs?: number;

Inherited from¶

Omit.maxSpeechMs

minSpeechMs?¶

optional minSpeechMs?: number;

Inherited from¶

Omit.minSpeechMs

model?¶

optional model?: string;

Inherited from¶

Omit.model

outputFormat?¶

optional outputFormat?: AzureSpeechSynthesisOutputFormat;

region?¶

optional region?: string;

sampleRate?¶

optional sampleRate?: number;

Inherited from¶

Omit.sampleRate

sdk?¶

optional sdk?: AzureSpeechSdk;

silenceThreshold?¶

optional silenceThreshold?: number;

Inherited from¶

Omit.silenceThreshold

speechKey?¶

optional speechKey?: string;

voiceName¶

voiceName: string;

AzureTextToSpeechInput¶

Properties¶

language?¶

optional language?: string;

outputFormat?¶

optional outputFormat?: AzureSpeechSynthesisOutputFormat;

signal?¶

optional signal?: AbortSignal;

text¶

text: string;

voiceName¶

voiceName: string;

Type Aliases¶

AzureAudioConfig¶

type AzureAudioConfig = MicrosoftSpeechSdk.AudioConfig | Record<string, unknown>;

AzureSpeechConfigFactory¶

type AzureSpeechConfigFactory = () => AzureSpeechConfig;

Returns¶

AzureSpeechConfig

AzureSpeechOperationAlias¶

type AzureSpeechOperationAlias = "voice.session.start" | "voice.turn.finalize" | "voice.speak";

AzureSpeechOperationHandler¶

type AzureSpeechOperationHandler<K> = (input) => Promise<AzureSpeechOperationOutputMap[K]>;

Type Parameters¶

Type Parameter
`K` extends `AzureSpeechOperationAlias`

Parameters¶

Parameter	Type
`input`	`AzureSpeechOperationInputMap`[`K`]

Returns¶

Promise\<AzureSpeechOperationOutputMap[K]>

AzureSpeechOperationHandlers¶

type AzureSpeechOperationHandlers = { [K in AzureSpeechOperationAlias]: AzureSpeechOperationHandler<K> };

AzureSpeechSynthesisOutputFormat¶

type AzureSpeechSynthesisOutputFormat =
  | AzureSpeechSynthesisOutputFormatName
  | MicrosoftSpeechSdk.SpeechSynthesisOutputFormat;

AzureSpeechSynthesisOutputFormatName¶

type AzureSpeechSynthesisOutputFormatName = keyof typeof MicrosoftSpeechSdk.SpeechSynthesisOutputFormat;

Variables¶

azureSpeechIntegration¶

const azureSpeechIntegration: DefinedIntegration<{
  capabilities: (
     | {
     audiences: "customer-facing"[];
     capability: string;
     description: string;
     exposesSensitiveData: true;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect: true;
   }
     | {
     audiences: ("customer-facing" | "internal-support")[];
     capability: string;
     description: string;
     exposesSensitiveData: true;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect?: never;
  })[];
  category: string;
  channelAudiences: ("customer-facing" | "mixed")[];
  coverage: {
     evidence: {
        label: string;
        url: string;
     }[];
     notes: string[];
     scope: "provider-api-subset";
  };
  credentialRequirements: {
     description: string;
     id: string;
     label: string;
     required: true;
  }[];
  directions: ("receive-only" | "send-only" | "bidirectional")[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "official";
  }[];
  metadata: {
     channelCoverage: {
        backgroundModelProvider: string;
        browserVoiceProtocol: string;
        fullAzureSpeechSdk: string;
        speechToText: string;
        telephony: string;
        textToSpeech: string;
     };
     implementation: {
        adapterCoverage: string[];
        rawClientEscapeHatch: boolean;
        sdkPackages: string[];
        strategy: string;
     };
     integrationEntryPoints: {
        manifest: string;
        runtime: string;
     };
     integrationName: string;
     integrationPackageName: string;
  };
  name: string;
  operations: (
     | {
     alias: string;
     capability: string;
     exposesSensitiveData: true;
     externallyVisible?: never;
     providerObject: string;
     providerOperation: string;
     requiresCredential: true;
     sideEffect?: never;
   }
     | {
     alias: string;
     capability: string;
     exposesSensitiveData?: never;
     externallyVisible: true;
     providerObject: string;
     providerOperation: string;
     requiresCredential: true;
     sideEffect: true;
  })[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "official";
}, unknown, {
  voice.session.start: (input, context) => Promise<AzureSpeechToTextResult>;
  voice.speak: (input, context) => Promise<ArrayBuffer>;
  voice.turn.finalize: (input, context) => Promise<AzureSpeechToTextResult>;
}>;

azureSpeechProviderManifest¶

const azureSpeechProviderManifest: {
  capabilities: {
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension?: boolean;
     label?: string;
     metadata?: Record<string, unknown>;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  category: string;
  channelAudiences: ("customer-facing" | "internal-support" | "mixed")[];
  coverage: {
     evidence: {
        label: string;
        url?: string;
     }[];
     notes: string[];
     scope:   | "support-workflow-subset"
        | "provider-api-subset"
        | "connector-required"
        | "local-protocol"
        | "full-provider-api";
  };
  credentialRequirements: {
     description?: string;
     id: string;
     label?: string;
     metadata?: Record<string, unknown>;
     required: boolean;
     scopes: string[];
  }[];
  directions: (
     | "receive-only"
     | "send-only"
     | "inbound-only"
     | "outbound-only"
    | "bidirectional")[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "community" | "official" | "unknown" | "partner";
     url?: string;
  }[];
  metadata?: Record<string, unknown>;
  name: string;
  operations: {
     alias: string;
     audience?: "customer-facing" | "internal-support" | "mixed";
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension: boolean;
     externallyVisible?: boolean;
     inputSchema?: unknown;
     inputSchemaName?: string;
     inputSchemaRef?: string;
     label?: string;
     metadata?: Record<string, unknown>;
     outputSchema?: unknown;
     outputSchemaName?: string;
     outputSchemaRef?: string;
     providerObject?: string;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     providerOperation?: string;
     requiredPolicyIds?: string[];
     requiresApproval?: boolean;
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "community" | "official" | "verified" | "experimental";
} & {
  capabilities: (
     | {
     audiences: "customer-facing"[];
     capability: string;
     description: string;
     exposesSensitiveData: true;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect: true;
   }
     | {
     audiences: ("customer-facing" | "internal-support")[];
     capability: string;
     description: string;
     exposesSensitiveData: true;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect?: never;
  })[];
  category: string;
  channelAudiences: ("customer-facing" | "mixed")[];
  coverage: {
     evidence: {
        label: string;
        url: string;
     }[];
     notes: string[];
     scope: "provider-api-subset";
  };
  credentialRequirements: {
     description: string;
     id: string;
     label: string;
     required: true;
  }[];
  directions: ("receive-only" | "send-only" | "bidirectional")[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "official";
  }[];
  metadata: {
     channelCoverage: {
        backgroundModelProvider: string;
        browserVoiceProtocol: string;
        fullAzureSpeechSdk: string;
        speechToText: string;
        telephony: string;
        textToSpeech: string;
     };
     implementation: {
        adapterCoverage: string[];
        rawClientEscapeHatch: boolean;
        sdkPackages: string[];
        strategy: string;
     };
     integrationEntryPoints: {
        manifest: string;
        runtime: string;
     };
     integrationName: string;
     integrationPackageName: string;
  };
  name: string;
  operations: (
     | {
     alias: string;
     capability: string;
     exposesSensitiveData: true;
     externallyVisible?: never;
     providerObject: string;
     providerOperation: string;
     requiresCredential: true;
     sideEffect?: never;
   }
     | {
     alias: string;
     capability: string;
     exposesSensitiveData?: never;
     externallyVisible: true;
     providerObject: string;
     providerOperation: string;
     requiresCredential: true;
     sideEffect: true;
  })[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "official";
};

Type Declaration¶

Name	Type
`capabilities`	{ `audiences?`: (`"customer-facing"` \| `"internal-support"` \| `"mixed"`)[]; `capability`: `string`; `changesWorkflow?`: `boolean`; `description?`: `string`; `exposesSensitiveData?`: `boolean`; `extension?`: `boolean`; `label?`: `string`; `metadata?`: `Record`\<`string`, `unknown`>; `providerObjects?`: { `description?`: `string`; `kind`: `string`; `label?`: `string`; `metadata?`: `Record`\<`string`, `unknown`>; `schemaName?`: `string`; }[]; `requiresCredential?`: `boolean`; `sideEffect?`: `boolean`; }[]
`category`	`string`
`channelAudiences`	(`"customer-facing"` \| `"internal-support"` \| `"mixed"`)[]
`coverage`	{ `evidence`: { `label`: `string`; `url?`: `string`; }[]; `notes`: `string`[]; `scope`: \| `"support-workflow-subset"` \| `"provider-api-subset"` \| `"connector-required"` \| `"local-protocol"` \| `"full-provider-api"`; }
`coverage.evidence`	{ `label`: `string`; `url?`: `string`; }[]
`coverage.notes`	`string`[]
`coverage.scope`	\| `"support-workflow-subset"` \| `"provider-api-subset"` \| `"connector-required"` \| `"local-protocol"` \| `"full-provider-api"`
`credentialRequirements`	{ `description?`: `string`; `id`: `string`; `label?`: `string`; `metadata?`: `Record`\<`string`, `unknown`>; `required`: `boolean`; `scopes`: `string`[]; }[]
`directions`	( \| `"receive-only"` \| `"send-only"` \| `"inbound-only"` \| `"outbound-only"` \| `"bidirectional"`)[]
`id`	`string`
`limitations`	`string`[]
`maintainers`	{ `name`: `string`; `type`: `"community"` \| `"official"` \| `"unknown"` \| `"partner"`; `url?`: `string`; }[]
`metadata?`	`Record`\<`string`, `unknown`>
`name`	`string`
`operations`	{ `alias`: `string`; `audience?`: `"customer-facing"` \| `"internal-support"` \| `"mixed"`; `audiences?`: (`"customer-facing"` \| `"internal-support"` \| `"mixed"`)[]; `capability`: `string`; `changesWorkflow?`: `boolean`; `description?`: `string`; `exposesSensitiveData?`: `boolean`; `extension`: `boolean`; `externallyVisible?`: `boolean`; `inputSchema?`: `unknown`; `inputSchemaName?`: `string`; `inputSchemaRef?`: `string`; `label?`: `string`; `metadata?`: `Record`\<`string`, `unknown`>; `outputSchema?`: `unknown`; `outputSchemaName?`: `string`; `outputSchemaRef?`: `string`; `providerObject?`: `string`; `providerObjects?`: { `description?`: `string`; `kind`: `string`; `label?`: `string`; `metadata?`: `Record`\<`string`, `unknown`>; `schemaName?`: `string`; }[]; `providerOperation?`: `string`; `requiredPolicyIds?`: `string`[]; `requiresApproval?`: `boolean`; `requiresCredential?`: `boolean`; `sideEffect?`: `boolean`; }[]
`packageName`	`string`
`privacyNotes`	`string`[]
`provider`	`string`
`trustLevel`	`"community"` \| `"official"` \| `"verified"` \| `"experimental"`

Type Declaration¶

Name	Type
`capabilities`	( \| { `audiences`: `"customer-facing"`[]; `capability`: `string`; `description`: `string`; `exposesSensitiveData`: `true`; `label`: `string`; `providerObjects`: { `kind`: `string`; `label`: `string`; }[]; `requiresCredential`: `true`; `sideEffect`: `true`; } \| { `audiences`: (`"customer-facing"` \| `"internal-support"`)[]; `capability`: `string`; `description`: `string`; `exposesSensitiveData`: `true`; `label`: `string`; `providerObjects`: { `kind`: `string`; `label`: `string`; }[]; `requiresCredential`: `true`; `sideEffect?`: `never`; })[]
`category`	`string`
`channelAudiences`	(`"customer-facing"` \| `"mixed"`)[]
`coverage`	{ `evidence`: { `label`: `string`; `url`: `string`; }[]; `notes`: `string`[]; `scope`: `"provider-api-subset"`; }
`coverage.evidence`	{ `label`: `string`; `url`: `string`; }[]
`coverage.notes`	`string`[]
`coverage.scope`	`"provider-api-subset"`
`credentialRequirements`	{ `description`: `string`; `id`: `string`; `label`: `string`; `required`: `true`; }[]
`directions`	(`"receive-only"` \| `"send-only"` \| `"bidirectional"`)[]
`id`	`string`
`limitations`	`string`[]
`maintainers`	{ `name`: `string`; `type`: `"official"`; }[]
`metadata`	{ `channelCoverage`: { `backgroundModelProvider`: `string`; `browserVoiceProtocol`: `string`; `fullAzureSpeechSdk`: `string`; `speechToText`: `string`; `telephony`: `string`; `textToSpeech`: `string`; }; `implementation`: { `adapterCoverage`: `string`[]; `rawClientEscapeHatch`: `boolean`; `sdkPackages`: `string`[]; `strategy`: `string`; }; `integrationEntryPoints`: { `manifest`: `string`; `runtime`: `string`; }; `integrationName`: `string`; `integrationPackageName`: `string`; }
`metadata.channelCoverage`	{ `backgroundModelProvider`: `string`; `browserVoiceProtocol`: `string`; `fullAzureSpeechSdk`: `string`; `speechToText`: `string`; `telephony`: `string`; `textToSpeech`: `string`; }
`metadata.channelCoverage.backgroundModelProvider`	`string`
`metadata.channelCoverage.browserVoiceProtocol`	`string`
`metadata.channelCoverage.fullAzureSpeechSdk`	`string`
`metadata.channelCoverage.speechToText`	`string`
`metadata.channelCoverage.telephony`	`string`
`metadata.channelCoverage.textToSpeech`	`string`
`metadata.implementation`	{ `adapterCoverage`: `string`[]; `rawClientEscapeHatch`: `boolean`; `sdkPackages`: `string`[]; `strategy`: `string`; }
`metadata.implementation.adapterCoverage`	`string`[]
`metadata.implementation.rawClientEscapeHatch`	`boolean`
`metadata.implementation.sdkPackages`	`string`[]
`metadata.implementation.strategy`	`string`
`metadata.integrationEntryPoints`	{ `manifest`: `string`; `runtime`: `string`; }
`metadata.integrationEntryPoints.manifest`	`string`
`metadata.integrationEntryPoints.runtime`	`string`
`metadata.integrationName`	`string`
`metadata.integrationPackageName`	`string`
`name`	`string`
`operations`	( \| { `alias`: `string`; `capability`: `string`; `exposesSensitiveData`: `true`; `externallyVisible?`: `never`; `providerObject`: `string`; `providerOperation`: `string`; `requiresCredential`: `true`; `sideEffect?`: `never`; } \| { `alias`: `string`; `capability`: `string`; `exposesSensitiveData?`: `never`; `externallyVisible`: `true`; `providerObject`: `string`; `providerOperation`: `string`; `requiresCredential`: `true`; `sideEffect`: `true`; })[]
`packageName`	`string`
`privacyNotes`	`string`[]
`provider`	`string`
`trustLevel`	`"official"`

createAzureSpeechVoiceAdapter¶

const createAzureSpeechVoiceAdapter: typeof createAzureSpeechVoiceProvider;

Functions¶

azureSpeechCredentialStatuses()¶

function azureSpeechCredentialStatuses(input): {
  expiresAt?: string;
  message?: string;
  providerPackageId?: string;
  requirementId: string;
  scopes?: string[];
  state:   | "required"
     | "configured"
     | "permission-blocked"
     | "not-required"
     | "missing"
     | "expired"
     | "insufficient-scope"
     | "unavailable";
}[];

Parameters¶

Parameter	Type
`input`	`AzureSpeechCredentialStatusInput`

Returns¶

{ expiresAt?: string; message?: string; providerPackageId?: string; requirementId: string; scopes?: string[]; state: | "required" | "configured" | "permission-blocked" | "not-required" | "missing" | "expired" | "insufficient-scope" | "unavailable"; }[]

createAzureSpeechClient()¶

function createAzureSpeechClient(options): AzureSpeechClient;

Parameters¶

Parameter	Type
`options`	`AzureSpeechClientOptions`

Returns¶

AzureSpeechClient

createAzureSpeechIntegration()¶

function createAzureSpeechIntegration(options): DefinedIntegration<{
  capabilities: (
     | {
     audiences: "customer-facing"[];
     capability: string;
     description: string;
     exposesSensitiveData: true;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect: true;
   }
     | {
     audiences: ("customer-facing" | "internal-support")[];
     capability: string;
     description: string;
     exposesSensitiveData: true;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect?: never;
  })[];
  category: string;
  channelAudiences: ("customer-facing" | "mixed")[];
  coverage: {
     evidence: {
        label: string;
        url: string;
     }[];
     notes: string[];
     scope: "provider-api-subset";
  };
  credentialRequirements: {
     description: string;
     id: string;
     label: string;
     required: true;
  }[];
  directions: ("receive-only" | "send-only" | "bidirectional")[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "official";
  }[];
  metadata: {
     channelCoverage: {
        backgroundModelProvider: string;
        browserVoiceProtocol: string;
        fullAzureSpeechSdk: string;
        speechToText: string;
        telephony: string;
        textToSpeech: string;
     };
     implementation: {
        adapterCoverage: string[];
        rawClientEscapeHatch: boolean;
        sdkPackages: string[];
        strategy: string;
     };
     integrationEntryPoints: {
        manifest: string;
        runtime: string;
     };
     integrationName: string;
     integrationPackageName: string;
  };
  name: string;
  operations: (
     | {
     alias: string;
     capability: string;
     exposesSensitiveData: true;
     externallyVisible?: never;
     providerObject: string;
     providerOperation: string;
     requiresCredential: true;
     sideEffect?: never;
   }
     | {
     alias: string;
     capability: string;
     exposesSensitiveData?: never;
     externallyVisible: true;
     providerObject: string;
     providerOperation: string;
     requiresCredential: true;
     sideEffect: true;
  })[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "official";
}, unknown, IntegrationOperationHandlers>;

Parameters¶

Parameter	Type
`options`	`AzureSpeechIntegrationOptions`

Returns¶

DefinedIntegration\<{ capabilities: ( | { audiences: "customer-facing"[]; capability: string; description: string; exposesSensitiveData: true; label: string; providerObjects: { kind: string; label: string; }[]; requiresCredential: true; sideEffect: true; } | { audiences: ("customer-facing" | "internal-support")[]; capability: string; description: string; exposesSensitiveData: true; label: string; providerObjects: { kind: string; label: string; }[]; requiresCredential: true; sideEffect?: never; })[]; category: string; channelAudiences: ("customer-facing" | "mixed")[]; coverage: { evidence: { label: string; url: string; }[]; notes: string[]; scope: "provider-api-subset"; }; credentialRequirements: { description: string; id: string; label: string; required: true; }[]; directions: ("receive-only" | "send-only" | "bidirectional")[]; id: string; limitations: string[]; maintainers: { name: string; type: "official"; }[]; metadata: { channelCoverage: { backgroundModelProvider: string; browserVoiceProtocol: string; fullAzureSpeechSdk: string; speechToText: string; telephony: string; textToSpeech: string; }; implementation: { adapterCoverage: string[]; rawClientEscapeHatch: boolean; sdkPackages: string[]; strategy: string; }; integrationEntryPoints: { manifest: string; runtime: string; }; integrationName: string; integrationPackageName: string; }; name: string; operations: ( | { alias: string; capability: string; exposesSensitiveData: true; externallyVisible?: never; providerObject: string; providerOperation: string; requiresCredential: true; sideEffect?: never; } | { alias: string; capability: string; exposesSensitiveData?: never; externallyVisible: true; providerObject: string; providerOperation: string; requiresCredential: true; sideEffect: true; })[]; packageName: string; privacyNotes: string[]; provider: string; trustLevel: "official"; }, unknown, IntegrationOperationHandlers>

createAzureSpeechOperationHandlers()¶

function createAzureSpeechOperationHandlers(options): AzureSpeechOperationHandlers;

Parameters¶

Parameter	Type
`options`	`AzureSpeechIntegrationOptions`

Returns¶

AzureSpeechOperationHandlers

createAzureSpeechRawConfigHandles()¶

function createAzureSpeechRawConfigHandles(options): AzureSpeechRawConfigHandles;

Parameters¶

Parameter	Type
`options`	`AzureSpeechClientOptions`

Returns¶

AzureSpeechRawConfigHandles

createAzureSpeechVoiceProvider()¶

function createAzureSpeechVoiceProvider(options): VoiceProvider;

Parameters¶

Parameter	Type
`options`	`AzureSpeechVoiceProviderOptions`

Returns¶

VoiceProvider