create-evaluation-job
Описание
Создаёт задание оценки.
См. также: Документацию API AWS
create-evaluation-job использует значения типа документа. Типы документов следуют модели данных JSON, где допустимыми значениями являются: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команд, параметров и вложенных параметров, помеченных типом document, необходимо указать JSON. Краткая запись не поддерживает типы документов.
Синтаксис
create-evaluation-job
--job-name <value>
[--job-description <value>]
[--client-request-token <value>]
--role-arn <value>
[--customer-encryption-key-id <value>]
[--job-tags <value>]
[--application-type <value>]
--evaluation-config <value>
--inference-config <value>
--output-data-config <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]
Параметры
--job-name (строка)
--job-description (строка)
--client-request-token (строка)
--role-arn (строка)
--customer-encryption-key-id (строка)
--job-tags (список)
Теги, которые необходимо прикрепить к заданию оценки модели.
(структура)
Определение пары ключ/значение для тега.
key -> (строка)
value -> (строка)
Краткая запись:
key=string,value=string ...
Синтаксис JSON:
[
{
"key": "string",
"value": "string"
}
...
]
--application-type (строка)
Указывает, предназначено ли задание оценки для оценки модели или оценки базы знаний (извлечения и генерации ответов).
Возможные значения:
ModelEvaluationRagEvaluation
--evaluation-config (структура помеченных объединений)
Содержит данные конфигурации задания оценки, автоматизированного или выполняемого человеком.
Примечание
Это структура помеченных союзов. Можно задать только один из следующих ключей верхнего уровня:automated, human.automated -> (структура)
Содержит данные конфигурации задания автоматической оценки, вычисляющего метрики.
datasetMetricConfigs -> (список)
Данные конфигурации наборов данных с запросами и метрик, которые вы хотите использовать для задания оценки.
(структура)
Определяет наборы данных с запросами, встроенные имена метрик и имена пользовательских метрик, а также тип задачи.
taskType -> (строка)
dataset -> (структура)
Указывает набор данных с запросами.
name -> (строка)
Builtin.Bold , Builtin.BoolQ , Builtin.NaturalQuestions , Builtin.Gigaword , Builtin.RealToxicityPrompts , Builtin.TriviaQA , Builtin.T-Rex , Builtin.WomensEcommerceClothingReviews и Builtin.Wikitext2 .datasetLocation -> (структура помеченных союзов)
Для пользовательских наборов данных с запросами необходимо указать расположение в Amazon S3, где сохранён набор данных.
Примечание
Это структура помеченных союзов. Можно задать только один из следующих ключей верхнего уровня:s3Uri.s3Uri -> (строка)
metricNames -> (список)
Имена метрик, которые вы хотите использовать для задания оценки.
Для заданий оценки знаний, оценивающих только поиск, допустимыми значениями являются “Builtin.ContextRelevance “, “Builtin.ContextCoverage “.
Для заданий оценки знаний, оценивающих поиск с генерацией ответа, допустимыми значениями являются “Builtin.Correctness “, “Builtin.Completeness “, “Builtin.Helpfulness “, “Builtin.LogicalCoherence “, “Builtin.Faithfulness “, “Builtin.Harmfulness “, “Builtin.Stereotyping “, “Builtin.Refusal “.
Для автоматизированных заданий оценки моделей допустимыми значениями являются “Builtin.Accuracy “, “Builtin.Robustness “, и “Builtin.Toxicity “. В заданиях оценки моделей, использующих LLM в качестве судьи, можно указать “Builtin.Correctness “, “Builtin.Completeness" , “Builtin.Faithfulness" , “Builtin.Helpfulness “, “Builtin.Coherence “, “Builtin.Relevance “, “Builtin.FollowingInstructions “, “Builtin.ProfessionalStyleAndTone “. Также можно указать следующие метрики, связанные с ответственной ИИ, только для заданий оценки моделей, использующих LLM в качестве судьи “Builtin.Harmfulness “, “Builtin.Stereotyping “, и “Builtin.Refusal “.
Для заданий оценки моделей, выполняемых вручную, список строк должен соответствовать параметру name, указанному в HumanEvaluationCustomMetric.
(строка)
evaluatorModelConfig -> (структура помеченных союзов)
Содержит данные конфигурации модели оценщика. EvaluatorModelConfig требуется для заданий оценки, использующих базу знаний, или в задании оценки модели, использующем модель в качестве судьи. Эта модель вычисляет все метрики, относящиеся к оценке.
Примечание
Это структура помеченных союзов. Можно задать только один из следующих ключей верхнего уровня:bedrockEvaluatorModels.bedrockEvaluatorModels -> (список)
Модель оценщика, используемая в задании оценки базы знаний или в задании оценки модели, использующем модель в качестве судьи. Эта модель вычисляет все метрики, относящиеся к оценке.
(структура)
Модель оценщика, используемая в задании оценки базы знаний или в задании оценки модели, использующем модель в качестве судьи. Эта модель вычисляет все метрики, относящиеся к оценке.
modelIdentifier -> (строка)
customMetricConfig -> (структура)
Определяет конфигурацию пользовательских метрик, которые будут использоваться в задании оценки.
customMetrics -> (список)
Определяет список пользовательских метрик, которые будут использоваться в задании оценки Amazon Bedrock.
(структура помеченных союзов)
Элемент массива, определяющий отдельную пользовательскую метрику для использования в задании оценки Amazon Bedrock.
Примечание
Это структура помеченных союзов. Можно задать только один из следующих ключей верхнего уровня:customMetricDefinition.customMetricDefinition -> (структура)
Определение пользовательской метрики для использования в задании оценки Amazon Bedrock.
name -> (строка)
instructions -> (строка)
ratingScale -> (список)
Определяет шкалу оценок, которая будет использоваться для пользовательской метрики. Рекомендуется всегда определять шкалу оценок при создании пользовательской метрики. Если вы не определите шкалу, Amazon Bedrock не сможет отобразить результаты оценки в консоли или рассчитать средние значения числовых оценок. Дополнительные сведения об указании шкалы оценок см. в разделе Определение схемы вывода (шкала оценок).
(структура)
Определяет значение и соответствующее определение для одного рейтинга в шкале оценок пользовательской метрики.
definition -> (строка)
value -> (структура помеченных союзов)
Определяет значение для одного рейтинга в шкале оценок пользовательской метрики.
Примечание
Это структура помеченных союзов. Можно задать только один из следующих ключей верхнего уровня:stringValue, floatValue.stringValue -> (строка)
floatValue -> (вещественное число)
evaluatorModelConfig -> (структура)
Конфигурация модели оценщика, которую вы хотите использовать для оценки пользовательских метрик в задании оценки Amazon Bedrock.
bedrockEvaluatorModels -> (список)
Определяет модель, которую вы хотите использовать для оценки пользовательских метрик в задании оценки Amazon Bedrock.
(структура)
Определяет модель, которую вы хотите использовать для оценки пользовательских метрик в задании оценки Amazon Bedrock.
modelIdentifier -> (строка)
human -> (структура)
Содержит данные конфигурации задания оценки, выполняемого людьми.
humanWorkflowConfig -> (структура)
Параметры человеческого рабочего процесса.
flowDefinitionArn -> (строка)
instructions -> (строка)
customMetrics -> (список)
Объект HumanEvaluationCustomMetric. Он содержит имена метрик, способ их оценки и необязательное описание.
(структура)
В задании оценки моделей, выполняемом вручную, необходимо определить имя метрики, способ её оценки ratingMethod и необязательное описание метрики.
name -> (строка)
description -> (строка)
ratingMethod -> (строка)
ThumbsUpDown , IndividualLikertScale ,``ComparisonLikertScale`` , ComparisonChoice и ComparisonRank.datasetMetricConfigs -> (список)
Используйте для указания метрик, задач и наборов данных с запросами, которые будут использоваться в задании оценки модели.
(структура)
Определяет наборы данных с запросами, встроенные имена метрик и имена пользовательских метрик, а также тип задачи.
taskType -> (строка)
dataset -> (структура)
Указывает набор данных с запросами.
name -> (строка)
Builtin.Bold , Builtin.BoolQ , Builtin.NaturalQuestions , Builtin.Gigaword , Builtin.RealToxicityPrompts , Builtin.TriviaQA , Builtin.T-Rex , Builtin.WomensEcommerceClothingReviews и Builtin.Wikitext2 .datasetLocation -> (структура помеченных союзов)
Для пользовательских наборов данных с запросами необходимо указать расположение в Amazon S3, где сохранён набор данных.
Примечание
Это структура помеченных союзов. Можно задать только один из следующих ключей верхнего уровня:s3Uri.s3Uri -> (строка)
metricNames -> (список)
Имена метрик, которые вы хотите использовать для задания оценки.
Для заданий оценки знаний, оценивающих только поиск, допустимыми значениями являются “Builtin.ContextRelevance “, “Builtin.ContextCoverage “.
Для заданий оценки знаний, оценивающих поиск с генерацией ответа, допустимыми значениями являются “Builtin.Correctness “, “Builtin.Completeness “, “Builtin.Helpfulness “, “Builtin.LogicalCoherence “, “Builtin.Faithfulness “, “Builtin.Harmfulness “, “Builtin.Stereotyping “, “Builtin.Refusal “.
Для автоматизированных заданий оценки моделей допустимыми значениями являются “Builtin.Accuracy “, “Builtin.Robustness “, и “Builtin.Toxicity “. В заданиях оценки моделей, использующих LLM в качестве судьи, можно указать “Builtin.Correctness “, “Builtin.Completeness" , “Builtin.Faithfulness" , “Builtin.Helpfulness “, “Builtin.Coherence “, “Builtin.Relevance “, “Builtin.FollowingInstructions “, “Builtin.ProfessionalStyleAndTone “. Также можно указать следующие метрики, связанные с ответственной ИИ, только для заданий оценки моделей, использующих LLM в качестве судьи “Builtin.Harmfulness “, “Builtin.Stereotyping “, и “Builtin.Refusal “.
Для заданий оценки моделей, выполняемых вручную, список строк должен соответствовать параметру name, указанному в HumanEvaluationCustomMetric.
(строка)
Синтаксис JSON:
{
"automated": {
"datasetMetricConfigs": [
{
"taskType": "Summarization"|"Classification"|"QuestionAndAnswer"|"Generation"|"Custom",
"dataset": {
"name": "string",
"datasetLocation": {
"s3Uri": "string"
}
},
"metricNames": ["string", ...]
}
...
],
"evaluatorModelConfig": {
"bedrockEvaluatorModels": [
{
"modelIdentifier": "string"
}
...
]
},
"customMetricConfig": {
"customMetrics": [
{
"customMetricDefinition": {
"name": "string",
"instructions": "string",
"ratingScale": [
{
"definition": "string",
"value": {
"stringValue": "string",
"floatValue": float
}
}
...
]
}
}
...
],
"evaluatorModelConfig": {
"bedrockEvaluatorModels": [
{
"modelIdentifier": "string"
}
...
]
}
}
},
"human": {
"humanWorkflowConfig": {
"flowDefinitionArn": "string",
"instructions": "string"
},
"customMetrics": [
{
"name": "string",
"description": "string",
"ratingMethod": "string"
}
...
],
"datasetMetricConfigs": [
{
"taskType": "Summarization"|"Classification"|"QuestionAndAnswer"|"Generation"|"Custom",
"dataset": {
"name": "string",
"datasetLocation": {
"s3Uri": "string"
}
},
"metricNames": ["string", ...]
}
...
]
}
}
--inference-config (структура помеченных союзов)
Содержит сведения о конфигурации модели вывода для задания оценки.
Для заданий оценки модели автоматизированные задания поддерживают одну модель или профиль вывода, а задания, использующие рабочих-людей, поддерживают две модели или профиля вывода.
Примечание
Это структура Tagged Union. Может быть установлен только один из следующих ключей верхнего уровня:models, ragConfigs.models -> (list)
Указывает модели вывода.
(структура tagged union)
Определяет модели, используемые в задании оценки модели.
Примечание
Это структура Tagged Union. Может быть установлен только один из следующих ключей верхнего уровня:bedrockModel, precomputedInferenceSource.bedrockModel -> (structure)
Определяет модель Amazon Bedrock или профиль вывода и параметры вывода, которые вы хотите использовать.
modelIdentifier -> (string)
inferenceParams -> (string)
performanceConfig -> (structure)
Указывает параметры производительности для модели или профиля вывода.
latency -> (string)
precomputedInferenceSource -> (structure)
Определяет модель, используемую для создания данных ответа вывода для задания оценки модели, в котором вы предоставляете собственные данные ответа вывода.
inferenceSourceIdentifier -> (string)
ragConfigs -> (list)
Содержит сведения о конфигурации вывода для задания оценки базы знаний, включая либо конфигурацию только извлечения, либо конфигурацию извлечения с формированием ответа.
(структура tagged union)
Содержит сведения о конфигурации для извлечения информации и формирования ответа.
Примечание
Это структура Tagged Union. Может быть установлен только один из следующих ключей верхнего уровня:knowledgeBaseConfig, precomputedRagSourceConfig.knowledgeBaseConfig -> (tagged union structure)
Содержит сведения о конфигурации для извлечения и формирования ответов базы знаний.
Примечание
Это структура Tagged Union. Может быть установлен только один из следующих ключей верхнего уровня:retrieveConfig, retrieveAndGenerateConfig.retrieveConfig -> (structure)
Содержит сведения о конфигурации для извлечения информации из базы знаний.
knowledgeBaseId -> (string)
knowledgeBaseRetrievalConfiguration -> (structure)
Содержит сведения о конфигурации для извлечения из базы знаний.
vectorSearchConfiguration -> (structure)
Содержит сведения о конфигурации для возврата результатов векторного поиска.
numberOfResults -> (integer)
overrideSearchType -> (string)
HYBRID поиска, используя как векторные вложения, так и необработанный текст, или SEMANTIC поиска, используя только векторные вложения. Для других конфигураций векторного хранилища доступен только SEMANTIC поиск.filter -> (tagged union structure)
Указывает фильтры, которые следует использовать для полей метаданных в источниках данных базы знаний перед возвратом результатов.
Примечание
Это структура Tagged Union. Может быть установлен только один из следующих ключей верхнего уровня:equals, notEquals, greaterThan, greaterThanOrEquals, lessThan, lessThanOrEquals, in, notIn, startsWith, listContains, stringContains, andAll, orAll.equals -> (structure)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение соответствует значению в этом объекте.
В следующем примере будут возвращены источники данных с атрибутом animal, значение которого равно «cat»: "equals": { "key": "animal", "value": "cat" }
key -> (string)
value -> (document)
notEquals -> (structure)
Возвращаются источники данных базы знаний, которые содержат атрибут метаданных, имя которого соответствует ключу, а значение не соответствует значению в этом объекте.
В следующем примере будут возвращены источники данных, которые не содержат атрибут animal, значение которого равно «cat»: "notEquals": { "key": "animal", "value": "cat" }
key -> (string)
value -> (document)
greaterThan -> (structure)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение больше значения в этом объекте.
В следующем примере будут возвращены источники данных с атрибутом year, значение которого больше «1989»: "greaterThan": { "key": "year", "value": 1989 }
key -> (string)
value -> (document)
greaterThanOrEquals -> (structure)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение больше или равно значению в этом объекте.
В следующем примере будут возвращены источники данных с атрибутом year, значение которого больше или равно «1989»: "greaterThanOrEquals": { "key": "year", "value": 1989 }
key -> (string)
value -> (document)
lessThan -> (structure)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение меньше значения в этом объекте.
В следующем примере будут возвращены источники данных с атрибутом year, значение которого меньше «1989»: "lessThan": { "key": "year", "value": 1989 }
key -> (string)
value -> (document)
lessThanOrEquals -> (structure)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение меньше или равно значению в этом объекте.
В следующем примере будут возвращены источники данных с атрибутом year, значение которого меньше или равно «1989»: "lessThanOrEquals": { "key": "year", "value": 1989 }
key -> (string)
value -> (document)
in -> (structure)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а его значение находится в списке, указанном в значении этого объекта.
В следующем примере будут возвращены источники данных с атрибутом animal, который равен «cat» или «dog»: "in": { "key": "animal", "value": ["cat", "dog"] }
key -> (string)
value -> (document)
notIn -> (structure)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а его значение отсутствует в списке, указанном в значении этого объекта.
В следующем примере будут возвращены источники данных, атрибут animal которых не равен ни «cat», ни «dog»: "notIn": { "key": "animal", "value": ["cat", "dog"] }
key -> (string)
value -> (document)
startsWith -> (structure)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а его значение начинается со значения в этом объекте. В настоящее время этот фильтр поддерживается только для векторных хранилищ Amazon OpenSearch Serverless.
В следующем примере будут возвращены источники данных с атрибутом animal, начинающимся с «ca» (например, «cat» или «camel»). "startsWith": { "key": "animal", "value": "ca" }
key -> (string)
value -> (document)
listContains -> (structure)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а его значение является списком, содержащим значение в качестве одного из его членов.
В следующем примере будут возвращены источники данных с атрибутом animals, который представляет собой список, содержащий элемент cat (например, ["dog", "cat"]): "listContains": { "key": "animals", "value": "cat" }
key -> (string)
value -> (document)
stringContains -> (structure)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а его значение является одним из следующих:
Строка, содержащая значение в качестве подстроки. В следующем примере будут возвращены источники данных с атрибутом animal, содержащим подстроку at (например, «cat»): "stringContains": { "key": "animal", "value": "at" }
Список с элементом, содержащим значение в качестве подстроки. В следующем примере будут возвращены источники данных с атрибутом animals, который представляет собой список, содержащий элемент, содержащий подстроку at (например, ["dog", "cat"]): "stringContains": { "key": "animals", "value": "at" }
key -> (string)
value -> (document)
andAll -> (list)
Данные из базы знаний возвращаются, если атрибуты метаданных удовлетворяют всем условиям фильтрации в этом списке.
(Структура помеченных объединений)
Указывает фильтры, которые следует использовать для атрибутов/полей метаданных в источниках данных базы знаний перед возвратом результатов.
Примечание
Это структура помеченных объединений. Только один из следующих ключей верхнего уровня может быть задан:equals, notEquals, greaterThan, greaterThanOrEquals, lessThan, lessThanOrEquals, in, notIn, startsWith, listContains, stringContains, andAll, orAll.equals -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с ключом, а значение которого совпадает со значением в этом объекте.
Следующий пример вернет источники данных со значением атрибута «animal» равным ‘cat’: "equals": { "key": "animal", "value": "cat" }
key -> (строка)
value -> (документ)
notEquals -> (структура)
Возвращаются источники данных базы знаний, содержащие атрибут метаданных, имя которого соответствует ключу, а значение которого не соответствует значению в этом объекте.
Следующий пример вернет источники данных, не содержащие атрибут «animal» со значением ‘cat’: "notEquals": { "key": "animal", "value": "cat" }
key -> (строка)
value -> (документ)
greaterThan -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого больше значения в этом объекте.
Следующий пример вернет источники данных с атрибутом «year» со значением больше ‘1989’: "greaterThan": { "key": "year", "value": 1989 }
key -> (строка)
value -> (документ)
greaterThanOrEquals -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого больше или равно значению в этом объекте.
Следующий пример вернет источники данных с атрибутом «year» со значением больше или равным ‘1989’: "greaterThanOrEquals": { "key": "year", "value": 1989 }
key -> (строка)
value -> (документ)
lessThan -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого меньше значения в этом объекте.
Следующий пример вернет источники данных с атрибутом «year» со значением меньше ‘1989’: "lessThan": { "key": "year", "value": 1989 }
key -> (строка)
value -> (документ)
lessThanOrEquals -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого меньше или равно значению в этом объекте.
Следующий пример вернет источники данных с атрибутом «year» со значением меньше или равным ‘1989’: "lessThanOrEquals": { "key": "year", "value": 1989 }
key -> (строка)
value -> (документ)
in -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого содержится в списке, указанном в значении этого объекта.
Следующий пример вернет источники данных с атрибутом «animal», значение которого равно ‘cat’ или ‘dog’: "in": { "key": "animal", "value": ["cat", "dog"] }
key -> (строка)
value -> (документ)
notIn -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого не содержится в списке, указанном в значении этого объекта.
Следующий пример вернет источники данных, у которых атрибут «animal» не равен ‘cat’ и не равен ‘dog’: "notIn": { "key": "animal", "value": ["cat", "dog"] }
key -> (строка)
value -> (документ)
startsWith -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого начинается со значения в этом объекте. Этот фильтр в настоящее время поддерживается только для векторных хранилищ Amazon OpenSearch Serverless.
Следующий пример вернет источники данных с атрибутом «animal», начинающимся с ‘ca’ (например, ‘cat’ или ‘camel’). "startsWith": { "key": "animal", "value": "ca" }
key -> (строка)
value -> (документ)
listContains -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого является списком, содержащим значение в качестве одного из своих элементов.
Следующий пример вернет источники данных с атрибутом «animals», который является списком, содержащим элемент «cat» (например, ["dog", "cat"] ): "listContains": { "key": "animals", "value": "cat" }
key -> (строка)
value -> (документ)
stringContains -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого является одним из следующих:
Строка, содержащая значение в качестве подстроки. Следующий пример вернет источники данных с атрибутом «animal», содержащим подстроку ‘at’ (например, ‘cat’): "stringContains": { "key": "animal", "value": "at" }
Список с элементом, содержащим значение в качестве подстроки. Следующий пример вернет источники данных с атрибутом «animals», который является списком, содержащим элемент, содержащий подстроку ‘at’ (например, ["dog", "cat"] ): "stringContains": { "key": "animals", "value": "at" }
key -> (строка)
value -> (документ)
andAll -> (список)
Источники данных базы знаний возвращаются, если их атрибуты метаданных удовлетворяют всем условиям фильтрации в этом списке.
(… рекурсивно …)
orAll -> (список)
Источники данных базы знаний возвращаются, если их атрибуты метаданных удовлетворяют хотя бы одному из условий фильтрации в этом списке.
(… рекурсивно …)
orAll -> (список)
Данные источников базы знаний возвращаются, если атрибуты метаданных удовлетворяют хотя бы одному из условий фильтрации в этом списке.
(структура помеченного объединения)
Определяет фильтры, которые будут применяться к атрибутам/полям метаданных в источниках данных базы знаний перед возвратом результатов.
Примечание
Это структура помеченного объединения. Может быть задан только один из следующих ключей верхнего уровня:equals, notEquals, greaterThan, greaterThanOrEquals, lessThan, lessThanOrEquals, in, notIn, startsWith, listContains, stringContains, andAll, orAll.equals -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с ключом, а значение которого совпадает со значением в этом объекте.
Следующий пример вернёт источники данных со значением атрибута «animal» равным ‘cat’: "equals": { "key": "animal", "value": "cat" }
key -> (строка)
value -> (документ)
notEquals -> (структура)
Возвращаются источники данных базы знаний, содержащие атрибут метаданных, имя которого совпадает с ключом, а значение которого не совпадает со значением в этом объекте.
Следующий пример вернёт источники данных, не содержащие атрибут «animal» со значением ‘cat’: "notEquals": { "key": "animal", "value": "cat" }
key -> (строка)
value -> (документ)
greaterThan -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с ключом, а значение которого больше значения в этом объекте.
Следующий пример вернёт источники данных со значением атрибута «year» большим, чем ‘1989’: "greaterThan": { "key": "year", "value": 1989 }
key -> (строка)
value -> (документ)
greaterThanOrEquals -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с ключом, а значение которого больше или равно значению в этом объекте.
Следующий пример вернёт источники данных со значением атрибута «year» большим или равным ‘1989’: "greaterThanOrEquals": { "key": "year", "value": 1989 }
key -> (строка)
value -> (документ)
lessThan -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с ключом, а значение которого меньше значения в этом объекте.
Следующий пример вернёт источники данных со значением атрибута «year» меньшим, чем ‘1989’: "lessThan": { "key": "year", "value": 1989 }
key -> (строка)
value -> (документ)
lessThanOrEquals -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с ключом, а значение которого меньше или равно значению в этом объекте.
Следующий пример вернёт источники данных со значением атрибута «year» меньшим или равным ‘1989’: "lessThanOrEquals": { "key": "year", "value": 1989 }
key -> (строка)
value -> (документ)
in -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с ключом, а значение которого содержится в списке, указанном в значении этого объекта.
Следующий пример вернёт источники данных со значением атрибута «animal», равным ‘cat’ или ‘dog’: "in": { "key": "animal", "value": ["cat", "dog"] }
key -> (строка)
value -> (документ)
notIn -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с ключом, а значение которого не содержится в списке, указанном в значении этого объекта.
Следующий пример вернёт источники данных, где атрибут «animal» не равен ‘cat’ и не равен ‘dog’: "notIn": { "key": "animal", "value": ["cat", "dog"] }
key -> (строка)
value -> (документ)
startsWith -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с ключом, а значение которого начинается со значения в этом объекте. Этот фильтр в настоящее время поддерживается только для векторных хранилищ Amazon OpenSearch Serverless.
Следующий пример вернёт источники данных со значением атрибута «animal», начинающимся с ‘ca’ (например, ‘cat’ или ‘camel’). "startsWith": { "key": "animal", "value": "ca" }
key -> (строка)
value -> (документ)
listContains -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с ключом, а значение которого является списком, содержащим значение в качестве одного из его элементов.
Следующий пример вернёт источники данных со значением атрибута «animals», которое является списком, содержащим элемент «cat» (например, ["dog", "cat"] ): "listContains": { "key": "animals", "value": "cat" }
key -> (строка)
value -> (документ)
stringContains -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с ключом, а значение которого является одним из следующих:
Строка, содержащая значение в качестве подстроки. Следующий пример вернёт источники данных со значением атрибута «animal», содержащим подстроку «at» (например, ‘cat’): "stringContains": { "key": "animal", "value": "at" }
Список с элементом, содержащим значение в качестве подстроки. Следующий пример вернёт источники данных со значением атрибута «animals», которое является списком, содержащим элемент, содержащий подстроку «at» (например, ["dog", "cat"] ): "stringContains": { "key": "animals", "value": "at" }
key -> (строка)
value -> (документ)
andAll -> (список)
Источники данных базы знаний возвращаются, если их атрибуты метаданных удовлетворяют всем условиям фильтрации в этом списке.
(… рекурсивно …)
orAll -> (список)
Источники данных базы знаний возвращаются, если их атрибуты метаданных удовлетворяют хотя бы одному из условий фильтрации в этом списке.
(… рекурсивно …)
retrieveAndGenerateConfig -> (структура)
Содержит сведения о конфигурации для извлечения информации из базы знаний и создания ответов.
type -> (string)
Тип ресурса, содержащего ваши данные для извлечения информации и создания ответов.
If you choose to use EXTERNAL_SOURCES , then currently only Claude 3 Sonnet models for knowledge bases are supported.
knowledgeBaseConfiguration -> (structure)
Содержит сведения о конфигурации для извлечения из базы знаний и генерации ответов.
knowledgeBaseId -> (string)
modelArn -> (string)
retrievalConfiguration -> (structure)
Содержит сведения о конфигурации для извлечения фрагментов текста.
vectorSearchConfiguration -> (structure)
Содержит сведения о конфигурации для возврата результатов векторного поиска.
numberOfResults -> (integer)
overrideSearchType -> (string)
HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available.filter -> (tagged union structure)
Указывает фильтры для использования в полях метаданных в источниках данных базы знаний перед возвращением результатов.
Примечание
This is a Tagged Union structure. Only one of the following top level keys can be set:equals, notEquals, greaterThan, greaterThanOrEquals, lessThan, lessThanOrEquals, in, notIn, startsWith, listContains, stringContains, andAll, orAll.equals -> (structure)
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.
The following example would return data sources with an animal attribute whose value is ‘cat’: "equals": { "key": "animal", "value": "cat" }
key -> (string)
value -> (document)
notEquals -> (structure)
Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn’t match the value in this object are returned.
The following example would return data sources that don’t contain an animal attribute whose value is ‘cat’: "notEquals": { "key": "animal", "value": "cat" }
key -> (string)
value -> (document)
greaterThan -> (structure)
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.
The following example would return data sources with an year attribute whose value is greater than ‘1989’: "greaterThan": { "key": "year", "value": 1989 }
key -> (string)
value -> (document)
greaterThanOrEquals -> (structure)
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is greater than or equal to ‘1989’: "greaterThanOrEquals": { "key": "year", "value": 1989 }
key -> (string)
value -> (document)
lessThan -> (structure)
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.
The following example would return data sources with an year attribute whose value is less than to ‘1989’: "lessThan": { "key": "year", "value": 1989 }
key -> (string)
value -> (document)
lessThanOrEquals -> (structure)
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is less than or equal to ‘1989’: "lessThanOrEquals": { "key": "year", "value": 1989 }
key -> (string)
value -> (document)
in -> (structure)
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.
The following example would return data sources with an animal attribute that is either ‘cat’ or ‘dog’: "in": { "key": "animal", "value": ["cat", "dog"] }
key -> (string)
value -> (document)
notIn -> (structure)
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn’t in the list specified in the value in this object.
The following example would return data sources whose animal attribute is neither ‘cat’ nor ‘dog’: "notIn": { "key": "animal", "value": ["cat", "dog"] }
key -> (string)
value -> (document)
startsWith -> (structure)
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
The following example would return data sources with an animal attribute starts with ‘ca’ (for example, ‘cat’ or ‘camel’). "startsWith": { "key": "animal", "value": "ca" }
key -> (string)
value -> (document)
listContains -> (structure)
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.
The following example would return data sources with an animals attribute that is a list containing a cat member (for example, ["dog", "cat"] ): "listContains": { "key": "animals", "value": "cat" }
key -> (string)
value -> (document)
stringContains -> (structure)
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:
A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example, ‘cat’): "stringContains": { "key": "animal", "value": "at" }
A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example, ["dog", "cat"] ): "stringContains": { "key": "animals", "value": "at" }
key -> (string)
value -> (document)
andAll -> (list)
Данные источников базы знаний возвращаются, если атрибуты их метаданных удовлетворяют всем условиям фильтрации в этом списке.
(структура помеченного объединения)
Указывает фильтры, которые следует использовать для атрибутов/полей метаданных в источниках данных базы знаний перед возвратом результатов.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:equals, notEquals, greaterThan, greaterThanOrEquals, lessThan, lessThanOrEquals, in, notIn, startsWith, listContains, stringContains, andAll, orAll.equals -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого соответствует значению в этом объекте.
Следующий пример вернёт источники данных со свойством animal, значение которого равно ‘cat’: "equals": { "key": "animal", "value": "cat" }
key -> (строка)
value -> (документ)
notEquals -> (структура)
Возвращаются источники данных базы знаний, которые содержат атрибут метаданных, имя которого соответствует ключу, а значение которого не соответствует значению в этом объекте.
Следующий пример вернёт источники данных, не содержащие атрибут animal со значением ‘cat’: "notEquals": { "key": "animal", "value": "cat" }
key -> (строка)
value -> (документ)
greaterThan -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого больше значения в этом объекте.
Следующий пример вернёт источники данных с атрибутом year, значение которого больше ‘1989’: "greaterThan": { "key": "year", "value": 1989 }
key -> (строка)
value -> (документ)
greaterThanOrEquals -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого больше или равно значению в этом объекте.
Следующий пример вернёт источники данных с атрибутом year, значение которого больше или равно ‘1989’: "greaterThanOrEquals": { "key": "year", "value": 1989 }
key -> (строка)
value -> (документ)
lessThan -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого меньше значения в этом объекте.
Следующий пример вернёт источники данных с атрибутом year, значение которого меньше ‘1989’: "lessThan": { "key": "year", "value": 1989 }
key -> (строка)
value -> (документ)
lessThanOrEquals -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого меньше или равно значению в этом объекте.
Следующий пример вернёт источники данных с атрибутом year, значение которого меньше или равно ‘1989’: "lessThanOrEquals": { "key": "year", "value": 1989 }
key -> (строка)
value -> (документ)
in -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого содержится в списке, указанном в значении в этом объекте.
Следующий пример вернёт источники данных с атрибутом animal, значением ‘cat’ или ‘dog’: "in": { "key": "animal", "value": ["cat", "dog"] }
key -> (строка)
value -> (документ)
notIn -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого не содержится в списке, указанном в значении в этом объекте.
Следующий пример вернёт источники данных, атрибут animal которых не равен ‘cat’ и не равен ‘dog’: "notIn": { "key": "animal", "value": ["cat", "dog"] }
key -> (строка)
value -> (документ)
startsWith -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого начинается со значения в этом объекте. Этот фильтр в настоящее время поддерживается только для векторных хранилищ Amazon OpenSearch Serverless.
Следующий пример вернёт источники данных с атрибутом animal, начинающимся с ‘ca’ (например, ‘cat’ или ‘camel’). "startsWith": { "key": "animal", "value": "ca" }
key -> (строка)
value -> (документ)
listContains -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого является списком, содержащим значение в качестве одного из своих элементов.
Следующий пример вернёт источники данных с атрибутом animals, являющимся списком, содержащим элемент «cat» (например, ["dog", "cat"] ): "listContains": { "key": "animals", "value": "cat" }
key -> (строка)
value -> (документ)
stringContains -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого является одним из следующих:
Строка, содержащая значение в качестве подстроки. Следующий пример вернёт источники данных с атрибутом animal, содержащим подстроку «at» (например, ‘cat’): "stringContains": { "key": "animal", "value": "at" }
Список с элементом, содержащим значение в качестве подстроки. Следующий пример вернёт источники данных с атрибутом animals, являющимся списком, содержащим элемент, содержащий подстроку «at» (например, ["dog", "cat"] ): "stringContains": { "key": "animals", "value": "at" }
key -> (строка)
value -> (документ)
andAll -> (список)
Источники данных базы знаний возвращаются, если их атрибуты метаданных удовлетворяют всем условиям фильтрации в этом списке.
(… рекурсивно …)
orAll -> (список)
Источники данных базы знаний возвращаются, если их атрибуты метаданных удовлетворяют хотя бы одному из условий фильтрации в этом списке.
(… рекурсивно …)
orAll -> (список)
Данные из базы знаний возвращаются, если атрибуты метаданных удовлетворяют хотя бы одному из фильтров в этом списке.
(структура помеченного объединения)
Указывает фильтры, используемые для атрибутов/полей метаданных в источниках данных базы знаний перед возвратом результатов.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:equals, notEquals, greaterThan, greaterThanOrEquals, lessThan, lessThanOrEquals, in, notIn, startsWith, listContains, stringContains, andAll, orAll.equals -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение соответствует значению в этом объекте.
Следующий пример вернет источники данных с атрибутом «animal» со значением «cat»: "equals": { "key": "animal", "value": "cat" }
key -> (строка)
value -> (документ)
notEquals -> (структура)
Возвращаются источники данных базы знаний, которые содержат атрибут метаданных, имя которого соответствует ключу, а значение которого не соответствует значению в этом объекте.
Следующий пример вернет источники данных, не содержащие атрибут «animal» со значением «cat»: "notEquals": { "key": "animal", "value": "cat" }
key -> (строка)
value -> (документ)
greaterThan -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого больше значения в этом объекте.
Следующий пример вернет источники данных с атрибутом «year» со значением больше «1989»: "greaterThan": { "key": "year", "value": 1989 }
key -> (строка)
value -> (документ)
greaterThanOrEquals -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого больше или равно значению в этом объекте.
Следующий пример вернет источники данных с атрибутом «year» со значением больше или равным «1989»: "greaterThanOrEquals": { "key": "year", "value": 1989 }
key -> (строка)
value -> (документ)
lessThan -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого меньше значения в этом объекте.
Следующий пример вернет источники данных с атрибутом «year» со значением меньше «1989»: "lessThan": { "key": "year", "value": 1989 }
key -> (строка)
value -> (документ)
lessThanOrEquals -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого меньше или равно значению в этом объекте.
Следующий пример вернет источники данных с атрибутом «year» со значением меньше или равным «1989»: "lessThanOrEquals": { "key": "year", "value": 1989 }
key -> (строка)
value -> (документ)
in -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого находится в списке, указанном в значении в этом объекте.
Следующий пример вернет источники данных с атрибутом «animal», значение которого является «cat» или «dog»: "in": { "key": "animal", "value": ["cat", "dog"] }
key -> (строка)
value -> (документ)
notIn -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого не входит в список, указанный в значении в этом объекте.
Следующий пример вернет источники данных, у которых атрибут «animal» не равен «cat» и не равен «dog»: "notIn": { "key": "animal", "value": ["cat", "dog"] }
key -> (строка)
value -> (документ)
startsWith -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого начинается с значения в этом объекте. Этот фильтр в настоящее время поддерживается только для хранилищ векторов Amazon OpenSearch Serverless.
Следующий пример вернет источники данных с атрибутом «animal», начинающимся с «ca» (например, «cat» или «camel»). "startsWith": { "key": "animal", "value": "ca" }
key -> (строка)
value -> (документ)
listContains -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого представляет собой список, содержащий значение как один из своих элементов.
Следующий пример вернет источники данных с атрибутом «animals», представляющим собой список, содержащий элемент «cat» (например, ["dog", "cat"] ): "listContains": { "key": "animals", "value": "cat" }
key -> (строка)
value -> (документ)
stringContains -> (структура)
Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует ключу, а значение которого является одним из следующих:
Строка, содержащая значение в качестве подстроки. Следующий пример вернет источники данных с атрибутом «animal», содержащим подстроку «at» (например, «cat»): "stringContains": { "key": "animal", "value": "at" }
Список с элементом, содержащим значение в качестве подстроки. Следующий пример вернет источники данных с атрибутом «animals», представляющим собой список, содержащий элемент, содержащий подстроку «at» (например, ["dog", "cat"] ): "stringContains": { "key": "animals", "value": "at" }
key -> (строка)
value -> (документ)
andAll -> (список)
Источники данных базы знаний возвращаются, если все фильтры в этом списке выполняются для их атрибутов метаданных.
(… рекурсивно …)
orAll -> (список)
Источники данных базы знаний возвращаются, если для их атрибутов метаданных выполняется хотя бы один из фильтров в этом списке.
(… рекурсивно …)
generationConfiguration -> (структура)
Содержит конфигурацию для генерации ответа на основе полученных фрагментов текста.
promptTemplate -> (структура)
Содержит шаблон для запроса, отправляемого модели для генерации ответа.
textPromptTemplate -> (строка)
Шаблон для запроса, отправляемого модели для генерации ответа. Вы можете включить заполнитель запроса, который заменяется перед отправкой запроса модели для предоставления инструкциям и контекста модели. Кроме того, вы можете включить теги XML для выделения значимых разделов шаблона запроса.
Дополнительную информацию см. в разделе Шаблон запроса для базы знаний и Использование тегов XML с моделями Anthropic Claude.
guardrailConfiguration -> (структура)
Содержит конфигурацию для ограничения.
guardrailId -> (строка)
guardrailVersion -> (строка)
kbInferenceConfig -> (структура)
Содержит конфигурацию для вывода для извлечения из базы знаний и генерации ответа.
textInferenceConfig -> (структура)
Содержит конфигурацию для генерации текста с использованием языковой модели через функцию RetrieveAndGenerate.
temperature -> (число с плавающей точкой)
topP -> (число с плавающей точкой)
maxTokens -> (целое число)
stopSequences -> (список)
Список последовательностей символов, которые, если сгенерированы, заставят модель прекратить генерацию дополнительных токенов. Не используйте минимальную длину 1 или максимальную длину 1000. Значения ограничений, описанные здесь, являются произвольными, для фактических значений обратитесь к ограничениям, определенным для вашей конкретной модели.
(строка)
additionalModelRequestFields -> (карта)
Дополнительные параметры модели и соответствующие значения, не включенные в структуру textInferenceConfig для базы знаний. Это позволяет предоставить пользовательские параметры модели, специфичные для используемой языковой модели.
key -> (строка)
value -> (документ)
orchestrationConfiguration -> (структура)
Содержит конфигурацию для обработки запроса моделью перед извлечением и генерацией ответа.
queryTransformationConfiguration -> (структура)
Содержит конфигурацию для преобразования запроса.
type -> (строка)
externalSourcesConfiguration -> (структура)
Настройка объекта оболочки внешнего источника в функции retrieveAndGenerate.
modelArn -> (строка)
sources -> (список)
Документ для объекта оболочки внешнего источника в функции retrieveAndGenerate.
(структура)
Уникальный внешний источник содержимого, содержащегося в объекте оболочки.
sourceType -> (строка)
s3Location -> (структура)
Расположение внешнего источника в S3.
uri -> (строка)
byteContent -> (структура)
Идентификатор, тип содержимого и данные объекта оболочки внешнего источника.
identifier -> (строка)
contentType -> (строка)
data -> (байты)
generationConfiguration -> (структура)
Содержит параметры конфигурации для генерации ответов на основе извлеченных фрагментов текста.
promptTemplate -> (структура)
Содержит шаблон для запроса объекта оболочки внешнего источника.
textPromptTemplate -> (строка)
Шаблон запроса, отправляемый модели для генерации ответа. Вы можете включать заглушки запроса, которые будут заменены перед отправкой запроса модели для предоставления инструкций и контекста модели. Кроме того, вы можете включать XML-теги для обозначения значимых разделов шаблона запроса.
Для получения дополнительной информации см. Шаблон запроса базы знаний и Использование XML-тегов с моделями Anthropic Claude.
guardrailConfiguration -> (структура)
Параметры конфигурации для ограничения.
guardrailId -> (строка)
guardrailVersion -> (строка)
kbInferenceConfig -> (структура)
Параметры конфигурации для вывода, когда используется RetrieveAndGenerate для генерации ответов при использовании внешнего источника.
textInferenceConfig -> (структура)
Содержит параметры конфигурации для генерации текста с помощью модели языка через функцию RetrieveAndGenerate.
temperature -> (число с плавающей запятой)
topP -> (число с плавающей запятой)
maxTokens -> (целое число)
stopSequences -> (список)
Список последовательностей символов, которые, если сгенерированы, заставят модель прекратить генерацию дополнительных токенов. Не используйте минимальную длину 1 или максимальную длину 1000. Предельные значения, описанные здесь, являются произвольными значениями, для фактических значений обратитесь к ограничениям, определенным для вашей конкретной модели.
(строка)
additionalModelRequestFields -> (словарь)
Дополнительные параметры модели и соответствующие значения, не включенные в конфигурацию вывода текста для внешнего источника. Принимает на вход пользовательские параметры модели, специфичные для используемой модели языка.
key -> (строка)
value -> (документ)
precomputedRagSourceConfig -> (структура помеченных объединений)
Содержит параметры конфигурации источника RAG, используемого для генерации данных ответа на вывод для задания оценки базы знаний.
Примечание
Это структура помеченных объединений. Только один из следующих верхних ключей может быть задан:retrieveSourceConfig, retrieveAndGenerateSourceConfig.retrieveSourceConfig -> (структура)
Резюме источника RAG, используемого для задания оценки базы знаний только для извлечения, где вы предоставляете собственные данные ответа на вывод.
ragSourceIdentifier -> (строка)
retrieveAndGenerateSourceConfig -> (структура)
Резюме источника RAG, используемого для задания оценки базы знаний с извлечением и генерацией, где вы предоставляете собственные данные ответа на вывод.
ragSourceIdentifier -> (строка)
Синтаксис JSON:
{
"models": [
{
"bedrockModel": {
"modelIdentifier": "string",
"inferenceParams": "string",
"performanceConfig": {
"latency": "standard"|"optimized"
}
},
"precomputedInferenceSource": {
"inferenceSourceIdentifier": "string"
}
}
...
],
"ragConfigs": [
{
"knowledgeBaseConfig": {
"retrieveConfig": {
"knowledgeBaseId": "string",
"knowledgeBaseRetrievalConfiguration": {
"vectorSearchConfiguration": {
"numberOfResults": integer,
"overrideSearchType": "HYBRID"|"SEMANTIC",
"filter": {
"equals": {
"key": "string",
"value": {...}
},
"notEquals": {
"key": "string",
"value": {...}
},
"greaterThan": {
"key": "string",
"value": {...}
},
"greaterThanOrEquals": {
"key": "string",
"value": {...}
},
"lessThan": {
"key": "string",
"value": {...}
},
"lessThanOrEquals": {
"key": "string",
"value": {...}
},
"in": {
"key": "string",
"value": {...}
},
"notIn": {
"key": "string",
"value": {...}
},
"startsWith": {
"key": "string",
"value": {...}
},
"listContains": {
"key": "string",
"value": {...}
},
"stringContains": {
"key": "string",
"value": {...}
},
"andAll": [
{
"equals": {
"key": "string",
"value": {...}
},
"notEquals": {
"key": "string",
"value": {...}
},
"greaterThan": {
"key": "string",
"value": {...}
},
"greaterThanOrEquals": {
"key": "string",
"value": {...}
},
"lessThan": {
"key": "string",
"value": {...}
},
"lessThanOrEquals": {
"key": "string",
"value": {...}
},
"in": {
"key": "string",
"value": {...}
},
"notIn": {
"key": "string",
"value": {...}
},
"startsWith": {
"key": "string",
"value": {...}
},
"listContains": {
"key": "string",
"value": {...}
},
"stringContains": {
"key": "string",
"value": {...}
},
"andAll": [
{ ... recursive ... }
...
],
"orAll": [
{ ... recursive ... }
...
]
}
...
],
"orAll": [
{
"equals": {
"key": "string",
"value": {...}
},
"notEquals": {
"key": "string",
"value": {...}
},
"greaterThan": {
"key": "string",
"value": {...}
},
"greaterThanOrEquals": {
"key": "string",
"value": {...}
},
"lessThan": {
"key": "string",
"value": {...}
},
"lessThanOrEquals": {
"key": "string",
"value": {...}
},
"in": {
"key": "string",
"value": {...}
},
"notIn": {
"key": "string",
"value": {...}
},
"startsWith": {
"key": "string",
"value": {...}
},
"listContains": {
"key": "string",
"value": {...}
},
"stringContains": {
"key": "string",
"value": {...}
},
"andAll": [
{ ... recursive ... }
...
],
"orAll": [
{ ... recursive ... }
...
]
}
...
]
}
}
}
},
"retrieveAndGenerateConfig": {
"type": "KNOWLEDGE_BASE"|"EXTERNAL_SOURCES",
"knowledgeBaseConfiguration": {
"knowledgeBaseId": "string",
"modelArn": "string",
"retrievalConfiguration": {
"vectorSearchConfiguration": {
"numberOfResults": integer,
"overrideSearchType": "HYBRID"|"SEMANTIC",
"filter": {
"equals": {
"key": "string",
"value": {...}
},
"notEquals": {
"key": "string",
"value": {...}
},
"greaterThan": {
"key": "string",
"value": {...}
},
"greaterThanOrEquals": {
"key": "string",
"value": {...}
},
"lessThan": {
"key": "string",
"value": {...}
},
"lessThanOrEquals": {
"key": "string",
"value": {...}
},
"in": {
"key": "string",
"value": {...}
},
"notIn": {
"key": "string",
"value": {...}
},
"startsWith": {
"key": "string",
"value": {...}
},
"listContains": {
"key": "string",
"value": {...}
},
"stringContains": {
"key": "string",
"value": {...}
},
"andAll": [
{
"equals": {
"key": "string",
"value": {...}
},
"notEquals": {
"key": "string",
"value": {...}
},
"greaterThan": {
"key": "string",
"value": {...}
},
"greaterThanOrEquals": {
"key": "string",
"value": {...}
},
"lessThan": {
"key": "string",
"value": {...}
},
"lessThanOrEquals": {
"key": "string",
"value": {...}
},
"in": {
"key": "string",
"value": {...}
},
"notIn": {
"key": "string",
"value": {...}
},
"startsWith": {
"key": "string",
"value": {...}
},
"listContains": {
"key": "string",
"value": {...}
},
"stringContains": {
"key": "string",
"value": {...}
},
"andAll": [
{ ... recursive ... }
...
],
"orAll": [
{ ... recursive ... }
...
]
}
...
],
"orAll": [
{
"equals": {
"key": "string",
"value": {...}
},
"notEquals": {
"key": "string",
"value": {...}
},
"greaterThan": {
"key": "string",
"value": {...}
},
"greaterThanOrEquals": {
"key": "string",
"value": {...}
},
"lessThan": {
"key": "string",
"value": {...}
},
"lessThanOrEquals": {
"key": "string",
"value": {...}
},
"in": {
"key": "string",
"value": {...}
},
"notIn": {
"key": "string",
"value": {...}
},
"startsWith": {
"key": "string",
"value": {...}
},
"listContains": {
"key": "string",
"value": {...}
},
"stringContains": {
"key": "string",
"value": {...}
},
"andAll": [
{ ... recursive ... }
...
],
"orAll": [
{ ... recursive ... }
...
]
}
...
]
}
}
},
"generationConfiguration": {
"promptTemplate": {
"textPromptTemplate": "string"
},
"guardrailConfiguration": {
"guardrailId": "string",
"guardrailVersion": "string"
},
"kbInferenceConfig": {
"textInferenceConfig": {
"temperature": float,
"topP": float,
"maxTokens": integer,
"stopSequences": ["string", ...]
}
},
"additionalModelRequestFields": {"string": {...}
...}
},
"orchestrationConfiguration": {
"queryTransformationConfiguration": {
"type": "QUERY_DECOMPOSITION"
}
}
},
"externalSourcesConfiguration": {
"modelArn": "string",
"sources": [
{
"sourceType": "S3"|"BYTE_CONTENT",
"s3Location": {
"uri": "string"
},
"byteContent": {
"identifier": "string",
"contentType": "string",
"data": blob
}
}
...
],
"generationConfiguration": {
"promptTemplate": {
"textPromptTemplate": "string"
},
"guardrailConfiguration": {
"guardrailId": "string",
"guardrailVersion": "string"
},
"kbInferenceConfig": {
"textInferenceConfig": {
"temperature": float,
"topP": float,
"maxTokens": integer,
"stopSequences": ["string", ...]
}
},
"additionalModelRequestFields": {"string": {...}
...}
}
}
}
},
"precomputedRagSourceConfig": {
"retrieveSourceConfig": {
"ragSourceIdentifier": "string"
},
"retrieveAndGenerateSourceConfig": {
"ragSourceIdentifier": "string"
}
}
}
...
]
}
--output-data-config (структура)
Содержит параметры конфигурации Amazon S3-бакета для хранения результатов задания оценки.
s3Uri -> (строка)
Упрощенный синтаксис:
s3Uri=string
Синтаксис JSON:
{
"s3Uri": "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
- текст
- таблица
- 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.
Вывод
jobArn -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
