create-experiment
Описание
Создаёт эксперимент Evidently. Перед созданием эксперимента необходимо создать функцию, используемую в эксперименте.
Эксперимент помогает принимать решения о проектировании функций на основе данных и доказательств. Эксперимент может одновременно проверять до пяти вариантов. Evidently собирает данные эксперимента и анализирует их с помощью статистических методов, предоставляя чёткие рекомендации о том, какие варианты работают лучше.
Вы можете необязательно указать segment, чтобы эксперимент учитывал только определённые типы аудитории в эксперименте, например, используя только сессии пользователей из определённого местоположения или которые используют определённый интернет-браузер.
Не используйте эту операцию для обновления существующего эксперимента. Вместо этого используйте UpdateExperiment.
См. также: Документацию API AWS
Синтаксис
create-experiment
[--description <value>]
--metric-goals <value>
--name <value>
[--online-ab-config <value>]
--project <value>
[--randomization-salt <value>]
[--sampling-rate <value>]
[--segment <value>]
[--tags <value>]
--treatments <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]
Параметры
--description (строка)
--metric-goals (список)
Массив структур, определяющих метрики, используемые в эксперименте, и то, является ли более высокое или более низкое значение для каждой метрики целью.
(структура)
Используйте эту структуру, чтобы указать Evidently, требуется ли более высокое или более низкое значение для метрики, используемой в эксперименте.
desiredChange -> (строка)
INCREASE означает, что вариант с большим числом для этой метрики работает лучше.
DECREASE означает, что вариант с меньшим числом для этой метрики работает лучше.
metricDefinition -> (структура)
Структура, содержащая подробности о метрике.
entityIdKey -> (строка)
userDetails.userID.eventPattern -> (строка)
Шаблон события EventBridge, определяющий, как регистрируется метрика.
Дополнительную информацию о шаблонах событий EventBridge см. в разделе Шаблоны событий Amazon EventBridge.
name -> (строка)
unitLabel -> (строка)
valueKey -> (строка)
Сокращенный синтаксис:
desiredChange=string,metricDefinition={entityIdKey=string,eventPattern=string,name=string,unitLabel=string,valueKey=string} ...
Синтаксис JSON:
[
{
"desiredChange": "INCREASE"|"DECREASE",
"metricDefinition": {
"entityIdKey": "string",
"eventPattern": "string",
"name": "string",
"unitLabel": "string",
"valueKey": "string"
}
}
...
]
--name (строка)
--online-ab-config (структура)
Структура, содержащая конфигурацию, какой вариант использовать в качестве «контрольной» версии. «Контрольная» версия используется для сравнения с другими вариантами. Эта структура также определяет, сколько трафика эксперимента выделяется каждому варианту.
controlTreatmentName -> (строка)
treatmentWeights -> (отображение)
Набор пар «ключ-значение». Ключи — имена вариантов, а значения — доля трафика эксперимента, которая будет назначена этому варианту. Укажите долю трафика в тысячных долях процента, например, 20000 для варианта будет выделять 20% трафика эксперимента этому варианту.
key -> (строка)
value -> (длинное целое число)
Сокращенный синтаксис:
controlTreatmentName=string,treatmentWeights={KeyName1=long,KeyName2=long}
Синтаксис JSON:
{
"controlTreatmentName": "string",
"treatmentWeights": {"string": long
...}
}
--project (строка)
--randomization-salt (строка)
randomizationSalt. Если вы опустите randomizationSalt, Evidently использует имя эксперимента как randomizationSalt.--sampling-rate (длинное целое число)
Доля доступной аудитории, которую вы хотите выделить для этого эксперимента в тысячных долях процента. Доступная аудитория — это общая аудитория за вычетом аудитории, которую вы выделили для переопределений или текущих запусков этой функции.
Это представлено в тысячных долях процента. Например, укажите 10000, чтобы выделить 10% доступной аудитории.
--segment (строка)
--tags (отображение)
Присваивает один или несколько тегов (пар «ключ-значение») эксперименту.
Теги помогают организовать и классифицировать ваши ресурсы. Вы также можете использовать их для ограничения прав пользователей, предоставив пользователю разрешение на доступ или изменение только ресурсов с определёнными значениями тегов.
Теги не имеют никакого семантического значения для Amazon Web Services и интерпретируются исключительно как строки символов.
Вы можете связать до 50 тегов с экспериментом.
Дополнительную информацию см. в разделе Маркировка ресурсов Amazon Web Services.
key -> (строка)
value -> (строка)
Сокращенный синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--treatments (список)
Массив структур, описывающих конфигурацию каждого варианта функции, используемого в эксперименте.
(структура)
Структура, определяющая одно лечение в эксперименте. Лечение — это вариант функции, который вы включаете в эксперимент.
description -> (строка)
feature -> (строка)
name -> (строка)
variation -> (строка)
Сокращенный синтаксис:
description=string,feature=string,name=string,variation=string ...
Синтаксис JSON:
[
{
"description": "string",
"feature": "string",
"name": "string",
"variation": "string"
}
...
]
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному в --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения JSON, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Печатает каркас JSON в стандартный вывод без отправки запроса API. Если предоставлено без значения или со значением input, печатает пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он напечатает пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверит входные данные команды и вернёт пример выходного JSON для этой команды. Сгенерированный каркас JSON нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном каркасе JSON.
Глобальные параметры
--debug (булево)
Включить отладочную запись.
--endpoint-url (строка)
Переопределить URL по умолчанию команды заданным URL.
--no-verify-ssl (булево)
По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение по умолчанию проверки сертификатов SSL.
--no-paginate (булево)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования выходных данных команды.
- json
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определённый профиль из вашего файла аутентификации.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить вывод цвета.
- on
- off
- auto
--no-sign-request (булево)
Не подписывать запросы. Кредиты не будут загружаться, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (булево)
Отключить пейджер cli для вывода.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры входных данных CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
experiment -> (структура)
Структура, содержащая данные о конфигурации созданного эксперимента.
arn -> (строка)
createdTime -> (метка времени)
description -> (строка)
execution -> (структура)
Структура, содержащая дату и время начала и окончания эксперимента.
endedTime -> (метка времени)
startedTime -> (метка времени)
lastUpdatedTime -> (метка времени)
metricGoals -> (список)
Массив структур, определяющих метрики, используемые в эксперименте, и является ли целевым значением более высокое или более низкое значение каждой метрики.
(структура)
Структура, указывающая Evidently, желательно ли большее или меньшее значение для метрики, используемой в эксперименте.
desiredChange -> (строка)
INCREASE означает, что вариация с более высоким значением по этой метрике показывает лучшие результаты.
DECREASE означает, что вариация с более низким значением по этой метрике показывает лучшие результаты.
metricDefinition -> (структура)
Структура, содержащая данные о метрике.
entityIdKey -> (строка)
eventPattern -> (строка)
Шаблон события EventBridge, определяющий, как регистрируется метрика.
Дополнительную информацию о шаблонах событий EventBridge см. в разделе Amazon EventBridge event patterns.
name -> (строка)
unitLabel -> (строка)
valueKey -> (строка)
name -> (строка)
onlineAbDefinition -> (структура)
Структура, содержащая конфигурацию, определяющую, какая вариация используется в качестве «контрольной» версии. «Контрольная» версия используется для сравнения с другими вариациями. Эта структура также определяет, какой объем трафика эксперимента распределяется для каждой вариации.
controlTreatmentName -> (строка)
treatmentWeights -> (карта)
Набор пар «ключ-значение». Ключи — имена вариаций, а значения — доля трафика эксперимента, распределяемого для этой вариации. Доля трафика задаётся в тысячных процентах, так что значение 20 000 для вариации будет распределять 20% трафика эксперимента для этой вариации.
key -> (строка)
value -> (целое число)
project -> (строка)
randomizationSalt -> (строка)
randomizationSalt .samplingRate -> (целое число)
В тысячных процентах, объем целевой аудитории, выделенной для этого эксперимента. Целевая аудитория — это общая аудитория за вычетом аудитории, которую вы выделили для переопределений или текущих запусков этой функции.
Это значение представляется в тысячных процентах, так что значение 10 000 соответствует 10% доступной аудитории.
schedule -> (структура)
Структура, содержащая время и дату завершения анализа эксперимента Evidently.
analysisCompleteTime -> (метка времени)
segment -> (строка)
status -> (строка)
statusReason -> (строка)
tags -> (карта)
Список ключей и значений тегов, связанных с этим экспериментом.
key -> (строка)
value -> (строка)
treatments -> (список)
Массив структур, описывающих конфигурацию каждой вариации функции, используемой в эксперименте.
(структура)
Структура, определяющая одно лечение в эксперименте. Лечение — это вариация функции, которую вы включаете в эксперимент.
description -> (строка)
featureVariations -> (карта)
Используемая вариация функции для этого лечения. Это пара «ключ-значение». Ключ — имя функции, а значение — имя вариации.
key -> (строка)
value -> (строка)
name -> (строка)
type -> (строка)
aws.experiment.onlineab .
© Copyright 2025, Amazon Web Services. Created using Sphinx.