Partager via

SpeechConfig class

  • Référence
Paquet:
microsoft-cognitiveservices-speech-sdk

Configuration vocale.

Propriétés

authorizationToken

Obtient le jeton d’autorisation.
endpointId

Obtient l’ID de point de terminaison d’un modèle vocal personnalisé utilisé pour la reconnaissance vocale.
outputFormat

Obtient le format de sortie de reconnaissance vocale (simple ou détaillé). Remarque : Ce format de sortie est pour le résultat de la reconnaissance vocale, utilisez [SpeechConfig.speechSynthesisOutputFormat] pour obtenir le format de sortie audio synthétisé.
region
speechRecognitionLanguage

Retourne la langue configurée.
speechSynthesisLanguage

Obtient la langue du synthétiseur vocal. Ajout dans la version 1.11.0.
speechSynthesisOutputFormat

Obtient le format de sortie de synthèse vocale. Ajout dans la version 1.11.0.
speechSynthesisVoiceName

Obtient la voix du synthétiseur vocal. Ajout dans la version 1.11.0.
subscriptionKey

Méthodes

close()

Ferme la configuration.
enableAudioLogging()

Activez la journalisation audio en service. Les journaux audio et de contenu sont stockés dans un stockage appartenant à Microsoft ou dans votre propre compte de stockage lié à votre abonnement Cognitive Services (Bring Your Own Storage (BYOS) enabled Speech ressource). Les journaux seront supprimés au bout de 30 jours. Ajout dans la version 1.7.0.
enableDictation()

Activez la dictée. Prise en charge uniquement dans la reconnaissance vocale continue. Ajout dans la version 1.7.0.
fromAuthorizationToken(string, string)

Crée un instance de la fabrique vocale avec le jeton d’autorisation initial et la région spécifiés. Remarque : l’appelant doit s’assurer que le jeton d’autorisation est valide. Avant que le jeton d’autorisation expire, l’appelant doit l’actualiser en appelant cet méthode setter avec un nouveau jeton valide. Remarque : Utilisez un jeton dérivé de votre clé d’abonnement LanguageUnderstanding au cas où vous souhaitez utiliser le module de reconnaissance d’intention. Comme les valeurs de configuration sont copiées lors de la création d’un module de reconnaissance, la nouvelle valeur de jeton ne s’applique pas aux générateurs de reconnaissance qui ont déjà été créés. Pour les éléments de reconnaissance qui ont été créés auparavant, vous devez définir le jeton d’autorisation du module de reconnaissance correspondant pour actualiser le jeton. Dans le cas contraire, les modules de reconnaissance rencontrent des erreurs lors de la reconnaissance.
fromEndpoint(URL, string)

Crée une instance de la configuration vocale avec le point de terminaison et la clé d’abonnement spécifiés. Cette méthode est destinée uniquement aux utilisateurs qui utilisent un point de terminaison ou des paramètres de service non standard. Remarque : Utilisez votre clé d’abonnement LanguageUnderstanding au cas où vous souhaitez utiliser le module de reconnaissance d’intention. Remarque : Les paramètres de requête spécifiés dans l’URL du point de terminaison ne sont pas modifiés, même s’ils sont définis par d’autres API. Par exemple, si la langue est définie dans l’URI en tant que paramètre de requête « language=de-DE », et également définie par SpeechConfig.speechRecognitionLanguage = « en-US », le paramètre de langue dans uri est prioritaire et la langue effective est « de-DE ». Seuls les paramètres qui ne sont pas spécifiés dans l’URL du point de terminaison peuvent être définis par d’autres API. Remarque : pour utiliser le jeton d’autorisation avec fromEndpoint, passez une chaîne vide à l’abonnementKey dans la méthode fromEndpoint, puis définissez authorizationToken="token » sur le instance SpeechConfig créé pour utiliser le jeton d’autorisation.
fromHost(URL, string)

Crée une instance de la configuration vocale avec l’hôte et la clé d’abonnement spécifiés. Cette méthode est destinée uniquement aux utilisateurs qui utilisent un hôte de service autre que par défaut. Le chemin d’accès aux ressources standard est supposé. Pour les services avec un chemin de ressource non standard ou aucun chemin d’accès, utilisez plutôt fromEndpoint. Remarque : Les paramètres de requête ne sont pas autorisés dans l’URI hôte et doivent être définis par d’autres API. Remarque : Pour utiliser un jeton d’autorisation avec fromHost, utilisez fromHost(URL), puis définissez la propriété AuthorizationToken sur le instance SpeechConfig créé. Remarque : Ajoutée dans la version 1.9.0.
fromSubscription(string, string)

Instance statique de SpeechConfig retourné par le passage de subscriptionKey et de la région de service. Remarque : Utilisez votre clé d’abonnement LanguageUnderstanding au cas où vous souhaitez utiliser le module de reconnaissance d’intention.
getProperty(string, string)

Retourne la valeur actuelle d’une propriété arbitraire.
requestWordLevelTimestamps()

Inclut des horodatages au niveau du mot. Ajout dans la version 1.7.0.
setProfanity(ProfanityOption)

Définit l’option de grossièreté. Ajout dans la version 1.7.0.
setProperty(string | PropertyId, string)

Définit une propriété arbitraire.
setProxy(string, number)

Définit la configuration du proxy. Applicable uniquement dans les environnements Node.js. Ajouté dans la version 1.4.0.
setProxy(string, number, string, string)

Définit la configuration du proxy. Applicable uniquement dans les environnements Node.js. Ajouté dans la version 1.4.0.
setServiceProperty(string, string, UriQueryParameter)

Définit une valeur de propriété qui sera passée au service à l’aide du canal spécifié. Ajout dans la version 1.7.0.

Détails de la propriété

authorizationToken

Obtient le jeton d’autorisation.

string authorizationToken

Valeur de propriété

string

endpointId

Obtient l’ID de point de terminaison d’un modèle vocal personnalisé utilisé pour la reconnaissance vocale.

string endpointId

Valeur de propriété

string

ID de point de terminaison

outputFormat

Obtient le format de sortie de reconnaissance vocale (simple ou détaillé). Remarque : Ce format de sortie est pour le résultat de la reconnaissance vocale, utilisez [SpeechConfig.speechSynthesisOutputFormat] pour obtenir le format de sortie audio synthétisé.

OutputFormat outputFormat

Valeur de propriété

OutputFormat

Retourne le format de sortie.

region 

string region

Valeur de propriété

string

Région définie dans la configuration.

speechRecognitionLanguage

Retourne la langue configurée.

string speechRecognitionLanguage

Valeur de propriété

string

speechSynthesisLanguage

Obtient la langue du synthétiseur vocal. Ajout dans la version 1.11.0.

string speechSynthesisLanguage

Valeur de propriété

string

Retourne la langue de synthèse vocale.

speechSynthesisOutputFormat

Obtient le format de sortie de synthèse vocale. Ajout dans la version 1.11.0.

SpeechSynthesisOutputFormat speechSynthesisOutputFormat

Valeur de propriété

SpeechSynthesisOutputFormat

Retourne le format de sortie de synthèse vocale

speechSynthesisVoiceName

Obtient la voix du synthétiseur vocal. Ajout dans la version 1.11.0.

string speechSynthesisVoiceName

Valeur de propriété

string

Retourne la voix de synthèse vocale.

subscriptionKey 

string subscriptionKey

Valeur de propriété

string

Clé d’abonnement définie dans la configuration.

Détails de la méthode

close()

Ferme la configuration.

function close()

enableAudioLogging()

Activez la journalisation audio en service. Les journaux audio et de contenu sont stockés dans un stockage appartenant à Microsoft ou dans votre propre compte de stockage lié à votre abonnement Cognitive Services (Bring Your Own Storage (BYOS) enabled Speech ressource). Les journaux seront supprimés au bout de 30 jours. Ajout dans la version 1.7.0.

function enableAudioLogging()

enableDictation()

Activez la dictée. Prise en charge uniquement dans la reconnaissance vocale continue. Ajout dans la version 1.7.0.

function enableDictation()

fromAuthorizationToken(string, string)

Crée un instance de la fabrique vocale avec le jeton d’autorisation initial et la région spécifiés. Remarque : l’appelant doit s’assurer que le jeton d’autorisation est valide. Avant que le jeton d’autorisation expire, l’appelant doit l’actualiser en appelant cet méthode setter avec un nouveau jeton valide. Remarque : Utilisez un jeton dérivé de votre clé d’abonnement LanguageUnderstanding au cas où vous souhaitez utiliser le module de reconnaissance d’intention. Comme les valeurs de configuration sont copiées lors de la création d’un module de reconnaissance, la nouvelle valeur de jeton ne s’applique pas aux générateurs de reconnaissance qui ont déjà été créés. Pour les éléments de reconnaissance qui ont été créés auparavant, vous devez définir le jeton d’autorisation du module de reconnaissance correspondant pour actualiser le jeton. Dans le cas contraire, les modules de reconnaissance rencontrent des erreurs lors de la reconnaissance.

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

Paramètres

authorizationToken

string

Jeton d’autorisation initial.

region

string

Nom de la région (voir la page région).

Retours

SpeechConfig

Une fabrique de parole instance.

fromEndpoint(URL, string)

Crée une instance de la configuration vocale avec le point de terminaison et la clé d’abonnement spécifiés. Cette méthode est destinée uniquement aux utilisateurs qui utilisent un point de terminaison ou des paramètres de service non standard. Remarque : Utilisez votre clé d’abonnement LanguageUnderstanding au cas où vous souhaitez utiliser le module de reconnaissance d’intention. Remarque : Les paramètres de requête spécifiés dans l’URL du point de terminaison ne sont pas modifiés, même s’ils sont définis par d’autres API. Par exemple, si la langue est définie dans l’URI en tant que paramètre de requête « language=de-DE », et également définie par SpeechConfig.speechRecognitionLanguage = « en-US », le paramètre de langue dans uri est prioritaire et la langue effective est « de-DE ». Seuls les paramètres qui ne sont pas spécifiés dans l’URL du point de terminaison peuvent être définis par d’autres API. Remarque : pour utiliser le jeton d’autorisation avec fromEndpoint, passez une chaîne vide à l’abonnementKey dans la méthode fromEndpoint, puis définissez authorizationToken="token » sur le instance SpeechConfig créé pour utiliser le jeton d’autorisation.

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

Paramètres

endpoint

URL

Point de terminaison de service auquel se connecter.

subscriptionKey

string

Clé d’abonnement. Si aucune clé d’abonnement n’est spécifiée, un jeton d’autorisation doit être défini.

Retours

SpeechConfig

Une fabrique de parole instance.

fromHost(URL, string)

Crée une instance de la configuration vocale avec l’hôte et la clé d’abonnement spécifiés. Cette méthode est destinée uniquement aux utilisateurs qui utilisent un hôte de service autre que par défaut. Le chemin d’accès aux ressources standard est supposé. Pour les services avec un chemin de ressource non standard ou aucun chemin d’accès, utilisez plutôt fromEndpoint. Remarque : Les paramètres de requête ne sont pas autorisés dans l’URI hôte et doivent être définis par d’autres API. Remarque : Pour utiliser un jeton d’autorisation avec fromHost, utilisez fromHost(URL), puis définissez la propriété AuthorizationToken sur le instance SpeechConfig créé. Remarque : Ajoutée dans la version 1.9.0.

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

Paramètres

hostName

URL

subscriptionKey

string

Clé d’abonnement. Si aucune clé d’abonnement n’est spécifiée, un jeton d’autorisation doit être défini.

Retours

SpeechConfig

Une fabrique de parole instance.

fromSubscription(string, string)

Instance statique de SpeechConfig retourné par le passage de subscriptionKey et de la région de service. Remarque : Utilisez votre clé d’abonnement LanguageUnderstanding au cas où vous souhaitez utiliser le module de reconnaissance d’intention.

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

Paramètres

subscriptionKey

string

Clé d’abonnement.

region

string

Nom de la région (voir la page région).

Retours

SpeechConfig

La fabrique vocale

getProperty(string, string)

Retourne la valeur actuelle d’une propriété arbitraire.

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

Paramètres

name

string

Nom de la propriété à interroger.

def

string

Valeur à retourner si la propriété n’est pas connue.

Retours

string

Valeur actuelle, ou valeur par défaut fournie, de la propriété donnée.

requestWordLevelTimestamps()

Inclut des horodatages au niveau du mot. Ajout dans la version 1.7.0.

function requestWordLevelTimestamps()

setProfanity(ProfanityOption)

Définit l’option de grossièreté. Ajout dans la version 1.7.0.

function setProfanity(profanity: ProfanityOption)

Paramètres

profanity
ProfanityOption

setProperty(string | PropertyId, string)

Définit une propriété arbitraire.

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

Paramètres

name

string | PropertyId

Nom de la propriété à définir.

value

string

Nouvelle valeur de la propriété.

setProxy(string, number)

Définit la configuration du proxy. Applicable uniquement dans les environnements Node.js. Ajouté dans la version 1.4.0.

function setProxy(proxyHostName: string, proxyPort: number)

Paramètres

proxyHostName

string

Nom d’hôte du serveur proxy.

proxyPort

number

Numéro de port du serveur proxy.

setProxy(string, number, string, string)

Définit la configuration du proxy. Applicable uniquement dans les environnements Node.js. Ajouté dans la version 1.4.0.

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

Paramètres

proxyHostName

string

Nom d’hôte du serveur proxy, sans le schéma de protocole (http://)

proxyPort

number

Numéro de port du serveur proxy.

proxyUserName

string

Nom d’utilisateur du serveur proxy.

proxyPassword

string

Mot de passe du serveur proxy.

setServiceProperty(string, string, UriQueryParameter)

Définit une valeur de propriété qui sera passée au service à l’aide du canal spécifié. Ajout dans la version 1.7.0.

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

Paramètres

name

string

value

string

channel
UriQueryParameter