DocumentTranslationClient class
Klient för Azure AI Document Translation-tjänsten, används för att översätta batcher av dokument lagrade i Azure Blob Storage.
Konstruktorer
| Document |
Skapar en instans av DocumentTranslationClient. |
Egenskaper
| pipeline | Pipelinen som används av den här klienten för att göra begäranden |
Metoder
| cancel |
Avbryt en bearbetning eller köad översättning. En översättning avbryts inte om den redan har slutförts eller misslyckats eller avbrutits. En felaktig begäran returneras. Alla dokument som har slutfört översättningen avbryts inte och debiteras. Alla väntande dokument avbryts om möjligt. |
| get |
Returnerar översättningsstatus för ett visst dokument baserat på begärande-ID och dokument-ID. |
| get |
Listan över stödda format som stöds av Document Translation-tjänsten. Listan innehåller det gemensamma filtillägget samt innehållstypen om du använder uppladdnings-API:et. |
| get |
Returnerar status för en dokumentöversättningsbegäran. Statusen innehåller den övergripande begärandestatusen samt statusen för dokument som översätts som en del av den begäran. |
| list |
Returnerar status för alla dokument i en begäran om översättning av batchdokument. Om antalet dokument i svaret överskrider vår växlingsgräns används växling på serversidan. Sidnumrerade svar anger ett partiellt resultat och innehåller en fortsättningstoken i svaret. Avsaknaden av en fortsättningstoken innebär att inga ytterligare sidor är tillgängliga. top, skip och maxPageSize-alternativen kan användas för att specificera ett antal resultat som ska returneras och en offset för samlingen. Top anger det totala antalet poster som användaren vill ska returneras över alla sidor. Skip anger antalet poster som ska hoppas över från listan över dokumentstatus som servern har baserat på den angivna sorteringsmetoden. Som standard sorterar vi efter fallande starttid. maxPageSize är det maximala antalet objekt som returneras på en sida. Om fler föremål begärs via top (eller top inte anges och det finns fler saker att returnera), |
| list |
Returnerar en lista över skickade batchbegäranden och status för varje begäran. Den här listan innehåller endast batchbegäranden som skickats av användaren (baserat på resursen). Om antalet begäranden överskrider vår växlingsgräns används växling på serversidan. Sidnumrerade svar anger ett partiellt resultat och innehåller en fortsättningstoken i svaret. Avsaknaden av en fortsättningstoken innebär att inga ytterligare sidor är tillgängliga. top, skip och maxPageSize-alternativen kan användas för att specificera ett antal resultat som ska returneras och en offset för samlingen. Top anger det totala antalet poster som användaren vill ska returneras över alla sidor. Skip anger antalet poster som ska hoppas över från listan över batcher baserat på den angivna sorteringsmetoden. Som standard sorterar vi efter fallande starttid. maxPageSize är det maximala antalet objekt som returneras på en sida. Om fler föremål begärs via top (eller top inte anges och det finns fler saker att returnera), |
| start |
Använd det här API:et för att skicka en massöversättningsbegäran (batch) till dokumentöversättningstjänsten. Varje begäran kan innehålla flera dokument och måste innehålla en käll- och målcontainer för varje dokument. Prefixet och suffixfiltret (om det tillhandahålls) används för att filtrera mappar. Prefixet tillämpas på undersökvägen efter containernamnet. Ordlistor/översättningsminne kan ingå i begäran och tillämpas av tjänsten när dokumentet översätts. Om ordlistan är ogiltig eller inte kan nås under översättningen visas ett fel i dokumentstatusen. Om det redan finns en fil med samma namn på målet skrivs den över. TargetUrl för varje målspråk måste vara unikt. |
Konstruktorinformation
DocumentTranslationClient(string, KeyCredential | TokenCredential, DocumentTranslationClientOptionalParams)
Skapar en instans av DocumentTranslationClient.
new DocumentTranslationClient(endpointParam: string, credential: KeyCredential | TokenCredential, options?: DocumentTranslationClientOptionalParams)Parametrar
- endpointParam
-
string
Ändpunkten för dokumentöversättning, till exempel https://<resource-name>.cognitiveservices.azure.com.
- credential
En nyckellegitimation eller token-credential som används för att autentisera förfrågningar till tjänsten.
Alternativ som används för att konfigurera klienten.
Egenskapsinformation
pipeline
Pipelinen som används av den här klienten för att göra begäranden
pipeline: PipelineEgenskapsvärde
Metodinformation
cancelTranslation(string, CancelTranslationOptionalParams)
Avbryt en bearbetning eller köad översättning. En översättning avbryts inte om den redan har slutförts eller misslyckats eller avbrutits. En felaktig begäran returneras. Alla dokument som har slutfört översättningen avbryts inte och debiteras. Alla väntande dokument avbryts om möjligt.
function cancelTranslation(translationId: string, options?: CancelTranslationOptionalParams): Promise<TranslationStatus>Parametrar
- translationId
-
string
- options
- CancelTranslationOptionalParams
Returer
Promise<TranslationStatus>
getDocumentStatus(string, string, GetDocumentStatusOptionalParams)
Returnerar översättningsstatus för ett visst dokument baserat på begärande-ID och dokument-ID.
function getDocumentStatus(translationId: string, documentId: string, options?: GetDocumentStatusOptionalParams): Promise<DocumentStatus>Parametrar
- translationId
-
string
- documentId
-
string
- options
- GetDocumentStatusOptionalParams
Returer
Promise<DocumentStatus>
getSupportedFormats(FileFormatType, GetSupportedFormatsOptionalParams)
Listan över stödda format som stöds av Document Translation-tjänsten. Listan innehåller det gemensamma filtillägget samt innehållstypen om du använder uppladdnings-API:et.
function getSupportedFormats(typeParam: FileFormatType, options?: GetSupportedFormatsOptionalParams): Promise<SupportedFileFormats>Parametrar
- typeParam
- FileFormatType
Returer
Promise<SupportedFileFormats>
getTranslationStatus(string, GetTranslationStatusOptionalParams)
Returnerar status för en dokumentöversättningsbegäran. Statusen innehåller den övergripande begärandestatusen samt statusen för dokument som översätts som en del av den begäran.
function getTranslationStatus(translationId: string, options?: GetTranslationStatusOptionalParams): Promise<TranslationStatus>Parametrar
- translationId
-
string
Returer
Promise<TranslationStatus>
listDocumentStatuses(string, ListDocumentStatusesOptionalParams)
Returnerar status för alla dokument i en begäran om översättning av batchdokument.
Om antalet dokument i svaret överskrider vår växlingsgräns används växling på serversidan. Sidnumrerade svar anger ett partiellt resultat och innehåller en fortsättningstoken i svaret. Avsaknaden av en fortsättningstoken innebär att inga ytterligare sidor är tillgängliga.
top, skip och maxPageSize-alternativen kan användas för att specificera ett antal resultat som ska returneras och en offset för samlingen.
Top anger det totala antalet poster som användaren vill ska returneras över alla sidor. Skip anger antalet poster som ska hoppas över från listan över dokumentstatus som servern har baserat på den angivna sorteringsmetoden. Som standard sorterar vi efter fallande starttid. maxPageSize är det maximala antalet objekt som returneras på en sida. Om fler föremål begärs via top (eller top inte anges och det finns fler saker att returnera),
function listDocumentStatuses(translationId: string, options?: ListDocumentStatusesOptionalParams): PagedAsyncIterableIterator<DocumentStatus, DocumentStatus[], PageSettings>Parametrar
- translationId
-
string
Returer
listTranslationStatuses(ListTranslationStatusesOptionalParams)
Returnerar en lista över skickade batchbegäranden och status för varje begäran. Den här listan innehåller endast batchbegäranden som skickats av användaren (baserat på resursen).
Om antalet begäranden överskrider vår växlingsgräns används växling på serversidan. Sidnumrerade svar anger ett partiellt resultat och innehåller en fortsättningstoken i svaret. Avsaknaden av en fortsättningstoken innebär att inga ytterligare sidor är tillgängliga.
top, skip och maxPageSize-alternativen kan användas för att specificera ett antal resultat som ska returneras och en offset för samlingen.
Top anger det totala antalet poster som användaren vill ska returneras över alla sidor. Skip anger antalet poster som ska hoppas över från listan över batcher baserat på den angivna sorteringsmetoden. Som standard sorterar vi efter fallande starttid. maxPageSize är det maximala antalet objekt som returneras på en sida. Om fler föremål begärs via top (eller top inte anges och det finns fler saker att returnera),
function listTranslationStatuses(options?: ListTranslationStatusesOptionalParams): PagedAsyncIterableIterator<TranslationStatus, TranslationStatus[], PageSettings>Parametrar
Returer
startTranslation(StartTranslationDetails, StartTranslationOptionalParams)
Använd det här API:et för att skicka en massöversättningsbegäran (batch) till dokumentöversättningstjänsten. Varje begäran kan innehålla flera dokument och måste innehålla en käll- och målcontainer för varje dokument.
Prefixet och suffixfiltret (om det tillhandahålls) används för att filtrera mappar. Prefixet tillämpas på undersökvägen efter containernamnet.
Ordlistor/översättningsminne kan ingå i begäran och tillämpas av tjänsten när dokumentet översätts.
Om ordlistan är ogiltig eller inte kan nås under översättningen visas ett fel i dokumentstatusen. Om det redan finns en fil med samma namn på målet skrivs den över. TargetUrl för varje målspråk måste vara unikt.
function startTranslation(body: StartTranslationDetails, options?: StartTranslationOptionalParams): PollerLike<OperationState<TranslationStatus>, TranslationStatus>Parametrar
- options
- StartTranslationOptionalParams