SpeechConfig class

Pacote:

microsoft-cognitiveservices-speech-sdk

Configuração de fala.

Propriedades

authorizationToken	Obtém o token de autorização.
endpointId	Obtém a ID do ponto de extremidade de um modelo de fala personalizado que é usado para reconhecimento de fala.
outputFormat	Obtém o formato de saída de reconhecimento de fala (simples ou detalhado). Observação: esse formato de saída é para o resultado do reconhecimento de fala, use [SpeechConfig.speechSynthesisOutputFormat] para obter o formato de saída de áudio sintetizado.
region
speechRecognitionLanguage	Retorna o idioma configurado.
speechSynthesisLanguage	Obtém o idioma do sintetizador de fala. Adicionado na versão 1.11.0.
speechSynthesisOutputFormat	Obtém o formato de saída de síntese de fala. Adicionado na versão 1.11.0.
speechSynthesisVoiceName	Obtém a voz do sintetizador de fala. Adicionado na versão 1.11.0.
subscriptionKey

Métodos

close()	Fecha a configuração.
enableAudioLogging()	Habilitar o log de áudio no serviço. Os logs de áudio e conteúdo são armazenados no armazenamento de propriedade da Microsoft ou em sua própria conta de armazenamento vinculada à sua assinatura dos Serviços Cognitivos (recurso de Fala habilitado para BYOS (Bring Your Own Storage). Os logs serão removidos após 30 dias. Adicionado na versão 1.7.0.
enableDictation()	Habilitar ditado. Compatível apenas com o reconhecimento contínuo de fala. Adicionado na versão 1.7.0.
fromAuthorizationToken(string, string)	Cria uma instância da fábrica de fala com o token de autorização inicial e a região especificados. Observação: o chamador precisa garantir que o token de autorização seja válido. Antes que o token de autorização expire, o chamador precisa atualizá-lo chamando esse setter com um novo token válido. Observação: use um token derivado de sua chave de assinatura LanguageUnderstanding caso deseje usar o Reconhecimento de intenções. À medida que os valores de configuração são copiados ao criar um novo reconhecedor, o novo valor de token não se aplicará aos reconhecedores que já foram criados. Para reconhecedores que foram criados antes, você precisa definir o token de autorização do reconhecedor correspondente para atualizar o token. Caso contrário, os reconhecedores encontrarão erros durante o reconhecimento.
fromEndpoint(URL, string)	Cria uma instância da configuração de fala com o ponto de extremidade e a chave de assinatura especificados. Esse método destina-se apenas a usuários que usam um ponto de extremidade de serviço ou parâmetros não padrão. Observação: use sua chave de assinatura LanguageUnderstanding caso deseje usar o Reconhecimento de intenções. Observação: os parâmetros de consulta especificados na URL do ponto de extremidade não são alterados, mesmo que sejam definidos por qualquer outra APIs. Por exemplo, se o idioma for definido no URI como parâmetro de consulta "language=de-DE", e também definido por SpeechConfig.speechRecognitionLanguage = "en-US", a configuração de idioma no URI terá precedência e o idioma efetivo será "de-DE". Somente os parâmetros que não são especificados na URL do ponto de extremidade podem ser definidos por outras APIs. Observação: para usar o token de autorização com fromEndpoint, passe uma cadeia de caracteres vazia para subscriptionKey no método fromEndpoint e defina authorizationToken="token" na instância speechConfig criada para usar o token de autorização.
fromHost(URL, string)	Cria uma instância da configuração de fala com a chave de assinatura e host especificada. Esse método destina-se apenas a usuários que usam um host de serviço não padrão. O caminho do recurso padrão será assumido. Para serviços com um caminho de recurso não padrão ou nenhum caminho, use fromEndpoint. Observação: os parâmetros de consulta não são permitidos no URI do host e devem ser definidos por outras APIs. Observação: para usar um token de autorização com fromHost, use fromHost(URL) e defina a propriedade AuthorizationToken na instância speechConfig criada. Observação: adicionado na versão 1.9.0.
fromSubscription(string, string)	Instância estática de SpeechConfig retornada passando subscriptionKey e região de serviço. Observação: use sua chave de assinatura LanguageUnderstanding caso deseje usar o Reconhecimento de intenções.
getProperty(string, string)	Retorna o valor atual de uma propriedade arbitrária.
requestWordLevelTimestamps()	Inclui carimbos de data/hora no nível da palavra. Adicionado na versão 1.7.0.
setProfanity(ProfanityOption)	Define a opção de conteúdo ofensivo. Adicionado na versão 1.7.0.
setProperty(string | PropertyId, string)	Define uma propriedade arbitrária.
setProxy(string, number)	Define a configuração de proxy. Relevante apenas em ambientes Node.js. Adicionado na versão 1.4.0.
setProxy(string, number, string, string)	Define a configuração de proxy. Relevante apenas em ambientes Node.js. Adicionado na versão 1.4.0.
setServiceProperty(string, string, UriQueryParameter)	Define um valor de propriedade que será passado para o serviço usando o canal especificado. Adicionado na versão 1.7.0.

Detalhes da propriedade

authorizationToken

Obtém o token de autorização.

string authorizationToken

Valor da propriedade

string

endpointId

Obtém a ID do ponto de extremidade de um modelo de fala personalizado que é usado para reconhecimento de fala.

string endpointId

Valor da propriedade

string

A ID do ponto de extremidade

outputFormat

Obtém o formato de saída de reconhecimento de fala (simples ou detalhado). Observação: esse formato de saída é para o resultado do reconhecimento de fala, use [SpeechConfig.speechSynthesisOutputFormat] para obter o formato de saída de áudio sintetizado.

OutputFormat outputFormat

Valor da propriedade

OutputFormat

Retorna o formato de saída.

region

string region

Valor da propriedade

string

A região definida na configuração.

speechRecognitionLanguage

Retorna o idioma configurado.

string speechRecognitionLanguage

Valor da propriedade

string

speechSynthesisLanguage

Obtém o idioma do sintetizador de fala. Adicionado na versão 1.11.0.

string speechSynthesisLanguage

Valor da propriedade

string

Retorna a linguagem de síntese de fala.

speechSynthesisOutputFormat

Obtém o formato de saída de síntese de fala. Adicionado na versão 1.11.0.

SpeechSynthesisOutputFormat speechSynthesisOutputFormat

Valor da propriedade

SpeechSynthesisOutputFormat

Retorna o formato de saída de síntese de fala

speechSynthesisVoiceName

Obtém a voz do sintetizador de fala. Adicionado na versão 1.11.0.

string speechSynthesisVoiceName

Valor da propriedade

string

Retorna a voz de síntese de fala.

subscriptionKey

string subscriptionKey

Valor da propriedade

string

A chave de assinatura definida na configuração.

Detalhes do método

close()

Fecha a configuração.

function close()

enableAudioLogging()

Habilitar o log de áudio no serviço. Os logs de áudio e conteúdo são armazenados no armazenamento de propriedade da Microsoft ou em sua própria conta de armazenamento vinculada à sua assinatura dos Serviços Cognitivos (recurso de Fala habilitado para BYOS (Bring Your Own Storage). Os logs serão removidos após 30 dias. Adicionado na versão 1.7.0.

function enableAudioLogging()

enableDictation()

Habilitar ditado. Compatível apenas com o reconhecimento contínuo de fala. Adicionado na versão 1.7.0.

function enableDictation()

fromAuthorizationToken(string, string)

Cria uma instância da fábrica de fala com o token de autorização inicial e a região especificados. Observação: o chamador precisa garantir que o token de autorização seja válido. Antes que o token de autorização expire, o chamador precisa atualizá-lo chamando esse setter com um novo token válido. Observação: use um token derivado de sua chave de assinatura LanguageUnderstanding caso deseje usar o Reconhecimento de intenções. À medida que os valores de configuração são copiados ao criar um novo reconhecedor, o novo valor de token não se aplicará aos reconhecedores que já foram criados. Para reconhecedores que foram criados antes, você precisa definir o token de autorização do reconhecedor correspondente para atualizar o token. Caso contrário, os reconhecedores encontrarão erros durante o reconhecimento.

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

Parâmetros

authorizationToken

string

O token de autorização inicial.

region

string

O nome da região (consulte a página da região).

Retornos

SpeechConfig

Uma instância de fábrica de fala.

fromEndpoint(URL, string)

Cria uma instância da configuração de fala com o ponto de extremidade e a chave de assinatura especificados. Esse método destina-se apenas a usuários que usam um ponto de extremidade de serviço ou parâmetros não padrão. Observação: use sua chave de assinatura LanguageUnderstanding caso deseje usar o Reconhecimento de intenções. Observação: os parâmetros de consulta especificados na URL do ponto de extremidade não são alterados, mesmo que sejam definidos por qualquer outra APIs. Por exemplo, se o idioma for definido no URI como parâmetro de consulta "language=de-DE", e também definido por SpeechConfig.speechRecognitionLanguage = "en-US", a configuração de idioma no URI terá precedência e o idioma efetivo será "de-DE". Somente os parâmetros que não são especificados na URL do ponto de extremidade podem ser definidos por outras APIs. Observação: para usar o token de autorização com fromEndpoint, passe uma cadeia de caracteres vazia para subscriptionKey no método fromEndpoint e defina authorizationToken="token" na instância speechConfig criada para usar o token de autorização.

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

Parâmetros

endpoint

URL

O ponto de extremidade de serviço ao qual se conectar.

subscriptionKey

string

A chave de assinatura. Se uma chave de assinatura não for especificada, um token de autorização deverá ser definido.

Retornos

SpeechConfig

Uma instância de fábrica de fala.

fromHost(URL, string)

Cria uma instância da configuração de fala com a chave de assinatura e host especificada. Esse método destina-se apenas a usuários que usam um host de serviço não padrão. O caminho do recurso padrão será assumido. Para serviços com um caminho de recurso não padrão ou nenhum caminho, use fromEndpoint. Observação: os parâmetros de consulta não são permitidos no URI do host e devem ser definidos por outras APIs. Observação: para usar um token de autorização com fromHost, use fromHost(URL) e defina a propriedade AuthorizationToken na instância speechConfig criada. Observação: adicionado na versão 1.9.0.

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

Parâmetros

hostName

URL

subscriptionKey

string

A chave de assinatura. Se uma chave de assinatura não for especificada, um token de autorização deverá ser definido.

Retornos

SpeechConfig

Uma instância de fábrica de fala.

fromSubscription(string, string)

Instância estática de SpeechConfig retornada passando subscriptionKey e região de serviço. Observação: use sua chave de assinatura LanguageUnderstanding caso deseje usar o Reconhecimento de intenções.

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

Parâmetros

subscriptionKey

string

A chave de assinatura.

region

string

O nome da região (consulte a página da região).

Retornos

SpeechConfig

A fábrica de fala

getProperty(string, string)

Retorna o valor atual de uma propriedade arbitrária.

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

Parâmetros

name

string

O nome da propriedade a ser consultada.

def

string

O valor a ser retornado caso a propriedade não seja conhecida.

Retornos

string

O valor atual, ou padrão fornecido, da propriedade fornecida.

requestWordLevelTimestamps()

Inclui carimbos de data/hora no nível da palavra. Adicionado na versão 1.7.0.

function requestWordLevelTimestamps()

setProfanity(ProfanityOption)

Define a opção de conteúdo ofensivo. Adicionado na versão 1.7.0.

function setProfanity(profanity: ProfanityOption)

Parâmetros

profanity

ProfanityOption

setProperty(string | PropertyId, string)

Define uma propriedade arbitrária.

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

Parâmetros

name

string | PropertyId

O nome da propriedade a ser definida.

value

string

O novo valor da propriedade.

setProxy(string, number)

Define a configuração de proxy. Relevante apenas em ambientes Node.js. Adicionado na versão 1.4.0.

function setProxy(proxyHostName: string, proxyPort: number)

Parâmetros

proxyHostName

string

O nome do host do servidor proxy.

proxyPort

number

O número da porta do servidor proxy.

setProxy(string, number, string, string)

Define a configuração de proxy. Relevante apenas em ambientes Node.js. Adicionado na versão 1.4.0.

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

Parâmetros

proxyHostName

string

O nome do host do servidor proxy, sem o esquema de protocolo (http://)

proxyPort

number

O número da porta do servidor proxy.

proxyUserName

string

O nome de usuário do servidor proxy.

proxyPassword

string

A senha do servidor proxy.

setServiceProperty(string, string, UriQueryParameter)

Define um valor de propriedade que será passado para o serviço usando o canal especificado. Adicionado na versão 1.7.0.

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

Parâmetros

name

string

value

string

channel

UriQueryParameter