Udostępnij za pośrednictwem

class SpeechConfig

  • Artykuł

Klasa, która definiuje konfiguracje rozpoznawania mowy/intencji lub syntezy mowy.

Elementy członkowskie

EmbeddedSpeechConfig

Składnia: public friend EmbeddedSpeechConfig;

HybridSpeechConfig

Składnia: public friend HybridSpeechConfig;

operator SPXSPEECHCONFIGHANDLE

Składnia: public inline explicit operator SPXSPEECHCONFIGHANDLE ( ) const;

Operator wewnętrzny używany do pobierania wartości uchwytu bazowego.

Zwraca

Uchwyt.

SetSpeechRecognitionLanguage

Składnia: public inline void SetSpeechRecognitionLanguage ( const std::string & lang );

Ustaw język wejściowy na rozpoznawanie mowy.

Parametry

  • lang Określa nazwę języka mówionego rozpoznawanego w formacie BCP-47.

GetSpeechRecognitionLanguage

Składnia: public inline std::string GetSpeechRecognitionLanguage ( ) const;

Pobiera język wejściowy do rozpoznawania mowy. Język jest określony w formacie BCP-47.

Zwraca

Język rozpoznawania mowy.

SetSpeechSynthesisLanguage

Składnia: public inline void SetSpeechSynthesisLanguage ( const std::string & lang );

Ustawia język syntetyzatora mowy. Dodano w wersji 1.4.0.

Parametry

  • lang Określa nazwę języka (np. en-US)

GetSpeechSynthesisLanguage

Składnia: public inline std::string GetSpeechSynthesisLanguage ( ) const;

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

Zwraca

Język syntezy mowy.

SetSpeechSynthesisVoiceName

Składnia: public inline void SetSpeechSynthesisVoiceName ( const std::string & voiceName );

Ustaw głos syntetyzatora mowy. Dodano w wersji 1.4.0.

Parametry

  • voiceName Określa nazwę głosu

GetSpeechSynthesisVoiceName

Składnia: public inline std::string GetSpeechSynthesisVoiceName ( ) const;

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

Zwraca

Nazwa głosu syntezy mowy.

SetSpeechSynthesisOutputFormat

Składnia: public inline void SetSpeechSynthesisOutputFormat ( SpeechSynthesisOutputFormat formatId );

Ustawia format danych wyjściowych syntezy mowy (np. Riff16Khz16BitMonoPcm). Dodano w wersji 1.4.0.

Parametry

  • formatId Określa identyfikator formatu danych wyjściowych

GetSpeechSynthesisOutputFormat

Składnia: public inline std::string GetSpeechSynthesisOutputFormat ( ) const;

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

Zwraca

Format danych wyjściowych syntezy mowy.

SetEndpointId

Składnia: public inline void SetEndpointId ( const std::string & endpointId );

Ustawia identyfikator punktu końcowego usługi Custom Speech lub Custom Voice.

Parametry

  • endpointId Identyfikator punktu końcowego.

GetEndpointId

Składnia: public inline std::string GetEndpointId ( ) const;

Pobiera identyfikator punktu końcowego usługi Custom Speech lub Custom Voice.

Zwraca

Identyfikator punktu końcowego.

SetAuthorizationToken

Składnia: public inline void SetAuthorizationToken ( const std::string & token );

Ustawia token autoryzacji, aby nawiązać połączenie z usługą. 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. 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.

Parametry

  • token Token autoryzacji.

GetAuthorizationToken

Składnia: public inline std::string GetAuthorizationToken ( ) const;

Pobiera token autoryzacji w celu nawiązania połączenia z usługą.

Zwraca

Token autoryzacji.

GetSubscriptionKey

Składnia: public inline std::string GetSubscriptionKey ( ) const;

Pobiera klucz subskrypcji, który jest używany do tworzenia rozpoznawania mowy lub rozpoznawania intencji albo rozpoznawania translacji lub syntetyzatora mowy.

Zwraca

Klucz subskrypcji.

GetRegion

Składnia: public inline std::string GetRegion ( ) const;

Pobiera klucz regionu, który został użyty do utworzenia rozpoznawania mowy lub rozpoznawania intencji albo rozpoznawania tłumaczenia lub syntezatora mowy.

Zwraca

Region.

GetOutputFormat

Składnia: public inline OutputFormat GetOutputFormat ( ) const;

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::GetSpeechSynthesisOutputFormat , aby uzyskać syntetyzowany format danych wyjściowych dźwięku.

Zwraca

Format danych wyjściowych rozpoznawania mowy.

SetOutputFormat

Składnia: public inline void SetOutputFormat ( OutputFormat format );

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

Parametry

  • format Format danych wyjściowych rozpoznawania mowy

SetProfanity

Składnia: public inline void SetProfanity ( ProfanityOption profanity );

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

Parametry

  • profanity Wartość opcji wulgaryzmów.

EnableAudioLogging

Składnia: public inline void EnableAudioLogging ( );

Włącza rejestrowanie audio w usłudze. Dodano w wersji 1.5.0.

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.

RequestWordLevelTimestamps

Składnia: public inline void RequestWordLevelTimestamps ( );

Zawiera znaczniki czasu na poziomie wyrazów w wyniku odpowiedzi. Dodano w wersji 1.5.0.

EnableDictation

Składnia: public inline void EnableDictation ( );

Włącza tryb dyktowania. Obsługiwane tylko w funkcji rozpoznawania ciągłego rozpoznawania mowy. Dodano w wersji 1.5.0.

SetProxy

Składnia: public inline void SetProxy ( const std::string & proxyHostName , uint32_t proxyPort , const std::string & proxyUserName , const std::string & proxyPassword );

Ustawia konfigurację serwera proxy Dodano w wersji 1.1.0.

Uwaga: funkcja serwera proxy nie jest dostępna w systemie macOS. Ta funkcja nie będzie miała wpływu na tę platformę.

Parametry

  • proxyHostName Nazwa hosta serwera proxy bez schematu protokołu ([http://](http://))

  • proxyPort Numer portu serwera proxy

  • proxyUserName Nazwa użytkownika serwera proxy

  • proxyPassword Hasło serwera proxy

SetProperty

Składnia: public inline void SetProperty ( const std::string & name , const std::string & value );

Ustawia wartość właściwości według nazwy.

Parametry

  • name Nazwa właściwości.

  • value Wartość właściwości.

Getproperty

Składnia: public inline std::string GetProperty ( const std::string & name ) const;

Pobiera wartość właściwości według nazwy.

Parametry

  • name Nazwa parametru.

Zwraca

Wartość właściwości.

Getproperty

Składnia: public inline std::string GetProperty ( PropertyId id ) const;

Pobiera wartość właściwości według identyfikatora.

Parametry

  • id Identyfikator parametru.

Zwraca

Wartość właściwości.

SetProperty

Składnia: public inline void SetProperty ( PropertyId id , const std::string & value );

Ustawia wartość właściwości według identyfikatora.

Parametry

  • id Identyfikator właściwości.

  • value Wartość właściwości.

SetServiceProperty

Składnia: public inline void SetServiceProperty ( const std::string & name , const std::string & value , ServicePropertyChannel channel );

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

Parametry

  • name Nazwa właściwości.

  • value Wartość właściwości.

  • channel Kanał używany do przekazywania określonej właściwości do usługi.

~SpeechConfig

Składnia: public inline virtual ~SpeechConfig ( );

Destrukuje obiekt.

OdSubskrypcja

Składnia: public inline static std::shared_ptr< SpeechConfig > FromSubscription ( const std::string & subscription , const std::string & region );

Tworzy wystąpienie konfiguracji mowy z określonym kluczem subskrypcji i regionem.

Parametry

Zwraca

Wskaźnik udostępniony do nowego wystąpienia konfiguracji mowy.

FromAuthorizationToken

Składnia: public inline static std::shared_ptr< SpeechConfig > FromAuthorizationToken ( const std::string & authToken , const std::string & region );

Tworzy wystąpienie konfiguracji mowy z określonym 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. 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.

Parametry

Zwraca

Wskaźnik udostępniony do nowego wystąpienia konfiguracji mowy.

Z punktu końcowego

Składnia: public inline static std::shared_ptr< SpeechConfig > FromEndpoint ( const std::string & endpoint , const std::string & subscription );

Tworzy wystąpienie konfiguracji mowy z określonym punktem końcowym i subskrypcją. Ta metoda jest przeznaczona tylko dla użytkowników korzystających z nietypowego punktu końcowego usługi. Uwaga: parametry zapytania określone w identyfikatorze URI punktu końcowego nie są zmieniane, nawet jeśli są ustawione przez inne interfejsy API. Jeśli na przykład język rozpoznawania jest zdefiniowany w identyfikatorze URI jako parametr zapytania "language=de-DE", a także ustawiony przez setSpeechRecognitionLanguage("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 identyfikatorze URI punktu końcowego, można ustawić przez inne interfejsy API. Uwaga: Aby użyć tokenu autoryzacji z usługą FromEndpoint, użyj polecenia FromEndpoint(const SPXSTRING&), a następnie wywołaj metodę SetAuthorizationToken() w utworzonym wystąpieniu usługi SpeechConfig.

Parametry

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

  • subscription Klucz subskrypcji.

Zwraca

Wskaźnik udostępniony do nowego wystąpienia konfiguracji mowy.

Z punktu końcowego

Składnia: public inline static std::shared_ptr< SpeechConfig > FromEndpoint ( const std::string & endpoint );

Tworzy wystąpienie usługi SpeechConfig z określonym punktem końcowym. Ta metoda jest przeznaczona tylko dla użytkowników korzystających z nietypowego punktu końcowego usługi. Uwaga: parametry zapytania określone w identyfikatorze URI punktu końcowego nie są zmieniane, nawet jeśli są ustawione przez inne interfejsy API. Niezależnie od tego, czy określony parametr zapytania jest obsługiwany, czy nie, zależy od punktu końcowego i scenariusza. Jeśli na przykład język rozpoznawania jest zdefiniowany w identyfikatorze URI jako parametr zapytania "language=de-DE", a także ustawiony przez setSpeechRecognitionLanguage("en-US"), ustawienie języka w identyfikatorze URI ma pierwszeństwo, a efektywny język to "de-DE". Przykład ma zastosowanie tylko wtedy, gdy kombinacja punktu końcowego i scenariusza obsługuje język jako parametr zapytania. Tylko parametry, które nie zostały określone w identyfikatorze URI punktu końcowego, można ustawić przez inne interfejsy API. Uwaga: jeśli punkt końcowy wymaga klucza subskrypcji do uwierzytelniania, użyj polecenia FromEndpoint(const SPXSTRING&, const SPXSTRING&), aby przekazać klucz subskrypcji jako parametr. Aby użyć tokenu autoryzacji z programem FromEndpoint, użyj tej metody do utworzenia wystąpienia usługi SpeechConfig, a następnie wywołaj metodę SetAuthorizationToken() w utworzonym wystąpieniu usługi SpeechConfig. Uwaga: dodano w wersji 1.5.0.

Parametry

  • endpoint Identyfikator URI punktu końcowego usługi do nawiązania połączenia.

Zwraca

Wskaźnik udostępniony do nowego wystąpienia konfiguracji mowy.

FromHost

Składnia: public inline static std::shared_ptr< SpeechConfig > FromHost ( const std::string & host , const std::string & subscription );

Tworzy wystąpienie konfiguracji mowy z określonym hostem i subskrypcją. 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 elementem FromHost, użyj polecenia FromHost(const SPXSTRING&), a następnie wywołaj metodę SetAuthorizationToken() w utworzonym wystąpieniu usługi SpeechConfig. Uwaga: dodano w wersji 1.8.0.

Parametry

  • host Host usługi do nawiązania połączenia. Format to "protocol://host:port", gdzie opcja ":p ort".

  • subscription Klucz subskrypcji.

Zwraca

Wskaźnik udostępniony do nowego wystąpienia konfiguracji mowy.

FromHost

Składnia: public inline static std::shared_ptr< SpeechConfig > FromHost ( const std::string & host );

Tworzy wystąpienie usługi SpeechConfig z określonym hostem. 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: jeśli host wymaga klucza subskrypcji do uwierzytelniania, użyj polecenia FromHost(const SPXSTRING&, const SPXSTRING&), aby przekazać klucz subskrypcji jako parametr. Aby użyć tokenu autoryzacji z funkcją FromHost, użyj tej metody do utworzenia wystąpienia usługi SpeechConfig, a następnie wywołaj metodę SetAuthorizationToken() w utworzonym wystąpieniu usługi SpeechConfig. Uwaga: dodano w wersji 1.8.0.

Parametry

  • host Identyfikator URI hosta usługi do nawiązania połączenia. Format to "protocol://host:port", gdzie opcja ":p ort".

Zwraca

Wskaźnik udostępniony do nowego wystąpienia konfiguracji mowy.