Ottenere i formati di documento supportati
Servizio di riferimento
: Versione dell'API Traduzione
documenti di Azure per intelligenza artificiale: v1.1
Il metodo Get supported document formats restituisce un elenco di formati di documento supportati dal servizio di traduzione documenti. L'elenco include l'estensione di file comune e il tipo di contenuto se si usa l'API di caricamento.
Richiesta URL
Inviare una richiesta GET a:
GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/documents/formats
Informazioni su come trovare il nome di dominio personalizzato.
Importante
- Tutte le richieste API al servizio traduzione documenti richiedono un endpoint di dominio personalizzato.
- Non è possibile usare l'endpoint trovato nella pagina delle chiavi e dell'endpoint della risorsa portale di Azure né nell'endpoint traduttore globale,
api.cognitive.microsofttranslator.comper effettuare richieste HTTP a Traduzione documenti.
Intestazioni delle richieste
Le intestazioni della richiesta sono le seguenti:
| Intestazioni | Descrizione |
|---|---|
| Ocp-Apim-Subscription-Key | Intestazione della richiesta obbligatoria |
Codici di stato della risposta
Di seguito sono riportati i possibili codici di stato HTTP restituiti da una richiesta.
| Codice di stato | Descrizione |
|---|---|
| 200 | OK. Restituisce l'elenco dei formati di file di documento supportati. |
| 500 | Errore interno del server. |
| Altri codici di stato | • Troppe richieste • Server temporaneo non disponibile |
Risposta al formato di file
Risposta fileFormatListResult riuscita
Le informazioni seguenti vengono restituite in una risposta con esito positivo.
| Nome | Tipo | Descrizione |
|---|---|---|
| value | FileFormat [] | FileFormat[] contiene i dettagli elencati. |
| value.contentTypes | string[] | Tipi di contenuto supportati per questo formato. |
| value.defaultVersion | string | Versione predefinita se non è specificato alcun valore. |
| value.fileExtensions | string[] | Estensione di file supportata per questo formato. |
| value.format | string | Nome del formato. |
| value.versions | string [] | Versione supportata. |
Risposta con errore
| Nome | Tipo | Descrizione |
|---|---|---|
| codice | string | Enumerazioni contenenti codici di errore di alto livello. Valori possibili: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • Servizio Non disponibile • Non autorizzato |
| messaggio | string | Ottiene un messaggio di errore di alto livello. |
| innerError | InnerTranslationError | Nuovo formato di errore interno conforme alle linee guida dell'API dei servizi di intelligenza artificiale di Azure. Questo messaggio di errore contiene le proprietà necessarie ErrorCode, message e proprietà facoltative target, details(coppia chiave-valore), errore interno(può essere annidato). |
| innerError.code | string | Ottiene la stringa di errore del codice. |
| innerError.message | string | Ottiene un messaggio di errore di alto livello. |
| innerError.target | string | Ottiene l'origine dell'errore. Ad esempio, sarebbe documents o document id per un documento non valido. |
Esempi
Esempio di risposta riuscita
L'oggetto JSON seguente è un esempio di risposta riuscita.
Codice di stato: 200
{
"value": [
{
"format": "PlainText",
"fileExtensions": [
".txt"
],
"contentTypes": [
"text/plain"
],
"versions": []
},
{
"format": "OpenXmlWord",
"fileExtensions": [
".docx"
],
"contentTypes": [
"application/vnd.openxmlformats-officedocument.wordprocessingml.document"
],
"versions": []
},
{
"format": "OpenXmlPresentation",
"fileExtensions": [
".pptx"
],
"contentTypes": [
"application/vnd.openxmlformats-officedocument.presentationml.presentation"
],
"versions": []
},
{
"format": "OpenXmlSpreadsheet",
"fileExtensions": [
".xlsx"
],
"contentTypes": [
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
],
"versions": []
},
{
"format": "OutlookMailMessage",
"fileExtensions": [
".msg"
],
"contentTypes": [
"application/vnd.ms-outlook"
],
"versions": []
},
{
"format": "HtmlFile",
"fileExtensions": [
".html",
".htm"
],
"contentTypes": [
"text/html"
],
"versions": []
},
{
"format": "PortableDocumentFormat",
"fileExtensions": [
".pdf"
],
"contentTypes": [
"application/pdf"
],
"versions": []
},
{
"format": "XLIFF",
"fileExtensions": [
".xlf"
],
"contentTypes": [
"application/xliff+xml"
],
"versions": [
"1.0",
"1.1",
"1.2"
]
},
{
"format": "TSV",
"fileExtensions": [
".tsv",
".tab"
],
"contentTypes": [
"text/tab-separated-values"
],
"versions": []
},
{
"format": "CSV",
"fileExtensions": [
".csv"
],
"contentTypes": [
"text/csv"
],
"versions": []
},
{
"format": "RichTextFormat",
"fileExtensions": [
".rtf"
],
"contentTypes": [
"application/rtf"
],
"versions": []
},
{
"format": "WordDocument",
"fileExtensions": [
".doc"
],
"contentTypes": [
"application/msword"
],
"versions": []
},
{
"format": "PowerpointPresentation",
"fileExtensions": [
".ppt"
],
"contentTypes": [
"application/vnd.ms-powerpoint"
],
"versions": []
},
{
"format": "ExcelSpreadsheet",
"fileExtensions": [
".xls"
],
"contentTypes": [
"application/vnd.ms-excel"
],
"versions": []
},
{
"format": "OpenDocumentText",
"fileExtensions": [
".odt"
],
"contentTypes": [
"application/vnd.oasis.opendocument.text"
],
"versions": []
},
{
"format": "OpenDocumentPresentation",
"fileExtensions": [
".odp"
],
"contentTypes": [
"application/vnd.oasis.opendocument.presentation"
],
"versions": []
},
{
"format": "OpenDocumentSpreadsheet",
"fileExtensions": [
".ods"
],
"contentTypes": [
"application/vnd.oasis.opendocument.spreadsheet"
],
"versions": []
},
{
"format": "Markdown",
"fileExtensions": [
".markdown",
".mdown",
".mkdn",
".md",
".mkd",
".mdwn",
".mdtxt",
".mdtext",
".rmd"
],
"contentTypes": [
"text/markdown",
"text/x-markdown",
"text/plain"
],
"versions": []
},
{
"format": "Mhtml",
"fileExtensions": [
".mhtml",
".mht"
],
"contentTypes": [
"message/rfc822",
"application/x-mimearchive",
"multipart/related"
],
"versions": []
}
]
}
Esempio di risposta di errore
L'oggetto JSON seguente è un esempio di risposta di errore. Lo schema per altri codici di errore è lo stesso.
Codice di stato: 500
{
"error": {
"code": "InternalServerError",
"message": "Internal Server Error",
"innerError": {
"code": "InternalServerError",
"message": "Unexpected internal server error has occurred"
}
}
}
Passaggi successivi
Seguire la guida introduttiva per altre informazioni sull'uso della traduzione dei documenti e della raccolta client.