SpeechConfig class

Paket:

microsoft-cognitiveservices-speech-sdk

Sprachkonfiguration.

Eigenschaften

authorizationToken	Ruft das Autorisierungstoken ab.
endpointId	Ruft die Endpunkt-ID eines benutzerdefinierten Sprachmodells ab, das für die Spracherkennung verwendet wird.
outputFormat	Ruft das Ausgabeformat der Spracherkennung ab (einfach oder detailliert). Hinweis: Dieses Ausgabeformat dient dem Ergebnis der Spracherkennung. Verwenden Sie [SpeechConfig.speechSynthesisOutputFormat], um ein synthetisiertes Audioausgabeformat abzurufen.
region
speechRecognitionLanguage	Gibt die konfigurierte Sprache zurück.
speechSynthesisLanguage	Ruft die Sprache des Sprachsynthesizers ab. In Version 1.11.0 hinzugefügt.
speechSynthesisOutputFormat	Ruft das Ausgabeformat der Sprachsynthese ab. In Version 1.11.0 hinzugefügt.
speechSynthesisVoiceName	Ruft die Stimme des Sprachsynthesizers ab. In Version 1.11.0 hinzugefügt.
subscriptionKey

Methoden

close()	Schließt die Konfiguration.
enableAudioLogging()	Aktivieren Sie die Audioprotokollierung im Dienst. Audio- und Inhaltsprotokolle werden entweder im Microsoft-eigenen Speicher oder in Ihrem eigenen Speicherkonto gespeichert, das mit Ihrem Cognitive Services-Abonnement (Bring Your Own Storage, BYOS) verknüpft ist. Die Protokolle werden nach 30 Tagen entfernt. In Version 1.7.0 hinzugefügt.
enableDictation()	Aktivieren Sie das Diktat. Wird nur in der kontinuierlichen Spracherkennung unterstützt. In Version 1.7.0 hinzugefügt.
fromAuthorizationToken(string, string)	Erstellt eine instance der Speech Factory mit dem angegebenen anfänglichen Autorisierungstoken und der angegebenen Region. Hinweis: Der Aufrufer muss sicherstellen, dass das Autorisierungstoken gültig ist. Bevor das Autorisierungstoken abläuft, muss der Aufrufer es aktualisieren, indem er diesen Setter mit einem neuen gültigen Token aufruft. Hinweis: Verwenden Sie ein Token, das von Ihrem LanguageUnderstanding-Abonnementschlüssel abgeleitet ist, falls Sie die Absichtserkennung verwenden möchten. Da Konfigurationswerte beim Erstellen einer neuen Erkennung kopiert werden, gilt der neue Tokenwert nicht für bereits erstellte Erkennungen. Für Erkennungen, die zuvor erstellt wurden, müssen Sie das Autorisierungstoken der entsprechenden Erkennung festlegen, um das Token zu aktualisieren. Andernfalls treten bei der Erkennung Fehler auf.
fromEndpoint(URL, string)	Erstellt eine instance der Sprachkonfiguration mit angegebenem Endpunkt und Abonnementschlüssel. Diese Methode ist nur für Benutzer vorgesehen, die einen nicht standardmäßigen Dienstendpunkt oder -parameter verwenden. Hinweis: Verwenden Sie Ihren LanguageUnderstanding-Abonnementschlüssel, falls Sie die Absichtserkennung verwenden möchten. Hinweis: Die in der Endpunkt-URL angegebenen Abfrageparameter werden nicht geändert, auch wenn sie von anderen APIs festgelegt werden. Wenn die Sprache beispielsweise im URI als Abfrageparameter "language=de-DE" definiert und auch von SpeechConfig.speechRecognitionLanguage = "en-US" festgelegt wird, hat die Spracheinstellung in uri Vorrang, und die effektive Sprache ist "de-DE". Nur die Parameter, die nicht in der Endpunkt-URL angegeben sind, können von anderen APIs festgelegt werden. Hinweis: Um das Autorisierungstoken mit fromEndpoint zu verwenden, übergeben Sie eine leere Zeichenfolge an den subscriptionKey in der fromEndpoint-Methode, und legen Sie dann authorizationToken="token" für die erstellte SpeechConfig-instance fest, um das Autorisierungstoken zu verwenden.
fromHost(URL, string)	Erstellt eine instance der Sprachkonfiguration mit dem angegebenen Host- und Abonnementschlüssel. Diese Methode ist nur für Benutzer vorgesehen, die einen nicht standardmäßigen Diensthost verwenden. Der Standardressourcenpfad wird angenommen. Verwenden Sie für Dienste mit einem nicht standardmäßigen Ressourcenpfad oder gar keinem Pfad stattdessen fromEndpoint. Hinweis: Abfrageparameter sind im Host-URI nicht zulässig und müssen von anderen APIs festgelegt werden. Hinweis: Um ein Autorisierungstoken mit fromHost zu verwenden, verwenden Sie fromHost(URL), und legen Sie dann die AuthorizationToken-Eigenschaft für die erstellte SpeechConfig-instance fest. Hinweis: In Version 1.9.0 hinzugefügt.
fromSubscription(string, string)	Statische instance von SpeechConfig zurückgegeben, indem subscriptionKey und die Dienstregion übergeben werden. Hinweis: Verwenden Sie Ihren LanguageUnderstanding-Abonnementschlüssel, falls Sie die Absichtserkennung verwenden möchten.
getProperty(string, string)	Gibt den aktuellen Wert einer beliebigen Eigenschaft zurück.
requestWordLevelTimestamps()	Enthält Zeitstempel auf Wortebene. In Version 1.7.0 hinzugefügt.
setProfanity(ProfanityOption)	Legt die Option "Obszönität" fest. In Version 1.7.0 hinzugefügt.
setProperty(string | PropertyId, string)	Legt eine beliebige Eigenschaft fest.
setProxy(string, number)	Legt die Proxykonfiguration fest. Nur in Node.js Umgebungen relevant. In Version 1.4.0 hinzugefügt.
setProxy(string, number, string, string)	Legt die Proxykonfiguration fest. Nur in Node.js Umgebungen relevant. In Version 1.4.0 hinzugefügt.
setServiceProperty(string, string, UriQueryParameter)	Legt einen Eigenschaftswert fest, der mithilfe des angegebenen Kanals an den Dienst übergeben wird. In Version 1.7.0 hinzugefügt.

Details zur Eigenschaft

authorizationToken

Ruft das Autorisierungstoken ab.

string authorizationToken

Eigenschaftswert

string

endpointId

Ruft die Endpunkt-ID eines benutzerdefinierten Sprachmodells ab, das für die Spracherkennung verwendet wird.

string endpointId

Eigenschaftswert

string

Die Endpunkt-ID

outputFormat

Ruft das Ausgabeformat der Spracherkennung ab (einfach oder detailliert). Hinweis: Dieses Ausgabeformat dient dem Ergebnis der Spracherkennung. Verwenden Sie [SpeechConfig.speechSynthesisOutputFormat], um ein synthetisiertes Audioausgabeformat abzurufen.

OutputFormat outputFormat

Eigenschaftswert

OutputFormat

Gibt das Ausgabeformat zurück.

region

string region

Eigenschaftswert

string

Die Region, die für die Konfiguration festgelegt ist.

speechRecognitionLanguage

Gibt die konfigurierte Sprache zurück.

string speechRecognitionLanguage

Eigenschaftswert

string

speechSynthesisLanguage

Ruft die Sprache des Sprachsynthesizers ab. In Version 1.11.0 hinzugefügt.

string speechSynthesisLanguage

Eigenschaftswert

string

Gibt die Sprache für die Sprachsynthese zurück.

speechSynthesisOutputFormat

Ruft das Ausgabeformat der Sprachsynthese ab. In Version 1.11.0 hinzugefügt.

SpeechSynthesisOutputFormat speechSynthesisOutputFormat

Eigenschaftswert

SpeechSynthesisOutputFormat

Gibt das Ausgabeformat der Sprachsynthese zurück

speechSynthesisVoiceName

Ruft die Stimme des Sprachsynthesizers ab. In Version 1.11.0 hinzugefügt.

string speechSynthesisVoiceName

Eigenschaftswert

string

Gibt die Sprachsynthesestimme zurück.

subscriptionKey

string subscriptionKey

Eigenschaftswert

string

Der Abonnementschlüssel, der in der Konfiguration festgelegt ist.

Details zur Methode

close()

Schließt die Konfiguration.

function close()

enableAudioLogging()

Aktivieren Sie die Audioprotokollierung im Dienst. Audio- und Inhaltsprotokolle werden entweder im Microsoft-eigenen Speicher oder in Ihrem eigenen Speicherkonto gespeichert, das mit Ihrem Cognitive Services-Abonnement (Bring Your Own Storage, BYOS) verknüpft ist. Die Protokolle werden nach 30 Tagen entfernt. In Version 1.7.0 hinzugefügt.

function enableAudioLogging()

enableDictation()

Aktivieren Sie das Diktat. Wird nur in der kontinuierlichen Spracherkennung unterstützt. In Version 1.7.0 hinzugefügt.

function enableDictation()

fromAuthorizationToken(string, string)

Erstellt eine instance der Speech Factory mit dem angegebenen anfänglichen Autorisierungstoken und der angegebenen Region. Hinweis: Der Aufrufer muss sicherstellen, dass das Autorisierungstoken gültig ist. Bevor das Autorisierungstoken abläuft, muss der Aufrufer es aktualisieren, indem er diesen Setter mit einem neuen gültigen Token aufruft. Hinweis: Verwenden Sie ein Token, das von Ihrem LanguageUnderstanding-Abonnementschlüssel abgeleitet ist, falls Sie die Absichtserkennung verwenden möchten. Da Konfigurationswerte beim Erstellen einer neuen Erkennung kopiert werden, gilt der neue Tokenwert nicht für bereits erstellte Erkennungen. Für Erkennungen, die zuvor erstellt wurden, müssen Sie das Autorisierungstoken der entsprechenden Erkennung festlegen, um das Token zu aktualisieren. Andernfalls treten bei der Erkennung Fehler auf.

static function fromAuthorizationToken(authorizationToken: string, region: string): SpeechConfig

Parameter

authorizationToken

string

Das anfängliche Autorisierungstoken.

region

string

Der Regionsname (siehe Regionsseite).

Gibt zurück

SpeechConfig

Eine Speech Factory-instance.

fromEndpoint(URL, string)

Erstellt eine instance der Sprachkonfiguration mit angegebenem Endpunkt und Abonnementschlüssel. Diese Methode ist nur für Benutzer vorgesehen, die einen nicht standardmäßigen Dienstendpunkt oder -parameter verwenden. Hinweis: Verwenden Sie Ihren LanguageUnderstanding-Abonnementschlüssel, falls Sie die Absichtserkennung verwenden möchten. Hinweis: Die in der Endpunkt-URL angegebenen Abfrageparameter werden nicht geändert, auch wenn sie von anderen APIs festgelegt werden. Wenn die Sprache beispielsweise im URI als Abfrageparameter "language=de-DE" definiert und auch von SpeechConfig.speechRecognitionLanguage = "en-US" festgelegt wird, hat die Spracheinstellung in uri Vorrang, und die effektive Sprache ist "de-DE". Nur die Parameter, die nicht in der Endpunkt-URL angegeben sind, können von anderen APIs festgelegt werden. Hinweis: Um das Autorisierungstoken mit fromEndpoint zu verwenden, übergeben Sie eine leere Zeichenfolge an den subscriptionKey in der fromEndpoint-Methode, und legen Sie dann authorizationToken="token" für die erstellte SpeechConfig-instance fest, um das Autorisierungstoken zu verwenden.

static function fromEndpoint(endpoint: URL, subscriptionKey?: string): SpeechConfig

Parameter

endpoint

URL

Der Dienstendpunkt, mit dem eine Verbindung hergestellt werden soll.

subscriptionKey

string

Der Abonnementschlüssel. Wenn kein Abonnementschlüssel angegeben wird, muss ein Autorisierungstoken festgelegt werden.

Gibt zurück

SpeechConfig

Eine Speech Factory-instance.

fromHost(URL, string)

Erstellt eine instance der Sprachkonfiguration mit dem angegebenen Host- und Abonnementschlüssel. Diese Methode ist nur für Benutzer vorgesehen, die einen nicht standardmäßigen Diensthost verwenden. Der Standardressourcenpfad wird angenommen. Verwenden Sie für Dienste mit einem nicht standardmäßigen Ressourcenpfad oder gar keinem Pfad stattdessen fromEndpoint. Hinweis: Abfrageparameter sind im Host-URI nicht zulässig und müssen von anderen APIs festgelegt werden. Hinweis: Um ein Autorisierungstoken mit fromHost zu verwenden, verwenden Sie fromHost(URL), und legen Sie dann die AuthorizationToken-Eigenschaft für die erstellte SpeechConfig-instance fest. Hinweis: In Version 1.9.0 hinzugefügt.

static function fromHost(hostName: URL, subscriptionKey?: string): SpeechConfig

Parameter

hostName

URL

subscriptionKey

string

Der Abonnementschlüssel. Wenn kein Abonnementschlüssel angegeben wird, muss ein Autorisierungstoken festgelegt werden.

Gibt zurück

SpeechConfig

Eine Speech Factory-instance.

fromSubscription(string, string)

Statische instance von SpeechConfig zurückgegeben, indem subscriptionKey und die Dienstregion übergeben werden. Hinweis: Verwenden Sie Ihren LanguageUnderstanding-Abonnementschlüssel, falls Sie die Absichtserkennung verwenden möchten.

static function fromSubscription(subscriptionKey: string, region: string): SpeechConfig

Parameter

subscriptionKey

string

Der Abonnementschlüssel.

region

string

Der Regionsname (siehe Regionsseite).

Gibt zurück

SpeechConfig

Die Sprachfactory

getProperty(string, string)

Gibt den aktuellen Wert einer beliebigen Eigenschaft zurück.

function getProperty(name: string, def?: string): string

Parameter

name

string

Der Name der abzufragenden Eigenschaft.

def

string

Der wert, der zurückgegeben werden soll, falls die Eigenschaft nicht bekannt ist.

Gibt zurück

string

Der aktuelle Wert oder der angegebene Standardwert der angegebenen Eigenschaft.

requestWordLevelTimestamps()

Enthält Zeitstempel auf Wortebene. In Version 1.7.0 hinzugefügt.

function requestWordLevelTimestamps()

setProfanity(ProfanityOption)

Legt die Option "Obszönität" fest. In Version 1.7.0 hinzugefügt.

function setProfanity(profanity: ProfanityOption)

Parameter

profanity

ProfanityOption

setProperty(string | PropertyId, string)

Legt eine beliebige Eigenschaft fest.

function setProperty(name: string | PropertyId, value: string)

Parameter

name

string | PropertyId

Der Name der festzulegenden Eigenschaft.

value

string

Der neue Wert der Eigenschaft.

setProxy(string, number)

Legt die Proxykonfiguration fest. Nur in Node.js Umgebungen relevant. In Version 1.4.0 hinzugefügt.

function setProxy(proxyHostName: string, proxyPort: number)

Parameter

proxyHostName

string

Der Hostname des Proxyservers.

proxyPort

number

Die Portnummer des Proxyservers.

setProxy(string, number, string, string)

Legt die Proxykonfiguration fest. Nur in Node.js Umgebungen relevant. In Version 1.4.0 hinzugefügt.

function setProxy(proxyHostName: string, proxyPort: number, proxyUserName: string, proxyPassword: string)

Parameter

proxyHostName

string

Der Hostname des Proxyservers ohne Protokollschema (http://)

proxyPort

number

Die Portnummer des Proxyservers.

proxyUserName

string

Der Benutzername des Proxyservers.

proxyPassword

string

Das Kennwort des Proxyservers.

setServiceProperty(string, string, UriQueryParameter)

Legt einen Eigenschaftswert fest, der mithilfe des angegebenen Kanals an den Dienst übergeben wird. In Version 1.7.0 hinzugefügt.

function setServiceProperty(name: string, value: string, channel: UriQueryParameter)

Parameter

name

string

value

string

channel

UriQueryParameter