Compartir a través de


TextTranslationClient Clase

Text Translation es una característica de API REST basada en la nube del servicio Translator que usa la tecnología de traducción automática neuronal para permitir la traducción de texto de origen a destino rápida y precisa en tiempo real en todos los idiomas admitidos.

La característica Text Translation admite los métodos siguientes:

Idiomas. Devuelve una lista de los idiomas admitidos por las operaciones Translate, Transliterate y Dictionary Lookup.

Translate. Traduce texto de un solo idioma de origen en textos en varios idiomas de destino con una sola solicitud.

Transliterate. Convierte caracteres o letras de un idioma de origen en los caracteres o letras correspondientes de un idioma de destino.

Detectar. Devuelve el código fuente del idioma y una variable booleana que indica si el idioma detectado es compatible con la traducción y la transliteración de texto.

Dictionary lookup. Devuelve palabras equivalentes del término de origen en el idioma de destino.

Dictionary example: devuelve ejemplos de estructura gramatical y contexto para el par formado por el término de origen y el término de destino.

Combinaciones de valores de punto de conexión y credenciales: str + AzureKeyCredential ( usado punto de conexión de traductor de dominio personalizado str + TokenCredential), que se usa para el punto de conexión regional con autenticación de tokens str + TranslatorCredential , que se usa para nubes nacionales None + AzureKeyCredential, que se usa para el punto de conexión de traductor global con el recurso de Traductor global Ninguno y token: punto de conexión de traductor general con TranslatorCredential : punto de conexión de traductor general con Translator regional Recursos

Herencia
azure.ai.translation.text._client.TextTranslationClient
TextTranslationClient

Constructor

TextTranslationClient(credential: AzureKeyCredential | TokenCredential | TranslatorCredential, *, endpoint: str | None = None, api_version='3.0', **kwargs)

Parámetros

endpoint
str
Requerido

Puntos de conexión de traducción de texto admitidos (protocolo y nombre de host, por ejemplo: https://api.cognitive.microsofttranslator.com). Necesario.

credential
Union[<xref:AzureKeyCredential> , <xref:TokenCredential> , TranslatorCredential]
Requerido

Credencial usada para autenticarse con el servicio Translator

api_version
str

El valor predeterminado es "3.0". Tenga en cuenta que reemplazar este valor predeterminado puede dar lugar a un comportamiento no admitido.

Métodos

close
find_sentence_boundaries

Buscar límites de oración.

Buscar límites de oración.

get_languages

Obtiene el conjunto de idiomas admitidos actualmente por otras operaciones de Traductor.

Obtiene el conjunto de idiomas admitidos actualmente por otras operaciones de Traductor.

lookup_dictionary_entries

Entradas del diccionario de búsqueda.

Entradas del diccionario de búsqueda.

lookup_dictionary_examples

Ejemplos de diccionarios de búsqueda.

Ejemplos de diccionarios de búsqueda.

send_request

Ejecuta la solicitud de red a través de las directivas encadenadas del cliente.


>>> from azure.core.rest import HttpRequest
>>> request = HttpRequest("GET", "https://www.example.org/")
<HttpRequest [GET], url: 'https://www.example.org/'>
>>> response = client.send_request(request)
<HttpResponse: 200 OK>

Para obtener más información sobre este flujo de código, consulte https://aka.ms/azsdk/dpcodegen/python/send_request

translate

Traducir texto.

Traducir texto.

transliterate

Transliterar texto.

Transliterar texto.

close

close() -> None

find_sentence_boundaries

Buscar límites de oración.

Buscar límites de oración.

find_sentence_boundaries(content: List[InputTextItem] | IO, *, client_trace_id: str | None = None, language: str | None = None, script: str | None = None, **kwargs: Any) -> List[BreakSentenceItem]

Parámetros

content
list[InputTextItem] o IO
Requerido

Matriz del texto para el que se calcularán los límites de la oración. Es un tipo [InputTextItem] o un tipo de E/S. Necesario.

client_trace_id
str

GUID generado por el cliente para identificar de forma única la solicitud. El valor predeterminado es Ninguno.

language
str

Etiqueta de idioma que identifica el idioma del texto de entrada. Si no se especifica un código, se aplicará la detección automática del idioma. El valor predeterminado es Ninguno.

script
str

Etiqueta de script que identifica el script que usa el texto de entrada. Si no se especifica un script, se asumirá el script predeterminado del idioma. El valor predeterminado es Ninguno.

content_type
str

Parámetro body Content-Type. Los valores conocidos son: application/json. El valor predeterminado es Ninguno.

Devoluciones

lista de BreakSentenceItem

Tipo de valor devuelto

Excepciones

get_languages

Obtiene el conjunto de idiomas admitidos actualmente por otras operaciones de Traductor.

Obtiene el conjunto de idiomas admitidos actualmente por otras operaciones de Traductor.

get_languages(*, client_trace_id: str | None = None, scope: str | None = None, accept_language: str | None = None, if_none_match: str | None = None, **kwargs: Any) -> GetLanguagesResult

Parámetros

client_trace_id
str

GUID generado por el cliente para identificar de forma única la solicitud. El valor predeterminado es Ninguno.

scope
str

Lista de nombres separados por comas que definen el grupo de idiomas que se devolverá. Los nombres de grupo permitidos son: translation, transliteration y dictionary. Si no se proporciona ningún ámbito, se devuelven todos los grupos, lo que es equivalente a pasar scope=translation,transliteration,dictionary. Para decidir qué conjunto de idiomas admitidos es adecuado para su escenario, consulte la descripción de <xref:response-body>. El valor predeterminado es Ninguno.

accept_language
str

Idioma que se usará para las cadenas de la interfaz de usuario. Algunos de los campos de la respuesta son nombres de idiomas o regiones. Utilice este parámetro para definir el idioma en que se devolverán los nombres. El idioma se especifica al proporcionar una etiqueta de idioma BCP 47 con el formato correcto. Por ejemplo, utilice el valor fr para solicitar nombres en francés o utilice el valor zh-Hant para solicitar nombres en chino tradicional. Los nombres se proporcionan en inglés cuando no se especifica un idioma de destino o cuando la localización no está disponible. El valor predeterminado es Ninguno.

if_none_match
str

Pasar el valor del encabezado de respuesta ETag en un campo If-None-Match permitirá al servicio optimizar la respuesta. Si no se ha modificado el recurso, el servicio devolverá el código de estado 304 y un cuerpo de respuesta vacío. El valor predeterminado es Ninguno.

Devoluciones

GetLanguagesResult. GetLanguagesResult es compatible con MutableMapping

Tipo de valor devuelto

Excepciones

lookup_dictionary_entries

Entradas del diccionario de búsqueda.

Entradas del diccionario de búsqueda.

lookup_dictionary_entries(content: List[InputTextItem] | IO, *, from_parameter: str, to: str, client_trace_id: str | None = None, **kwargs: Any) -> List[DictionaryLookupItem]

Parámetros

content
list[InputTextItem] o IO
Requerido

Matriz del texto que se va a enviar al diccionario. Es un tipo [InputTextItem] o un tipo de E/S. Necesario.

from_parameter
str

Especifica el idioma del texto de entrada. El idioma de origen debe ser uno de los idiomas admitidos incluidos en el ámbito del diccionario. Necesario.

to
str

Especifica el idioma del texto de salida. El idioma de destino debe ser uno de los idiomas admitidos incluidos en el ámbito del diccionario. Necesario.

client_trace_id
str

GUID generado por el cliente para identificar de forma única la solicitud. El valor predeterminado es Ninguno.

content_type
str

Parámetro body Content-Type. Los valores conocidos son: application/json. El valor predeterminado es Ninguno.

Devoluciones

lista de DictionaryLookupItem

Tipo de valor devuelto

Excepciones

lookup_dictionary_examples

Ejemplos de diccionarios de búsqueda.

Ejemplos de diccionarios de búsqueda.

lookup_dictionary_examples(content: List[DictionaryExampleTextItem] | IO, *, from_parameter: str, to: str, client_trace_id: str | None = None, **kwargs: Any) -> List[DictionaryExampleItem]

Parámetros

content
list[DictionaryExampleTextItem] o IO
Requerido

Matriz del texto que se va a enviar al diccionario. Es un tipo [DictionaryExampleTextItem] o un tipo de E/S. Necesario.

from_parameter
str

Especifica el idioma del texto de entrada. El idioma de origen debe ser uno de los idiomas admitidos incluidos en el ámbito del diccionario. Necesario.

to
str

Especifica el idioma del texto de salida. El idioma de destino debe ser uno de los idiomas admitidos incluidos en el ámbito del diccionario. Necesario.

client_trace_id
str

GUID generado por el cliente para identificar de forma única la solicitud. El valor predeterminado es Ninguno.

content_type
str

Parámetro body Content-Type. Los valores conocidos son: application/json. El valor predeterminado es Ninguno.

Devoluciones

lista de DictionaryExampleItem

Tipo de valor devuelto

Excepciones

send_request

Ejecuta la solicitud de red a través de las directivas encadenadas del cliente.


>>> from azure.core.rest import HttpRequest
>>> request = HttpRequest("GET", "https://www.example.org/")
<HttpRequest [GET], url: 'https://www.example.org/'>
>>> response = client.send_request(request)
<HttpResponse: 200 OK>

Para obtener más información sobre este flujo de código, consulte https://aka.ms/azsdk/dpcodegen/python/send_request

send_request(request: HttpRequest, **kwargs: Any) -> HttpResponse

Parámetros

request
HttpRequest
Requerido

La solicitud de red que desea realizar. Necesario.

stream
bool

Indica si se transmitirá la carga de respuesta. El valor predeterminado es False.

Devoluciones

Respuesta de la llamada de red. No realiza el control de errores en la respuesta.

Tipo de valor devuelto

translate

Traducir texto.

Traducir texto.

translate(content: List[InputTextItem] | IO, *, to: List[str], client_trace_id: str | None = None, from_parameter: str | None = None, text_type: str | TextType | None = None, category: str | None = None, profanity_action: str | ProfanityAction | None = None, profanity_marker: str | ProfanityMarker | None = None, include_alignment: bool | None = None, include_sentence_length: bool | None = None, suggested_from: str | None = None, from_script: str | None = None, to_script: str | None = None, allow_fallback: bool | None = None, **kwargs: Any) -> List[TranslatedTextItem]

Parámetros

content
list[InputTextItem] o IO
Requerido

Matriz del texto que se va a traducir. Es un tipo [InputTextItem] o un tipo de E/S. Necesario.

to
list[str]

Especifica el idioma del texto de salida. El idioma de destino debe ser uno de los idiomas admitidos incluidos en el ámbito de traducción. Por ejemplo, use to=de para traducir a alemán. Es posible traducir a varios idiomas simultáneamente mediante la repetición del parámetro en la cadena de consulta. Por ejemplo, use to=de&to=it para traducir a alemán e italiano. Necesario.

client_trace_id
str

GUID generado por el cliente para identificar de forma única la solicitud. El valor predeterminado es Ninguno.

from_parameter
str

Especifica el idioma del texto de entrada. Busque los idiomas disponibles para traducir mediante la búsqueda de idiomas admitidos mediante el ámbito de traducción. Si no se especifica el parámetro from, se aplica la detección automática de idioma para determinar el idioma de origen.

Debe usar el parámetro from en lugar de la detección automática al usar la característica de diccionario dinámico. Nota: La característica de diccionario dinámico distingue mayúsculas de minúsculas. El valor predeterminado es Ninguno.

text_type
str o TextType

Define si el texto que se está traduciendo es texto sin formato o texto HTML. El código HTML debe ser un elemento completo y bien formado. Los valores posibles son: plain (valor predeterminado) o html. Los valores conocidos son: "plain" y "html". El valor predeterminado es Ninguno.

category
str

Una cadena que especifica la categoría (dominio) de la traducción. Este parámetro se utiliza para obtener las traducciones de un sistema personalizado creado con Custom Translator. Agregue el identificador de categoría de los detalles del proyecto de Traductor personalizado a este parámetro para usar el sistema personalizado implementado. El valor predeterminado es: general. El valor predeterminado es Ninguno.

profanity_action
str o ProfanityAction

Especifica cómo se deben tratar las palabras soeces en las traducciones. Los valores posibles son: NoAction (valor predeterminado), Marcado o Eliminado. Los valores conocidos son: "NoAction", "Marked" y "Deleted". El valor predeterminado es Ninguno.

profanity_marker
str o ProfanityMarker

Especifica cómo deben marcarse las palabras soeces en las traducciones. Los valores posibles son: Asterisco (valor predeterminado) o Tag. Los valores conocidos son: "Asterisco" y "Tag". El valor predeterminado es Ninguno.

include_alignment
bool

Especifica si se debe incluir la proyección de la alineación del texto de origen en el texto traducido. Los valores posibles son: true o false (valor predeterminado). El valor predeterminado es Ninguno.

include_sentence_length
bool

Especifica si se deben incluir los límites de oraciones del texto de entrada y el texto traducido. Los valores posibles son: true o false (valor predeterminado). El valor predeterminado es Ninguno.

suggested_from
str

Especifica un idioma de reserva si no se puede identificar el idioma del texto de entrada. La detección automática de idioma se aplica cuando se omite el parámetro from. Si se produce un error en la detección, se asume el idioma suggestedFrom. El valor predeterminado es Ninguno.

from_script
str

Especifica el script del texto de entrada. El valor predeterminado es Ninguno.

to_script
str

Especifica el script del texto traducido. El valor predeterminado es Ninguno.

allow_fallback
bool

Especifica que el servicio tiene permiso para recurrir a un sistema general cuando no existe uno personalizado. Los valores posibles son: true (valor predeterminado) o false.

allowFallback=false especifica que la traducción solo debe usar sistemas entrenados para la categoría especificada por la solicitud. Si una traducción del idioma X al idioma Y requiere de encadenamiento a través de un idioma puente E, entonces todos los sistemas de la cadena (X → E y E → Y) deberán estar personalizados y tener la misma categoría. Si no se encuentra ningún sistema con la categoría específica, la solicitud devolverá un código de estado de 400. allowFallback=true especifica que el servicio puede recurrir a un sistema general cuando no existe un sistema personalizado. El valor predeterminado es Ninguno.

content_type
str

Parámetro body Content-Type. Los valores conocidos son: application/json. El valor predeterminado es Ninguno.

Devoluciones

lista de TranslatedTextItem

Tipo de valor devuelto

Excepciones

transliterate

Transliterar texto.

Transliterar texto.

transliterate(content: List[InputTextItem] | IO, *, language: str, from_script: str, to_script: str, client_trace_id: str | None = None, **kwargs: Any) -> List[TransliteratedText]

Parámetros

content
list[InputTextItem] o IO
Requerido

Matriz del texto que se va a transliterar. Es un tipo [InputTextItem] o un tipo de E/S. Necesario.

language
str

Especifica el idioma del texto que se va a convertir de un script a otro. Los idiomas posibles se enumeran en el ámbito de transliteración obtenido consultando el servicio para sus idiomas admitidos. Necesario.

from_script
str

Especifica el script que usa el texto de entrada. Busque los idiomas admitidos mediante el ámbito de transliteración para buscar los scripts de entrada disponibles para el idioma seleccionado. Necesario.

to_script
str

Especifica el nombre del script de salida. Busque idiomas admitidos mediante el ámbito de transliteración para buscar scripts de salida disponibles para la combinación seleccionada de lenguaje de entrada y script de entrada. Necesario.

client_trace_id
str

GUID generado por el cliente para identificar de forma única la solicitud. El valor predeterminado es Ninguno.

content_type
str

Parámetro body Content-Type. Los valores conocidos son: application/json. El valor predeterminado es Ninguno.

Devoluciones

lista de transliteracióntexto

Tipo de valor devuelto

Excepciones