создать-базу-знаний
Описание
Создаёт базу знаний.
Примечание
При использовании этого API вы не можете повторно использовать Amazon AppIntegrations DataIntegrations с внешними базами знаний, такими как Salesforce и ServiceNow. В противном случае вы получите ошибку InvalidRequestException.
Например, вы программно управляете своей внешней базой знаний и хотите добавить или удалить одно из полей, которое импортируется из Salesforce. Сделайте следующее:
- Вызовите DeleteKnowledgeBase.
- Вызовите DeleteDataIntegration.
- Вызовите CreateDataIntegration для повторного создания DataIntegration или создания другого.
- Вызовите CreateKnowledgeBase.
См. также: Документация AWS API
Синтаксис
create-knowledge-base
[--client-token <value>]
--name <value>
--knowledge-base-type <value>
[--source-configuration <value>]
[--rendering-configuration <value>]
[--vector-ingestion-configuration <value>]
[--server-side-encryption-configuration <value>]
[--description <value>]
[--tags <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]
Параметры
--client-token (строка)
--name (строка)
--knowledge-base-type (строка)
Тип базы знаний. Только базы знаний типа CUSTOM позволяют загружать собственное содержимое. Базы знаний типа EXTERNAL поддерживают интеграцию с сторонними системами, содержимое которых синхронизируется автоматически.
Возможные значения:
EXTERNALCUSTOMQUICK_RESPONSESMESSAGE_TEMPLATESMANAGED
--source-configuration (структура помеченного объединения)
Источник содержимого базы знаний. Устанавливать этот аргумент необходимо только для баз знаний типа EXTERNAL или Managed.
Примечание
Это структура помеченного объединения. Можно задать только один из следующих ключей верхнего уровня: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.Синтаксис JSON:
{
"appIntegrations": {
"appIntegrationArn": "string",
"objectFields": ["string", ...]
},
"managedSourceConfiguration": {
"webCrawlerConfiguration": {
"urlConfiguration": {
"seedUrls": [
{
"url": "string"
}
...
]
},
"crawlerLimits": {
"rateLimit": integer
},
"inclusionFilters": ["string", ...],
"exclusionFilters": ["string", ...],
"scope": "HOST_ONLY"|"SUBDOMAINS"
}
}
}
--rendering-configuration (структура)
Информация о том, как отобразить содержимое.
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.
Сокращенный синтаксис:
templateUri=string
Синтаксис JSON:
{
"templateUri": "string"
}
--vector-ingestion-configuration (структура)
Содержит подробности о том, как извлекать документы из источника данных.
chunkingConfiguration -> (структура)
Подробности о том, как разбивать документы на фрагменты в источнике данных. Фрагмент — это выдержка из источника данных, возвращаемая при запросе базы знаний, к которой он принадлежит.
chunkingStrategy -> (строка)
NONE, то, возможно, вы захотите предварительно обработать свои файлы, разделив их так, чтобы каждый файл соответствовал фрагменту.fixedSizeChunkingConfiguration -> (структура)
Конфигурации для выбора разбивки на фрагменты фиксированного размера. Если вы установите chunkingStrategy как NONE, исключите это поле.
maxTokens -> (целое число)
overlapPercentage -> (целое число)
hierarchicalChunkingConfiguration -> (структура)
Настройки для разбиения документов на фрагменты иерархическим способом для источника данных. Иерархическое разбиение разделяет документы на уровни фрагментов, где первый уровень содержит большие фрагменты, а второй уровень — более мелкие фрагменты, полученные из первого уровня.
levelConfigurations -> (список)
Настройки токенов для каждого уровня.
(структура)
Настройки токенов для каждого уровня.
maxTokens -> (целое число)
overlapTokens -> (целое число)
semanticChunkingConfiguration -> (структура)
Настройки для семантического разбиения документов для источника данных. Семантическое разбиение разбивает документ на меньшие документы на основе групп схожего содержимого, полученных из текста с помощью обработки естественного языка.
maxTokens -> (целое число)
bufferSize -> (целое число)
breakpointPercentileThreshold -> (целое число)
parsingConfiguration -> (структура)
Пользовательский анализатор для документов источника данных.
parsingStrategy -> (строка)
bedrockFoundationModelConfiguration -> (структура)
Настройки модели фундамента, используемой для анализа документов источника данных.
modelArn -> (строка)
parsingPrompt -> (структура)
Инструкции по интерпретации содержимого документа.
parsingPromptText -> (строка)
Синтаксис JSON:
{
"chunkingConfiguration": {
"chunkingStrategy": "FIXED_SIZE"|"NONE"|"HIERARCHICAL"|"SEMANTIC",
"fixedSizeChunkingConfiguration": {
"maxTokens": integer,
"overlapPercentage": integer
},
"hierarchicalChunkingConfiguration": {
"levelConfigurations": [
{
"maxTokens": integer
}
...
],
"overlapTokens": integer
},
"semanticChunkingConfiguration": {
"maxTokens": integer,
"bufferSize": integer,
"breakpointPercentileThreshold": integer
}
},
"parsingConfiguration": {
"parsingStrategy": "BEDROCK_FOUNDATION_MODEL",
"bedrockFoundationModelConfiguration": {
"modelArn": "string",
"parsingPrompt": {
"parsingPromptText": "string"
}
}
}
}
--server-side-encryption-configuration (структура)
Сведения о конфигурации используемого клиентом управляемого ключа для шифрования.
Этот ключ KMS должен иметь политику, которая разрешает kms:CreateGrant , kms:DescribeKey , kms:Decrypt и kms:GenerateDataKey* разрешения идентификатору IAM, использующему ключ для вызова Amazon Q в Connect.
Дополнительную информацию об установке управляемого ключа клиента для Amazon Q в Connect см. в разделе Активируйте Amazon Q в Connect для вашей учетной записи.
kmsKeyId -> (строка)
Сокращенный синтаксис:
kmsKeyId=string
Синтаксис JSON:
{
"kmsKeyId": "string"
}
--description (строка)
--tags (массив)
Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу.
ключ -> (строка)
значение -> (строка)
Сокращенная синтаксическая запись:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--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.
Вывод
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 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 Servicesapp-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 -> (строка)
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.