SpeechConfig class

Balíček:

microsoft-cognitiveservices-speech-sdk

Konfigurace řeči.

Vlastnosti

authorizationToken	Získá autorizační token.
endpointId	Získá ID koncového bodu přizpůsobeného modelu řeči, který se používá pro rozpoznávání řeči.
outputFormat	Získá výstupní formát rozpoznávání řeči (jednoduchý nebo podrobný). Poznámka: Tento výstupní formát je určený pro výsledky rozpoznávání řeči. K získání syntetizovaného formátu zvukového výstupu použijte [SpeechConfig.speechSynthesisOutputFormat].
region
speechRecognitionLanguage	Vrátí nakonfigurovaný jazyk.
speechSynthesisLanguage	Získá jazyk syntetizátoru řeči. Přidáno ve verzi 1.11.0.
speechSynthesisOutputFormat	Získá výstupní formát syntézy řeči. Přidáno ve verzi 1.11.0.
speechSynthesisVoiceName	Získá hlas syntetizátoru řeči. Přidáno ve verzi 1.11.0.
subscriptionKey

Metody

close()	Zavře konfiguraci.
enableAudioLogging()	Povolte protokolování zvuku ve službě. Protokoly zvuku a obsahu se ukládají buď do úložiště vlastněného Microsoftem, nebo do vašeho vlastního účtu úložiště propojeného s vaším předplatným služeb Cognitive Services (prostředek služby Speech s podporou funkce Přineste si vlastní úložiště (BYOS). Protokoly se odeberou po 30 dnech. Přidáno ve verzi 1.7.0.
enableDictation()	Povolte diktování. Podporuje se jenom v nepřetržitém rozpoznávání řeči. Přidáno ve verzi 1.7.0.
fromAuthorizationToken(string, string)	Vytvoří instanci objektu pro vytváření řeči se zadaným počátečním autorizačním tokenem a oblastí. Poznámka: Volající musí ověřit platnost autorizačního tokenu. Před vypršením platnosti autorizačního tokenu ho volající musí aktualizovat zavoláním tohoto setteru s novým platným tokenem. Poznámka: Pokud chcete použít rozpoznávání záměru, použijte token odvozený z klíče předplatného LanguageUnderstanding. Při kopírování konfiguračních hodnot při vytváření nového nástroje pro rozpoznávání se nová hodnota tokenu nebude vztahovat na nástroje pro rozpoznávání, které už byly vytvořeny. Pro rozpoznávání, které byly vytvořeny dříve, musíte nastavit autorizační token odpovídajícího nástroje pro rozpoznávání, aby se token aktualizoval. V opačném případě se rozpoznávání při rozpoznávání setká s chybami.
fromEndpoint(URL, string)	Vytvoří instanci konfigurace řeči se zadaným koncovým bodem a klíčem předplatného. Tato metoda je určená jenom uživatelům, kteří používají nestandardní koncový bod služby nebo parametry. Poznámka: Pokud chcete použít rozpoznávání záměru, použijte klíč předplatného LanguageUnderstanding. Poznámka: Parametry dotazu zadané v adrese URL koncového bodu se nezmění, a to ani v případě, že jsou nastavené jinými rozhraními API. Pokud je například jazyk definovaný v identifikátoru URI jako parametr dotazu "language=de-DE" a také nastavený parametrem SpeechConfig.speechRecognitionLanguage = "en-US", bude mít přednost nastavení jazyka v identifikátoru URI a efektivní jazyk je "de-DE". Jiná rozhraní API můžou nastavit jenom parametry, které nejsou zadané v adrese URL koncového bodu. Poznámka: Pokud chcete použít autorizační token s parametrem fromEndpoint, předejte prázdný řetězec subscriptionKey v metodě fromEndpoint a pak nastavte authorizationToken="token" ve vytvořené instanci SpeechConfig tak, aby používala autorizační token.
fromHost(URL, string)	Vytvoří instanci konfigurace řeči se zadaným klíčem hostitele a předplatného. Tato metoda je určena pouze pro uživatele, kteří používají jiné než výchozí hostitele služby. Předpokládá se standardní cesta k prostředku. Pro služby s nestandardní cestou k prostředku nebo vůbec žádnou cestou použijte fromEndpoint. Poznámka: Parametry dotazu nejsou v identifikátoru URI hostitele povoleny a musí být nastaveny jinými rozhraními API. Poznámka: Pokud chcete použít autorizační token s parametrem fromHost, použijte fromHost(URL) a pak nastavte vlastnost AuthorizationToken ve vytvořené instanci SpeechConfig. Poznámka: Přidáno ve verzi 1.9.0.
fromSubscription(string, string)	Statická instance SpeechConfig vrácená předáním subscriptionKey a oblasti služby. Poznámka: Pokud chcete použít rozpoznávání záměru, použijte klíč předplatného LanguageUnderstanding.
getProperty(string, string)	Vrátí aktuální hodnotu libovolné vlastnosti.
requestWordLevelTimestamps()	Zahrnuje časová razítka na úrovni slov. Přidáno ve verzi 1.7.0.
setProfanity(ProfanityOption)	Nastaví možnost vulgárních výrazů. Přidáno ve verzi 1.7.0.
setProperty(string | PropertyId, string)	Nastaví libovolnou vlastnost.
setProxy(string, number)	Nastaví konfiguraci proxy serveru. Relevantní pouze v Node.js prostředích. Přidáno ve verzi 1.4.0.
setProxy(string, number, string, string)	Nastaví konfiguraci proxy serveru. Relevantní pouze v Node.js prostředích. Přidáno ve verzi 1.4.0.
setServiceProperty(string, string, UriQueryParameter)	Nastaví hodnotu vlastnosti, která se předá službě pomocí zadaného kanálu. Přidáno ve verzi 1.7.0.

Podrobnosti vlastnosti

authorizationToken

Získá autorizační token.

string authorizationToken

Hodnota vlastnosti

string

endpointId

Získá ID koncového bodu přizpůsobeného modelu řeči, který se používá pro rozpoznávání řeči.

string endpointId

Hodnota vlastnosti

string

ID koncového bodu

outputFormat

Získá výstupní formát rozpoznávání řeči (jednoduchý nebo podrobný). Poznámka: Tento výstupní formát je určený pro výsledky rozpoznávání řeči. K získání syntetizovaného formátu zvukového výstupu použijte [SpeechConfig.speechSynthesisOutputFormat].

OutputFormat outputFormat

Hodnota vlastnosti

OutputFormat

Vrátí výstupní formát.

region

string region

Hodnota vlastnosti

string

Oblast nastavená v konfiguraci.

speechRecognitionLanguage

Vrátí nakonfigurovaný jazyk.

string speechRecognitionLanguage

Hodnota vlastnosti

string

speechSynthesisLanguage

Získá jazyk syntetizátoru řeči. Přidáno ve verzi 1.11.0.

string speechSynthesisLanguage

Hodnota vlastnosti

string

Vrátí jazyk syntézy řeči.

speechSynthesisOutputFormat

Získá výstupní formát syntézy řeči. Přidáno ve verzi 1.11.0.

SpeechSynthesisOutputFormat speechSynthesisOutputFormat

Hodnota vlastnosti

SpeechSynthesisOutputFormat

Vrátí výstupní formát syntézy řeči.

speechSynthesisVoiceName

Získá hlas syntetizátoru řeči. Přidáno ve verzi 1.11.0.

string speechSynthesisVoiceName

Hodnota vlastnosti

string

Vrátí hlas syntézy řeči.

subscriptionKey

string subscriptionKey

Hodnota vlastnosti

string

Klíč předplatného nastavený v konfiguraci.

Podrobnosti metody

close()

Zavře konfiguraci.

function close()

enableAudioLogging()

Povolte protokolování zvuku ve službě. Protokoly zvuku a obsahu se ukládají buď do úložiště vlastněného Microsoftem, nebo do vašeho vlastního účtu úložiště propojeného s vaším předplatným služeb Cognitive Services (prostředek služby Speech s podporou funkce Přineste si vlastní úložiště (BYOS). Protokoly se odeberou po 30 dnech. Přidáno ve verzi 1.7.0.

function enableAudioLogging()

enableDictation()

Povolte diktování. Podporuje se jenom v nepřetržitém rozpoznávání řeči. Přidáno ve verzi 1.7.0.

function enableDictation()

fromAuthorizationToken(string, string)

Vytvoří instanci objektu pro vytváření řeči se zadaným počátečním autorizačním tokenem a oblastí. Poznámka: Volající musí ověřit platnost autorizačního tokenu. Před vypršením platnosti autorizačního tokenu ho volající musí aktualizovat zavoláním tohoto setteru s novým platným tokenem. Poznámka: Pokud chcete použít rozpoznávání záměru, použijte token odvozený z klíče předplatného LanguageUnderstanding. Při kopírování konfiguračních hodnot při vytváření nového nástroje pro rozpoznávání se nová hodnota tokenu nebude vztahovat na nástroje pro rozpoznávání, které už byly vytvořeny. Pro rozpoznávání, které byly vytvořeny dříve, musíte nastavit autorizační token odpovídajícího nástroje pro rozpoznávání, aby se token aktualizoval. V opačném případě se rozpoznávání při rozpoznávání setká s chybami.

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

Parametry

authorizationToken

string

Počáteční autorizační token.

region

string

Název oblasti (viz stránka oblasti).

Návraty

SpeechConfig

Instance objektu pro vytváření řeči

fromEndpoint(URL, string)

Vytvoří instanci konfigurace řeči se zadaným koncovým bodem a klíčem předplatného. Tato metoda je určená jenom uživatelům, kteří používají nestandardní koncový bod služby nebo parametry. Poznámka: Pokud chcete použít rozpoznávání záměru, použijte klíč předplatného LanguageUnderstanding. Poznámka: Parametry dotazu zadané v adrese URL koncového bodu se nezmění, a to ani v případě, že jsou nastavené jinými rozhraními API. Pokud je například jazyk definovaný v identifikátoru URI jako parametr dotazu "language=de-DE" a také nastavený parametrem SpeechConfig.speechRecognitionLanguage = "en-US", bude mít přednost nastavení jazyka v identifikátoru URI a efektivní jazyk je "de-DE". Jiná rozhraní API můžou nastavit jenom parametry, které nejsou zadané v adrese URL koncového bodu. Poznámka: Pokud chcete použít autorizační token s parametrem fromEndpoint, předejte prázdný řetězec subscriptionKey v metodě fromEndpoint a pak nastavte authorizationToken="token" ve vytvořené instanci SpeechConfig tak, aby používala autorizační token.

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

Parametry

endpoint

URL

Koncový bod služby, ke kterému se chcete připojit.

subscriptionKey

string

Klíč předplatného. Pokud není klíč předplatného zadaný, musí se nastavit autorizační token.

Návraty

SpeechConfig

Instance objektu pro vytváření řeči

fromHost(URL, string)

Vytvoří instanci konfigurace řeči se zadaným klíčem hostitele a předplatného. Tato metoda je určena pouze pro uživatele, kteří používají jiné než výchozí hostitele služby. Předpokládá se standardní cesta k prostředku. Pro služby s nestandardní cestou k prostředku nebo vůbec žádnou cestou použijte fromEndpoint. Poznámka: Parametry dotazu nejsou v identifikátoru URI hostitele povoleny a musí být nastaveny jinými rozhraními API. Poznámka: Pokud chcete použít autorizační token s parametrem fromHost, použijte fromHost(URL) a pak nastavte vlastnost AuthorizationToken ve vytvořené instanci SpeechConfig. Poznámka: Přidáno ve verzi 1.9.0.

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

Parametry

hostName

URL

subscriptionKey

string

Klíč předplatného. Pokud není klíč předplatného zadaný, musí se nastavit autorizační token.

Návraty

SpeechConfig

Instance objektu pro vytváření řeči

fromSubscription(string, string)

Statická instance SpeechConfig vrácená předáním subscriptionKey a oblasti služby. Poznámka: Pokud chcete použít rozpoznávání záměru, použijte klíč předplatného LanguageUnderstanding.

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

Parametry

subscriptionKey

string

Klíč předplatného.

region

string

Název oblasti (viz stránka oblasti).

Návraty

SpeechConfig

Objekt pro vytváření řeči

getProperty(string, string)

Vrátí aktuální hodnotu libovolné vlastnosti.

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

Parametry

name

string

Název vlastnosti, která se má dotazovat.

def

string

Hodnota, která se má vrátit v případě, že vlastnost není známa.

Návraty

string

Aktuální nebo zadaná výchozí hodnota dané vlastnosti.

requestWordLevelTimestamps()

Zahrnuje časová razítka na úrovni slov. Přidáno ve verzi 1.7.0.

function requestWordLevelTimestamps()

setProfanity(ProfanityOption)

Nastaví možnost vulgárních výrazů. Přidáno ve verzi 1.7.0.

function setProfanity(profanity: ProfanityOption)

Parametry

profanity

ProfanityOption

setProperty(string | PropertyId, string)

Nastaví libovolnou vlastnost.

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

Parametry

name

string | PropertyId

Název vlastnosti, kterou chcete nastavit.

value

string

Nová hodnota vlastnosti.

setProxy(string, number)

Nastaví konfiguraci proxy serveru. Relevantní pouze v Node.js prostředích. Přidáno ve verzi 1.4.0.

function setProxy(proxyHostName: string, proxyPort: number)

Parametry

proxyHostName

string

Název hostitele proxy serveru.

proxyPort

number

Číslo portu proxy serveru.

setProxy(string, number, string, string)

Nastaví konfiguraci proxy serveru. Relevantní pouze v Node.js prostředích. Přidáno ve verzi 1.4.0.

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

Parametry

proxyHostName

string

Název hostitele proxy serveru bez schématu protokolu (http://)

proxyPort

number

Číslo portu proxy serveru.

proxyUserName

string

Uživatelské jméno proxy serveru.

proxyPassword

string

Heslo proxy serveru.

setServiceProperty(string, string, UriQueryParameter)

Nastaví hodnotu vlastnosti, která se předá službě pomocí zadaného kanálu. Přidáno ve verzi 1.7.0.

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

Parametry

name

string

value

string

channel

UriQueryParameter