次の方法で共有

@azure-rest/ai-translation-document package

インターフェイス

BatchRequest

入力バッチ変換要求の定義
CancelTranslation200Response

要求は成功しました。
CancelTranslationDefaultHeaders
CancelTranslationDefaultResponse
DocumentFilter

ドキュメント フィルター
DocumentStatusOutput

ドキュメントの状態の応答
DocumentTranslate
DocumentTranslate200Headers
DocumentTranslate200Response

要求は成功しました。
DocumentTranslateBodyParam
DocumentTranslateContentDocumentPartDescriptor
DocumentTranslateContentGlossaryPartDescriptor
DocumentTranslateDefaultHeaders
DocumentTranslateDefaultResponse
DocumentTranslateHeaderParam
DocumentTranslateHeaders
DocumentTranslateMediaTypesParam
DocumentTranslateQueryParam
DocumentTranslateQueryParamProperties
DocumentTranslationClientOptions

クライアントの省略可能なパラメーター
DocumentsStatusOutput

ドキュメントの状態の応答
FileFormatOutput

ファイル形式
GetDocumentStatus
GetDocumentStatus200Response

要求は成功しました。
GetDocumentStatusDefaultHeaders
GetDocumentStatusDefaultResponse
GetDocumentsStatus
GetDocumentsStatus200Response

要求は成功しました。
GetDocumentsStatusDefaultHeaders
GetDocumentsStatusDefaultResponse
GetDocumentsStatusQueryParam
GetDocumentsStatusQueryParamProperties
GetSupportedFormats
GetSupportedFormats200Response

要求は成功しました。
GetSupportedFormatsDefaultHeaders
GetSupportedFormatsDefaultResponse
GetSupportedFormatsQueryParam
GetSupportedFormatsQueryParamProperties
GetTranslationStatus
GetTranslationStatus200Response

要求は成功しました。
GetTranslationStatusDefaultHeaders
GetTranslationStatusDefaultResponse
GetTranslationsStatus200Response

要求は成功しました。
GetTranslationsStatusDefaultHeaders
GetTranslationsStatusDefaultResponse
GetTranslationsStatusQueryParam
GetTranslationsStatusQueryParamProperties
Glossary

要求の用語集/翻訳メモリ
InnerTranslationErrorOutput

https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owで利用可能な Cognitive Services API ガイドラインに準拠した新しい内部エラー形式。 これには、必須プロパティ ErrorCode、メッセージ、および省略可能なプロパティ ターゲット、details(キー値ペア)、内部エラー (入れ子にできます) が含まれます。
PagingOptions

ページング ヘルパーのオプション
Routes
SimplePollerLike

実行時間の長い操作をポーリングするために使用できる単純なポーリングツール。
SourceInput

入力ドキュメントのソース
StartTranslation
StartTranslation202Headers
StartTranslation202Response

要求は処理のために受け入れ済みですが、処理はまだ完了していません。
StartTranslationBodyParam
StartTranslationDefaultHeaders
StartTranslationDefaultResponse
StartTranslationDetails

翻訳ジョブの送信バッチ要求
StartTranslationLogicalResponse

実行時間の長い startTranslation 操作の最後の応答
StatusSummaryOutput

状態の概要
SupportedFileFormatsOutput

サポートされているファイル形式の一覧
TargetInput

完成した翻訳済みドキュメントの宛先
TranslationErrorOutput

これには、エラー コード、メッセージ、詳細、ターゲットを含む外部エラーと、よりわかりやすい詳細を含む内部エラーが含まれます。
TranslationStatusOutput

翻訳ジョブの状態の応答
TranslationsStatusOutput

翻訳ジョブの状態の応答

型エイリアス

CancelTranslationParameters
DocumentTranslateContent

ドキュメント翻訳要求コンテンツ
DocumentTranslateParameters
DocumentTranslationClient
FileFormatType

FileFormatType のエイリアス
GetArrayType

配列の型を抽出するヘルパー型
GetDocumentStatusParameters
GetDocumentsStatusParameters
GetPage

ページの取得方法と、次のページへのリンク (ある場合) を定義するカスタム関数の型。
GetSupportedFormatsParameters
GetTranslationStatusParameters
GetTranslationsStatusParameters
PaginateReturn

応答型からページングされた要素の型を推測するヘルパー型。この型は、ページアイテムが見つかった応答のプロパティを示す itemName プロパティに対する x-ms-pageable の swagger 情報に基づいて生成されます。 既定値は valueです。 この型を使用すると、2 番目のパラメーターとして取得する応答に基づいて、厳密に型指定された反復子を提供できます
StartTranslationParameters
StatusOutput

StatusOutput のエイリアス
StorageInputType

StorageInputType のエイリアス
StorageSource

StorageSource のエイリアス
TranslationErrorCodeOutput

TranslationErrorCodeOutput のエイリアス

関数

default(string, TokenCredential | KeyCredential, DocumentTranslationClientOptions)

DocumentTranslationClient の新しいインスタンスを初期化する
getLongRunningPoller<TResult>(Client, StartTranslationDefaultResponse | StartTranslation202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

実行時間の長い操作のポーリングに役立つ Poller オブジェクトを構築するヘルパー関数。
isUnexpected(DocumentTranslate200Response | DocumentTranslateDefaultResponse)
isUnexpected(StartTranslationLogicalResponse | StartTranslationDefaultResponse | StartTranslation202Response)
isUnexpected(GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse)
isUnexpected(GetDocumentStatus200Response | GetDocumentStatusDefaultResponse)
isUnexpected(GetTranslationStatus200Response | GetTranslationStatusDefaultResponse)
isUnexpected(CancelTranslation200Response | CancelTranslationDefaultResponse)
isUnexpected(GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse)
isUnexpected(GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Autorest x-ms-pageable 拡張機能の仕様に従った最初の応答からの結果を改ページするヘルパー

関数の詳細

default(string, TokenCredential | KeyCredential, DocumentTranslationClientOptions)

DocumentTranslationClient の新しいインスタンスを初期化する

function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: DocumentTranslationClientOptions): DocumentTranslationClient

パラメーター

endpointParam

string

サポートされているドキュメント変換エンドポイント、プロトコル、ホスト名(例: https://{TranslatorResourceName}.cognitiveservices.azure.com/translator。

credentials

TokenCredential | KeyCredential

クライアント資格情報を一意に識別する

options
DocumentTranslationClientOptions

すべての省略可能なパラメーターのパラメーター

戻り値

DocumentTranslationClient

getLongRunningPoller<TResult>(Client, StartTranslationDefaultResponse | StartTranslation202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

実行時間の長い操作のポーリングに役立つ Poller オブジェクトを構築するヘルパー関数。

function getLongRunningPoller<TResult>(client: Client, initialResponse: StartTranslationDefaultResponse | StartTranslation202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

パラメーター

client
Client

追加のページを取得する要求の送信に使用するクライアント。

initialResponse

StartTranslationDefaultResponse | StartTranslation202Response

最初の応答。

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

再開状態またはカスタム ポーリング間隔を設定するオプション。

戻り値

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

  • 操作状態の更新をポーリングし、最終的に最終的な応答を取得するポーリング オブジェクト。

isUnexpected(DocumentTranslate200Response | DocumentTranslateDefaultResponse) 

function isUnexpected(response: DocumentTranslate200Response | DocumentTranslateDefaultResponse): response

パラメーター

response

DocumentTranslate200Response | DocumentTranslateDefaultResponse

戻り値

response

isUnexpected(StartTranslationLogicalResponse | StartTranslationDefaultResponse | StartTranslation202Response) 

function isUnexpected(response: StartTranslationLogicalResponse | StartTranslationDefaultResponse | StartTranslation202Response): response

パラメーター

response

StartTranslationLogicalResponse | StartTranslationDefaultResponse | StartTranslation202Response

戻り値

response

isUnexpected(GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse) 

function isUnexpected(response: GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse): response

パラメーター

response

GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse

戻り値

response

isUnexpected(GetDocumentStatus200Response | GetDocumentStatusDefaultResponse) 

function isUnexpected(response: GetDocumentStatus200Response | GetDocumentStatusDefaultResponse): response

パラメーター

response

GetDocumentStatus200Response | GetDocumentStatusDefaultResponse

戻り値

response

isUnexpected(GetTranslationStatus200Response | GetTranslationStatusDefaultResponse) 

function isUnexpected(response: GetTranslationStatus200Response | GetTranslationStatusDefaultResponse): response

パラメーター

response

GetTranslationStatus200Response | GetTranslationStatusDefaultResponse

戻り値

response

isUnexpected(CancelTranslation200Response | CancelTranslationDefaultResponse) 

function isUnexpected(response: CancelTranslation200Response | CancelTranslationDefaultResponse): response

パラメーター

response

CancelTranslation200Response | CancelTranslationDefaultResponse

戻り値

response

isUnexpected(GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse) 

function isUnexpected(response: GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse): response

パラメーター

response

GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse

戻り値

response

isUnexpected(GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse) 

function isUnexpected(response: GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse): response

パラメーター

response

GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse

戻り値

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Autorest x-ms-pageable 拡張機能の仕様に従った最初の応答からの結果を改ページするヘルパー

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

パラメーター

client
Client

次のページ要求の送信に使用するクライアント

initialResponse

TResponse

nextLink と要素の現在のページを含む初期応答

options

PagingOptions<TResponse>

戻り値

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

  • PagedAsyncIterableIterator を使用して要素を反復処理する