DocumentTranslationClient class
Client voor de Azure AI Document Translation-service, gebruikt om batches documenten te vertalen die zijn opgeslagen in Azure Blob Storage.
Constructors
| Document |
Maakt een instantie van DocumentTranslationClient aan. |
Eigenschappen
| pipeline | De pijplijn die door deze client wordt gebruikt om aanvragen te doen |
Methoden
| cancel |
Annuleer een verwerking of vertaling in de wachtrij. Een vertaling wordt niet geannuleerd als deze al is voltooid of mislukt of geannuleerd. Er wordt een ongeldige aanvraag geretourneerd. Alle documenten die de vertaling hebben voltooid, worden niet geannuleerd en worden in rekening gebracht. Alle documenten die in behandeling zijn, worden indien mogelijk geannuleerd. |
| get |
Retourneert de vertaalstatus voor een specifiek document op basis van de aanvraag-id en document-id. |
| get |
De lijst van ondersteunde formaten die door de Document Translation-dienst worden ondersteund. De lijst bevat de algemene bestandsextensie, evenals het inhoudstype als u de upload-API gebruikt. |
| get |
Retourneert de status voor een documentomzettingsaanvraag. De status bevat de algemene aanvraagstatus, evenals de status voor documenten die worden vertaald als onderdeel van die aanvraag. |
| list |
Retourneert de status voor alle documenten in een batchdocumentomzettingsaanvraag. Als het aantal documenten in het antwoord de limiet voor paging overschrijdt, wordt paging aan de serverzijde gebruikt. Gepagineerde antwoorden geven een gedeeltelijk resultaat aan en bevatten een vervolgtoken in het antwoord. Het ontbreken van een vervolgtoken betekent dat er geen extra pagina's beschikbaar zijn. top, skip en maxPageSize-opties kunnen worden gebruikt om een aantal resultaten aan te geven die teruggegeven moeten worden en een offset voor de collectie. top geeft het totale aantal records aan dat de gebruiker over alle pagina's wil teruggeven. skip geeft het aantal records aan dat overgeslagen moet worden uit de lijst van documentstatus die door de server wordt vastgehouden op basis van de gespecificeerde sorteermethode. Standaard sorteren we op aflopende begintijd. maxPageSize is het maximale aantal items dat in een pagina wordt teruggegeven. Als er via top meer items worden aangevraagd (of top is niet gespecificeerd en er meer items moeten worden teruggestuurd), |
| list |
Retourneert een lijst met batchaanvragen die zijn ingediend en de status voor elke aanvraag. Deze lijst bevat alleen batchaanvragen die door de gebruiker zijn ingediend (op basis van de resource). Als het aantal aanvragen de limiet voor paging overschrijdt, wordt paging aan de serverzijde gebruikt. Gepagineerde antwoorden geven een gedeeltelijk resultaat aan en bevatten een vervolgtoken in het antwoord. Het ontbreken van een vervolgtoken betekent dat er geen extra pagina's beschikbaar zijn. top, skip en maxPageSize-opties kunnen worden gebruikt om een aantal resultaten aan te geven die teruggegeven moeten worden en een offset voor de collectie. top geeft het totale aantal records aan dat de gebruiker over alle pagina's wil teruggeven. skip geeft het aantal records aan dat uit de lijst met batches moet worden overgeslagen op basis van de gespecificeerde sorteermethode. Standaard sorteren we op aflopende begintijd. maxPageSize is het maximale aantal items dat in een pagina wordt teruggegeven. Als er via top meer items worden aangevraagd (of top is niet gespecificeerd en er meer items moeten worden teruggestuurd), |
| start |
Gebruik deze API om een bulkomzettingsaanvraag (batch) naar de service documentomzetting te verzenden. Elke aanvraag kan meerdere documenten bevatten en moet een bron- en doelcontainer voor elk document bevatten. Het voorvoegsel- en achtervoegselfilter (indien opgegeven) worden gebruikt om mappen te filteren. Het voorvoegsel wordt toegepast op het subpad na de containernaam. Woordenlijsten/vertaalgeheugen kunnen worden opgenomen in de aanvraag en worden door de service toegepast wanneer het document wordt vertaald. Als de woordenlijst tijdens de vertaling ongeldig of onbereikbaar is, wordt een fout aangegeven in de documentstatus. Als er al een bestand met dezelfde naam op de bestemming bestaat, wordt het overschreven. De targetUrl voor elke doeltaal moet uniek zijn. |
Constructordetails
DocumentTranslationClient(string, KeyCredential | TokenCredential, DocumentTranslationClientOptionalParams)
Maakt een instantie van DocumentTranslationClient aan.
new DocumentTranslationClient(endpointParam: string, credential: KeyCredential | TokenCredential, options?: DocumentTranslationClientOptionalParams)Parameters
- endpointParam
-
string
Het Document Translation-eindpunt, bijvoorbeeld https://<resource-name>.cognitiveservices.azure.com.
- credential
Een sleutelinloggegevens of tokencredential die worden gebruikt om verzoeken aan de dienst te authenticeren.
Opties om de client te configureren.
Eigenschapdetails
pipeline
De pijplijn die door deze client wordt gebruikt om aanvragen te doen
pipeline: PipelineWaarde van eigenschap
Methodedetails
cancelTranslation(string, CancelTranslationOptionalParams)
Annuleer een verwerking of vertaling in de wachtrij. Een vertaling wordt niet geannuleerd als deze al is voltooid of mislukt of geannuleerd. Er wordt een ongeldige aanvraag geretourneerd. Alle documenten die de vertaling hebben voltooid, worden niet geannuleerd en worden in rekening gebracht. Alle documenten die in behandeling zijn, worden indien mogelijk geannuleerd.
function cancelTranslation(translationId: string, options?: CancelTranslationOptionalParams): Promise<TranslationStatus>Parameters
- translationId
-
string
- options
- CancelTranslationOptionalParams
Retouren
Promise<TranslationStatus>
getDocumentStatus(string, string, GetDocumentStatusOptionalParams)
Retourneert de vertaalstatus voor een specifiek document op basis van de aanvraag-id en document-id.
function getDocumentStatus(translationId: string, documentId: string, options?: GetDocumentStatusOptionalParams): Promise<DocumentStatus>Parameters
- translationId
-
string
- documentId
-
string
- options
- GetDocumentStatusOptionalParams
Retouren
Promise<DocumentStatus>
getSupportedFormats(FileFormatType, GetSupportedFormatsOptionalParams)
De lijst van ondersteunde formaten die door de Document Translation-dienst worden ondersteund. De lijst bevat de algemene bestandsextensie, evenals het inhoudstype als u de upload-API gebruikt.
function getSupportedFormats(typeParam: FileFormatType, options?: GetSupportedFormatsOptionalParams): Promise<SupportedFileFormats>Parameters
- typeParam
- FileFormatType
Retouren
Promise<SupportedFileFormats>
getTranslationStatus(string, GetTranslationStatusOptionalParams)
Retourneert de status voor een documentomzettingsaanvraag. De status bevat de algemene aanvraagstatus, evenals de status voor documenten die worden vertaald als onderdeel van die aanvraag.
function getTranslationStatus(translationId: string, options?: GetTranslationStatusOptionalParams): Promise<TranslationStatus>Parameters
- translationId
-
string
Retouren
Promise<TranslationStatus>
listDocumentStatuses(string, ListDocumentStatusesOptionalParams)
Retourneert de status voor alle documenten in een batchdocumentomzettingsaanvraag.
Als het aantal documenten in het antwoord de limiet voor paging overschrijdt, wordt paging aan de serverzijde gebruikt. Gepagineerde antwoorden geven een gedeeltelijk resultaat aan en bevatten een vervolgtoken in het antwoord. Het ontbreken van een vervolgtoken betekent dat er geen extra pagina's beschikbaar zijn.
top, skip en maxPageSize-opties kunnen worden gebruikt om een aantal resultaten aan te geven die teruggegeven moeten worden en een offset voor de collectie.
top geeft het totale aantal records aan dat de gebruiker over alle pagina's wil teruggeven. skip geeft het aantal records aan dat overgeslagen moet worden uit de lijst van documentstatus die door de server wordt vastgehouden op basis van de gespecificeerde sorteermethode. Standaard sorteren we op aflopende begintijd. maxPageSize is het maximale aantal items dat in een pagina wordt teruggegeven. Als er via top meer items worden aangevraagd (of top is niet gespecificeerd en er meer items moeten worden teruggestuurd),
function listDocumentStatuses(translationId: string, options?: ListDocumentStatusesOptionalParams): PagedAsyncIterableIterator<DocumentStatus, DocumentStatus[], PageSettings>Parameters
- translationId
-
string
Retouren
listTranslationStatuses(ListTranslationStatusesOptionalParams)
Retourneert een lijst met batchaanvragen die zijn ingediend en de status voor elke aanvraag. Deze lijst bevat alleen batchaanvragen die door de gebruiker zijn ingediend (op basis van de resource).
Als het aantal aanvragen de limiet voor paging overschrijdt, wordt paging aan de serverzijde gebruikt. Gepagineerde antwoorden geven een gedeeltelijk resultaat aan en bevatten een vervolgtoken in het antwoord. Het ontbreken van een vervolgtoken betekent dat er geen extra pagina's beschikbaar zijn.
top, skip en maxPageSize-opties kunnen worden gebruikt om een aantal resultaten aan te geven die teruggegeven moeten worden en een offset voor de collectie.
top geeft het totale aantal records aan dat de gebruiker over alle pagina's wil teruggeven. skip geeft het aantal records aan dat uit de lijst met batches moet worden overgeslagen op basis van de gespecificeerde sorteermethode. Standaard sorteren we op aflopende begintijd. maxPageSize is het maximale aantal items dat in een pagina wordt teruggegeven. Als er via top meer items worden aangevraagd (of top is niet gespecificeerd en er meer items moeten worden teruggestuurd),
function listTranslationStatuses(options?: ListTranslationStatusesOptionalParams): PagedAsyncIterableIterator<TranslationStatus, TranslationStatus[], PageSettings>Parameters
Retouren
startTranslation(StartTranslationDetails, StartTranslationOptionalParams)
Gebruik deze API om een bulkomzettingsaanvraag (batch) naar de service documentomzetting te verzenden. Elke aanvraag kan meerdere documenten bevatten en moet een bron- en doelcontainer voor elk document bevatten.
Het voorvoegsel- en achtervoegselfilter (indien opgegeven) worden gebruikt om mappen te filteren. Het voorvoegsel wordt toegepast op het subpad na de containernaam.
Woordenlijsten/vertaalgeheugen kunnen worden opgenomen in de aanvraag en worden door de service toegepast wanneer het document wordt vertaald.
Als de woordenlijst tijdens de vertaling ongeldig of onbereikbaar is, wordt een fout aangegeven in de documentstatus. Als er al een bestand met dezelfde naam op de bestemming bestaat, wordt het overschreven. De targetUrl voor elke doeltaal moet uniek zijn.
function startTranslation(body: StartTranslationDetails, options?: StartTranslationOptionalParams): PollerLike<OperationState<TranslationStatus>, TranslationStatus>Parameters
- options
- StartTranslationOptionalParams