Spec-Zone.ru › AWS CLI v2

[ aws . bedrock-agent ]

получить-источник-данных

Описание

Получает информацию о источнике данных.

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

Синтаксис

  get-data-source
--data-source-id <value>
--knowledge-base-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]

Параметры

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

Уникальный идентификатор источника данных.

--knowledge-base-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 (строка)

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

  • on
  • off
  • auto

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

Вывод

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

Содержит данные о источнике данных.

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

Время создания источника данных.

dataDeletionPolicy -> (строка)

Политика удаления данных для источника данных.

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

Настройки подключения к источнику данных.

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

Настройки подключения к Confluence в качестве источника данных.

Примечание

Подключение к источнику данных Confluence находится в предварительной версии и может быть изменено.

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

Настройки сканирования контента Confluence. Например, настройка определенных типов контента Confluence.

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

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

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

Настройки фильтрации определенных объектов или типов контента источника данных.

filters -> (список)

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

(структура)

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

exclusionFilters -> (список)

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

(строка)

inclusionFilters -> (список)

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

(строка)

objectType -> (строка)

Поддерживаемый тип объекта или тип контента источника данных.

type -> (строка)

Тип фильтрации, который вы хотите применить к определенным объектам или содержимому источника данных. Например, тип PATTERN — это шаблоны регулярных выражений, которые можно применять для фильтрации контента.

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

Информация о конечной точке подключения к вашему источнику данных Confluence.

authType -> (строка)

Поддерживаемый тип аутентификации для аутентификации и подключения к вашему экземпляру Confluence.

credentialsSecretArn -> (строка)

Идентификатор ресурса Amazon (ARN) секрета Secrets Manager, в котором хранятся ваши учетные данные аутентификации для URL вашего экземпляра Confluence. Для получения дополнительной информации о парах «ключ-значение», которые должны быть включены в ваш секрет в зависимости от типа аутентификации, см. конфигурацию подключения к Confluence.

hostType -> (строка)

Поддерживаемый тип хоста: онлайн/облако или сервер/локальный.

hostUrl -> (строка)

URL хоста Confluence или URL экземпляра.

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

Настройки подключения к Amazon S3 в качестве источника данных.

bucketArn -> (строка)

Идентификатор ресурса Amazon (ARN) ведра S3, содержащего ваши данные.

bucketOwnerAccountId -> (строка)

Идентификатор учетной записи владельца ведра S3.

inclusionPrefixes -> (список)

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

(строка)

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

Настройки подключения к Salesforce в качестве источника данных.

Примечание

Подключение к источнику данных Salesforce находится в предварительной версии и может быть изменено.

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

Настройки сканирования контента Salesforce. Например, настройка определенных типов контента Salesforce.

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

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

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

Настройки фильтрации определенных объектов или типов контента источника данных.

filters -> (список)

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

(структура)

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

exclusionFilters -> (список)

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

(строка)

inclusionFilters -> (список)

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

(строка)

objectType -> (строка)

Поддерживаемый тип объекта или тип контента источника данных.

type -> (строка)

Тип фильтрации, который вы хотите применить к определенным объектам или содержимому источника данных. Например, тип PATTERN — это шаблоны регулярных выражений, которые можно применять для фильтрации контента.

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

Информация о конечной точке подключения к вашему источнику данных Salesforce.

authType -> (строка)

Поддерживаемый тип аутентификации для аутентификации и подключения к вашему экземпляру Salesforce.

credentialsSecretArn -> (строка)

Идентификатор ресурса Amazon (ARN) секрета Secrets Manager, в котором хранятся ваши учетные данные аутентификации для URL вашего экземпляра Salesforce. Для получения дополнительной информации о парах «ключ-значение», которые должны быть включены в ваш секрет в зависимости от типа аутентификации, см. конфигурацию подключения к Salesforce.

hostUrl -> (строка)

URL хоста Salesforce или URL экземпляра.

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

Настройки подключения к SharePoint в качестве источника данных.

Примечание

Подключение к источнику данных SharePoint находится в предварительной версии и может быть изменено.

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

Настройки сканирования контента SharePoint. Например, настройка определенных типов контента SharePoint.

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

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

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

Настройки фильтрации определенных объектов или типов контента источника данных.

filters -> (список)

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

(структура)

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

exclusionFilters -> (список)

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

(строка)

inclusionFilters -> (список)

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

(строка)

objectType -> (строка)

Поддерживаемый тип объекта или тип контента источника данных.

type -> (строка)

Тип фильтрации, который вы хотите применить к определенным объектам или содержимому источника данных. Например, тип PATTERN — это шаблоны регулярных выражений, которые можно применять для фильтрации контента.

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

Информация о конечной точке подключения к вашему источнику данных SharePoint.

authType -> (строка)

Поддерживаемый тип аутентификации для аутентификации и подключения к вашему сайту/сайтам SharePoint.

credentialsSecretArn -> (строка)

Идентификатор ресурса Amazon (ARN) секрета Secrets Manager, в котором хранятся ваши учетные данные аутентификации для вашего сайта/сайтов SharePoint. Для получения дополнительной информации о парах «ключ-значение», которые должны быть включены в ваш секрет в зависимости от типа аутентификации, см. конфигурацию подключения к SharePoint.

domain -> (строка)

Домен вашего экземпляра или URL сайта/сайтов SharePoint.

hostType -> (строка)

Поддерживаемый тип хоста: онлайн/облако или сервер/локальный.

siteUrls -> (список)

Список одного или нескольких URL-адресов сайтов SharePoint.

(строка)

tenantId -> (строка)

Идентификатор вашего клиента Microsoft 365.

type -> (строка)

Тип источника данных.

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

Настройка веб-адресов для сканирования в вашем источнике данных. Вы должны быть авторизованы для сканирования этих адресов.

Примечание

Сканирование веб-адресов как вашего источника данных находится в предварительном релизе и может быть изменено.

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

Подробности конфигурации веб-сканера для веб-источника данных.

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

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

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

Максимальное количество веб-страниц, сканируемых из ваших исходных адресов, до 25 000 страниц. Если количество веб-страниц превысит этот лимит, синхронизация источника данных завершится неудачей, и никакие веб-страницы не будут обработаны.

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

Максимальная скорость сканирования страниц, до 300 в минуту на хост.

exclusionFilters -> (список)

Список одного или нескольких шаблонов исключений с регулярными выражениями для исключения определённых веб-адресов. Если вы указали фильтр включения и исключения, и оба подходят для URL-адреса, то фильтр исключения имеет приоритет, и содержимое веб-страницы URL-адреса не будет сканироваться.

(строка)

inclusionFilters -> (список)

Список одного или нескольких шаблонов включения с регулярными выражениями для включения определённых URL-адресов. Если вы указали фильтр включения и исключения, и оба подходят для URL-адреса, то фильтр исключения имеет приоритет, и содержимое веб-страницы URL-адреса не будет сканироваться.

(строка)

scope -> (строка)

Область сканирования для ваших URL-адресов.

Вы можете выбрать сканирование только веб-страниц, принадлежащих одному хосту или домену. Например, только веб-страницы, содержащие начальный URL-адрес «https://docs.aws.amazon.com/bedrock/latest/userguide/» и никакие другие домены. Вы можете включить поддомены в дополнение к хосту или основному домену. Например, веб-страницы, содержащие «aws.amazon.com», также могут включать поддомен «docs.aws.amazon.com».

userAgent -> (строка)

Возвращает суффикс пользовательского агента для вашего веб-сканера.

userAgentHeader -> (строка)

Строка, используемая для идентификации сканера или бота при доступе к веб-серверу. Значение заголовка пользовательского агента состоит из bedrockbot , UUID и суффикса пользовательского агента вашего сканера (если он предоставлен). По умолчанию он установлен на bedrockbot_UUID . Вы можете дополнить bedrockbot_UUID пользовательским суффиксом, чтобы разрешить доступ к вашим исходным URL-адресам определённому пользовательскому агенту.

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

Подробности конфигурации источника данных для веб-данных.

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

Настройка URL-адреса/адресов.

seedUrls -> (список)

Один или несколько начальных URL-адресов.

(структура)

Начальный URL-адрес. Вы должны быть авторизованы для сканирования этого адреса.

url -> (строка)

Начальный URL-адрес.

dataSourceId -> (строка)

Уникальный идентификатор источника данных.

description -> (строка)

Описание источника данных.

failureReasons -> (список)

Подробные причины неудачного удаления источника данных.

(строка)

knowledgeBaseId -> (строка)

Уникальный идентификатор базы знаний, к которой принадлежит источник данных.

name -> (строка)

Название источника данных.

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

Содержит информацию о конфигурации шифрования на стороне сервера.

kmsKeyArn -> (строка)

Amazon Resource Name (ARN) ключа KMS, используемого для шифрования ресурса.

status -> (строка)

Статус источника данных. Возможные статусы:

  • Доступно – Источник данных создан и готов к загрузке в базу знаний.
  • Удаляется – Источник данных удаляется.

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

Время последнего обновления источника данных.

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

Содержит информацию о способе загрузки документов в источник данных.

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

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

chunkingStrategy -> (строка)

База знаний может разбить ваши исходные данные на куски. Кусок представляет собой фрагмент из источника данных, который возвращается при запросе к базе знаний, к которой он относится. У вас есть следующие варианты для разбивки данных на куски. Если вы выберите NONE, то, возможно, вам нужно предварительно обработать файлы, разделив их так, чтобы каждый файл соответствовал куску.

  • FIXED_SIZE – Amazon Bedrock разбивает ваши исходные данные на куски приблизительно заданного размера, указанного в fixedSizeChunkingConfiguration.
  • HIERARCHICAL – Разделение документов на слои кусков, где первый слой содержит большие куски, а второй – меньшие куски, полученные из первого слоя.
  • SEMANTIC – Разделение документов на куски на основе групп похожих фрагментов, полученных с помощью обработки естественного языка.
  • NONE – Amazon Bedrock обрабатывает каждый файл как один кусок. Если вы выберите этот вариант, вам, возможно, нужно предварительно разделить документы на отдельные файлы.

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

Настройки для выбора разбивки на куски фиксированного размера. Если вы зададите chunkingStrategy как NONE, исключите этот параметр.

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

Максимальное количество токенов в куске.

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

Процент перекрытия между смежными кусками источника данных.

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

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

levelConfigurations -> (список)

Настройки токенов для каждого слоя.

(структура)

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

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

Максимальное количество токенов, которое может содержать кусок в этом слое.

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

Количество токенов, повторяющихся в кусках одного и того же слоя.

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

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

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

Порог несовпадения для разделения кусков.

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

Размер буфера.

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

Максимальное количество токенов, которое может содержать кусок.

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

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

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

Конфигурация модели Amazon Bedrock, используемой для обогащения контекстом.

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

Стратегия обогащения, используемая для предоставления дополнительного контекста. Например, Neptune GraphRAG использует модели Amazon Bedrock для извлечения сущностей куска.

method -> (строка)

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

modelArn -> (строка)

Amazon Resource Name (ARN) модели, используемой для создания векторных вложений для базы знаний.

type -> (строка)

Метод, используемый для обогащения контекстом. Должны быть модели Amazon Bedrock.

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

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

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

Путь к ведру S3 для входных и выходных объектов.

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

Путь к ведру S3.

uri -> (строка)

URI расположения. Например, s3://my-bucket/chunk-processor/ .

transformations -> (список)

Функция Lambda, обрабатывающая документы.

(структура)

Пользовательский этап обработки документов, перемещаемых по конвейеру загрузки источника данных. Для обработки документов после преобразования в куски установите шаг, к которому применяется POST_CHUNKING .

stepToApply -> (строка)

Когда служба применяет преобразование.

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

Функция Lambda, обрабатывающая документы.

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

Функция Lambda.

lambdaArn -> (строка)

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

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

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

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

Если вы укажете BEDROCK_DATA_AUTOMATION как стратегию разбора для загрузки вашего источника данных, используйте этот объект для изменения конфигураций, использующих парсер Amazon Bedrock Data Automation.

parsingModality -> (строка)

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

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

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

modelArn -> (строка)

ARN модели оснований для использования при разборе.

parsingModality -> (строка)

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

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

Инструкции по интерпретации содержимого документа.

parsingPromptText -> (строка)

Инструкции по интерпретации содержимого документа.

parsingStrategy -> (строка)

Стратегия разбора для источника данных.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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