SpeechTranslationConfig class
Configuração de tradução de fala.
- Extends
Propriedades
| authorization |
Obtém/define o token de autorização. 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. |
| endpoint |
Obtém a ID do ponto de extremidade de um modelo de fala personalizado que é usado para reconhecimento de fala. |
| output |
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 | |
| speech |
Obtém/define o idioma de reconhecimento de fala. |
| speech |
Obtém o idioma do sintetizador de fala. Adicionado na versão 1.11.0. |
| speech |
Obtém o formato de saída de síntese de fala. Adicionado na versão 1.11.0. |
| speech |
Obtém a voz do sintetizador de fala. Adicionado na versão 1.11.0. |
| subscription |
|
| target |
Obtém o idioma de destino (texto) para o qual traduzir. |
| token |
Obtém a instância TokenCredential se configurada. Disponível somente se estiver usando a autenticação baseada em AAD por meio de TokenCredential. |
| voice |
Obtém o nome de voz selecionado. |
Métodos
| add |
Adicione um idioma de destino (texto) para o qual traduzir. |
| close() | Descarte os recursos associados. |
| from |
Instância estática de SpeechTranslationConfig retornada passando o token de autorização e a região de serviço. 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 definindo a propriedade authorizationToken com um novo token válido. Caso contrário, todos os reconhecedores criados por essa instância de SpeechTranslationConfig encontrarão erros durante o reconhecimento. À 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. |
| from |
Cria uma instância de uma configuração de tradução de fala com um ponto de extremidade personalizado e uma credencial. Os parâmetros de consulta especificados no URI do ponto de extremidade não são alterados, mesmo que sejam definidos por qualquer outra chamada de API. Por exemplo, se o idioma de reconhecimento for definido no parâmetro de consulta URI como "language=de-DE", e a propriedade SpeechRecognitionLanguage for definida como "en-US", o idioma definido no URI terá precedência e "de-DE" permanecerá o idioma esperado. Como os parâmetros incluídos no URI do ponto de extremidade têm prioridade, somente os parâmetros que não são especificados no URI do ponto de extremidade podem ser definidos por outras APIs. Tipos de credenciais compatíveis:
|
| from |
Cria uma instância da configuração de traduçã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: as propriedades de consulta especificadas na URL do ponto de extremidade não são alteradas, mesmo que sejam definidas por outras APIs. Por exemplo, se o idioma for definido no uri como parâmetro de consulta "language=de-DE", e também definido pela propriedade speechRecognitionLanguage, a configuração de idioma no uri terá precedência e o idioma efetivo será "de-DE". Somente as propriedades que não são especificadas na URL do ponto de extremidade podem ser definidas por outras APIs. Observação: para usar o token de autorização com fromEndpoint, passe uma cadeia de caracteres vazia para a subscriptionKey no método fromEndpoint e defina authorizationToken="token" na instância de SpeechConfig criada para usar o token de autorização. |
| from |
Cria uma instância da configuração de fala com o host e a chave de assinatura especificados. Esse método destina-se somente aos 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 em vez disso. 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 de SpeechConfig criada. Observação: adicionado na versão 1.9.0. |
| from |
Instância estática de SpeechTranslationConfig retornada passando uma chave de assinatura e uma região de serviço. |
| set |
Define uma propriedade nomeada como valor |
Métodos herdados
| enable |
Habilite 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 ao recurso de Fala habilitado para ByOS (Traga Seu Próprio Armazenamento). Os logs serão removidos após 30 dias. Adicionado na versão 1.7.0. |
| enable |
Ative o ditado. Compatível apenas com o reconhecimento contínuo de fala. Adicionado na versão 1.7.0. |
| get |
Retorna o valor atual de uma propriedade arbitrária. |
| request |
Inclui carimbos de data/hora de nível de palavra. Adicionado na versão 1.7.0. |
| set |
Define a opção de palavrões. Adicionado na versão 1.7.0. |
| set |
Define a configuração de proxy. Somente relevante em ambientes Node.js. Adicionado na versão 1.4.0. |
| set |
Define a configuração de proxy. Somente relevante em ambientes Node.js. Adicionado na versão 1.4.0. |
| set |
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/define o token de autorização. 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.
void authorizationToken
Valor da propriedade
void
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
Retorna o formato de saída.
region
string region
Valor da propriedade
string
A região definida na configuração.
speechRecognitionLanguage
Obtém/define o idioma de reconhecimento de fala.
void speechRecognitionLanguage
Valor da propriedade
void
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
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.
targetLanguages
Obtém o idioma de destino (texto) para o qual traduzir.
string[] targetLanguages
Valor da propriedade
string[]
tokenCredential
Obtém a instância TokenCredential se configurada. Disponível somente se estiver usando a autenticação baseada em AAD por meio de TokenCredential.
any tokenCredential
Valor da propriedade
any
voiceName
Obtém o nome de voz selecionado.
string voiceName
Valor da propriedade
string
O nome da voz.
Detalhes do método
addTargetLanguage(string)
Adicione um idioma de destino (texto) para o qual traduzir.
function addTargetLanguage(value: string)
Parâmetros
- value
-
string
A linguagem como de-DE
close()
Descarte os recursos associados.
function close()
fromAuthorizationToken(string, string)
Instância estática de SpeechTranslationConfig retornada passando o token de autorização e a região de serviço. 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 definindo a propriedade authorizationToken com um novo token válido. Caso contrário, todos os reconhecedores criados por essa instância de SpeechTranslationConfig encontrarão erros durante o reconhecimento. À 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): SpeechTranslationConfig
Parâmetros
- authorizationToken
-
string
O token de autorização.
- region
-
string
O nome da região (consulte a página da região).
Retornos
A configuração de tradução de fala.
fromEndpoint(URL, any)
Cria uma instância de uma configuração de tradução de fala com um ponto de extremidade personalizado e uma credencial. Os parâmetros de consulta especificados no URI do ponto de extremidade não são alterados, mesmo que sejam definidos por qualquer outra chamada de API. Por exemplo, se o idioma de reconhecimento for definido no parâmetro de consulta URI como "language=de-DE", e a propriedade SpeechRecognitionLanguage for definida como "en-US", o idioma definido no URI terá precedência e "de-DE" permanecerá o idioma esperado. Como os parâmetros incluídos no URI do ponto de extremidade têm prioridade, somente os parâmetros que não são especificados no URI do ponto de extremidade podem ser definidos por outras APIs. Tipos de credenciais compatíveis:
- KeyCredential: para autenticação baseada em chave de API.
- TokenCredential: para autenticação baseada em Azure AD. Observação: para usar o token de autorização com fromEndpoint, passe uma cadeia de caracteres vazia para a subscriptionKey no método fromEndpoint e defina authorizationToken="token" na instância de SpeechConfig criada para usar o token de autorização.
static function fromEndpoint(endpoint: URL, credential: any): SpeechTranslationConfig
Parâmetros
- endpoint
-
URL
O ponto de extremidade de serviço ao qual se conectar.
- credential
-
any
A credencial usada para autenticação.
Retornos
Uma instância de fábrica de fala.
fromEndpoint(URL, string)
Cria uma instância da configuração de traduçã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: as propriedades de consulta especificadas na URL do ponto de extremidade não são alteradas, mesmo que sejam definidas por outras APIs. Por exemplo, se o idioma for definido no uri como parâmetro de consulta "language=de-DE", e também definido pela propriedade speechRecognitionLanguage, a configuração de idioma no uri terá precedência e o idioma efetivo será "de-DE". Somente as propriedades que não são especificadas na URL do ponto de extremidade podem ser definidas por outras APIs. Observação: para usar o token de autorização com fromEndpoint, passe uma cadeia de caracteres vazia para a subscriptionKey no método fromEndpoint e defina authorizationToken="token" na instância de SpeechConfig criada para usar o token de autorização.
static function fromEndpoint(endpoint: URL, subscriptionKey?: string): SpeechTranslationConfig
Parâmetros
- endpoint
-
URL
O ponto de extremidade de serviço ao qual se conectar.
- subscriptionKey
-
string
A chave da assinatura.
Retornos
Uma instância de configuração de tradução de fala.
fromHost(URL, string)
Cria uma instância da configuração de fala com o host e a chave de assinatura especificados. Esse método destina-se somente aos 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 em vez disso. 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 de SpeechConfig criada. Observação: adicionado na versão 1.9.0.
static function fromHost(hostName: URL, subscriptionKey?: string): SpeechTranslationConfig
Parâmetros
- hostName
-
URL
- subscriptionKey
-
string
A chave da assinatura. Se uma chave de assinatura não for especificada, um token de autorização deverá ser definido.
Retornos
Uma instância de fábrica de fala.
fromSubscription(string, string)
Instância estática de SpeechTranslationConfig retornada passando uma chave de assinatura e uma região de serviço.
static function fromSubscription(subscriptionKey: string, region: string): SpeechTranslationConfig
Parâmetros
- subscriptionKey
-
string
A chave da assinatura.
- region
-
string
O nome da região (consulte a página da região).
Retornos
A configuração de tradução de fala.
setProperty(string | PropertyId, string)
Define uma propriedade nomeada como valor
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.
Detalhes do método herdado
enableAudioLogging()
Habilite 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 ao recurso de Fala habilitado para ByOS (Traga Seu Próprio Armazenamento). Os logs serão removidos após 30 dias. Adicionado na versão 1.7.0.
function enableAudioLogging()
Herdado deSpeechConfig.enableAudioLogging
enableDictation()
Ative o ditado. Compatível apenas com o reconhecimento contínuo de fala. Adicionado na versão 1.7.0.
function enableDictation()
Herdado deSpeechConfig.enableDictation
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 fornecido como padrão, da propriedade fornecida.
Herdado deSpeechConfig.getProperty
requestWordLevelTimestamps()
Inclui carimbos de data/hora de nível de palavra. Adicionado na versão 1.7.0.
function requestWordLevelTimestamps()
Herdado deSpeechConfig.requestWordLevelTimestamps
setProfanity(ProfanityOption)
Define a opção de palavrões. Adicionado na versão 1.7.0.
function setProfanity(profanity: ProfanityOption)
Parâmetros
- profanity
- ProfanityOption
Herdado deSpeechConfig.setProfanity
setProxy(string, number)
Define a configuração de proxy. Somente relevante 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.
Herdado deSpeechConfig.setProxy
setProxy(string, number, string, string)
Define a configuração de proxy. Somente relevante 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.
Herdado deSpeechConfig.setProxy
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
Herdado deSpeechConfig.setServiceProperty