batch-put-document

Описание

Добавляет один или несколько документов в индекс Amazon Q Business.

Вы используете этот API для:

импорта структурированных и неструктурированных документов, а также документов, хранящихся в бакете Amazon S3, в индекс Amazon Q Business.
добавления пользовательских атрибутов к документам в индексе Amazon Q Business.
прикрепления списка управления доступом к документам, добавленным в индекс Amazon Q Business.

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

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

Синтаксис

  batch-put-document
--application-id <value>
--index-id <value>
--documents <value>
[--role-arn <value>]
[--data-source-sync-id <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]

Параметры

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

Идентификатор приложения Amazon Q Business.

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

Идентификатор индекса Amazon Q Business, в который нужно добавить документы.

--documents (список)

Один или несколько документов для добавления в индекс.

(структура)

Документ в приложении Amazon Q Business.

id -> (строка)

Идентификатор документа.

attributes -> (список)

Пользовательские атрибуты для настройки ответов веб-интерфейса Amazon Q Business.

(структура)

Атрибут или поле метаданных документа.

name -> (строка)

Идентификатор атрибута.

value -> (структура помеченного объединения)

Значение атрибута.

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть задан: stringValue, stringListValue, longValue, dateValue.

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

longValue -> (целое)

Целое значение.

dateValue -> (метка времени)

Дата, представленная в формате ISO 8601.

Важно, чтобы часовой пояс был включен в формате ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

content -> (структура помеченного объединения)

Содержание документа.

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть задан: blob, s3.

blob -> (двоичные данные)

Содержимое документа. Документы, передаваемые в параметр blob, должны быть закодированы в base64. Возможно, вам не нужно кодировать байты файла документа, если вы используете Amazon Web Services SDK для вызова API Amazon Q Business. Если вы вызываете конечную точку Amazon Q Business напрямую с помощью REST, вы должны закодировать содержимое в base64 перед отправкой.

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

Путь к документу в бакете Amazon S3.

bucket -> (строка)

Имя бакета S3, содержащего файл.

key -> (строка)

Имя файла.

contentType -> (строка)

Тип файла документа в поле Blob.

Если вы хотите индексировать фрагменты или подмножества HTML-документов, а не весь HTML-документ, добавьте открывающие и закрывающие теги HTML (<HTML>content</HTML> ) вокруг содержимого.

title -> (строка)

Заголовок документа.

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

Настройка параметров доступа к документу.

accessControls -> (список)

Список объектов AccessControlList.

(структура)

Список принципалов. Каждый принципал может быть либо USER, либо GROUP и может иметь права доступа к документу ALLOW или DENY.

principals -> (список)

Содержит список принципалов, где принципал может быть либо USER, либо GROUP. Каждый принципал может иметь следующие типы доступа к документу: ALLOW или DENY.

(структура помеченного объединения)

Предоставляет информацию о пользователях и группах, используемую для фильтрации документов для генерации ответов Amazon Q Business.

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть задан: user, group.

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

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

id -> (строка)

Идентификатор пользователя.

access -> (строка)

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

membershipType -> (строка)

Тип группы.

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

Группа, связанная с принципалом.

name -> (строка)

Имя группы.

access -> (строка)

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

membershipType -> (строка)

Тип группы.

memberRelation -> (строка)

Описание отношений членства в списке принципалов.

memberRelation -> (строка)

Описание отношений членства в объекте AccessControlList.

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

Информация о конфигурации для изменения метаданных и содержимого документа во время процесса загрузки документа.

inlineConfigurations -> (список)

Информация о конфигурации для изменения атрибутов документа или полей метаданных и содержимого при загрузке документов в Amazon Q Business.

(структура)

Предоставляет информацию о конфигурации для применения базовой логики изменения метаданных и содержимого документа при загрузке документов в Amazon Q Business.

Для применения расширенной логики, выходящей за рамки базовой логики, см. ` HookConfiguration https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html`__ .

Для получения дополнительной информации, см. Настройка обогащения документов .

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

Условие, используемое для целевого атрибута документа или поля метаданных при загрузке документов в Amazon Q Business. Вы используете это с ` DocumentAttributeTarget https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html`__ для применения условия.

Например, можно создать целевое поле «Отдел» и предварительно заполнить его названиями отделов, связанными с документами, на основе информации в поле «Source_URI». Установите условие, что если поле «Source_URI» содержит «financial» в своём значении URI, то предварительно заполните целевое поле «Отдел» целевым значением «Финансы» для документа.

Amazon Q Business не может создать целевое поле, если оно не было предварительно создано как индексное поле. После создания индексного поля вы можете создать поле метаданных документа, используя DocumentAttributeTarget . Amazon Q Business затем сопоставит вновь созданное поле метаданных с индексным полем.

key -> (строка)

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

Например, «Source_URI» может быть идентификатором атрибута или поля метаданных, содержащего URI источников, связанных с документами.

В настоящее время Amazon Q Business не поддерживает _document_body в качестве ключа атрибута, используемого для условия.

operator -> (строка)

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

В настоящее время Amazon Q Business не поддерживает _document_body в качестве ключа атрибута, используемого для условия.

value -> (структура помеченных объединений)

Значение атрибута документа. Вы можете указать только одно значение для атрибута документа.

Примечание

Это структура помеченных объединений. Только один из следующих верхних ключей может быть задан: stringValue, stringListValue, longValue, dateValue.

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

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

Целое число со знаком.

dateValue -> (отметка времени)

Дата, выраженная в формате ISO 8601.

Важно включить часовой пояс в формате даты-времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты-времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.

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

Целевой атрибут документа или поле метаданных, которое необходимо изменить при загрузке документов в Amazon Q Business.

Например, вы можете удалить все идентификаторы клиентов, связанные с документами, хранящиеся в поле метаданных документа «Customer_ID», установив ключ целевого объекта как «Customer_ID» и флаг удаления на TRUE . Это удаляет все значения идентификаторов клиентов в поле «Customer_ID». Это очистит персональные идентификационные данные из метаданных каждого документа.

Amazon Q Business не может создать целевое поле, если оно не было предварительно создано как индексное поле. После создания индексного поля вы можете создать поле метаданных документа, используя ` DocumentAttributeTarget https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html`__ . Amazon Q Business затем сопоставит вновь созданный атрибут документа с индексным полем.

Вы также можете использовать это с ` DocumentAttributeCondition https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html`__ .

key -> (строка)

Идентификатор целевого атрибута документа или поля метаданных. Например, «Отдел» может быть идентификатором целевого атрибута или поля метаданных, содержащего названия отделов, связанных с документами.

value -> (структура помеченных объединений)

Значение атрибута документа. Вы можете указать только одно значение для атрибута документа.

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

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

Целое число со знаком.

dateValue -> (отметка времени)

Дата, выраженная в формате ISO 8601.

attributeValueOperator -> (строка)

TRUE для удаления существующего целевого значения для указанного целевого ключа атрибута. Вы не можете создать целевое значение и установить это значение на TRUE .

documentContentOperator -> (строка)

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

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

Предоставляет информацию о конфигурации для вызова функции Lambda в Lambda для изменения метаданных и содержимого документа при загрузке документов в Amazon Q Business.

Вы можете настроить свою функцию Lambda, используя параметр PreExtractionHookConfiguration, если хотите применить расширенные изменения к исходным или необработанным документам.

Если вы хотите применить расширенные изменения к структурированным документам Amazon Q Business, вы должны настроить свою функцию Lambda, используя PostExtractionHookConfiguration.

Вы можете вызвать только одну функцию Lambda. Однако эта функция может вызывать другие необходимые функции.

Для получения дополнительной информации, см. Настройка обогащения документов.

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

Условие, используемое для вызова функции Lambda.

Например, вы можете задать условие, что если есть пустые значения даты-времени, то Amazon Q Business должен вызвать функцию, которая вставит текущую дату-время.

key -> (строка)

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

В настоящее время Amazon Q Business не поддерживает _document_body в качестве ключа атрибута, используемого для условия.

operator -> (строка)

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

В настоящее время Amazon Q Business не поддерживает _document_body в качестве ключа атрибута, используемого для условия.

value -> (структура помеченных объединений)

Значение атрибута документа. Вы можете указать только одно значение для атрибута документа.

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

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

Целое число со знаком.

dateValue -> (отметка времени)

Дата, выраженная в формате ISO 8601.

lambdaArn -> (строка)

Идентификатор ресурса Amazon (ARN) функции Lambda во время загрузки. Для получения дополнительной информации, см. Использование функций Lambda для обогащения документов Amazon Q Business.

s3BucketName -> (строка)

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

roleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли с разрешениями для запуска PreExtractionHookConfiguration и PostExtractionHookConfiguration для изменения метаданных и содержимого документа во время процесса загрузки документа.

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

Предоставляет конфигурационную информацию для вызова функции Lambda в Lambda для изменения метаданных и содержимого документа при добавлении документов в Amazon Q Business.

Вы можете настроить функцию Lambda, используя параметр PreExtractionHookConfiguration, если хотите применить расширенные изменения к исходным или необработанным документам.

Если вы хотите применить расширенные изменения к структурированным документам Amazon Q Business, необходимо настроить вашу функцию Lambda, используя PostExtractionHookConfiguration.

Вы можете вызвать только одну функцию Lambda. Однако эта функция может вызывать другие необходимые функции.

Для получения дополнительной информации см. Настройка обогащения документов.

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

Условие, используемое для вызова функции Lambda.

Например, можно указать условие, при котором, если есть пустые значения даты и времени, Amazon Q Business должен вызвать функцию, которая вставляет текущую дату и время.

key -> (строка)

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

Например, ‘Source_URI’ может быть идентификатором атрибута или поля метаданных, содержащего URI источников, связанных с документами.

В настоящее время Amazon Q Business не поддерживает _document_body в качестве ключа атрибута, используемого для условия.

operator -> (строка)

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

В настоящее время Amazon Q Business не поддерживает _document_body в качестве ключа атрибута, используемого для условия.

value -> (структура помеченных объединений)

Значение атрибута документа. Вы можете указать только одно значение для атрибута документа.

Примечание

Это структура помеченных объединений. Можно установить только один из следующих верхних ключей: stringValue, stringListValue, longValue, dateValue.

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

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

Значение целого числа.

dateValue -> (отметка времени)

Дата, выраженная в формате ISO 8601.

Важно включить часовой пояс в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

lambdaArn -> (строка)

Amazon Resource Name (ARN) функции Lambda во время загрузки. Для получения дополнительной информации см. Использование функций Lambda для обогащения документов Amazon Q Business.

s3BucketName -> (строка)

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

roleArn -> (строка)

Amazon Resource Name (ARN) роли с разрешением на выполнение PreExtractionHookConfiguration и PostExtractionHookConfiguration для изменения метаданных и содержимого документа во время процесса загрузки документов.

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

Настройка для извлечения информации из медиа в документе.

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

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

imageExtractionStatus -> (строка)

Укажите, необходимо ли извлекать семантическое значение из изображений и визуальных элементов из документов.

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

Настройки для извлечения и обработки аудиоконтента из медиафайлов.

audioExtractionStatus -> (строка)

Статус извлечения аудио (ВКЛЮЧЕНО или ОТКЛЮЧЕНО) для обработки аудиоконтента из файлов.

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

Настройки для извлечения и обработки видеоконтента из медиафайлов.

videoExtractionStatus -> (строка)

Статус извлечения видео (ВКЛЮЧЕНО или ОТКЛЮЧЕНО) для обработки видеоконтента из файлов.

JSON Синтаксис:

[
  {
    "id": "string",
    "attributes": [
      {
        "name": "string",
        "value": {
          "stringValue": "string",
          "stringListValue": ["string", ...],
          "longValue": long,
          "dateValue": timestamp
        }
      }
      ...
    ],
    "content": {
      "blob": blob,
      "s3": {
        "bucket": "string",
        "key": "string"
      }
    },
    "contentType": "PDF"|"HTML"|"MS_WORD"|"PLAIN_TEXT"|"PPT"|"RTF"|"XML"|"XSLT"|"MS_EXCEL"|"CSV"|"JSON"|"MD",
    "title": "string",
    "accessConfiguration": {
      "accessControls": [
        {
          "principals": [
            {
              "user": {
                "id": "string",
                "access": "ALLOW"|"DENY",
                "membershipType": "INDEX"|"DATASOURCE"
              },
              "group": {
                "name": "string",
                "access": "ALLOW"|"DENY",
                "membershipType": "INDEX"|"DATASOURCE"
              }
            }
            ...
          ],
          "memberRelation": "AND"|"OR"
        }
        ...
      ],
      "memberRelation": "AND"|"OR"
    },
    "documentEnrichmentConfiguration": {
      "inlineConfigurations": [
        {
          "condition": {
            "key": "string",
            "operator": "GREATER_THAN"|"GREATER_THAN_OR_EQUALS"|"LESS_THAN"|"LESS_THAN_OR_EQUALS"|"EQUALS"|"NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"|"EXISTS"|"NOT_EXISTS"|"BEGINS_WITH",
            "value": {
              "stringValue": "string",
              "stringListValue": ["string", ...],
              "longValue": long,
              "dateValue": timestamp
            }
          },
          "target": {
            "key": "string",
            "value": {
              "stringValue": "string",
              "stringListValue": ["string", ...],
              "longValue": long,
              "dateValue": timestamp
            },
            "attributeValueOperator": "DELETE"
          },
          "documentContentOperator": "DELETE"
        }
        ...
      ],
      "preExtractionHookConfiguration": {
        "invocationCondition": {
          "key": "string",
          "operator": "GREATER_THAN"|"GREATER_THAN_OR_EQUALS"|"LESS_THAN"|"LESS_THAN_OR_EQUALS"|"EQUALS"|"NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"|"EXISTS"|"NOT_EXISTS"|"BEGINS_WITH",
          "value": {
            "stringValue": "string",
            "stringListValue": ["string", ...],
            "longValue": long,
            "dateValue": timestamp
          }
        },
        "lambdaArn": "string",
        "s3BucketName": "string",
        "roleArn": "string"
      },
      "postExtractionHookConfiguration": {
        "invocationCondition": {
          "key": "string",
          "operator": "GREATER_THAN"|"GREATER_THAN_OR_EQUALS"|"LESS_THAN"|"LESS_THAN_OR_EQUALS"|"EQUALS"|"NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"|"EXISTS"|"NOT_EXISTS"|"BEGINS_WITH",
          "value": {
            "stringValue": "string",
            "stringListValue": ["string", ...],
            "longValue": long,
            "dateValue": timestamp
          }
        },
        "lambdaArn": "string",
        "s3BucketName": "string",
        "roleArn": "string"
      }
    },
    "mediaExtractionConfiguration": {
      "imageExtractionConfiguration": {
        "imageExtractionStatus": "ENABLED"|"DISABLED"
      },
      "audioExtractionConfiguration": {
        "audioExtractionStatus": "ENABLED"|"DISABLED"
      },
      "videoExtractionConfiguration": {
        "videoExtractionStatus": "ENABLED"|"DISABLED"
      }
    }
  }
  ...
]

--role-arn (строка)

Amazon Resource Name (ARN) IAM-роли с разрешением доступа к вашему ведру S3.

--data-source-sync-id (строка)

Идентификатор синхронизации источника данных, во время которой были добавлены документы.

--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
table
yaml
yaml-stream

--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.

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

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

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

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

Вывод

failedDocuments -> (список)

Список документов, которые не были добавлены в индекс Amazon Q Business, так как документ не прошёл проверку. Каждый документ содержит сообщение об ошибке, указывающее причину невозможности добавления документа в индекс.

(структура)

Список документов, которые не смогли быть удалены из индекса Amazon Q Business. Каждый элемент содержит сообщение об ошибке, указывающее причину невозможности удаления документа из индекса.

id -> (строка)

Идентификатор документа, который не удалось удалить из индекса Amazon Q Business.

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

Объяснение, почему документ не удалось удалить из индекса.

errorMessage -> (строка)

Сообщение, объясняющее ошибку запроса Amazon Q Business.

errorCode -> (строка)

Код, связанный с ошибкой запроса Amazon Q Business.

dataSourceId -> (строка)

Идентификатор подключения к источнику данных Amazon Q Business, содержащий проблемный документ.