[ aws . bedrock-agent-runtime ]
retrieve-and-generate
Описание
Запрашивает базу знаний и генерирует ответы на основе полученных результатов и с использованием указанной основной модели или профиля вывода. Ответ приводит только источники, относящиеся к запросу.
См. также: Документацию API AWS
retrieve-and-generate использует значения типа документа. Типы документов следуют модели данных JSON, где допустимые значения: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команды, опций и вложенных параметров, помеченных типом document, необходимо предоставить JSON. Краткая форма записи не поддерживает типы документов.
Синтаксис
retrieve-and-generate
--input <value>
[--retrieve-and-generate-configuration <value>]
[--session-configuration <value>]
[--session-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]
Параметры
--input (структура)
Содержит запрос, который будет отправлен в базу знаний.
text -> (строка)
Краткая форма записи:
text=string
Формат JSON:
{
"text": "string"
}
--retrieve-and-generate-configuration (структура)
Содержит настройки для запроса к базе знаний и процесса извлечения. Для получения дополнительной информации см. Настройки запросов.
externalSourcesConfiguration -> (структура)
Настройки для объекта обертки внешнего источника в функции retrieveAndGenerate.
generationConfiguration -> (структура)
Подсказка, используемая с объектом обертки внешнего источника в функции retrieveAndGenerate.
additionalModelRequestFields -> (карта)
Дополнительные параметры модели и соответствующие им значения, которые не включены в структуру textInferenceConfig для внешнего источника. Принимает пользовательские параметры модели, специфичные для используемой языковой модели.
key -> (строка)
value -> (документ)
guardrailConfiguration -> (структура)
Подробные настройки для ограничения.
guardrailId -> (строка)
guardrailVersion -> (строка)
inferenceConfig -> (структура)
Настройки конфигурации вывода при использовании RetrieveAndGenerate для генерации ответов с использованием внешнего источника.
textInferenceConfig -> (структура)
Настройки конфигурации, специфичные для генерации текста при генерации ответов с помощью RetrieveAndGenerate.
maxTokens -> (целое число)
stopSequences -> (список)
Список последовательностей символов, которые, если сгенерированы, заставят модель прекратить дальнейшую генерацию токенов. Не используйте минимальную длину 1 или максимальную длину 1000. Значения пределов, описанные здесь, являются условными. Для фактических значений обратитесь к пределам, определенным вашей конкретной моделью.
(строка)
temperature -> (число с плавающей точкой)
topP -> (число с плавающей точкой)
performanceConfig -> (структура)
Настройки задержки для модели.
latency -> (строка)
optimized.promptTemplate -> (структура)
Содержит текстовую строку promptTemplate для объекта обертки внешнего источника.
textPromptTemplate -> (строка)
Шаблон подсказки, который отправляется модели для генерации ответа. Вы можете включать заглушки подсказки, которые заменяются перед отправкой подсказки модели для предоставления инструкции и контекста модели. Кроме того, вы можете включать теги XML для выделения осмысленных разделов шаблона подсказки.
Дополнительную информацию см. в следующих источниках:
- Шаблоны подсказок для базы знаний
- Использование тегов XML с моделями Anthropic Claude
modelArn -> (строка)
retrieveAndGenerate.sources -> (список)
Документ для объекта обертки внешнего источника в функции retrieveAndGenerate.
(структура)
Уникальный внешний источник содержимого, содержащегося в объекте обертки.
byteContent -> (структура)
Идентификатор, тип содержимого и данные объекта обертки внешнего источника.
contentType -> (строка)
data -> (бинарные данные)
identifier -> (строка)
s3Location -> (структура)
Расположение объекта обертки внешнего источника в S3.
uri -> (строка)
sourceType -> (строка)
knowledgeBaseConfiguration -> (структура)
Содержит подробности о базе знаний для извлечения информации и генерации ответов.
generationConfiguration -> (структура)
Содержит настройки для генерации ответов на основе результатов запроса к базе знаний.
additionalModelRequestFields -> (карта)
Дополнительные параметры модели и соответствующие значения, не включенные в структуру textInferenceConfig для базы знаний. Это позволяет пользователям предоставлять пользовательские параметры модели, специфичные для используемой языковой модели.
key -> (строка)
value -> (документ)
guardrailConfiguration -> (структура)
Подробные настройки для ограждения.
guardrailId -> (строка)
guardrailVersion -> (строка)
inferenceConfig -> (структура)
Настройки конфигурации для вывода, когда используется RetrieveAndGenerate для генерации ответов при использовании базы знаний в качестве источника.
textInferenceConfig -> (структура)
Настройки конфигурации, специфичные для генерации текста при генерации ответов с использованием RetrieveAndGenerate.
maxTokens -> (целое число)
stopSequences -> (список)
Список последовательностей символов, которые, если будут сгенерированы, заставят модель прекратить генерацию дополнительных токенов. Не используйте минимальную длину 1 или максимальную длину 1000. Значения лимитов, описанные здесь, являются условными значениями, для фактических значений обратитесь к пределам, определённым вашей конкретной моделью.
(строка)
temperature -> (число с плавающей точкой)
topP -> (число с плавающей точкой)
performanceConfig -> (структура)
Настройки задержки для модели.
latency -> (строка)
optimized.promptTemplate -> (структура)
Содержит шаблон запроса, который отправляется модели для генерации ответа. Запросы генерации должны включать переменную $search_results$. Дополнительную информацию см. в руководстве по использованию заполнительных переменных.
textPromptTemplate -> (строка)
Шаблон запроса, который отправляется модели для генерации ответа. Вы можете включать заполнители запросов, которые заменяются перед отправкой запроса модели для предоставления инструкции и контекста модели. Кроме того, вы можете включать теги XML для выделения осмысленных разделов шаблона запроса.
Дополнительную информацию см. в следующих ресурсах:
- Шаблоны запросов для базы знаний
- Использование тегов XML с моделями Anthropic Claude
knowledgeBaseId -> (строка)
modelArn -> (строка)
orchestrationConfiguration -> (структура)
Настройки для обработки запроса моделью перед извлечением и генерацией.
additionalModelRequestFields -> (карта)
Дополнительные параметры модели и соответствующие значения, не включенные в структуру textInferenceConfig для базы знаний. Это позволяет пользователям предоставлять пользовательские параметры модели, специфичные для используемой языковой модели.
key -> (строка)
value -> (документ)
inferenceConfig -> (структура)
Настройки конфигурации для вывода, когда используется RetrieveAndGenerate для генерации ответов при использовании базы знаний в качестве источника.
textInferenceConfig -> (структура)
Настройки конфигурации, специфичные для генерации текста при генерации ответов с использованием RetrieveAndGenerate.
maxTokens -> (целое число)
stopSequences -> (список)
Список последовательностей символов, которые, если будут сгенерированы, заставят модель прекратить генерацию дополнительных токенов. Не используйте минимальную длину 1 или максимальную длину 1000. Значения лимитов, описанные здесь, являются условными значениями, для фактических значений обратитесь к пределам, определённым вашей конкретной моделью.
(строка)
temperature -> (число с плавающей точкой)
topP -> (число с плавающей точкой)
performanceConfig -> (структура)
Настройки задержки для модели.
latency -> (строка)
optimized.promptTemplate -> (структура)
Содержит шаблон запроса, который отправляется модели. Запросы организации должны включать переменные $conversation_history$ и $output_format_instructions$. Дополнительную информацию см. в руководстве по использованию заполнительных переменных.
textPromptTemplate -> (строка)
Шаблон запроса, который отправляется модели для генерации ответа. Вы можете включать заполнители запросов, которые заменяются перед отправкой запроса модели для предоставления инструкции и контекста модели. Кроме того, вы можете включать теги XML для выделения осмысленных разделов шаблона запроса.
Дополнительную информацию см. в следующих ресурсах:
- Шаблоны запросов для базы знаний
- Использование тегов XML с моделями Anthropic Claude
queryTransformationConfiguration -> (структура)
Для разделения запроса и извлечения нескольких источников установите тип преобразования в значение QUERY_DECOMPOSITION.
type -> (строка)
retrievalConfiguration -> (структура)
Содержит конфигурации для получения и возврата запроса к базе знаний.
vectorSearchConfiguration -> (структура)
Содержит сведения о том, как должны возвращаться результаты векторного поиска. Дополнительную информацию см. в разделах Конфигурации запросов.
filter -> (структура помеченного объединения)
Указывает фильтры, которые следует использовать для метаданных в источниках данных базы знаний перед возвратом результатов. Дополнительную информацию см. в разделах Конфигурации запросов.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:andAll, equals, greaterThan, greaterThanOrEquals, in, lessThan, lessThanOrEquals, listContains, notEquals, notIn, orAll, startsWith, stringContains.andAll -> (список)
Источники данных базы знаний возвращаются, если атрибуты их метаданных удовлетворяют всем условиям фильтрации в этом списке.
(структура помеченного объединения)
Указывает фильтры, которые следует использовать для атрибутов метаданных в источниках данных базы знаний перед возвратом результатов. Дополнительную информацию см. в разделах Конфигурации запросов. Примеры использования этих фильтров приведены ниже.
Этот тип данных используется в следующих операциях API:
- Запрос на получение – в поле
filter - Запрос на получение и генерацию – в поле
filter
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:andAll, equals, greaterThan, greaterThanOrEquals, in, lessThan, lessThanOrEquals, listContains, notEquals, notIn, orAll, startsWith, stringContains.andAll -> (список)
Источники данных базы знаний возвращаются, если их атрибуты метаданных удовлетворяют всем условиям фильтрации в этом списке.
(… рекурсивно …)
equals -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение совпадает с value в этом объекте.
Следующий пример вернёт источники данных с атрибутом animal, значение которого равно cat :
"equals": { "key": "animal", "value": "cat" }key -> (строка)
value -> (документ)
greaterThan -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение больше, чем value в этом объекте.
Следующий пример вернёт источники данных с атрибутом year, значение которого больше, чем 1989 :
"greaterThan": { "key": "year", "value": 1989 }key -> (строка)
value -> (документ)
greaterThanOrEquals -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение больше или равно value в этом объекте.
Следующий пример вернёт источники данных с атрибутом year, значение которого больше или равно 1989 :
"greaterThanOrEquals": { "key": "year", "value": 1989 }key -> (строка)
value -> (документ)
in -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение находится в списке, указанном в value в этом объекте.
Следующий пример вернёт источники данных с атрибутом animal, значение которого равно либо cat, либо dog :
"in": { "key": "animal", "value": ["cat", "dog"] }key -> (строка)
value -> (документ)
lessThan -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение меньше, чем value в этом объекте.
Следующий пример вернёт источники данных с атрибутом year, значение которого меньше, чем 1989.
"lessThan": { "key": "year", "value": 1989 }key -> (строка)
value -> (документ)
lessThanOrEquals -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение меньше или равно value в этом объекте.
Следующий пример вернёт источники данных с атрибутом year, значение которого меньше или равно 1989.
"lessThanOrEquals": { "key": "year", "value": 1989 }key -> (строка)
value -> (документ)
listContains -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение представляет собой список, который содержит value в качестве одного из своих элементов.
Следующий пример вернёт источники данных с атрибутом animals, представляющим собой список, содержащий элемент cat (например, ["dog", "cat"]).
"listContains": { "key": "animals", "value": "cat" }key -> (строка)
value -> (документ)
notEquals -> (структура)
Источники данных базы знаний возвращаются, когда:
- Он содержит атрибут метаданных, имя которого совпадает с
key, а значение не совпадает сvalueв этом объекте. - Ключ отсутствует в документе.
Следующий пример вернёт источники данных, которые не содержат атрибут animal, значение которого равно cat.
"notEquals": { "key": "animal", "value": "cat" }key -> (строка)
value -> (документ)
notIn -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение не содержится в списке, указанном в value в этом объекте.
Следующий пример вернёт источники данных, у которых атрибут animal не равен ни cat, ни dog.
"notIn": { "key": "animal", "value": ["cat", "dog"] }key -> (строка)
value -> (документ)
orAll -> (список)
Источники данных базы знаний возвращаются, если их атрибуты метаданных удовлетворяют хотя бы одному из условий фильтрации в этом списке.
(… рекурсивно …)
startsWith -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение начинается с value в этом объекте. Этот фильтр в настоящее время поддерживается только для векторных хранилищ Amazon OpenSearch Serverless.
Следующий пример вернёт источники данных с атрибутом animal, начинающимся с ca (например, cat или camel).
"startsWith": { "key": "animal", "value": "ca" }key -> (строка)
value -> (документ)
stringContains -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение является одним из следующих:
- Строка, содержащая
valueв качестве подстроки. Следующий пример вернёт источники данных с атрибутомanimal, содержащим подстрокуat(например,cat)."stringContains": { "key": "animal", "value": "at" } - Список с элементом, содержащим
valueв качестве подстроки. Следующий пример вернёт источники данных с атрибутомanimals, представляющим собой список, содержащий элемент, содержащий подстрокуat(например,["dog", "cat"])."stringContains": { "key": "animals", "value": "at" }
key -> (строка)
value -> (документ)
equals -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение совпадает с value в этом объекте.
Следующий пример вернёт источники данных с атрибутом animal, значение которого равно cat :
"equals": { "key": "animal", "value": "cat" }key -> (строка)
value -> (документ)
greaterThan -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение больше, чем value в этом объекте.
Следующий пример вернёт источники данных с атрибутом year, значение которого больше, чем 1989 :
"greaterThan": { "key": "year", "value": 1989 }key -> (строка)
value -> (документ)
greaterThanOrEquals -> (структура)
Данные источников базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение которого больше или равно value в этом объекте.
Следующий пример вернёт источники данных с атрибутом year, значение которого больше или равно 1989 :
"greaterThanOrEquals": { "key": "year", "value": 1989 }key -> (строка)
value -> (документ)
in -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение которого входит в список, указанный в value в этом объекте.
Следующий пример вернёт источники данных с атрибутом animal, который равен либо cat, либо dog :
"in": { "key": "animal", "value": ["cat", "dog"] }key -> (строка)
value -> (документ)
lessThan -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение которого меньше value в этом объекте.
Следующий пример вернёт источники данных с атрибутом year, значение которого меньше 1989.
"lessThan": { "key": "year", "value": 1989 }key -> (строка)
value -> (документ)
lessThanOrEquals -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение которого меньше или равно value в этом объекте.
Следующий пример вернёт источники данных с атрибутом year, значение которого меньше или равно 1989.
"lessThanOrEquals": { "key": "year", "value": 1989 }key -> (строка)
value -> (документ)
listContains -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение которого является списком, содержащим value в качестве одного из своих элементов.
Следующий пример вернёт источники данных с атрибутом animals, который является списком, содержащим элемент cat (например, ["dog", "cat"]).
"listContains": { "key": "animals", "value": "cat" }key -> (строка)
value -> (документ)
notEquals -> (структура)
Источники данных базы знаний возвращаются, когда:
- Они содержат атрибут метаданных, имя которого совпадает с
key, а значение которого не совпадает со значениемvalueв этом объекте. - Ключ отсутствует в документе.
Следующий пример вернёт источники данных, которые не содержат атрибута animal со значением cat.
"notEquals": { "key": "animal", "value": "cat" }key -> (строка)
value -> (документ)
notIn -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, а значение которого не входит в список, указанный в value в этом объекте.
Следующий пример вернёт источники данных, у которых атрибут animal не равен ни cat, ни dog.
"notIn": { "key": "animal", "value": ["cat", "dog"] }key -> (строка)
value -> (документ)
orAll -> (список)
Данные из базы знаний возвращаются, если атрибуты метаданных удовлетворяют хотя бы одному из условий фильтрации в этом списке.
(структура помеченного объединения)
Указывает фильтры, которые следует применять к атрибутам метаданных в источниках данных базы знаний перед возвратом результатов. Дополнительную информацию см. в разделе Конфигурации запросов. Примеры использования этих фильтров см. ниже.
Этот тип данных используется в следующих операциях API:
- Запрос извлечения – в поле
filter - Запрос извлечения и генерации – в поле
filter
Примечание
Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня:andAll, equals, greaterThan, greaterThanOrEquals, in, lessThan, lessThanOrEquals, listContains, notEquals, notIn, orAll, startsWith, stringContains.andAll -> (список)
Данные из базы знаний возвращаются, если атрибуты метаданных удовлетворяют всем условиям фильтрации в этом списке.
(… рекурсивно …)
equals -> (структура)
Данные из базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение соответствует значению value в этом объекте.
Следующий пример вернёт источники данных с атрибутом animal, значение которого равно cat:
"equals": { "key": "animal", "value": "cat" }key -> (строка)
value -> (документ)
greaterThan -> (структура)
Данные из базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение которого больше value в этом объекте.
Следующий пример вернёт источники данных с атрибутом year, значение которого больше 1989:
"greaterThan": { "key": "year", "value": 1989 }key -> (строка)
value -> (документ)
greaterThanOrEquals -> (структура)
Данные из базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение которого больше или равно value в этом объекте.
Следующий пример вернёт источники данных с атрибутом year, значение которого больше или равно 1989:
"greaterThanOrEquals": { "key": "year", "value": 1989 }key -> (строка)
value -> (документ)
in -> (структура)
Данные из базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение которого находится в списке, указанном в value в этом объекте.
Следующий пример вернёт источники данных с атрибутом animal, значение которого равно либо cat, либо dog:
"in": { "key": "animal", "value": ["cat", "dog"] }key -> (строка)
value -> (документ)
lessThan -> (структура)
Данные из базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение которого меньше value в этом объекте.
Следующий пример вернёт источники данных с атрибутом year, значение которого меньше 1989.
"lessThan": { "key": "year", "value": 1989 }key -> (строка)
value -> (документ)
lessThanOrEquals -> (структура)
Данные из базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение которого меньше или равно value в этом объекте.
Следующий пример вернёт источники данных с атрибутом year, значение которого меньше или равно 1989.
"lessThanOrEquals": { "key": "year", "value": 1989 }key -> (строка)
value -> (документ)
listContains -> (структура)
Данные из базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение которого является списком, содержащим value в качестве одного из своих элементов.
Следующий пример вернёт источники данных с атрибутом animals, который является списком, содержащим элемент cat (например, ["dog", "cat"]).
"listContains": { "key": "animals", "value": "cat" }key -> (строка)
value -> (документ)
notEquals -> (структура)
Данные из базы знаний возвращаются, когда:
- Содержит атрибут метаданных, имя которого соответствует
key, а значение которого не соответствует значениюvalueв этом объекте. - Ключ отсутствует в документе.
Следующий пример вернёт источники данных, не содержащие атрибута animal, значение которого равно cat.
"notEquals": { "key": "animal", "value": "cat" }key -> (строка)
value -> (документ)
notIn -> (структура)
Данные из базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение которого не находится в списке, указанном в value в этом объекте.
Следующий пример вернёт источники данных, у которых атрибут animal не равен ни cat, ни dog.
"notIn": { "key": "animal", "value": ["cat", "dog"] }key -> (строка)
value -> (документ)
orAll -> (список)
Данные из базы знаний возвращаются, если атрибуты метаданных удовлетворяют хотя бы одному из условий фильтрации в этом списке.
(… рекурсивно …)
startsWith -> (структура)
Данные из базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение которого начинается с value в этом объекте. Этот фильтр в настоящее время поддерживается только для векторных хранилищ Amazon OpenSearch Serverless.
Следующий пример вернёт источники данных с атрибутом animal, начинающимся с ca (например, cat или camel).
"startsWith": { "key": "animal", "value": "ca" }key -> (строка)
value -> (документ)
stringContains -> (структура)
Данные из базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение которого является одним из следующих:
- Строка, содержащая
valueв качестве подстроки. Следующий пример вернёт источники данных с атрибутомanimal, содержащим подстрокуat(например,cat)."stringContains": { "key": "animal", "value": "at" } - Список с элементом, содержащим
valueв качестве подстроки. Следующий пример вернёт источники данных с атрибутомanimals, который является списком, содержащим элемент, содержащий подстрокуat(например,["dog", "cat"])."stringContains": { "key": "animals", "value": "at" }
key -> (строка)
value -> (документ)
startsWith -> (структура)
Данные из базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение которого начинается с value в этом объекте. Этот фильтр в настоящее время поддерживается только для векторных хранилищ Amazon OpenSearch Serverless.
Следующий пример вернёт источники данных с атрибутом animal, начинающимся с ca (например, cat или camel).
"startsWith": { "key": "animal", "value": "ca" }key -> (строка)
value -> (документ)
stringContains -> (структура)
Данные из базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение которого является одним из следующих:
- Строка, содержащая
valueв качестве подстроки. Следующий пример вернёт источники данных с атрибутомanimal, содержащим подстрокуat(например,cat)."stringContains": { "key": "animal", "value": "at" } - Список с элементом, содержащим
valueв качестве подстроки. Следующий пример вернёт источники данных с атрибутомanimals, который является списком, содержащим элемент, содержащий подстрокуat(например,["dog", "cat"])."stringContains": { "key": "animals", "value": "at" }
key -> (строка)
value -> (документ)
implicitFilterConfiguration -> (структура)
Настройки для неявного фильтра.
metadataAttributes -> (список)
Метаданные, которые могут использоваться в фильтре.
(структура)
Подробная информация об атрибуте метаданных.
description -> (строка)
key -> (строка)
type -> (строка)
modelArn -> (строка)
numberOfResults -> (целое число)
overrideSearchType -> (строка)
HYBRID поиска, использующего как векторные вложения, так и обычный текст, или SEMANTIC поиска, использующего только векторные вложения. Для других конфигураций векторного хранилища доступен только SEMANTIC поиск. Для получения дополнительной информации см. Тестирование базы знаний .rerankingConfiguration -> (структура)
Содержит конфигурации для переранжирования полученных результатов. Для получения дополнительной информации см. Улучшение релевантности ответов запросов с помощью модели переранжирования .
bedrockRerankingConfiguration -> (структура)
Содержит конфигурации для модели переранжирования Amazon Bedrock.
metadataConfiguration -> (структура)
Содержит конфигурации для использования метаданных при переранжировании.
selectionMode -> (строка)
SELECTIVE, включите поле selectiveModeConfiguration.selectiveModeConfiguration -> (структура помеченного союза)
Содержит конфигурации для полей метаданных, которые следует включать или исключать при рассмотрении переранжирования.
Примечание
Это структура помеченного союза. Может быть установлено только одно из следующих верхнеуровневых ключей:fieldsToExclude, fieldsToInclude.fieldsToExclude -> (список)
Массив объектов, каждый из которых указывает поле метаданных, которое следует исключить из рассмотрения при переранжировании.
(структура)
Содержит информацию о поле метаданных, которое следует включать или исключать из рассмотрения при переранжировании.
fieldName -> (строка)
fieldsToInclude -> (список)
Массив объектов, каждый из которых указывает поле метаданных, которое следует включить в рассмотрение при переранжировании. Остальные поля метаданных игнорируются.
(структура)
Содержит информацию о поле метаданных, которое следует включать или исключать из рассмотрения при переранжировании.
fieldName -> (строка)
modelConfiguration -> (структура)
Содержит конфигурации для модели переранжирования.
additionalModelRequestFields -> (карта)
Объект JSON, ключи которого являются полями запроса для модели, а значения — значениями для этих полей.
key -> (строка)
value -> (документ)
modelArn -> (строка)
numberOfRerankedResults -> (целое число)
type -> (строка)
type -> (строка)
Тип ресурса, содержащего ваши данные для извлечения информации и генерирования ответов.
Примечание
Если вы выберетеEXTERNAL_SOURCES, то в настоящее время поддерживаются только модели Anthropic Claude 3 Sonnet для баз знаний.Синтаксис JSON:
{
"externalSourcesConfiguration": {
"generationConfiguration": {
"additionalModelRequestFields": {"string": {...}
...},
"guardrailConfiguration": {
"guardrailId": "string",
"guardrailVersion": "string"
},
"inferenceConfig": {
"textInferenceConfig": {
"maxTokens": integer,
"stopSequences": ["string", ...],
"temperature": float,
"topP": float
}
},
"performanceConfig": {
"latency": "standard"|"optimized"
},
"promptTemplate": {
"textPromptTemplate": "string"
}
},
"modelArn": "string",
"sources": [
{
"byteContent": {
"contentType": "string",
"data": blob,
"identifier": "string"
},
"s3Location": {
"uri": "string"
},
"sourceType": "S3"|"BYTE_CONTENT"
}
...
]
},
"knowledgeBaseConfiguration": {
"generationConfiguration": {
"additionalModelRequestFields": {"string": {...}
...},
"guardrailConfiguration": {
"guardrailId": "string",
"guardrailVersion": "string"
},
"inferenceConfig": {
"textInferenceConfig": {
"maxTokens": integer,
"stopSequences": ["string", ...],
"temperature": float,
"topP": float
}
},
"performanceConfig": {
"latency": "standard"|"optimized"
},
"promptTemplate": {
"textPromptTemplate": "string"
}
},
"knowledgeBaseId": "string",
"modelArn": "string",
"orchestrationConfiguration": {
"additionalModelRequestFields": {"string": {...}
...},
"inferenceConfig": {
"textInferenceConfig": {
"maxTokens": integer,
"stopSequences": ["string", ...],
"temperature": float,
"topP": float
}
},
"performanceConfig": {
"latency": "standard"|"optimized"
},
"promptTemplate": {
"textPromptTemplate": "string"
},
"queryTransformationConfiguration": {
"type": "QUERY_DECOMPOSITION"
}
},
"retrievalConfiguration": {
"vectorSearchConfiguration": {
"filter": {
"andAll": [
{
"andAll": [
{ ... recursive ... }
...
],
"equals": {
"key": "string",
"value": {...}
},
"greaterThan": {
"key": "string",
"value": {...}
},
"greaterThanOrEquals": {
"key": "string",
"value": {...}
},
"in": {
"key": "string",
"value": {...}
},
"lessThan": {
"key": "string",
"value": {...}
},
"lessThanOrEquals": {
"key": "string",
"value": {...}
},
"listContains": {
"key": "string",
"value": {...}
},
"notEquals": {
"key": "string",
"value": {...}
},
"notIn": {
"key": "string",
"value": {...}
},
"orAll": [
{ ... recursive ... }
...
],
"startsWith": {
"key": "string",
"value": {...}
},
"stringContains": {
"key": "string",
"value": {...}
}
}
...
],
"equals": {
"key": "string",
"value": {...}
},
"greaterThan": {
"key": "string",
"value": {...}
},
"greaterThanOrEquals": {
"key": "string",
"value": {...}
},
"in": {
"key": "string",
"value": {...}
},
"lessThan": {
"key": "string",
"value": {...}
},
"lessThanOrEquals": {
"key": "string",
"value": {...}
},
"listContains": {
"key": "string",
"value": {...}
},
"notEquals": {
"key": "string",
"value": {...}
},
"notIn": {
"key": "string",
"value": {...}
},
"orAll": [
{
"andAll": [
{ ... recursive ... }
...
],
"equals": {
"key": "string",
"value": {...}
},
"greaterThan": {
"key": "string",
"value": {...}
},
"greaterThanOrEquals": {
"key": "string",
"value": {...}
},
"in": {
"key": "string",
"value": {...}
},
"lessThan": {
"key": "string",
"value": {...}
},
"lessThanOrEquals": {
"key": "string",
"value": {...}
},
"listContains": {
"key": "string",
"value": {...}
},
"notEquals": {
"key": "string",
"value": {...}
},
"notIn": {
"key": "string",
"value": {...}
},
"orAll": [
{ ... recursive ... }
...
],
"startsWith": {
"key": "string",
"value": {...}
},
"stringContains": {
"key": "string",
"value": {...}
}
}
...
],
"startsWith": {
"key": "string",
"value": {...}
},
"stringContains": {
"key": "string",
"value": {...}
}
},
"implicitFilterConfiguration": {
"metadataAttributes": [
{
"description": "string",
"key": "string",
"type": "STRING"|"NUMBER"|"BOOLEAN"|"STRING_LIST"
}
...
],
"modelArn": "string"
},
"numberOfResults": integer,
"overrideSearchType": "HYBRID"|"SEMANTIC",
"rerankingConfiguration": {
"bedrockRerankingConfiguration": {
"metadataConfiguration": {
"selectionMode": "SELECTIVE"|"ALL",
"selectiveModeConfiguration": {
"fieldsToExclude": [
{
"fieldName": "string"
}
...
],
"fieldsToInclude": [
{
"fieldName": "string"
}
...
]
}
},
"modelConfiguration": {
"additionalModelRequestFields": {"string": {...}
...},
"modelArn": "string"
},
"numberOfRerankedResults": integer
},
"type": "BEDROCK_RERANKING_MODEL"
}
}
}
},
"type": "KNOWLEDGE_BASE"|"EXTERNAL_SOURCES"
}
--session-configuration (структура)
Содержит сведения о сеансе с базой знаний.
kmsKeyArn -> (строка)
Сокращенный синтаксис:
kmsKeyArn=string
Синтаксис JSON:
{
"kmsKeyArn": "string"
}
--session-id (строка)
RetrieveAndGenerate Amazon Bedrock автоматически генерирует это значение. Вы должны повторно использовать это значение для всех последующих запросов в том же сеансе разговора. Это значение позволяет Amazon Bedrock сохранять контекст и знания из предыдущих взаимодействий. Вы не можете явно установить sessionId самостоятельно.--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.
Вывод
citations -> (список)
Список фрагментов сгенерированного ответа, основанных на источниках из базы знаний, вместе с информацией об источниках.
(структура)
Объект, содержащий фрагмент сгенерированного ответа, основанный на источнике из базы знаний, вместе с информацией об источнике.
Этот тип данных используется в следующих операциях API:
- Ответ InvokeAgent – в поле
citations - Ответ RetrieveAndGenerate – в поле
citations
generatedResponsePart -> (структура)
Содержит сгенерированный ответ и метаданные
textResponsePart -> (структура)
Содержит метаданные о текстовой части сгенерированного ответа, сопровождаемой ссылкой.
span -> (структура)
Содержит информацию о том, где текст со ссылкой начинается и заканчивается в сгенерированном выводе.
end -> (целое число)
start -> (целое число)
text -> (строка)
retrievedReferences -> (список)
Содержит метаданные об источниках, использованных для сгенерированного ответа.
(структура)
Содержит метаданные об источнике, использованном для сгенерированного ответа.
Этот тип данных используется в следующих операциях API:
- Ответ RetrieveAndGenerate – в поле
retrievedReferences - Ответ InvokeAgent – в поле
retrievedReferences
content -> (структура)
Содержит цитируемый текст из источника данных.
byteContent -> (строка)
data:image/jpeg;base64,${base64-encoded string} .row -> (список)
Указывает информацию о строках с ячейками для возврата в результате извлечения.
(структура)
Содержит информацию об столбце с ячейкой для возврата в результате извлечения.
columnName -> (строка)
columnValue -> (строка)
type -> (строка)
text -> (строка)
type -> (строка)
location -> (структура)
Содержит информацию о местоположении источника данных.
confluenceLocation -> (структура)
Местоположение источника данных Confluence.
url -> (строка)
customDocumentLocation -> (структура)
Указывает местоположение документа в пользовательском источнике данных.
id -> (строка)
kendraDocumentLocation -> (структура)
Местоположение документа в Amazon Kendra.
uri -> (строка)
s3Location -> (структура)
Местоположение источника данных S3.
uri -> (строка)
salesforceLocation -> (структура)
Местоположение источника данных Salesforce.
url -> (строка)
sharePointLocation -> (структура)
Местоположение источника данных SharePoint.
url -> (строка)
sqlLocation -> (структура)
Указывает информацию об SQL запросе, использованном для получения результата.
query -> (строка)
type -> (строка)
webLocation -> (структура)
Местоположение источника данных — URL веб-страницы(страниц).
url -> (строка)
metadata -> (карта)
Содержит атрибуты метаданных и их значения для файла в источнике данных. Дополнительную информацию см. в разделе Метаданные и фильтрация.
key -> (строка)
value -> (документ)
guardrailAction -> (строка)
output -> (структура)
Содержит ответ, сгенерированный в результате запроса к базе знаний.
text -> (строка)
sessionId -> (строка)
RetrieveAndGenerate Amazon Bedrock автоматически генерирует это значение. Вы должны повторно использовать это значение для всех последующих запросов в той же сессии разговора. Это значение позволяет Amazon Bedrock сохранять контекст и знания из предыдущих взаимодействий. Вы не можете явно установить sessionId самостоятельно.
© Copyright 2025, Amazon Web Services. Created using Sphinx.