Spec-Zone.ru › AWS CLI v2

[ aws . rekognition ]

get-text-detection

Описание

Получает результаты распознавания текста из анализа видео Amazon Rekognition, запущенного с помощью StartTextDetection.

Распознавание текста с Amazon Rekognition Video — асинхронная операция. Вы запускаете распознавание текста, вызывая StartTextDetection, которая возвращает идентификатор задания (JobId). Когда операция распознавания текста завершается, Amazon Rekognition публикует состояние завершения в тему Amazon Simple Notification Service, зарегистрированную в исходном вызове StartTextDetection. Чтобы получить результаты операции распознавания текста, сначала проверьте, что значение статуса, опубликованное в теме Amazon SNS, равно SUCCEEDED. В случае успеха вызовите GetTextDetection и передайте идентификатор задания (JobId) из исходного вызова StartLabelDetection.

GetTextDetection возвращает массив распознанного текста (TextDetections), отсортированный по времени распознавания, до 100 слов на кадр видео.

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

Используйте параметр MaxResults, чтобы ограничить количество возвращаемых распознанных текстов. Если результатов больше, чем указано в MaxResults, значение NextToken в ответе операции содержит маркер пагинации для получения следующего набора результатов. Чтобы получить следующую страницу результатов, вызовите GetTextDetection и заполните параметр запроса NextToken значением маркера, возвращённым из предыдущего вызова GetTextDetection.

См. также: Документацию API AWS

Синтаксис

  get-text-detection
--job-id <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--job-id (строка)

Идентификатор задания для операции распознавания текста, для которого требуется вернуть результаты. Вы получаете идентификатор задания из первоначального вызова StartTextDetection.

--max-results (целое число)

Максимальное количество результатов, возвращаемых за один вызов пагинации. Максимальное значение, которое можно указать, равно 1000.

--next-token (строка)

Если предыдущий ответ был неполным (потому что ещё есть метки для получения), Amazon Rekognition Video возвращает маркер пагинации в ответе. Вы можете использовать этот маркер пагинации для получения следующего набора текста.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному в --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, это будет выводить пример входного YAML, который можно использовать с --cli-input-yaml. При предоставлении значения output выполняется валидация входных данных команды и возвращается пример выходного JSON для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладку.

--endpoint-url (строка)

Переопределить значение URL по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую пагинацию. Если автоматическая пагинация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования выходных данных команды.

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определённого профиля из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии данного инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • включено
  • выключено
  • автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл с пакетом сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить кли-пейджер для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

JobStatus -> (строка)

Текущий статус задания по распознаванию текста.

StatusMessage -> (строка)

Если задание завершилось неудачно, StatusMessage предоставляет описательное сообщение об ошибке.

VideoMetadata -> (структура)

Информация о видео, которое проанализировал Amazon Rekognition. Videometadata возвращается на каждой странице в результатах по страниц из операций с видео Amazon Rekognition.

Codec -> (строка)

Тип сжатия, используемый в проанализированном видео.

DurationMillis -> (длинное целое число)

Продолжительность видео в миллисекундах.

Format -> (строка)

Формат проанализированного видео. Возможные значения: MP4, MOV и AVI.

FrameRate -> (вещественное число)

Количество кадров в секунду в видео.

FrameHeight -> (длинное целое число)

Вертикальное разрешение видео в пикселях.

FrameWidth -> (длинное целое число)

Горизонтальное разрешение видео в пикселях.

ColorRange -> (строка)

Описание диапазона значений яркости в видео, либо LIMITED (16 до 235), либо FULL (0 до 255).

TextDetections -> (список)

Массив текста, обнаруженного в видео. Каждый элемент содержит обнаруженный текст, время в миллисекундах с начала видео, когда был обнаружен текст, и расположение на экране.

(структура)

Информация об обнаруженном тексте в видео. Включает обнаруженный текст, время в миллисекундах с начала видео, когда был обнаружен текст, и его расположение на экране.

Timestamp -> (длинное целое число)

Время в миллисекундах с начала видео, когда был обнаружен текст. Обратите внимание, что Timestamp не гарантирует точность до отдельного кадра, где текст впервые появляется.

TextDetection -> (структура)

Подробности о распознанном тексте в видео.

DetectedText -> (строка)

Слово или строка текста, распознанные Amazon Rekognition.

Type -> (строка)

Тип обнаруженного текста.

Id -> (целое число)

Идентификатор обнаруженного текста. Идентификатор уникален только для одного вызова DetectText .

ParentId -> (целое число)

Идентификатор родительского элемента для обнаруженного текста, определенного по значению ID . Если тип обнаруженного текста — LINE , значение ParentId — Null .

Confidence -> (вещественное число)

Уверенность Amazon Rekognition в точности обнаруженного текста и геометрических точек вокруг обнаруженного текста.

Geometry -> (структура)

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

BoundingBox -> (структура)

Прямоугольник, грубо определяющий расположение обнаруженного элемента на изображении.

Width -> (вещественное число)

Ширина прямоугольника как отношение к общей ширине изображения.

Height -> (вещественное число)

Высота прямоугольника как отношение к общей высоте изображения.

Left -> (вещественное число)

Левая координата прямоугольника как отношение к общей ширине изображения.

Top -> (вещественное число)

Верхняя координата прямоугольника как отношение к общей высоте изображения.

Polygon -> (список)

Полигон вокруг обнаруженного элемента внутри прямоугольника.

(структура)

Координаты X и Y точки на изображении или кадре видео. Значения X и Y — это отношения к общему размеру изображения или разрешению видео. Например, если входное изображение 700x200, и значения X = 0,5 и Y = 0,25, то точка расположена в пикселе (350, 50) на изображении.

Массив объектов Point образует Polygon . Polygon возвращается функциями DetectText и DetectCustomLabels. Polygon представляет собой полигон, точно окружающий обнаруженный элемент. Дополнительная информация в разделе Geometry Руководства разработчика Amazon Rekognition.

X -> (вещественное число)

Значение координаты X для точки на Polygon.

Y -> (вещественное число)

Значение координаты Y для точки на Polygon.

NextToken -> (строка)

Если ответ усечён, Amazon Rekognition Video возвращает этот маркер, который можно использовать в последующем запросе для получения следующего набора текста.

TextModelVersion -> (строка)

Номер версии модели распознавания текста, которая использовалась для распознавания текста.

JobId -> (строка)

Идентификатор задания по распознаванию текста, для которого необходимо получить результаты. Идентификатор задания возвращается при первом вызове StartTextDetection.

Video -> (структура)

Файл видео, хранящийся в ведре Amazon S3. Amazon Rekognition видеооперации, такие как StartLabelDetection, используют Video для указания видео для анализа. Поддерживаемые форматы файлов: .mp4, .mov и .avi.

S3Object -> (структура)

Имя ведра Amazon S3 и имя файла видео.

Bucket -> (строка)

Имя ведра S3.

Name -> (строка)

Имя объекта S3.

Version -> (строка)

Если в ведре включена функция версий, можно указать версию объекта.

JobTag -> (строка)

Идентификатор задания, указанный в вызове StartTextDetection и возвращенный в уведомлении о завершении задания, отправленном в вашу тему Amazon Simple Notification Service.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API