SpeechConfig class

  • Referencia
Paquete:
microsoft-cognitiveservices-speech-sdk

Configuración de voz.

Propiedades

authorizationToken

Obtiene el token de autorización.
endpointId

Obtiene el identificador de punto de conexión de un modelo de voz personalizado que se usa para el reconocimiento de voz.
outputFormat

Obtiene el formato de salida del reconocimiento de voz (simple o detallado). Nota: Este formato de salida es para el resultado del reconocimiento de voz, use [SpeechConfig.speechSynthesisOutputFormat] para obtener el formato de salida de audio sintetizado.
region
speechRecognitionLanguage

Devuelve el idioma configurado.
speechSynthesisLanguage

Obtiene el idioma del sintetizador de voz. Se agregó en la versión 1.11.0.
speechSynthesisOutputFormat

Obtiene el formato de salida de síntesis de voz. Se agregó en la versión 1.11.0.
speechSynthesisVoiceName

Obtiene la voz del sintetizador de voz. Se agregó en la versión 1.11.0.
subscriptionKey

Métodos

close()

Cierra la configuración.
enableAudioLogging()

Habilite el registro de audio en el servicio. Los registros de audio y contenido se almacenan en el almacenamiento propiedad de Microsoft o en su propia cuenta de almacenamiento vinculada a la suscripción de Cognitive Services (Bring Your Own Storage [BYOS]) habilitado para el recurso de voz). Los registros se quitarán después de 30 días. Se agregó en la versión 1.7.0.
enableDictation()

Habilite el dictado. Solo se admite en el reconocimiento continuo de voz. Se agregó en la versión 1.7.0.
fromAuthorizationToken(string, string)

Crea una instancia de la factoría de voz con el token de autorización inicial y la región especificados. Nota: El autor de la llamada debe asegurarse de que el token de autorización es válido. Antes de que expire el token de autorización, el autor de la llamada debe actualizarlo llamando a este establecedor con un nuevo token válido. Nota: Use un token derivado de la clave de suscripción LanguageUnderstanding en caso de que desee usar el reconocedor de intenciones. Como los valores de configuración se copian al crear un nuevo reconocedor, el nuevo valor de token no se aplicará a los reconocedores que ya se han creado. Para los reconocedores que se han creado antes, debe establecer el token de autorización del reconocedor correspondiente para actualizar el token. De lo contrario, los reconocedores encontrarán errores durante el reconocimiento.
fromEndpoint(URL, string)

Crea una instancia de la configuración de voz con el punto de conexión y la clave de suscripción especificados. Este método está pensado solo para los usuarios que usan un punto de conexión de servicio o parámetros no estándar. Nota: Use la clave de suscripción LanguageUnderstanding en caso de que desee usar el reconocedor de intenciones. Nota: Los parámetros de consulta especificados en la dirección URL del punto de conexión no se cambian, incluso si se establecen mediante otras API. Por ejemplo, si el idioma se define en el URI como parámetro de consulta "language=de-DE", y también se establece mediante SpeechConfig.speechRecognitionLanguage = "en-US", la configuración de idioma en URI tiene prioridad y el idioma efectivo es "de-DE". Solo los parámetros que no se especifican en la dirección URL del punto de conexión se pueden establecer mediante otras API. Nota: Para usar el token de autorización con fromEndpoint, pase una cadena vacía a subscriptionKey en el método fromEndpoint y, a continuación, establezca authorizationToken="token" en la instancia de SpeechConfig creada para usar el token de autorización.
fromHost(URL, string)

Crea una instancia de la configuración de voz con el host y la clave de suscripción especificados. Este método está pensado solo para los usuarios que usan un host de servicio no predeterminado. Se presupone la ruta de acceso del recurso estándar. En el caso de los servicios con una ruta de acceso de recursos no estándar o ninguna ruta de acceso, use fromEndpoint en su lugar. Nota: Los parámetros de consulta no se permiten en el URI del host y deben establecerse mediante otras API. Nota: Para usar un token de autorización con fromHost, use fromHost(URL) y establezca la propiedad AuthorizationToken en la instancia de SpeechConfig creada. Nota: Se ha agregado en la versión 1.9.0.
fromSubscription(string, string)

Instancia estática de SpeechConfig devuelta pasando subscriptionKey y región de servicio. Nota: Use la clave de suscripción LanguageUnderstanding en caso de que desee usar el reconocedor de intenciones.
getProperty(string, string)

Devuelve el valor actual de una propiedad arbitraria.
requestWordLevelTimestamps()

Incluye marcas de tiempo de nivel de palabra. Se agregó en la versión 1.7.0.
setProfanity(ProfanityOption)

Establece la opción soeces. Se agregó en la versión 1.7.0.
setProperty(string | PropertyId, string)

Establece una propiedad arbitraria.
setProxy(string, number)

Establece la configuración de proxy. Solo es relevante en entornos de Node.js. Se agregó en la versión 1.4.0.
setProxy(string, number, string, string)

Establece la configuración de proxy. Solo es relevante en entornos de Node.js. Se agregó en la versión 1.4.0.
setServiceProperty(string, string, UriQueryParameter)

Establece un valor de propiedad que se pasará al servicio mediante el canal especificado. Se agregó en la versión 1.7.0.

Detalles de las propiedades

authorizationToken

Obtiene el token de autorización.

string authorizationToken

Valor de propiedad

string

endpointId

Obtiene el identificador de punto de conexión de un modelo de voz personalizado que se usa para el reconocimiento de voz.

string endpointId

Valor de propiedad

string

El identificador del punto de conexión

outputFormat

Obtiene el formato de salida del reconocimiento de voz (simple o detallado). Nota: Este formato de salida es para el resultado del reconocimiento de voz, use [SpeechConfig.speechSynthesisOutputFormat] para obtener el formato de salida de audio sintetizado.

OutputFormat outputFormat

Valor de propiedad

OutputFormat

Devuelve el formato de salida.

region 

string region

Valor de propiedad

string

Región establecida en la configuración.

speechRecognitionLanguage

Devuelve el idioma configurado.

string speechRecognitionLanguage

Valor de propiedad

string

speechSynthesisLanguage

Obtiene el idioma del sintetizador de voz. Se agregó en la versión 1.11.0.

string speechSynthesisLanguage

Valor de propiedad

string

Devuelve el lenguaje de síntesis de voz.

speechSynthesisOutputFormat

Obtiene el formato de salida de síntesis de voz. Se agregó en la versión 1.11.0.

SpeechSynthesisOutputFormat speechSynthesisOutputFormat

Valor de propiedad

SpeechSynthesisOutputFormat

Devuelve el formato de salida de síntesis de voz.

speechSynthesisVoiceName

Obtiene la voz del sintetizador de voz. Se agregó en la versión 1.11.0.

string speechSynthesisVoiceName

Valor de propiedad

string

Devuelve la voz de síntesis de voz.

subscriptionKey 

string subscriptionKey

Valor de propiedad

string

Clave de suscripción establecida en la configuración.

Detalles del método

close()

Cierra la configuración.

function close()

enableAudioLogging()

Habilite el registro de audio en el servicio. Los registros de audio y contenido se almacenan en el almacenamiento propiedad de Microsoft o en su propia cuenta de almacenamiento vinculada a la suscripción de Cognitive Services (Bring Your Own Storage [BYOS]) habilitado para el recurso de voz). Los registros se quitarán después de 30 días. Se agregó en la versión 1.7.0.

function enableAudioLogging()

enableDictation()

Habilite el dictado. Solo se admite en el reconocimiento continuo de voz. Se agregó en la versión 1.7.0.

function enableDictation()

fromAuthorizationToken(string, string)

Crea una instancia de la factoría de voz con el token de autorización inicial y la región especificados. Nota: El autor de la llamada debe asegurarse de que el token de autorización es válido. Antes de que expire el token de autorización, el autor de la llamada debe actualizarlo llamando a este establecedor con un nuevo token válido. Nota: Use un token derivado de la clave de suscripción LanguageUnderstanding en caso de que desee usar el reconocedor de intenciones. Como los valores de configuración se copian al crear un nuevo reconocedor, el nuevo valor de token no se aplicará a los reconocedores que ya se han creado. Para los reconocedores que se han creado antes, debe establecer el token de autorización del reconocedor correspondiente para actualizar el token. De lo contrario, los reconocedores encontrarán errores durante el reconocimiento.

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

Parámetros

authorizationToken

string

Token de autorización inicial.

region

string

El nombre de la región (consulte la página región).

Devoluciones

SpeechConfig

Una instancia de la factoría de voz.

fromEndpoint(URL, string)

Crea una instancia de la configuración de voz con el punto de conexión y la clave de suscripción especificados. Este método está pensado solo para los usuarios que usan un punto de conexión de servicio o parámetros no estándar. Nota: Use la clave de suscripción LanguageUnderstanding en caso de que desee usar el reconocedor de intenciones. Nota: Los parámetros de consulta especificados en la dirección URL del punto de conexión no se cambian, incluso si se establecen mediante otras API. Por ejemplo, si el idioma se define en el URI como parámetro de consulta "language=de-DE", y también se establece mediante SpeechConfig.speechRecognitionLanguage = "en-US", la configuración de idioma en URI tiene prioridad y el idioma efectivo es "de-DE". Solo los parámetros que no se especifican en la dirección URL del punto de conexión se pueden establecer mediante otras API. Nota: Para usar el token de autorización con fromEndpoint, pase una cadena vacía a subscriptionKey en el método fromEndpoint y, a continuación, establezca authorizationToken="token" en la instancia de SpeechConfig creada para usar el token de autorización.

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

Parámetros

endpoint

URL

Punto de conexión de servicio al que se va a conectar.

subscriptionKey

string

Clave de suscripción. Si no se especifica una clave de suscripción, se debe establecer un token de autorización.

Devoluciones

SpeechConfig

Una instancia de la factoría de voz.

fromHost(URL, string)

Crea una instancia de la configuración de voz con el host y la clave de suscripción especificados. Este método está pensado solo para los usuarios que usan un host de servicio no predeterminado. Se presupone la ruta de acceso del recurso estándar. En el caso de los servicios con una ruta de acceso de recursos no estándar o ninguna ruta de acceso, use fromEndpoint en su lugar. Nota: Los parámetros de consulta no se permiten en el URI del host y deben establecerse mediante otras API. Nota: Para usar un token de autorización con fromHost, use fromHost(URL) y establezca la propiedad AuthorizationToken en la instancia de SpeechConfig creada. Nota: Se ha agregado en la versión 1.9.0.

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

Parámetros

hostName

URL

subscriptionKey

string

Clave de suscripción. Si no se especifica una clave de suscripción, se debe establecer un token de autorización.

Devoluciones

SpeechConfig

Una instancia de la factoría de voz.

fromSubscription(string, string)

Instancia estática de SpeechConfig devuelta pasando subscriptionKey y región de servicio. Nota: Use la clave de suscripción LanguageUnderstanding en caso de que desee usar el reconocedor de intenciones.

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

Parámetros

subscriptionKey

string

Clave de suscripción.

region

string

El nombre de la región (consulte la página región).

Devoluciones

SpeechConfig

La factoría de voz

getProperty(string, string)

Devuelve el valor actual de una propiedad arbitraria.

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

Parámetros

name

string

Nombre de la propiedad que se va a consultar.

def

string

El valor que se va a devolver en caso de que no se conozca la propiedad .

Devoluciones

string

Valor actual, o valor predeterminado proporcionado, de la propiedad especificada.

requestWordLevelTimestamps()

Incluye marcas de tiempo de nivel de palabra. Se agregó en la versión 1.7.0.

function requestWordLevelTimestamps()

setProfanity(ProfanityOption)

Establece la opción soeces. Se agregó en la versión 1.7.0.

function setProfanity(profanity: ProfanityOption)

Parámetros

profanity
ProfanityOption

setProperty(string | PropertyId, string)

Establece una propiedad arbitraria.

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

Parámetros

name

string | PropertyId

Nombre de la propiedad que se va a establecer.

value

string

Nuevo valor de la propiedad.

setProxy(string, number)

Establece la configuración de proxy. Solo es relevante en entornos de Node.js. Se agregó en la versión 1.4.0.

function setProxy(proxyHostName: string, proxyPort: number)

Parámetros

proxyHostName

string

Nombre de host del servidor proxy.

proxyPort

number

Número de puerto del servidor proxy.

setProxy(string, number, string, string)

Establece la configuración de proxy. Solo es relevante en entornos de Node.js. Se agregó en la versión 1.4.0.

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

Parámetros

proxyHostName

string

Nombre de host del servidor proxy, sin el esquema de protocolo (http://)

proxyPort

number

Número de puerto del servidor proxy.

proxyUserName

string

Nombre de usuario del servidor proxy.

proxyPassword

string

Contraseña del servidor proxy.

setServiceProperty(string, string, UriQueryParameter)

Establece un valor de propiedad que se pasará al servicio mediante el canal especificado. Se agregó en la versión 1.7.0.

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

Parámetros

name

string

value

string

channel
UriQueryParameter