Spec-Zone.ru › AWS CLI v2

[ aws . qconnect ]

list-knowledge-bases

Описание

Отображает список баз знаний.

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

list-knowledge-bases — это операция с постраничной выборкой. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничную выборку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной выборкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: knowledgeBaseSummaries

Синтаксис

  list-knowledge-bases
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

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

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

Токен для указания точки начала постраничной выборки. Это NextToken из ранее укороченного ответа.

Примеры использования см. в разделе Постраничная выборка в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для вызова службы AWS. Это не влияет на количество элементов, возвращаемых в выводе команды. Уменьшение размера страницы приводит к большему количеству вызовов службы AWS, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов службы AWS.

Примеры использования см. в разделе Постраничная выборка в Руководстве пользователя AWS Command Line Interface.

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

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной выборки укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная выборка в Руководстве пользователя AWS Command Line Interface.

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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.

Вывод

knowledgeBaseSummaries -> (список)

Информация о базах знаний.

(структура)

Сводная информация о базе знаний.

knowledgeBaseId -> (строка)

Идентификатор базы знаний.

knowledgeBaseArn -> (строка)

Amazon Resource Name (ARN) базы знаний.

name -> (строка)

Название базы знаний.

knowledgeBaseType -> (строка)

Тип базы знаний.

status -> (строка)

Состояние сводной информации о базе знаний.

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

Конфигурационная информация о внешнем источнике данных.

Примечание

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

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

Конфигурационная информация для Amazon AppIntegrations для автоматической обработки содержимого.

appIntegrationArn -> (строка)

Amazon Resource Name (ARN) интеграции данных AppIntegrations для обработки содержимого.

  • Для Salesforce , ваша интеграция данных AppIntegrations должна иметь ObjectConfiguration, если objectFields не указан, включая как минимум Id , ArticleNumber , VersionNumber , Title , PublishStatus и IsDeleted в качестве исходных полей.
  • Для ServiceNow , ваша интеграция данных AppIntegrations должна иметь ObjectConfiguration, если objectFields не указан, включая как минимум number , short_description , sys_mod_count , workflow_state и active в качестве исходных полей.
  • Для Zendesk , ваша интеграция данных AppIntegrations должна иметь ObjectConfiguration, если objectFields не указан, включая как минимум id , title , updated_at и draft в качестве исходных полей.
  • Для SharePoint , ваша интеграция данных AppIntegrations должна иметь FileConfiguration, включая только расширения файлов, которые находятся среди docx , pdf , html , htm и txt .
  • Для Amazon S3 , ObjectConfiguration и FileConfiguration вашей интеграции данных AppIntegrations должны быть null. SourceURI вашей интеграции данных должно использовать следующий формат: s3://your_s3_bucket_name .

Предупреждение

Политика ведра соответствующего ведра S3 должна разрешать Amazon Web Services-принципалу app-integrations.amazonaws.com выполнять s3:ListBucket , s3:GetObject и s3:GetBucketLocation над ведром.

objectFields -> (список)

Поля из источника, доступные вашим агентам в Amazon Q в Connect. Необязательно, если ObjectConfiguration включен в предоставленную интеграцию данных.

  • Для Salesforce , вы должны включить как минимум Id , ArticleNumber , VersionNumber , Title , PublishStatus и IsDeleted .
  • Для ServiceNow , вы должны включить как минимум number , short_description , sys_mod_count , workflow_state и active .
  • Для Zendesk , вы должны включить как минимум id , title , updated_at и draft .

Убедитесь, что вы включаете дополнительные поля. Эти поля индексируются и используются для получения рекомендаций.

(строка)

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

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

Примечание

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

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

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

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

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

seedUrls -> (список)

Список URL-адресов для сканирования.

(структура)

URL-адрес для сканирования.

url -> (строка)

URL для сканирования

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

Конфигурация ограничений сканирования для веб-URL.

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

Скорость извлечения веб-URL в минуту.

inclusionFilters -> (список)

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

(строка)

exclusionFilters -> (список)

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

(строка)

scope -> (строка)

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

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

Содержит сведения о том, как обрабатывать документы в источнике данных.

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

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

chunkingStrategy -> (строка)

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

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

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

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

Максимальное количество токенов, включаемых в часть.

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

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

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

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

levelConfigurations -> (список)

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

(структура)

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

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

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

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

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

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

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

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

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

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

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

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

Пороговое значение несовпадения для разделения частей.

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

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

parsingStrategy -> (строка)

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

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

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

modelArn -> (строка)

ARN модели основного уровня.

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

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

parsingPromptText -> (строка)

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

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

Информация о том, как отобразить содержимое.

templateUri -> (строка)

Шаблон URI, содержащий ровно одну переменную в формате ${variableName}. Это может быть задано только для баз знаний EXTERNAL. Для Salesforce, ServiceNow и Zendesk переменная должна быть одной из следующих:

  • Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus или IsDeleted
  • ServiceNow: number , short_description , sys_mod_count , workflow_state или active
  • Zendesk: id , title , updated_at или draft

Переменная заменяется фактическим значением для части содержимого при вызове GetContent .

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

Конфигурационная информация для управляемого клиентом ключа, используемого для шифрования.

Этот ключ KMS должен иметь политику, разрешающую kms:CreateGrant , kms:DescribeKey , kms:Decrypt и kms:GenerateDataKey* разрешения для учетной записи IAM, использующей ключ для вызова Amazon Q в Connect.

Дополнительную информацию о настройке управляемого клиентом ключа для Amazon Q в Connect см. в разделе Enable Amazon Q in Connect for your instance .

kmsKeyId -> (строка)

Управляемый клиентом ключ, используемый для шифрования. Дополнительную информацию о настройке управляемого клиентом ключа для Amazon Q в Connect см. в разделе Enable Amazon Q in Connect for your instance . Сведения о допустимых значениях ID см. в разделе Идентификаторы ключей (KeyId) .

description -> (строка)

Описание базы знаний.

tags -> (карта)

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

key -> (строка)

value -> (строка)

nextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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