Spec-Zone.ru › AWS CLI v2

[ aws . rekognition ]

start-text-detection

Описание

Запускает асинхронное обнаружение текста в сохранённом видео.

Amazon Rekognition Video может обнаруживать текст в видео, хранящемся в ведре Amazon S3. Используйте Video, чтобы указать имя ведра и имя файла видео. StartTextDetection возвращает идентификатор задачи (JobId ), который вы используете для получения результатов операции. После завершения обнаружения текста Amazon Rekognition Video публикует статус завершения в тему Amazon Simple Notification Service, которую вы указываете в NotificationChannel.

Чтобы получить результаты операции обнаружения текста, сначала убедитесь, что значение статуса, опубликованное в тему Amazon SNS, равно SUCCEEDED. В таком случае вызовите GetTextDetection и передайте идентификатор задачи (JobId) из первоначального вызова в StartTextDetection.

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

Синтаксис

  start-text-detection
--video <value>
[--client-request-token <value>]
[--notification-channel <value>]
[--job-tag <value>]
[--filters <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]

Параметры

--video (структура)

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

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

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

Bucket -> (строка)

Имя ведра S3.

Name -> (строка)

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

Version -> (строка)

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

Краткая запись:

S3Object={Bucket=string,Name=string,Version=string}

Синтаксис JSON:

{
  "S3Object": {
    "Bucket": "string",
    "Name": "string",
    "Version": "string"
  }
}

--client-request-token (строка)

Идемпотентный токен, используемый для идентификации запроса запуска. Если вы используете один и тот же токен с несколькими запросами StartTextDetection, возвращается та же JobId. Используйте ClientRequestToken, чтобы предотвратить случайный запуск одной и той же задачи более одного раза.

--notification-channel (структура)

Тема Amazon Simple Notification Service, в которую Amazon Rekognition публикует статус завершения операции анализа видео. Для получения дополнительной информации см. Вызов операций Amazon Rekognition Video. Обратите внимание, что тема Amazon SNS должна иметь имя темы, начинающееся с AmazonRekognition, если вы используете политику разрешений AmazonRekognitionServiceRole для доступа к теме. Для получения дополнительной информации см. Предоставление доступа к нескольким темам Amazon SNS.

SNSTopicArn -> (строка)

Тема Amazon SNS, в которую Amazon Rekognition отправляет статус завершения.

RoleArn -> (строка)

ARN роли IAM, предоставляющей Amazon Rekognition права публикации в тему Amazon SNS.

Краткая запись:

SNSTopicArn=string,RoleArn=string

Синтаксис JSON:

{
  "SNSTopicArn": "string",
  "RoleArn": "string"
}

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

Идентификатор, возвращаемый в статусе завершения, опубликованном вашей темой Amazon Simple Notification Service. Например, вы можете использовать JobTag для группирования связанных задач и их идентификации в уведомлении о завершении.

--filters (структура)

Дополнительные параметры, которые позволяют установить критерии, которым должен соответствовать текст, чтобы быть включённым в ваш ответ.

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

Фильтры, ориентированные на свойства текста, такие как уверенность или размер.

MinConfidence -> (число с плавающей точкой)

Устанавливает уверенность в обнаружении слова. Слова с уверенностью в обнаружении ниже этого значения будут исключены из результата. Значения должны быть от 0 до 100. По умолчанию MinConfidence составляет 80.

MinBoundingBoxHeight -> (число с плавающей точкой)

Устанавливает минимальную высоту рамки обнаружения слова. Слова с высотой рамки, меньшей этого значения, будут исключены из результата. Значение относится к высоте кадра видео.

MinBoundingBoxWidth -> (число с плавающей точкой)

Устанавливает минимальную ширину рамки обнаружения слова. Слова с шириной рамки, меньшей этого значения, будут исключены из результата. Значение относится к ширине кадра видео.

RegionsOfInterest -> (список)

Фильтр, ориентированный на определённую область кадра. Использует объект BoundingBox для задания области экрана.

(структура)

Указывает местоположение в кадре, которое Rekognition проверяет на объекты интереса, такие как текст, метки или лица. Использует объект BoundingBox или Polygon для задания области экрана.

Слово, лицо или метка включаются в область, если они более чем наполовину находятся в этой области. Если есть несколько областей, слово, лицо или метка сравниваются со всеми областями экрана. Любой объект интереса, который более чем наполовину находится в области, сохраняется в результатах.

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

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

Width -> (число с плавающей точкой)

Ширина рамки как отношение к общей ширине изображения.

Height -> (число с плавающей точкой)

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

Left -> (число с плавающей точкой)

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

Top -> (число с плавающей точкой)

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

Polygon -> (список)

Указывает фигуру, состоящую из до 10 объектов Point для определения области интереса.

(структура)

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

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

X -> (число с плавающей точкой)

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

Y -> (число с плавающей точкой)

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

Синтаксис JSON:

{
  "WordFilter": {
    "MinConfidence": float,
    "MinBoundingBoxHeight": float,
    "MinBoundingBoxWidth": float
  },
  "RegionsOfInterest": [
    {
      "BoundingBox": {
        "Width": float,
        "Height": float,
        "Left": float,
        "Top": float
      },
      "Polygon": [
        {
          "X": float,
          "Y": float
        }
        ...
      ]
    }
    ...
  ]
}

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

--generate-cli-skeleton (строка) Печатает скелет JSON в стандартный вывод без отправки запроса API. Если предоставлено значение null или 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
  • текст
  • таблица
  • 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.

Вывод

JobId -> (строка)

Идентификатор задачи обнаружения текста. Используйте JobId для идентификации задачи в последующем вызове GetTextDetection.

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

Spec-Zone.ru

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