SpeechConfig class

Pakiet:

microsoft-cognitiveservices-speech-sdk

Konfiguracja mowy.

Właściwości

authorizationToken	Pobiera token autoryzacji.
endpointId	Pobiera identyfikator punktu końcowego dostosowanego modelu mowy używanego do rozpoznawania mowy.
outputFormat	Pobiera format danych wyjściowych rozpoznawania mowy (prosty lub szczegółowy). Uwaga: Ten format danych wyjściowych jest przeznaczony dla wyniku rozpoznawania mowy, użyj polecenia [SpeechConfig.speechSynthesisOutputFormat], aby uzyskać syntetyzowany format danych wyjściowych dźwięku.
region
speechRecognitionLanguage	Zwraca skonfigurowany język.
speechSynthesisLanguage	Pobiera język syntezatora mowy. Dodano w wersji 1.11.0.
speechSynthesisOutputFormat	Pobiera format danych wyjściowych syntezy mowy. Dodano w wersji 1.11.0.
speechSynthesisVoiceName	Pobiera głos syntetyzatora mowy. Dodano w wersji 1.11.0.
subscriptionKey

Metody

close()	Zamyka konfigurację.
enableAudioLogging()	Włącz rejestrowanie audio w usłudze. Dzienniki audio i zawartości są przechowywane w magazynie należącym do firmy Microsoft lub na własnym koncie magazynu połączonym z subskrypcją usług Cognitive Services (Bring Your Own Storage (BYOS) z włączoną usługą Mowa. Dzienniki zostaną usunięte po upływie 30 dni. Dodano w wersji 1.7.0.
enableDictation()	Włącz dyktowanie. Obsługiwane tylko w funkcji rozpoznawania ciągłego rozpoznawania mowy. Dodano w wersji 1.7.0.
fromAuthorizationToken(string, string)	Tworzy wystąpienie fabryki mowy z określonym początkowym tokenem autoryzacji i regionem. Uwaga: obiekt wywołujący musi upewnić się, że token autoryzacji jest prawidłowy. Przed wygaśnięciem tokenu autoryzacji obiekt wywołujący musi go odświeżyć, wywołując ten setter z nowym prawidłowym tokenem. Uwaga: użyj tokenu pochodzącego z klucza subskrypcji LanguageUnderstanding, jeśli chcesz użyć rozpoznawania intencji. Ponieważ wartości konfiguracji są kopiowane podczas tworzenia nowego rozpoznawania, nowa wartość tokenu nie będzie stosowana do elementów rozpoznających, które zostały już utworzone. W przypadku rozpoznawania utworzonych wcześniej należy ustawić token autoryzacji odpowiedniego rozpoznawania, aby odświeżyć token. W przeciwnym razie podczas rozpoznawania wystąpią błędy rozpoznawania.
fromEndpoint(URL, string)	Tworzy wystąpienie konfiguracji mowy z określonym punktem końcowym i kluczem subskrypcji. Ta metoda jest przeznaczona tylko dla użytkowników korzystających z niestandardowego punktu końcowego lub parametrów usługi. Uwaga: użyj klucza subskrypcji LanguageUnderstanding, jeśli chcesz użyć rozpoznawania intencji. Uwaga: parametry zapytania określone w adresie URL punktu końcowego nie są zmieniane, nawet jeśli są ustawione przez inne interfejsy API. Jeśli na przykład język jest zdefiniowany w identyfikatorze URI jako parametr zapytania "language=de-DE", a także ustawiony przez speechConfig.speechRecognitionLanguage = "en-US", ustawienie języka w identyfikatorze URI ma pierwszeństwo, a efektywny język to "de-DE". Tylko parametry, które nie zostały określone w adresie URL punktu końcowego, można ustawić przez inne interfejsy API. Uwaga: Aby użyć tokenu autoryzacji z parametrem fromEndpoint, przekaż pusty ciąg do elementu subscriptionKey w metodzie fromEndpoint, a następnie ustaw wartość authorizationToken="token" w utworzonym wystąpieniu usługi SpeechConfig, aby użyć tokenu autoryzacji.
fromHost(URL, string)	Tworzy wystąpienie konfiguracji mowy z określonym hostem i kluczem subskrypcji. Ta metoda jest przeznaczona tylko dla użytkowników korzystających z hosta usługi innej niż domyślna. Założono, że zostanie założona standardowa ścieżka zasobu. W przypadku usług z niestandardową ścieżką zasobu lub żadną ścieżką należy zamiast tego użyć polecenia fromEndpoint. Uwaga: parametry zapytania nie są dozwolone w identyfikatorze URI hosta i muszą być ustawione przez inne interfejsy API. Uwaga: Aby użyć tokenu autoryzacji z parametrem fromHost, użyj właściwości fromHost(URL), a następnie ustaw właściwość AuthorizationToken w utworzonym wystąpieniu usługi SpeechConfig. Uwaga: dodano w wersji 1.9.0.
fromSubscription(string, string)	Statyczne wystąpienie usługi SpeechConfig zwrócone przez przekazanie wartości subscriptionKey i regionu usługi. Uwaga: użyj klucza subskrypcji LanguageUnderstanding, jeśli chcesz użyć rozpoznawania intencji.
getProperty(string, string)	Zwraca bieżącą wartość dowolnej właściwości.
requestWordLevelTimestamps()	Zawiera znaczniki czasu na poziomie wyrazów. Dodano w wersji 1.7.0.
setProfanity(ProfanityOption)	Ustawia opcję wulgaryzmów. Dodano w wersji 1.7.0.
setProperty(string | PropertyId, string)	Ustawia dowolną właściwość.
setProxy(string, number)	Ustawia konfigurację serwera proxy. Dotyczy tylko środowisk Node.js. Dodano w wersji 1.4.0.
setProxy(string, number, string, string)	Ustawia konfigurację serwera proxy. Dotyczy tylko środowisk Node.js. Dodano w wersji 1.4.0.
setServiceProperty(string, string, UriQueryParameter)	Ustawia wartość właściwości, która zostanie przekazana do usługi przy użyciu określonego kanału. Dodano w wersji 1.7.0.

Szczegóły właściwości

authorizationToken

Pobiera token autoryzacji.

string authorizationToken

Wartość właściwości

string

endpointId

Pobiera identyfikator punktu końcowego dostosowanego modelu mowy używanego do rozpoznawania mowy.

string endpointId

Wartość właściwości

string

Identyfikator punktu końcowego

outputFormat

Pobiera format danych wyjściowych rozpoznawania mowy (prosty lub szczegółowy). Uwaga: Ten format danych wyjściowych jest przeznaczony dla wyniku rozpoznawania mowy, użyj polecenia [SpeechConfig.speechSynthesisOutputFormat], aby uzyskać syntetyzowany format danych wyjściowych dźwięku.

OutputFormat outputFormat

Wartość właściwości

OutputFormat

Zwraca format danych wyjściowych.

region

string region

Wartość właściwości

string

Region ustawiony w konfiguracji.

speechRecognitionLanguage

Zwraca skonfigurowany język.

string speechRecognitionLanguage

Wartość właściwości

string

speechSynthesisLanguage

Pobiera język syntezatora mowy. Dodano w wersji 1.11.0.

string speechSynthesisLanguage

Wartość właściwości

string

Zwraca język syntezy mowy.

speechSynthesisOutputFormat

Pobiera format danych wyjściowych syntezy mowy. Dodano w wersji 1.11.0.

SpeechSynthesisOutputFormat speechSynthesisOutputFormat

Wartość właściwości

SpeechSynthesisOutputFormat

Zwraca format danych wyjściowych syntezy mowy

speechSynthesisVoiceName

Pobiera głos syntetyzatora mowy. Dodano w wersji 1.11.0.

string speechSynthesisVoiceName

Wartość właściwości

string

Zwraca głos syntezy mowy.

subscriptionKey

string subscriptionKey

Wartość właściwości

string

Klucz subskrypcji ustawiony w konfiguracji.

Szczegóły metody

close()

Zamyka konfigurację.

function close()

enableAudioLogging()

Włącz rejestrowanie audio w usłudze. Dzienniki audio i zawartości są przechowywane w magazynie należącym do firmy Microsoft lub na własnym koncie magazynu połączonym z subskrypcją usług Cognitive Services (Bring Your Own Storage (BYOS) z włączoną usługą Mowa. Dzienniki zostaną usunięte po upływie 30 dni. Dodano w wersji 1.7.0.

function enableAudioLogging()

enableDictation()

Włącz dyktowanie. Obsługiwane tylko w funkcji rozpoznawania ciągłego rozpoznawania mowy. Dodano w wersji 1.7.0.

function enableDictation()

fromAuthorizationToken(string, string)

Tworzy wystąpienie fabryki mowy z określonym początkowym tokenem autoryzacji i regionem. Uwaga: obiekt wywołujący musi upewnić się, że token autoryzacji jest prawidłowy. Przed wygaśnięciem tokenu autoryzacji obiekt wywołujący musi go odświeżyć, wywołując ten setter z nowym prawidłowym tokenem. Uwaga: użyj tokenu pochodzącego z klucza subskrypcji LanguageUnderstanding, jeśli chcesz użyć rozpoznawania intencji. Ponieważ wartości konfiguracji są kopiowane podczas tworzenia nowego rozpoznawania, nowa wartość tokenu nie będzie stosowana do elementów rozpoznających, które zostały już utworzone. W przypadku rozpoznawania utworzonych wcześniej należy ustawić token autoryzacji odpowiedniego rozpoznawania, aby odświeżyć token. W przeciwnym razie podczas rozpoznawania wystąpią błędy rozpoznawania.

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

Parametry

authorizationToken

string

Początkowy token autoryzacji.

region

string

Nazwa regionu (zobacz stronę regionów).

Zwraca

SpeechConfig

Wystąpienie fabryki mowy.

fromEndpoint(URL, string)

Tworzy wystąpienie konfiguracji mowy z określonym punktem końcowym i kluczem subskrypcji. Ta metoda jest przeznaczona tylko dla użytkowników korzystających z niestandardowego punktu końcowego lub parametrów usługi. Uwaga: użyj klucza subskrypcji LanguageUnderstanding, jeśli chcesz użyć rozpoznawania intencji. Uwaga: parametry zapytania określone w adresie URL punktu końcowego nie są zmieniane, nawet jeśli są ustawione przez inne interfejsy API. Jeśli na przykład język jest zdefiniowany w identyfikatorze URI jako parametr zapytania "language=de-DE", a także ustawiony przez speechConfig.speechRecognitionLanguage = "en-US", ustawienie języka w identyfikatorze URI ma pierwszeństwo, a efektywny język to "de-DE". Tylko parametry, które nie zostały określone w adresie URL punktu końcowego, można ustawić przez inne interfejsy API. Uwaga: Aby użyć tokenu autoryzacji z parametrem fromEndpoint, przekaż pusty ciąg do elementu subscriptionKey w metodzie fromEndpoint, a następnie ustaw wartość authorizationToken="token" w utworzonym wystąpieniu usługi SpeechConfig, aby użyć tokenu autoryzacji.

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

Parametry

endpoint

URL

Punkt końcowy usługi do nawiązania połączenia.

subscriptionKey

string

Klucz subskrypcji. Jeśli klucz subskrypcji nie zostanie określony, należy ustawić token autoryzacji.

Zwraca

SpeechConfig

Wystąpienie fabryki mowy.

fromHost(URL, string)

Tworzy wystąpienie konfiguracji mowy z określonym hostem i kluczem subskrypcji. Ta metoda jest przeznaczona tylko dla użytkowników korzystających z hosta usługi innej niż domyślna. Założono, że zostanie założona standardowa ścieżka zasobu. W przypadku usług z niestandardową ścieżką zasobu lub żadną ścieżką należy zamiast tego użyć polecenia fromEndpoint. Uwaga: parametry zapytania nie są dozwolone w identyfikatorze URI hosta i muszą być ustawione przez inne interfejsy API. Uwaga: Aby użyć tokenu autoryzacji z parametrem fromHost, użyj właściwości fromHost(URL), a następnie ustaw właściwość AuthorizationToken w utworzonym wystąpieniu usługi SpeechConfig. Uwaga: dodano w wersji 1.9.0.

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

Parametry

hostName

URL

subscriptionKey

string

Klucz subskrypcji. Jeśli klucz subskrypcji nie zostanie określony, należy ustawić token autoryzacji.

Zwraca

SpeechConfig

Wystąpienie fabryki mowy.

fromSubscription(string, string)

Statyczne wystąpienie usługi SpeechConfig zwrócone przez przekazanie wartości subscriptionKey i regionu usługi. Uwaga: użyj klucza subskrypcji LanguageUnderstanding, jeśli chcesz użyć rozpoznawania intencji.

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

Parametry

subscriptionKey

string

Klucz subskrypcji.

region

string

Nazwa regionu (zobacz stronę regionów).

Zwraca

SpeechConfig

Fabryka mowy

getProperty(string, string)

Zwraca bieżącą wartość dowolnej właściwości.

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

Parametry

name

string

Nazwa właściwości, która ma być wysyłana do zapytania.

def

string

Wartość zwracana w przypadku, gdy właściwość nie jest znana.

Zwraca

string

Bieżąca wartość lub podana wartość domyślna danej właściwości.

requestWordLevelTimestamps()

Zawiera znaczniki czasu na poziomie wyrazów. Dodano w wersji 1.7.0.

function requestWordLevelTimestamps()

setProfanity(ProfanityOption)

Ustawia opcję wulgaryzmów. Dodano w wersji 1.7.0.

function setProfanity(profanity: ProfanityOption)

Parametry

profanity

ProfanityOption

setProperty(string | PropertyId, string)

Ustawia dowolną właściwość.

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

Parametry

name

string | PropertyId

Nazwa właściwości do ustawienia.

value

string

Nowa wartość właściwości.

setProxy(string, number)

Ustawia konfigurację serwera proxy. Dotyczy tylko środowisk Node.js. Dodano w wersji 1.4.0.

function setProxy(proxyHostName: string, proxyPort: number)

Parametry

proxyHostName

string

Nazwa hosta serwera proxy.

proxyPort

number

Numer portu serwera proxy.

setProxy(string, number, string, string)

Ustawia konfigurację serwera proxy. Dotyczy tylko środowisk Node.js. Dodano w wersji 1.4.0.

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

Parametry

proxyHostName

string

Nazwa hosta serwera proxy bez schematu protokołu (http://)

proxyPort

number

Numer portu serwera proxy.

proxyUserName

string

Nazwa użytkownika serwera proxy.

proxyPassword

string

Hasło serwera proxy.

setServiceProperty(string, string, UriQueryParameter)

Ustawia wartość właściwości, która zostanie przekazana do usługi przy użyciu określonego kanału. Dodano w wersji 1.7.0.

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

Parametry

name

string

value

string

channel

UriQueryParameter