обновить-шаблон-uri-базы-знаний
Описание
Обновляет URI шаблона базы знаний. Поддерживается только для баз знаний типа EXTERNAL. Включите одну переменную в формате ${variable}; она интерполируется Amazon Q в Connect с использованием полученного содержимого. Например, если вы импортируете статью Salesforce, она имеет значение Id, и вы можете установить URI шаблона в https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.
См. также: Документация API AWS
Синтаксис
update-knowledge-base-template-uri
--knowledge-base-id <value>
--template-uri <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 (строка)
--template-uri (строка)
--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.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запроса параметров CLI.
Вывод
knowledgeBase -> (структура)
База знаний, которую нужно обновить.
knowledgeBaseId -> (строка)
knowledgeBaseArn -> (строка)
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 -> (строка)
parsingPrompt -> (структура)
Инструкции по интерпретации содержимого документа.
parsingPromptText -> (строка)
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 -> (строка)
crawlerLimits -> (структура)
Настройки ограничений сканирования для веб-URL-адресов.
rateLimit -> (целое число)
inclusionFilters -> (список)
Список одного или нескольких включений шаблонов регулярных выражений для включения определенных URL-адресов. Если вы указываете фильтр включения и исключения и оба совпадают с URL-адресом, фильтр исключения имеет приоритет, и веб-контент URL-адреса не сканируется.
(строка)
exclusionFilters -> (список)
Список одного или нескольких шаблонов исключений регулярных выражений для исключения определенных URL-адресов. Если вы указываете фильтр включения и исключения и оба совпадают с URL-адресом, фильтр исключения имеет приоритет, и веб-контент URL-адреса не сканируется.
(строка)
scope -> (строка)
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 -> (строка)
description -> (строка)
tags -> (отображение)
Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу.
key -> (строка)
value -> (строка)
ingestionStatus -> (строка)
ingestionFailureReasons -> (список)
Список причин ошибок при загрузке по файлам.
(строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.