Поделиться через

@azure-rest/ai-document-intelligence package

Интерфейсы

AddressValueOutput

Значение поля адреса.
AnalyzeBatchDocuments
AnalyzeBatchDocuments202Headers
AnalyzeBatchDocuments202Response

Запрос был принят для обработки, но обработка еще не завершена.
AnalyzeBatchDocumentsBodyParam
AnalyzeBatchDocumentsDefaultResponse
AnalyzeBatchDocumentsLogicalResponse

Окончательный ответ для длительных операций анализаBatchDocuments
AnalyzeBatchDocumentsMediaTypesParam
AnalyzeBatchDocumentsQueryParam
AnalyzeBatchDocumentsQueryParamProperties
AnalyzeBatchDocumentsRequest

Параметры анализа документов пакетной службы.
AnalyzeBatchOperationDetailOutput

Сведения об операции для документа в пакетном анализе.
AnalyzeBatchResultOperationOutput

Состояние и результат выполнения пакетной операции анализа.
AnalyzeBatchResultOutput

Результат анализа пакетного документа.
AnalyzeDocument202Headers
AnalyzeDocument202Response

Запрос был принят для обработки, но обработка еще не завершена.
AnalyzeDocumentBodyParam
AnalyzeDocumentDefaultResponse
AnalyzeDocumentFromStream
AnalyzeDocumentFromStream202Headers
AnalyzeDocumentFromStream202Response

Запрос был принят для обработки, но обработка еще не завершена.
AnalyzeDocumentFromStreamBodyParam
AnalyzeDocumentFromStreamDefaultResponse
AnalyzeDocumentFromStreamLogicalResponse

Окончательный ответ для длительной операции анализаDocumentFromStream
AnalyzeDocumentFromStreamMediaTypesParam
AnalyzeDocumentFromStreamQueryParam
AnalyzeDocumentFromStreamQueryParamProperties
AnalyzeDocumentLogicalResponse

Окончательный ответ для длительной операции анализаDocument
AnalyzeDocumentMediaTypesParam
AnalyzeDocumentQueryParam
AnalyzeDocumentQueryParamProperties
AnalyzeDocumentRequest

Параметры анализа документов.
AnalyzeResultOperationOutput

Состояние и результат операции анализа.
AnalyzeResultOutput

Результат анализа документов.
AuthorizeClassifierCopy
AuthorizeClassifierCopy200Response

Запрос выполнен успешно.
AuthorizeClassifierCopyBodyParam
AuthorizeClassifierCopyDefaultResponse
AuthorizeClassifierCopyRequest

Текст запроса на авторизацию копирования классификатора документов.
AuthorizeCopyRequest

Текст запроса на авторизацию копирования модели документов.
AuthorizeModelCopy
AuthorizeModelCopy200Response

Запрос выполнен успешно.
AuthorizeModelCopyBodyParam
AuthorizeModelCopyDefaultResponse
AzureBlobContentSource

Содержимое хранилища BLOB-объектов Azure.
AzureBlobContentSourceOutput

Содержимое хранилища BLOB-объектов Azure.
AzureBlobFileListContentSource

Список файлов в хранилище BLOB-объектов Azure.
AzureBlobFileListContentSourceOutput

Список файлов в хранилище BLOB-объектов Azure.
BoundingRegionOutput

Ограничивающий многоугольник на определенной странице входных данных.
BuildClassifier
BuildClassifier202Headers
BuildClassifier202Response

Запрос был принят для обработки, но обработка еще не завершена.
BuildClassifierBodyParam
BuildClassifierDefaultResponse
BuildClassifierLogicalResponse

Окончательный ответ для длительной операции buildClassifier
BuildDocumentClassifierRequest

Текст запроса на создание нового пользовательского классификатора документов.
BuildDocumentModelRequest

Текст запроса на создание новой пользовательской модели документов.
BuildModel
BuildModel202Headers
BuildModel202Response

Запрос был принят для обработки, но обработка еще не завершена.
BuildModelBodyParam
BuildModelDefaultResponse
BuildModelLogicalResponse

Окончательный ответ для длительной операции buildModel
ClassifierCopyAuthorization

Авторизация для копирования классификатора документов в указанный целевой ресурс и классификаторId.
ClassifierCopyAuthorizationOutput

Авторизация для копирования классификатора документов в указанный целевой ресурс и классификаторId.
ClassifierDocumentTypeDetails

Сведения о типе документа классификатора.
ClassifierDocumentTypeDetailsOutput

Сведения о типе документа классификатора.
ClassifyDocument202Headers
ClassifyDocument202Response

Запрос был принят для обработки, но обработка еще не завершена.
ClassifyDocumentBodyParam
ClassifyDocumentDefaultResponse
ClassifyDocumentFromStream
ClassifyDocumentFromStream202Headers
ClassifyDocumentFromStream202Response

Запрос был принят для обработки, но обработка еще не завершена.
ClassifyDocumentFromStreamBodyParam
ClassifyDocumentFromStreamDefaultResponse
ClassifyDocumentFromStreamLogicalResponse

Окончательный ответ для длительной операции classifyDocumentFromStream
ClassifyDocumentFromStreamMediaTypesParam
ClassifyDocumentFromStreamQueryParam
ClassifyDocumentFromStreamQueryParamProperties
ClassifyDocumentLogicalResponse

Окончательный ответ для длительной операции classifyDocument
ClassifyDocumentMediaTypesParam
ClassifyDocumentQueryParam
ClassifyDocumentQueryParamProperties
ClassifyDocumentRequest

Параметры классификации документов.
ComposeDocumentModelRequest

Текст запроса на создание модели составного документа из моделей документов компонентов.
ComposeModel
ComposeModel202Headers
ComposeModel202Response

Запрос был принят для обработки, но обработка еще не завершена.
ComposeModelBodyParam
ComposeModelDefaultResponse
ComposeModelLogicalResponse

Окончательный ответ для длительной операции composeModel
CopyAuthorization

Авторизация для копирования модели документов в указанный целевой ресурс и modelId.
CopyAuthorizationOutput

Авторизация для копирования модели документов в указанный целевой ресурс и modelId.
CopyClassifierTo
CopyClassifierTo202Headers
CopyClassifierTo202Response

Запрос был принят для обработки, но обработка еще не завершена.
CopyClassifierToBodyParam
CopyClassifierToDefaultResponse
CopyClassifierToLogicalResponse

Окончательный ответ для длительной операции copyClassifierTo
CopyModelTo
CopyModelTo202Headers
CopyModelTo202Response

Запрос был принят для обработки, но обработка еще не завершена.
CopyModelToBodyParam
CopyModelToDefaultResponse
CopyModelToLogicalResponse

Окончательный ответ для длительной операции copyModelTo
CurrencyValueOutput

Значение поля валюты.
CustomDocumentModelsDetailsOutput

Сведения о пользовательских моделях документов.
DeleteClassifier204Headers
DeleteClassifier204Response

Для этого запроса нет содержимого, но заголовки могут быть полезны.
DeleteClassifierDefaultResponse
DeleteClassifierHeaderParam
DeleteClassifierHeaders
DeleteModel204Headers
DeleteModel204Response

Для этого запроса нет содержимого, но заголовки могут быть полезны.
DeleteModelDefaultResponse
DeleteModelHeaderParam
DeleteModelHeaders
DocumentBarcodeOutput

Объект штрихкода.
DocumentCaptionOutput

Объект заголовка, описывающий таблицу или рисунок.
DocumentClassifierBuildOperationDetailsOutput

Получение объекта ответа операции.
DocumentClassifierCopyToOperationDetailsOutput

Получение объекта ответа операции.
DocumentClassifierDetailsOutput

Сведения о классификаторе документов.
DocumentFieldOutput

Объект, представляющий содержимое и расположение значения поля.
DocumentFieldSchema

Описание семантической схемы поля с помощью синтаксиса стиля схемы JSON.
DocumentFieldSchemaOutput

Описание семантической схемы поля с помощью синтаксиса стиля схемы JSON.
DocumentFigureOutput

Объект, представляющий фигуру в документе.
DocumentFootnoteOutput

Объект сноски, описывающий таблицу или рисунок.
DocumentFormulaOutput

Объект формулы.
DocumentIntelligenceClientOptions

Необязательные параметры для клиента
DocumentKeyValueElementOutput

Объект, представляющий ключ поля или значение в паре "ключ-значение".
DocumentKeyValuePairOutput

Объект, представляющий поле формы с отдельной меткой поля (ключом) и значением поля (может быть пустым).
DocumentLanguageOutput

Объект, представляющий обнаруженный язык для заданного диапазона текста.
DocumentLineOutput

Объект строки содержимого, состоящий из соседней последовательности элементов содержимого, таких как слова и знаки выделения.
DocumentModelBuildOperationDetailsOutput

Получение объекта ответа операции.
DocumentModelComposeOperationDetailsOutput

Получение объекта ответа операции.
DocumentModelCopyToOperationDetailsOutput

Получение объекта ответа операции.
DocumentModelDetailsOutput

Сведения о модели документа.
DocumentOutput

Объект, описывающий расположение и семантическое содержимое документа.
DocumentPageOutput

Элементы содержимого и макета, извлеченные на странице из входных данных.
DocumentParagraphOutput

Объект абзаца, состоящий с смежными линиями, как правило, с общим выравниванием и интервалами.
DocumentSectionOutput

Объект, представляющий раздел в документе.
DocumentSelectionMarkOutput

Объект метки выбора, представляющий флажки, переключатели и другие элементы, указывающие на выделение.
DocumentSpanOutput

Непрерывная область сцепленного свойства содержимого, указанная как смещение и длина.
DocumentStyleOutput

Объект, представляющий наблюдаемые стили текста.
DocumentTableCellOutput

Объект, представляющий расположение и содержимое ячейки таблицы.
DocumentTableOutput

Объект таблицы, состоящий из ячеек таблицы, расположенных в прямоугольном макете.
DocumentTypeDetails

Сведения о типе документа.
DocumentTypeDetailsOutput

Сведения о типе документа.
DocumentWordOutput

Объект слова, состоящий из непрерывной последовательности символов. Для языков, не разделенных пробелами, таких как китайский, японский и корейский, каждый символ представлен как собственное слово.
ErrorModelOutput

Объект ошибки.
ErrorResponseOutput

Объект ответа об ошибке.
GetAnalyzeBatchResult
GetAnalyzeBatchResult200Response

Запрос выполнен успешно.
GetAnalyzeBatchResultDefaultResponse
GetAnalyzeResult
GetAnalyzeResult200Response

Запрос выполнен успешно.
GetAnalyzeResultDefaultResponse
GetAnalyzeResultFigure
GetAnalyzeResultFigure200Headers
GetAnalyzeResultFigure200Response

Запрос выполнен успешно.
GetAnalyzeResultFigureDefaultResponse
GetAnalyzeResultPdf
GetAnalyzeResultPdf200Headers
GetAnalyzeResultPdf200Response

Запрос выполнен успешно.
GetAnalyzeResultPdfDefaultResponse
GetClassifier
GetClassifier200Headers
GetClassifier200Response

Запрос выполнен успешно.
GetClassifierDefaultResponse
GetClassifierHeaderParam
GetClassifierHeaders
GetClassifyResult
GetClassifyResult200Response

Запрос выполнен успешно.
GetClassifyResultDefaultResponse
GetDocumentClassifierBuildOperation200Headers
GetDocumentClassifierBuildOperation200Response

Запрос выполнен успешно.
GetDocumentClassifierBuildOperationDefaultResponse
GetDocumentClassifierBuildOperationHeaderParam
GetDocumentClassifierBuildOperationHeaders
GetDocumentClassifierCopyToOperation200Headers
GetDocumentClassifierCopyToOperation200Response

Запрос выполнен успешно.
GetDocumentClassifierCopyToOperationDefaultResponse
GetDocumentClassifierCopyToOperationHeaderParam
GetDocumentClassifierCopyToOperationHeaders
GetDocumentModelBuildOperation
GetDocumentModelBuildOperation200Headers
GetDocumentModelBuildOperation200Response

Запрос выполнен успешно.
GetDocumentModelBuildOperationDefaultResponse
GetDocumentModelBuildOperationHeaderParam
GetDocumentModelBuildOperationHeaders
GetDocumentModelComposeOperation200Headers
GetDocumentModelComposeOperation200Response

Запрос выполнен успешно.
GetDocumentModelComposeOperationDefaultResponse
GetDocumentModelComposeOperationHeaderParam
GetDocumentModelComposeOperationHeaders
GetDocumentModelCopyToOperation200Headers
GetDocumentModelCopyToOperation200Response

Запрос выполнен успешно.
GetDocumentModelCopyToOperationDefaultResponse
GetDocumentModelCopyToOperationHeaderParam
GetDocumentModelCopyToOperationHeaders
GetModel
GetModel200Headers
GetModel200Response

Запрос выполнен успешно.
GetModelDefaultResponse
GetModelHeaderParam
GetModelHeaders
GetOperation200Headers
GetOperation200Response

Запрос выполнен успешно.
GetOperationDefaultResponse
GetOperationHeaderParam
GetOperationHeaders
GetResourceInfo
GetResourceInfo200Response

Запрос выполнен успешно.
GetResourceInfoDefaultResponse
InnerErrorOutput

Объект, содержащий более конкретные сведения об ошибке.
ListClassifiers
ListClassifiers200Headers
ListClassifiers200Response

Запрос выполнен успешно.
ListClassifiersDefaultResponse
ListClassifiersHeaderParam
ListClassifiersHeaders
ListModels
ListModels200Headers
ListModels200Response

Запрос выполнен успешно.
ListModelsDefaultResponse
ListModelsHeaderParam
ListModelsHeaders
ListOperations
ListOperations200Headers
ListOperations200Response

Запрос выполнен успешно.
ListOperationsDefaultResponse
ListOperationsHeaderParam
ListOperationsHeaders
OperationDetailsOutputParent

Сведения об операциях.
PagingOptions

Параметры вспомогательного помощника по страницам
ResourceDetailsOutput

Общие сведения о текущем ресурсе.
Routes
SimplePollerLike

Простой опросщик, который можно использовать для опроса длительной операции.
WarningOutput

Объект ошибки.

Псевдонимы типа

AnalyzeBatchDocumentsParameters
AnalyzeDocumentFromStreamParameters
AnalyzeDocumentParameters
AnalyzeOutputOption

Псевдоним для AnalyzeOutputOption
AuthorizeClassifierCopyParameters
AuthorizeModelCopyParameters
BuildClassifierParameters
BuildModelParameters
ClassifyDocumentFromStreamParameters
ClassifyDocumentParameters
ComposeModelParameters
ContentFormat

Псевдоним для ContentFormat
ContentFormatOutput

Псевдоним для ContentFormatOutput
ContentSourceKind

Псевдоним для ContentSourceKind
ContentSourceKindOutput

Псевдоним для ContentSourceKindOutput
CopyClassifierToParameters
CopyModelToParameters
DeleteClassifierParameters
DeleteModelParameters
DocumentAnalysisFeature

Псевдоним для DocumentAnalysisFeature
DocumentAnalysisFeatureOutput

Псевдоним для DocumentAnalysisFeatureOutput
DocumentBarcodeKindOutput

Псевдоним для DocumentBarcodeKindOutput
DocumentBuildMode

Псевдоним для DocumentBuildMode
DocumentBuildModeOutput

Псевдоним для DocumentBuildModeOutput
DocumentFieldType

Псевдоним для DocumentFieldType
DocumentFieldTypeOutput

Псевдоним для DocumentFieldTypeOutput
DocumentFormulaKindOutput

Псевдоним для DocumentFormulaKindOutput
DocumentIntelligenceClient
DocumentSelectionMarkStateOutput

Псевдоним для DocumentSelectionMarkStateOutput
DocumentSignatureTypeOutput

Псевдоним для DocumentSignatureTypeOutput
DocumentTableCellKindOutput

Псевдоним для DocumentTableCellKindOutput
FontStyleOutput

Псевдоним для FontStyleOutput
FontWeightOutput

Псевдоним для FontWeightOutput
GetAnalyzeBatchResultParameters
GetAnalyzeResultFigureParameters
GetAnalyzeResultParameters
GetAnalyzeResultPdfParameters
GetArrayType

Вспомогательный тип для извлечения типа массива
GetClassifierParameters
GetClassifyResultParameters
GetDocumentClassifierBuildOperationParameters
GetDocumentClassifierCopyToOperationParameters
GetDocumentModelBuildOperationParameters
GetDocumentModelComposeOperationParameters
GetDocumentModelCopyToOperationParameters
GetModelParameters
GetOperationParameters
GetPage

Тип настраиваемой функции, которая определяет, как получить страницу и ссылку на следующую.
GetResourceInfoParameters
LengthUnitOutput

Псевдоним для LengthUnitOutput
ListClassifiersParameters
ListModelsParameters
ListOperationsParameters
OperationDetailsOutput

Сведения об операциях.
OperationKindOutput

Псевдоним для OperationKindOutput
OperationStatusOutput

Псевдоним для OperationStatusOutput
PagedDocumentClassifierDetailsOutput

Коллекция paged элементов DocumentClassifierDetails
PagedDocumentModelDetailsOutput

Коллекция paged элементов DocumentModelDetails
PagedOperationDetailsOutput

Коллекция paged элементов OperationDetails
PaginateReturn

Вспомогательный тип для вывода типа страничных элементов из типа ответа этот тип создается на основе сведений swagger для x-ms-pageable специально в свойстве itemName, которое указывает свойство ответа, в котором находятся элементы страницы. Значение по умолчанию — value. Этот тип позволяет предоставлять строго типизированный итератор на основе ответа, который мы получаем в качестве второго параметра.
ParagraphRoleOutput

Псевдоним для ParagraphRoleOutput
SplitMode

Псевдоним для SplitMode
SplitModeOutput

Псевдоним для SplitModeOutput
StringIndexType

Псевдоним для StringIndexType
StringIndexTypeOutput

Псевдоним для StringIndexTypeOutput

Функции

default(string, TokenCredential | KeyCredential, DocumentIntelligenceClientOptions)

Инициализация нового экземпляра DocumentIntelligenceClient
getLongRunningPoller<TResult>(Client, AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Вспомогающая функция, которая создает объект Poller, чтобы помочь провести опрос длительной операции.
getLongRunningPoller<TResult>(Client, BuildModel202Response | BuildModelDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, ComposeModel202Response | ComposeModelDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, CopyModelTo202Response | CopyModelToDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, BuildClassifier202Response | BuildClassifierDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, CopyClassifierTo202Response | CopyClassifierToDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
isUnexpected(ListOperations200Response | ListOperationsDefaultResponse)
isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse)
isUnexpected(GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse)
isUnexpected(GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse)
isUnexpected(GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse)
isUnexpected(GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse)
isUnexpected(GetOperation200Response | GetOperationDefaultResponse)
isUnexpected(GetResourceInfo200Response | GetResourceInfoDefaultResponse)
isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse)
isUnexpected(GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse)
isUnexpected(GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse)
isUnexpected(AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse)
isUnexpected(AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse)
isUnexpected(GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse)
isUnexpected(AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse)
isUnexpected(GetModel200Response | GetModelDefaultResponse)
isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse)
isUnexpected(BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse)
isUnexpected(ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse)
isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse)
isUnexpected(CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse)
isUnexpected(ListModels200Response | ListModelsDefaultResponse)
isUnexpected(BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse)
isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse)
isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse)
isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse)
isUnexpected(ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse)
isUnexpected(ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse)
isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse)
isUnexpected(AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse)
isUnexpected(CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Вспомогательный элемент для разбивки результатов из первоначального ответа, который соответствует спецификации расширения autorest x-ms-pageable

Сведения о функции

default(string, TokenCredential | KeyCredential, DocumentIntelligenceClientOptions)

Инициализация нового экземпляра DocumentIntelligenceClient

function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: DocumentIntelligenceClientOptions): DocumentIntelligenceClient

Параметры

endpointParam

string

Конечная точка службы аналитики документов.

credentials

TokenCredential | KeyCredential

уникально идентификация учетных данных клиента

options
DocumentIntelligenceClientOptions

параметр для всех необязательных параметров

Возвращаемое значение

DocumentIntelligenceClient

getLongRunningPoller<TResult>(Client, AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Вспомогающая функция, которая создает объект Poller, чтобы помочь провести опрос длительной операции.

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

Параметры

client
Client

Клиент, используемый для отправки запроса, чтобы получить дополнительные страницы.

initialResponse

AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse

Начальный ответ.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Параметры для задания состояния возобновления или настраиваемого интервала опроса.

Возвращаемое значение

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

  • Объект опроса для проверки обновлений состояния операции и в конечном итоге получает окончательный ответ.

getLongRunningPoller<TResult>(Client, BuildModel202Response | BuildModelDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>) 

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

Параметры

client
Client
initialResponse

BuildModel202Response | BuildModelDefaultResponse

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Возвращаемое значение

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

getLongRunningPoller<TResult>(Client, ComposeModel202Response | ComposeModelDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>) 

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

Параметры

client
Client
initialResponse

ComposeModel202Response | ComposeModelDefaultResponse

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Возвращаемое значение

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

getLongRunningPoller<TResult>(Client, CopyModelTo202Response | CopyModelToDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>) 

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

Параметры

client
Client
initialResponse

CopyModelTo202Response | CopyModelToDefaultResponse

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Возвращаемое значение

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

getLongRunningPoller<TResult>(Client, BuildClassifier202Response | BuildClassifierDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>) 

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

Параметры

client
Client
initialResponse

BuildClassifier202Response | BuildClassifierDefaultResponse

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Возвращаемое значение

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

getLongRunningPoller<TResult>(Client, CopyClassifierTo202Response | CopyClassifierToDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>) 

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

Параметры

client
Client
initialResponse

CopyClassifierTo202Response | CopyClassifierToDefaultResponse

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Возвращаемое значение

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

getLongRunningPoller<TResult>(Client, AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>) 

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

Параметры

client
Client
initialResponse

AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Возвращаемое значение

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

getLongRunningPoller<TResult>(Client, ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>) 

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

Параметры

client
Client
initialResponse

ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Возвращаемое значение

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

isUnexpected(ListOperations200Response | ListOperationsDefaultResponse) 

function isUnexpected(response: ListOperations200Response | ListOperationsDefaultResponse): response

Параметры

response

ListOperations200Response | ListOperationsDefaultResponse

Возвращаемое значение

response

isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse) 

function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse): response

Параметры

response

GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse

Возвращаемое значение

response

isUnexpected(GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse) 

function isUnexpected(response: GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse): response

Параметры

response

GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse

Возвращаемое значение

response

isUnexpected(GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse) 

function isUnexpected(response: GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse): response

Параметры

response

GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse

Возвращаемое значение

response

isUnexpected(GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse) 

function isUnexpected(response: GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse): response

Параметры

response

GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse

Возвращаемое значение

response

isUnexpected(GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse) 

function isUnexpected(response: GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse): response

Параметры

response

GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse

Возвращаемое значение

response

isUnexpected(GetOperation200Response | GetOperationDefaultResponse) 

function isUnexpected(response: GetOperation200Response | GetOperationDefaultResponse): response

Параметры

response

GetOperation200Response | GetOperationDefaultResponse

Возвращаемое значение

response

isUnexpected(GetResourceInfo200Response | GetResourceInfoDefaultResponse) 

function isUnexpected(response: GetResourceInfo200Response | GetResourceInfoDefaultResponse): response

Параметры

response

GetResourceInfo200Response | GetResourceInfoDefaultResponse

Возвращаемое значение

response

isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse) 

function isUnexpected(response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse): response

Параметры

response

GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse

Возвращаемое значение

response

isUnexpected(GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse) 

function isUnexpected(response: GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse): response

Параметры

response

GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse

Возвращаемое значение

response

isUnexpected(GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse) 

function isUnexpected(response: GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse): response

Параметры

response

GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse

Возвращаемое значение

response

isUnexpected(AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse) 

function isUnexpected(response: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse): response

Параметры

response

AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse

Возвращаемое значение

response

isUnexpected(AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse) 

function isUnexpected(response: AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse): response

Параметры

response

AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse

Возвращаемое значение

response

isUnexpected(GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse) 

function isUnexpected(response: GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse): response

Параметры

response

GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse

Возвращаемое значение

response

isUnexpected(AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse) 

function isUnexpected(response: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse): response

Параметры

response

AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse

Возвращаемое значение

response

isUnexpected(GetModel200Response | GetModelDefaultResponse) 

function isUnexpected(response: GetModel200Response | GetModelDefaultResponse): response

Параметры

response

GetModel200Response | GetModelDefaultResponse

Возвращаемое значение

response

isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse) 

function isUnexpected(response: DeleteModel204Response | DeleteModelDefaultResponse): response

Параметры

response

DeleteModel204Response | DeleteModelDefaultResponse

Возвращаемое значение

response

isUnexpected(BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse) 

function isUnexpected(response: BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse): response

Параметры

response

BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse

Возвращаемое значение

response

isUnexpected(ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse) 

function isUnexpected(response: ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse): response

Параметры

response

ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse

Возвращаемое значение

response

isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse) 

function isUnexpected(response: AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse): response

Параметры

response

AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse

Возвращаемое значение

response

isUnexpected(CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse) 

function isUnexpected(response: CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse): response

Параметры

response

CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse

Возвращаемое значение

response

isUnexpected(ListModels200Response | ListModelsDefaultResponse) 

function isUnexpected(response: ListModels200Response | ListModelsDefaultResponse): response

Параметры

response

ListModels200Response | ListModelsDefaultResponse

Возвращаемое значение

response

isUnexpected(BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse) 

function isUnexpected(response: BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse): response

Параметры

response

BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse

Возвращаемое значение

response

isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse) 

function isUnexpected(response: ListClassifiers200Response | ListClassifiersDefaultResponse): response

Параметры

response

ListClassifiers200Response | ListClassifiersDefaultResponse

Возвращаемое значение

response

isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse) 

function isUnexpected(response: GetClassifier200Response | GetClassifierDefaultResponse): response

Параметры

response

GetClassifier200Response | GetClassifierDefaultResponse

Возвращаемое значение

response

isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse) 

function isUnexpected(response: DeleteClassifier204Response | DeleteClassifierDefaultResponse): response

Параметры

response

DeleteClassifier204Response | DeleteClassifierDefaultResponse

Возвращаемое значение

response

isUnexpected(ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse) 

function isUnexpected(response: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse): response

Параметры

response

ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse

Возвращаемое значение

response

isUnexpected(ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse) 

function isUnexpected(response: ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse): response

Параметры

response

ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse

Возвращаемое значение

response

isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse) 

function isUnexpected(response: GetClassifyResult200Response | GetClassifyResultDefaultResponse): response

Параметры

response

GetClassifyResult200Response | GetClassifyResultDefaultResponse

Возвращаемое значение

response

isUnexpected(AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse) 

function isUnexpected(response: AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse): response

Параметры

response

AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse

Возвращаемое значение

response

isUnexpected(CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse) 

function isUnexpected(response: CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse): response

Параметры

response

CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse

Возвращаемое значение

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 для итерации элементов