Spec-Zone.ru › AWS CLI v2

[ aws . qconnect ]

получение-базы-знаний

Описание

Получает информацию о базе знаний.

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

Синтаксис

  get-knowledge-base
--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]

Параметры

--knowledge-base-id (строка)

Идентификатор базы знаний. Может быть либо ID, либо ARN. В URL нельзя использовать ARN.

--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
  • текст
  • таблица
  • 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.

Вывод

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

База знаний.

knowledgeBaseId -> (строка)

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

knowledgeBaseArn -> (строка)

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

name -> (строка)

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

knowledgeBaseType -> (строка)

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

status -> (строка)

Статус базы знаний.

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

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

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

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

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

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

chunkingStrategy -> (строка)

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

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

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

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

Максимальное количество токенов в фрагменте.

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

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

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

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

levelConfigurations -> (список)

Параметры токенов для каждого слоя.

(структура)

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

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

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

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

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

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

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

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

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

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

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

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

Пороговое значение несходства для разделения фрагментов.

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

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

parsingStrategy -> (строка)

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

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

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

modelArn -> (строка)

ARN модели фундаментального обучения.

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

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

parsingPromptText -> (строка)

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

sourceConfiguration -> (структура со связанными типами)

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

Примечание

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

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

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

appIntegrationArn -> (строка)

Amazon Resource Name (ARN) AppIntegrations DataIntegration для импорта содержимого.

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

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

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

objectFields -> (список)

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

  • Для 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.

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 см. в разделе Включить Amazon Q в Connect для вашего экземпляра.

kmsKeyId -> (строка)

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

description -> (строка)

Описание.

tags -> (карта)

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

key -> (строка)

value -> (строка)

ingestionStatus -> (строка)

Статус импорта из источника данных.

ingestionFailureReasons -> (список)

Список причин ошибок при импорте по файлам.

(строка)

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

Spec-Zone.ru

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