Spec-Zone.ru › AWS CLI v2

[ aws . bedrock ]

get-evaluation-job

Описание

Получает информацию об оценке задания, например, статус задания.

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

get-evaluation-job использует значения типов документов. Типы документов следуют модели данных JSON, где допустимые значения: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команды, опции и вложенные параметры, помеченные типом document, должны быть предоставлены в формате JSON. Краткая синтаксическая запись не поддерживает типы документов.

Синтаксис

  get-evaluation-job
--job-identifier <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-identifier (строка)

Amazon Resource Name (ARN) задания оценки, для которого требуется информация.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, указанному в --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет интерпретирована буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, будет выведен пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно валидирует входные данные команды и возвращает образец выходного JSON для этой команды. Сгенерированный каркас JSON нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном каркасе JSON.

Глобальные опции

--debug (логическое значение)

Включает отладовую запись в журнал.

--endpoint-url (строка)

Переопределяет URL по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при взаимодействии с сервисами AWS. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Эта опция переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (логическое значение)

Отключает автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

  • json
  • text
  • таблица
  • 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.

Вывод

jobName -> (строка)

Имя задания оценки.

status -> (строка)

Текущий статус задания оценки.

jobArn -> (строка)

Amazon Resource Name (ARN) задания оценки.

jobDescription -> (строка)

Описание задания оценки.

roleArn -> (строка)

Amazon Resource Name (ARN) роли службы IAM, используемой в задании оценки.

customerEncryptionKeyId -> (строка)

Amazon Resource Name (ARN) управляемого пользователем ключа шифрования, указанного при создании задания оценки.

jobType -> (строка)

Указывает, является ли задание оценки автоматическим или основанным на участии человека.

applicationType -> (строка)

Указывает, предназначено ли задание оценки для оценки модели или оценки базы знаний (извлечения и генерации ответов).

evaluationConfig -> (структура помеченного объединения)

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

Примечание

Это структура помеченного союза. Можно задать только один из следующих ключей верхнего уровня: 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 -> (строка)

S3 URI указанного в задании S3-бакета.

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 -> (строка)

Amazon Resource Name (ARN) модели оценщика, используемой в задании оценки базы знаний или в задании оценки моделей, использующих модель в качестве судьи.

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

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

customMetrics -> (список)

Определяет список настраиваемых метрик, которые нужно использовать в задании оценки Amazon Bedrock.

(структура помеченного союза)

Элемент массива, определяющий одну настраиваемую метрику для использования в задании оценки Amazon Bedrock.

Примечание

Это структура помеченного союза. Можно задать только один из следующих ключей верхнего уровня: customMetricDefinition.

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

Определение настраиваемой метрики для использования в задании оценки Amazon Bedrock.

name -> (строка)

Имя настраиваемой метрики. Имена должны быть уникальными в вашем регионе Amazon Web Services.

instructions -> (строка)

Запрос для настраиваемой метрики, который инструктирует модель оценщика, как оценить модель или источник RAG, подлежащие оценке.

ratingScale -> (список)

Определяет шкалу рейтингов, используемую для настраиваемой метрики. Рекомендуется всегда определять шкалу рейтингов при создании настраиваемой метрики. Если вы не определите шкалу, Amazon Bedrock не сможет отобразить результаты оценки в консоли или рассчитать средние значения числовых оценок. Дополнительные сведения об указании шкалы рейтингов см. в разделе Указание схемы вывода (шкалы рейтингов).

(структура)

Определяет значение и соответствующее определение для одного рейтинга в шкале рейтингов настраиваемой метрики.

definition -> (строка)

Определяет определение для одного рейтинга в шкале рейтингов настраиваемой метрики.

value -> (структура помеченного союза)

Определяет значение для одного рейтинга в шкале рейтингов настраиваемой метрики.

Примечание

Это структура помеченного союза. Можно задать только один из следующих ключей верхнего уровня: stringValue, floatValue.

stringValue -> (строка)

Строка, представляющая значение рейтинга в шкале рейтингов настраиваемой метрики.

floatValue -> (число с плавающей запятой)

Число с плавающей запятой, представляющее значение рейтинга в шкале рейтингов настраиваемой метрики.

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

Конфигурация модели оценщика, которую вы хотите использовать для оценки настраиваемых метрик в задании оценки Amazon Bedrock.

bedrockEvaluatorModels -> (список)

Определяет модель, которую вы хотите использовать для оценки настраиваемых метрик в задании оценки Amazon Bedrock.

(структура)

Определяет модель, которую вы хотите использовать для оценки настраиваемых метрик в задании оценки Amazon Bedrock.

modelIdentifier -> (строка)

Amazon Resource Name (ARN) модели оценщика для настраиваемых метрик. Список поддерживаемых моделей оценщиков см. в разделах Оценка производительности модели с помощью другого LLM в качестве судьи и Оценка производительности источников RAG с помощью оценок Amazon Bedrock.

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

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

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

Параметры рабочего процесса с участием людей.

flowDefinitionArn -> (строка)

Amazon Resource Number (ARN) для определения потока

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 -> (строка)

S3 URI указанного в задании S3-бакета.

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.

(строка)

inferenceConfig -> (структура помеченного союза)

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

Примечание

Это структура Tagged Union. Только один из следующих ключей верхнего уровня может быть установлен: models, ragConfigs.

models -> (list)

Указывает модели вывода.

(структура помеченной объединением)

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

Примечание

Это структура Tagged Union. Только один из следующих ключей верхнего уровня может быть установлен: bedrockModel, precomputedInferenceSource.

bedrockModel -> (structure)

Определяет модель Amazon Bedrock или профиль вывода и параметры вывода, которые вы хотите использовать.

modelIdentifier -> (string)

ARN модели Amazon Bedrock или указанного профиля вывода.

inferenceParams -> (string)

Каждый Amazon Bedrock поддерживает различные параметры вывода, которые изменяют поведение модели во время вывода.

performanceConfig -> (structure)

Указывает настройки производительности для модели или профиля вывода.

latency -> (string)

Указывает, следует ли использовать версию модели или профиля вывода, оптимизированную по задержке, или стандартную версию.

precomputedInferenceSource -> (structure)

Определяет модель, используемую для создания данных ответа вывода для задания оценки модели, в котором вы предоставляете собственные данные ответа вывода.

inferenceSourceIdentifier -> (string)

Метка, идентифицирующая модель, используемую в задании оценки модели, в котором вы предоставляете собственные данные ответа вывода.

ragConfigs -> (list)

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

(структура помеченной объединением)

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

Примечание

Это структура Tagged Union. Только один из следующих ключей верхнего уровня может быть установлен: knowledgeBaseConfig, precomputedRagSourceConfig.

knowledgeBaseConfig -> (tagged union structure)

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

Примечание

Это структура Tagged Union. Только один из следующих ключей верхнего уровня может быть установлен: retrieveConfig, retrieveAndGenerateConfig.

retrieveConfig -> (structure)

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

knowledgeBaseId -> (string)

Уникальный идентификатор базы знаний.

knowledgeBaseRetrievalConfiguration -> (structure)

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

vectorSearchConfiguration -> (structure)

Содержит сведения о конфигурации для возврата результатов из векторного поиска.

numberOfResults -> (integer)

Количество извлекаемых фрагментов текста; количество возвращаемых результатов.

overrideSearchType -> (string)

По умолчанию Amazon Bedrock решает стратегию поиска за вас. Если вы используете векторное хранилище Amazon OpenSearch Serverless, содержащее фильтруемое текстовое поле, вы можете указать, следует ли запрашивать базу знаний с помощью 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)

Тип ресурса, содержащего ваши данные для извлечения информации и генерации ответов.

Если вы решите использовать EXTERNAL_SOURCES, то в настоящее время поддерживаются только модели Claude 3 Sonnet для баз знаний.

knowledgeBaseConfiguration -> (structure)

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

knowledgeBaseId -> (string)

Уникальный идентификатор базы знаний.

modelArn -> (string)

Ресурс Amazon Name (ARN) базовой модели или профиля вывода, используемого для генерации ответов.

retrievalConfiguration -> (structure)

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

vectorSearchConfiguration -> (structure)

Содержит сведения о конфигурации для возврата результатов из векторного поиска.

numberOfResults -> (integer)

Количество извлекаемых текстовых фрагментов; количество возвращаемых результатов.

overrideSearchType -> (string)

По умолчанию Amazon Bedrock выбирает стратегию поиска для вас. Если вы используете векторное хранилище Amazon OpenSearch Serverless, которое содержит фильтруемое текстовое поле, вы можете указать, следует ли запрашивать базу знаний с 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, содержащим подстроку ‘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 -> (вещественное число)

Управляет случайностью генерируемого текста моделью языка, влияя на то, насколько модель придерживается наиболее предсказуемых следующих слов по сравнению с исследованием более неожиданных вариантов. Более низкое значение температуры (например, 0,2 или 0,3) делает вывод модели более детерминированным или предсказуемым, в то время как более высокое значение температуры (например, 0,8 или 0,9) делает вывод более творческим или непредсказуемым.

topP -> (вещественное число)

Пороговое значение распределения вероятностей, которое управляет тем, что модель рассматривает для набора возможных следующих токенов. Модель будет учитывать только верхний p% распределения вероятностей при генерации следующего токена.

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

Максимальное количество токенов для генерации в тексте вывода. Не используйте минимальное значение 0 или максимальное значение 65536. Предельные значения, описанные здесь, являются произвольными значениями; для фактических значений см. пределы, определённые вашей конкретной моделью.

stopSequences -> (список)

Список последовательностей символов, которые, если они будут сгенерированы, заставят модель прекратить генерацию дополнительных токенов. Не используйте минимальную длину 1 или максимальную длину 1000. Предельные значения, описанные здесь, являются произвольными значениями; для фактических значений см. пределы, определённые вашей конкретной моделью.

(строка)

additionalModelRequestFields -> (массив)

Дополнительные параметры модели и соответствующие значения, не включенные в структуру textInferenceConfig для базы знаний. Это позволяет предоставить настраиваемые параметры модели, специфичные для используемой модели языка.

key -> (строка)

value -> (документ)

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

Содержит конфигурацию для модели по обработке запроса перед извлечением и генерацией ответа.

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

Содержит конфигурацию для преобразования запроса.

type -> (строка)

Тип преобразования, применяемый к запросу.

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

Конфигурация объекта обертки внешнего источника в функции retrieveAndGenerate.

modelArn -> (строка)

Идентификатор ресурса Amazon (ARN) основной модели или профиля вывода, используемого для генерации ответов.

sources -> (список)

Документ для объекта обертки внешнего источника в функции retrieveAndGenerate.

(структура)

Уникальный внешний источник содержимого, содержащегося в объекте обертки.

sourceType -> (строка)

Тип источника объекта обертки внешнего источника.

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

Расположение внешнего источника в S3.

uri -> (строка)

Расположение URI S3 для объекта обертки документа.

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

Идентификатор, тип содержимого и данные объекта обертки внешнего источника.

identifier -> (строка)

Имя файла документа, содержащегося в объекте обертки.

contentType -> (строка)

Тип MIME документа, содержащегося в объекте обертки.

data -> (байты)

Значение байта файла для загрузки, закодированное как строка Base-64.

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

Содержит конфигурацию для генерации ответа на основе извлеченных фрагментов текста.

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

Содержит шаблон запроса для объекта обертки внешнего источника.

textPromptTemplate -> (строка)

Шаблон запроса, отправляемый модели для генерации ответа. Вы можете включить заглушки запроса, которые заменяются перед отправкой запроса модели для предоставления инструкций и контекста модели. Кроме того, вы можете включать теги XML для обозначения значимых разделов шаблона запроса.

Для получения дополнительной информации см. Шаблон запроса базы знаний и Использование тегов XML с моделями Anthropic Claude.

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

Конфигурация для ограничения.

guardrailId -> (строка)

Уникальный идентификатор ограничения.

guardrailVersion -> (строка)

Версия ограничения.

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

Конфигурация для вывода при использовании RetrieveAndGenerate для генерации ответов при использовании внешнего источника.

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

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

temperature -> (число с плавающей точкой)

Управляет случайностью текста, генерируемого языковой моделью, влияя на то, насколько модель придерживается наиболее предсказуемых последующих слов по сравнению с исследованием более неожиданных вариантов. Более низкое значение температуры (например, 0,2 или 0,3) делает результаты модели более детерминированными или предсказуемыми, в то время как более высокое значение температуры (например, 0,8 или 0,9) делает результаты более творческими или непредсказуемыми.

topP -> (число с плавающей точкой)

Пороговое значение распределения вероятностей, которое управляет тем, что модель рассматривает в наборе возможных следующих токенов. Модель будет рассматривать только верхний p% распределения вероятностей при генерации следующего токена.

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

Максимальное количество токенов для генерации в выходном тексте. Не используйте минимум 0 или максимум 65536. Указанные здесь предельные значения являются условными. Для фактических значений обратитесь к ограничениям, определённым для вашей конкретной модели.

stopSequences -> (список)

Список последовательностей символов, которые, если будут сгенерированы, заставят модель прекратить генерацию дополнительных токенов. Не используйте минимальную длину 1 или максимальную длину 1000. Указанные здесь предельные значения являются условными. Для фактических значений обратитесь к ограничениям, определённым для вашей конкретной модели.

(строка)

additionalModelRequestFields -> (карта)

Дополнительные параметры модели и соответствующие значения, не включенные в конфигурацию вывода текста для внешнего источника. Принимает пользовательские параметры модели, специфичные для используемой языковой модели.

key -> (строка)

value -> (документ)

precomputedRagSourceConfig -> (меченый объединённый структурой)

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

Примечание

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

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

Резюме источника RAG, используемого для задания оценки базы знаний с извлечением, где вы предоставляете собственные данные ответа вывода.

ragSourceIdentifier -> (строка)

Метка, определяющая источник RAG, используемый для задания оценки базы знаний с извлечением, где вы предоставляете собственные данные ответа вывода.

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

Резюме источника RAG, используемого для задания оценки базы знаний с извлечением и генерацией, где вы предоставляете собственные данные ответа вывода.

ragSourceIdentifier -> (строка)

Метка, определяющая источник RAG, используемый для задания оценки базы знаний с извлечением и генерацией, где вы предоставляете собственные данные ответа вывода.

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

Содержит конфигурацию ведра Amazon S3 для хранения результатов задания оценки.

s3Uri -> (строка)

URI Amazon S3, где сохраняются результаты задания оценки.

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

Время создания задания оценки.

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

Время последнего изменения задания оценки.

failureMessages -> (список)

Список строк, указывающих причины, по которым задание оценки не удалось создать.

(строка)

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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