@azure-rest/ai-document-intelligence package
Интерфейсы
Псевдонимы типа
Функции
Сведения о функции
default(string, TokenCredential | KeyCredential, DocumentIntelligenceClientOptions)
Инициализация нового экземпляра DocumentIntelligenceClient
function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: DocumentIntelligenceClientOptions): DocumentIntelligenceClient
Параметры
- endpointParam
-
string
Конечная точка службы аналитики документов.
- credentials
уникально идентификация учетных данных клиента
параметр для всех необязательных параметров
Возвращаемое значение
getLongRunningPoller<TResult>(Client, AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, GetLongRunningPollerOptions)
Вспомогающая функция, которая создает объект Poller, чтобы помочь провести опрос длительной операции.
function getLongRunningPoller<TResult>(client: Client, initialResponse: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
Параметры
- client
- Client
Клиент, используемый для отправки запроса, чтобы получить дополнительные страницы.
- initialResponse
-
AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse
Начальный ответ.
- options
- GetLongRunningPollerOptions
Параметры для задания состояния возобновления или настраиваемого интервала опроса.
Возвращаемое значение
PollerLike<OperationState<TResult>, TResult>
- Объект опроса для проверки обновлений состояния операции и в конечном итоге получает окончательный ответ.
getLongRunningPoller<TResult>(Client, BuildModel202Response | BuildModelDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildModel202Response | BuildModelDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
Параметры
- client
- Client
- initialResponse
- options
- GetLongRunningPollerOptions
Возвращаемое значение
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, ComposeModel202Response | ComposeModelDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: ComposeModel202Response | ComposeModelDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
Параметры
- client
- Client
- initialResponse
- options
- GetLongRunningPollerOptions
Возвращаемое значение
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, CopyModelTo202Response | CopyModelToDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: CopyModelTo202Response | CopyModelToDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
Параметры
- client
- Client
- initialResponse
- options
- GetLongRunningPollerOptions
Возвращаемое значение
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, BuildClassifier202Response | BuildClassifierDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildClassifier202Response | BuildClassifierDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
Параметры
- client
- Client
- initialResponse
- options
- GetLongRunningPollerOptions
Возвращаемое значение
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, CopyClassifierTo202Response | CopyClassifierToDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: CopyClassifierTo202Response | CopyClassifierToDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
Параметры
- client
- Client
- initialResponse
-
CopyClassifierTo202Response | CopyClassifierToDefaultResponse
- options
- GetLongRunningPollerOptions
Возвращаемое значение
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
Параметры
- client
- Client
- initialResponse
-
AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse
- options
- GetLongRunningPollerOptions
Возвращаемое значение
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
Параметры
- client
- Client
- options
- GetLongRunningPollerOptions
Возвращаемое значение
PollerLike<OperationState<TResult>, TResult>
isUnexpected(ListOperations200Response | ListOperationsDefaultResponse)
function isUnexpected(response: ListOperations200Response | ListOperationsDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse)
function isUnexpected(response: GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse)
function isUnexpected(response: GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(GetOperation200Response | GetOperationDefaultResponse)
function isUnexpected(response: GetOperation200Response | GetOperationDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(GetResourceDetails200Response | GetResourceDetailsDefaultResponse)
function isUnexpected(response: GetResourceDetails200Response | GetResourceDetailsDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse)
function isUnexpected(response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(DeleteAnalyzeResult204Response | DeleteAnalyzeResultDefaultResponse)
function isUnexpected(response: DeleteAnalyzeResult204Response | DeleteAnalyzeResultDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse)
function isUnexpected(response: GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse)
function isUnexpected(response: GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse)
function isUnexpected(response: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse)
function isUnexpected(response: AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse)
function isUnexpected(response: GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(DeleteAnalyzeBatchResult204Response | DeleteAnalyzeBatchResultDefaultResponse)
function isUnexpected(response: DeleteAnalyzeBatchResult204Response | DeleteAnalyzeBatchResultDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse)
function isUnexpected(response: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(ListAnalyzeBatchResults200Response | ListAnalyzeBatchResultsDefaultResponse)
function isUnexpected(response: ListAnalyzeBatchResults200Response | ListAnalyzeBatchResultsDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(GetModel200Response | GetModelDefaultResponse)
function isUnexpected(response: GetModel200Response | GetModelDefaultResponse): response
Параметры
- response
Возвращаемое значение
response
isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse)
function isUnexpected(response: DeleteModel204Response | DeleteModelDefaultResponse): response
Параметры
- response
Возвращаемое значение
response
isUnexpected(BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse)
function isUnexpected(response: BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse)
function isUnexpected(response: ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse)
function isUnexpected(response: AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse)
function isUnexpected(response: CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(ListModels200Response | ListModelsDefaultResponse)
function isUnexpected(response: ListModels200Response | ListModelsDefaultResponse): response
Параметры
- response
Возвращаемое значение
response
isUnexpected(BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse)
function isUnexpected(response: BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse)
function isUnexpected(response: ListClassifiers200Response | ListClassifiersDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse)
function isUnexpected(response: GetClassifier200Response | GetClassifierDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse)
function isUnexpected(response: DeleteClassifier204Response | DeleteClassifierDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse)
function isUnexpected(response: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse)
function isUnexpected(response: ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse)
function isUnexpected(response: GetClassifyResult200Response | GetClassifyResultDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse)
function isUnexpected(response: AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse): response
Параметры
Возвращаемое значение
response
isUnexpected(CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse)
function isUnexpected(response: CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse): response
Параметры
Возвращаемое значение
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
Начальный ответ, содержащий следующую ссылку и текущую страницу элементов
- options
-
PagingOptions<TResponse>
Возвращаемое значение
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator для итерации элементов
parseResultIdFromResponse({ headers: { operation-location: string } })
Возвращает идентификатор операции из заголовка initialResponse
function parseResultIdFromResponse(initialResponse: { headers: { operation-location: string } }): string
Параметры
- initialResponse
-
{ headers: { operation-location: string } }
Возвращаемое значение
string
streamToUint8Array(ReadableStream)
Преобразует NodeJS.ReadableStream в Uint8Array.
function streamToUint8Array(stream: ReadableStream): Promise<Uint8Array>
Параметры
- stream
-
ReadableStream
Возвращаемое значение
Promise<Uint8Array>