formrecognizer Пакет

Пакеты

aio

Классы

AccountProperties	Сводка по всем пользовательским моделям в учетной записи. Новые возможности в версии 2.1: поддержка методов to_dict и from_dict
AddressValue	Значение поля адреса. Новые возможности в версии 2023-07-31: свойства unit, city_district, state_district, пригорода, дома и уровня .
AnalyzeResult	Результат анализа документов.
AnalyzedDocument	Объект , описывающий расположение и семантическое содержимое документа.
BlobFileListSource	Источник содержимого для списка файлов в Хранилище BLOB-объектов Azure.
BlobSource	Источник содержимого для Хранилище BLOB-объектов Azure.
BoundingRegion	Ограничивающая область, соответствующая странице.
ClassifierDocumentTypeDetails	Источник данных для обучения.
CurrencyValue	Элемент значения валюты. Новые возможности в версии 2023-07-31: свойство кода .
CustomDocumentModelsDetails	Сведения о пользовательских моделях в ресурсе Распознаватель документов.
CustomFormModel	Представляет обученную модель. Новые возможности в версии 2.1: свойства model_name и свойства, поддержка методов to_dict и from_dict
CustomFormModelField	Поле, которое модель будет извлекать из форм, которые она анализирует. Новые возможности в версии 2.1: поддержка методов to_dict и from_dict
CustomFormModelInfo	Сведения о пользовательской модели. Новые возможности в версии 2.1: свойства model_name и свойства, поддержка методов to_dict и from_dict
CustomFormModelProperties	Необязательные свойства модели. Новые возможности в версии 2.1: поддержка методов to_dict и from_dict
CustomFormSubmodel	Представляет подмодель, которая извлекает поля из определенного типа формы. Новые возможности в версии 2.1: свойство model_id, поддержка методов to_dict и from_dict
DocumentAnalysisClient	DocumentAnalysisClient анализирует сведения из документов и изображений, а также классифицирует документы. Это интерфейс для анализа с предварительно созданными моделями (квитанции, визитные карточки, счета, удостоверения документов, среди прочего), анализа макета из документов, анализа общих типов документов и анализа пользовательских документов с помощью встроенных моделей (полный список моделей, поддерживаемых службой, см. в разделе https://aka.ms/azsdk/formrecognizer/models). Он предоставляет различные методы на основе входных данных из URL-адреса и входных данных из потока. Примечание DocumentAnalysisClient следует использовать с версиями API 31.08.2022 и более. Чтобы использовать версии <API =v2.1, создайте экземпляр FormRecognizerClient. Новые возможности в версии 2022-08-31: DocumentAnalysisClient и его клиентские методы.
DocumentAnalysisError	DocumentAnalysisError содержит сведения об ошибке, возвращаемой службой.
DocumentAnalysisInnerError	Сведения о внутренней ошибке для DocumentAnalysisError.
DocumentBarcode	Объект штрихкода.
DocumentClassifierDetails	Сведения о классификаторе документов. Включает типы документов, которые модель может классифицировать.
DocumentField	Объект , представляющий содержимое и расположение значения поля документа. Новые возможности в версии 2023-07-31: логическое значение value_type и логическое значение
DocumentFormula	Объект формулы.
DocumentKeyValueElement	Объект , представляющий ключ поля или значение в паре "ключ-значение".
DocumentKeyValuePair	Объект, представляющий поле документа с отдельной меткой поля (ключом) и значением поля (может быть пустым).
DocumentLanguage	Объект , представляющий обнаруженный язык для заданного текстового диапазона.
DocumentLine	Объект строки содержимого, представляющий содержимое, найденное в одной строке документа.
DocumentModelAdministrationClient	DocumentModelAdministrationClient — это интерфейс Распознаватель документов для создания моделей и управления ими. Она предоставляет методы для создания моделей и классификаторов, а также методы для просмотра и удаления моделей и классификаторов, просмотра операций модели и классификатора, доступа к сведениям об учетной записи, копирования моделей в другой ресурс Распознаватель документов и создания новой модели из коллекции существующих моделей. Примечание DocumentModelAdministrationClient следует использовать с версиями API 31.08.2022 и более. Чтобы использовать версии <API =v2.1, создайте экземпляр FormTrainingClient. Новые возможности в версии 2022-08-31: DocumentModelAdministrationClient и его клиентские методы.
DocumentModelAdministrationLROPoller	Реализует протокол, за которым следуют возвращаемые объекты опроса.
DocumentModelDetails	Сведения о модели документа. Включает типы документов, которые модель может анализировать. Новые возможности в версии 2023-07-31: свойство expires_on .
DocumentModelSummary	Сводка сведений о модели документа, включая идентификатор модели, ее описание и время создания модели. Новые возможности в версии 2023-07-31: свойство expires_on .
DocumentPage	Содержимое и элементы макета, извлеченные из страницы входных данных. Новые возможности в версии 2023-07-31: свойства штрихкодов и формул .
DocumentParagraph	Объект абзаца обычно состоит из смежных линий с общим выравниванием и интервалом. Новые возможности в версии 2023-07-31: роль formulaBlock .
DocumentSelectionMark	Объект метки выделения, представляющий проверка прямоугольники, переключатели и другие элементы, указывающие на выделение.
DocumentSpan	Непрерывная область содержимого свойства, указанная в виде смещения и длины.
DocumentStyle	Объект , представляющий наблюдаемые стили текста. Новые возможности в версии 2023-07-31: свойства similar_font_family, font_style, font_weight, color и background_color .
DocumentTable	Объект таблицы, состоящий из ячеек таблицы, расположенных в прямоугольном макете.
DocumentTableCell	Объект , представляющий расположение и содержимое ячейки таблицы.
DocumentTypeDetails	DocumentTypeDetails представляет тип документа, который может распознать модель, включая его поля и типы, а также достоверность для этих полей.
DocumentWord	Объект слова, состоящий из непрерывной последовательности символов. Для языков, не разделенных пробелами, таких как китайский, японский и корейский, каждый символ представлен как собственное слово.
FieldData	Содержит данные для поля формы. Сюда входят текст, расположение текста в форме и коллекция элементов, составляющих текст. Новые возможности в версии 2.1: FormSelectionMark добавляется в типы, возвращаемые в списке field_elements, поддержка методов to_dict и from_dict
FormElement	Базовый тип, включающий свойства элемента формы. Новые возможности в версии 2.1: поддержка методов to_dict и from_dict
FormField	Представляет поле, распознанное во входной форме. Новые возможности в версии 2.1: поддержка методов to_dict и from_dict
FormLine	Объект , представляющий извлеченную строку текста. Новые возможности в версии 2.1: свойство appearance, поддержка методов to_dict и from_dict
FormPage	Представляет страницу, распознаваемую из входного документа. Содержит строки, слова, метки выделения, таблицы и метаданные страницы. Новые возможности в версии 2.1: свойство selection_marks, поддержка методов to_dict и from_dict
FormPageRange	Диапазон страниц из 1 формы. Новые возможности в версии 2.1: поддержка методов to_dict и from_dict
FormRecognizerClient	FormRecognizerClient извлекает сведения из форм и изображений в структурированные данные. Это интерфейс, используемый для анализа с помощью предварительно созданных моделей (квитанций, визитных карточек, счетов, документов, удостоверений), распознавания содержимого и макета из форм и анализа пользовательских форм из обученных моделей. Он предоставляет различные методы на основе входных данных из URL-адреса и входных данных из потока. Примечание FormRecognizerClient следует использовать с версиями <API =v2.1. Чтобы использовать API версий 2022-08-31 и более поздних версий, создайте экземпляр DocumentAnalysisClient.
FormRecognizerError	Представляет ошибку, которая произошла во время обучения. Новые возможности в версии 2.1: поддержка методов to_dict и from_dict
FormSelectionMark	Сведения о извлеченной выделенной метки. Новые возможности в версии 2.1: поддержка методов to_dict и from_dict
FormTable	Сведения о извлеченной таблице, содержащейся на странице. Новые возможности в версии 2.1. Свойство bounding_box, поддержка методов to_dict и from_dict
FormTableCell	Представляет ячейку, содержащуюся в таблице, распознанной из входного документа. Новые возможности версии 2.1: FormSelectionMark добавлен в типы, возвращаемые в списке field_elements, поддержка методов to_dict и from_dict
FormTrainingClient	FormTrainingClient — это интерфейс Распознаватель документов, используемый для создания пользовательских моделей и управления ими. Она предоставляет методы обучения моделей в предоставленных формах, а также методы просмотра и удаления моделей, доступа к свойствам учетной записи, копирования моделей в другой ресурс Распознаватель документов и создания моделей из коллекции существующих моделей, обученных с помощью меток. Примечание FormTrainingClient следует использовать с api версии <=v2.1. Чтобы использовать API версии 2022-08-31 и более поздних версий, создайте экземпляр DocumentModelAdministrationClient.
FormWord	Представляет слово, распознанное из входного документа. Новые возможности в версии 2.1: поддержка методов to_dict и from_dict
OperationDetails	OperationDetails состоит из сведений об операции модели, включая результат или ошибку операции, если она была завершена. Обратите внимание, что сведения об операциях сохраняются только в течение 24 часов. Если операция прошла успешно, доступ к модели также можно получить с помощью <xref:azure.ai.formrecognizer.get_document_model>API , <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier>, <xref:azure.ai.formrecognizer.list_document_classifiers> . Новые возможности в версии 2023-07-31: тип documentClassifierBuild и результат DocumentClassifierDetails .
OperationSummary	Сведения об операции модели, включая вид и состояние операции, время ее создания и многое другое. Обратите внимание, что сведения об операциях сохраняются только в течение 24 часов. Если операция прошла успешно, доступ к модели можно получить с помощью <xref:azure.ai.formrecognizer.get_document_model>API , <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier>, . <xref:azure.ai.formrecognizer.list_document_classifiers> Чтобы узнать, почему операция завершилась сбоем, используйте <xref:azure.ai.formrecognizer.get_operation> и укажите operation_id. Новое в версии 2023-07-31: тип documentClassifierBuild .
Point	Координата x, y точки на ограничивающем прямоугольнине или многоугольнике. Новые возможности в версии 2.1: поддержка методов to_dict и from_dict
QuotaDetails	Используемая квота, ограничение и следующий сброс даты и времени.
RecognizedForm	Представляет форму, распознаваемую обученной или предварительно созданной моделью. Свойство fields содержит поля формы, извлеченные из формы. Таблицы, текстовые строки/слова и метки выделения извлекаются для каждой страницы и находятся в свойстве pages . Новые возможности версии 2.1: свойства form_type_confidence и model_id, поддержка методов to_dict и from_dict
ResourceDetails	Сведения о ресурсе Распознаватель документов. Новое в версии 2023-07-31: свойство neural_document_model_quota .
TextAppearance	Объект , представляющий внешний вид текстовой строки. Новые возможности в версии 2.1: поддержка методов to_dict и from_dict
TrainingDocumentInfo	Отчет для отдельного документа, используемого для обучения пользовательской модели. Новые возможности в версии 2.1. Свойство model_id, поддержка методов to_dict и from_dict

Перечисления

AnalysisFeature	Функции анализа документов, которые необходимо включить.
CustomFormModelStatus	Состояние, указывающее готовность модели к использованию.
DocumentAnalysisApiVersion	Распознаватель документов версий API, поддерживаемых DocumentAnalysisClient и DocumentModelAdministrationClient.
FieldValueType	Семантический тип данных значения поля. Новые возможности в версии 2.1: значения selectionMark и countryRegion
FormContentType	Тип контента для отправки. Новые возможности в версии 2.1: поддержка image/bmp
FormRecognizerApiVersion	Распознаватель документов версий API, поддерживаемых FormRecognizerClient и FormTrainingClient.
LengthUnit	Единица измерения, используемая свойствами ширины, высоты и ограничивающего прямоугольника. Для изображений используется единица измерения "пиксель". Для PDF единица измерения — "дюйм".
ModelBuildMode	Режим, используемый при создании пользовательских моделей. Для получения дополнительной информации см. https://aka.ms/azsdk/formrecognizer/buildmode.
TrainingStatus	Состояние операции обучения.