launchdarkly_api 25.2.0 → 25.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +64 -39
- data/docs/AIConfig.md +7 -5
- data/docs/AIConfigPatch.md +8 -4
- data/docs/AIConfigPost.md +8 -6
- data/docs/AIConfigTargeting.md +3 -3
- data/docs/AIConfigTargetingEnvironmentRule.md +8 -0
- data/docs/AIConfigTargetingEnvironmentRuleClause.md +2 -0
- data/docs/AIConfigVariation.md +1 -1
- data/docs/AIConfigVariationPatch.md +1 -1
- data/docs/AgentControlApi.md +110 -110
- data/docs/AgentOptimization.md +1 -1
- data/docs/AgentOptimizationJudge.md +1 -1
- data/docs/AgentOptimizationPost.md +1 -1
- data/docs/AgentSkill.md +3 -1
- data/docs/AgentSkillPatch.md +3 -1
- data/docs/AgentSkillPost.md +3 -1
- data/docs/AiConfigsMetricListingRep.md +2 -0
- data/docs/ApprovalsApi.md +1 -1
- data/docs/CreateFlagReleasePlanRequest.md +32 -0
- data/docs/EnvironmentReleasePlan.md +38 -0
- data/docs/EnvironmentReleasePlanClause.md +28 -0
- data/docs/EnvironmentReleasePlanMetric.md +20 -0
- data/docs/EnvironmentReleasePlanPhase.md +24 -0
- data/docs/EnvironmentReleasePlanProgressiveRelease.md +26 -0
- data/docs/EnvironmentReleasePlanProgressiveReleaseRep.md +26 -0
- data/docs/EnvironmentReleasePlanStep.md +22 -0
- data/docs/EnvironmentReleasePlans.md +22 -0
- data/docs/EnvironmentReleasePlansBetaApi.md +633 -0
- data/docs/EnvironmentReleasePlansLink.md +20 -0
- data/docs/EnvironmentReleasePlansPaginatedLinks.md +26 -0
- data/docs/EnvironmentReleasesMetricListingRep.md +2 -0
- data/docs/{ReleaseMethod.md → ExecutionMode.md} +2 -2
- data/docs/FeatureFlagsApi.md +1 -1
- data/docs/FlagReleasePlan.md +36 -0
- data/docs/FlagReleasePlanEnvironment.md +24 -0
- data/docs/FlagReleasePlanRequest.md +30 -0
- data/docs/FlagReleasePlansBetaApi.md +392 -0
- data/docs/FlagReleasePlansError.md +20 -0
- data/docs/FlagReleasePlansLink.md +20 -0
- data/docs/FlagReleasePlansPaginatedLinks.md +26 -0
- data/docs/ListFlagReleasePlansResponse.md +22 -0
- data/docs/MaintainerIdentifier.md +79 -0
- data/docs/MaintainerIdentifierMember.md +20 -0
- data/docs/MaintainerIdentifierTeam.md +20 -0
- data/docs/MaintainerResponse.md +79 -0
- data/docs/MaintainerResponseMember.md +26 -0
- data/docs/MaintainerResponseTeam.md +22 -0
- data/docs/PinnedSkillToolRef.md +20 -0
- data/docs/PostEnvironmentReleasePlanRequest.md +26 -0
- data/docs/PutDefaultEnvironmentReleasePlanRequest.md +18 -0
- data/docs/PutEnvironmentReleasePlanRequest.md +26 -0
- data/docs/PutFlagReleasePlanRequest.md +32 -0
- data/docs/QuickStats.md +2 -2
- data/docs/SkillToolRef.md +20 -0
- data/docs/ToolReferences.md +5 -1
- data/docs/ToolSkillReference.md +22 -0
- data/docs/TriggerType.md +15 -0
- data/lib/launchdarkly_api/api/agent_control_api.rb +98 -98
- data/lib/launchdarkly_api/api/approvals_api.rb +2 -2
- data/lib/launchdarkly_api/api/environment_release_plans_beta_api.rb +730 -0
- data/lib/launchdarkly_api/api/feature_flags_api.rb +2 -2
- data/lib/launchdarkly_api/api/{release_policies_beta_api.rb → flag_release_plans_beta_api.rb} +173 -212
- data/lib/launchdarkly_api/models/agent_optimization.rb +1 -1
- data/lib/launchdarkly_api/models/agent_optimization_judge.rb +1 -1
- data/lib/launchdarkly_api/models/agent_optimization_post.rb +1 -1
- data/lib/launchdarkly_api/models/agent_skill.rb +14 -2
- data/lib/launchdarkly_api/models/agent_skill_patch.rb +16 -4
- data/lib/launchdarkly_api/models/agent_skill_post.rb +16 -4
- data/lib/launchdarkly_api/models/ai_config.rb +16 -6
- data/lib/launchdarkly_api/models/ai_config_patch.rb +27 -7
- data/lib/launchdarkly_api/models/ai_config_post.rb +19 -9
- data/lib/launchdarkly_api/models/ai_config_targeting.rb +3 -3
- data/lib/launchdarkly_api/models/ai_config_targeting_environment_rule.rb +40 -1
- data/lib/launchdarkly_api/models/ai_config_targeting_environment_rule_clause.rb +11 -1
- data/lib/launchdarkly_api/models/ai_config_variation.rb +1 -1
- data/lib/launchdarkly_api/models/ai_config_variation_patch.rb +1 -1
- data/lib/launchdarkly_api/models/ai_configs_metric_listing_rep.rb +11 -1
- data/lib/launchdarkly_api/models/create_flag_release_plan_request.rb +335 -0
- data/lib/launchdarkly_api/models/environment_release_plan.rb +426 -0
- data/lib/launchdarkly_api/models/{release_policies_access_allowed_reason.rb → environment_release_plan_clause.rb} +98 -65
- data/lib/launchdarkly_api/models/{release_policies_access_allowed_rep.rb → environment_release_plan_metric.rb} +28 -41
- data/lib/launchdarkly_api/models/environment_release_plan_phase.rb +208 -0
- data/lib/launchdarkly_api/models/environment_release_plan_progressive_release.rb +285 -0
- data/lib/launchdarkly_api/models/{release_policies_access_denied_reason.rb → environment_release_plan_progressive_release_rep.rb} +85 -67
- data/lib/launchdarkly_api/models/{release_policy_stage.rb → environment_release_plan_step.rb} +43 -4
- data/lib/launchdarkly_api/models/{release_policies_response.rb → environment_release_plans.rb} +16 -7
- data/lib/launchdarkly_api/models/{release_policies_access_denied.rb → environment_release_plans_link.rb} +16 -50
- data/lib/launchdarkly_api/models/environment_release_plans_paginated_links.rb +200 -0
- data/lib/launchdarkly_api/models/environment_releases_metric_listing_rep.rb +11 -1
- data/lib/launchdarkly_api/models/{release_method.rb → execution_mode.rb} +6 -7
- data/lib/launchdarkly_api/models/expanded_ai_config.rb +1 -1
- data/lib/launchdarkly_api/models/flag_release_plan.rb +359 -0
- data/lib/launchdarkly_api/models/{put_release_policy_request.rb → flag_release_plan_environment.rb} +47 -65
- data/lib/launchdarkly_api/models/{post_release_policy_request.rb → flag_release_plan_request.rb} +64 -67
- data/lib/launchdarkly_api/models/flag_release_plans_error.rb +208 -0
- data/lib/launchdarkly_api/models/flag_release_plans_link.rb +156 -0
- data/lib/launchdarkly_api/models/flag_release_plans_paginated_links.rb +200 -0
- data/lib/launchdarkly_api/models/list_flag_release_plans_response.rb +202 -0
- data/lib/launchdarkly_api/models/maintainer_identifier.rb +56 -0
- data/lib/launchdarkly_api/models/maintainer_identifier_member.rb +214 -0
- data/lib/launchdarkly_api/models/{progressive_release_config.rb → maintainer_identifier_team.rb} +66 -32
- data/lib/launchdarkly_api/models/maintainer_response.rb +56 -0
- data/lib/launchdarkly_api/models/maintainer_response_member.rb +225 -0
- data/lib/launchdarkly_api/models/maintainer_response_team.rb +206 -0
- data/lib/launchdarkly_api/models/{release_policies_access_rep.rb → pinned_skill_tool_ref.rb} +46 -45
- data/lib/launchdarkly_api/models/{release_policy.rb → post_environment_release_plan_request.rb} +93 -120
- data/lib/launchdarkly_api/models/{release_policies_access.rb → put_default_environment_release_plan_request.rb} +33 -44
- data/lib/launchdarkly_api/models/put_environment_release_plan_request.rb +285 -0
- data/lib/launchdarkly_api/models/put_flag_release_plan_request.rb +309 -0
- data/lib/launchdarkly_api/models/quick_stats.rb +2 -2
- data/lib/launchdarkly_api/models/skill_tool_ref.rb +195 -0
- data/lib/launchdarkly_api/models/tool_references.rb +26 -4
- data/lib/launchdarkly_api/models/tool_skill_reference.rb +220 -0
- data/lib/launchdarkly_api/models/trigger_type.rb +42 -0
- data/lib/launchdarkly_api/version.rb +1 -1
- data/lib/launchdarkly_api.rb +35 -16
- data/spec/api/agent_control_api_spec.rb +49 -49
- data/spec/api/approvals_api_spec.rb +1 -1
- data/spec/api/environment_release_plans_beta_api_spec.rb +156 -0
- data/spec/api/feature_flags_api_spec.rb +1 -1
- data/spec/api/{release_policies_beta_api_spec.rb → flag_release_plans_beta_api_spec.rb} +43 -56
- data/spec/models/agent_skill_patch_spec.rb +6 -0
- data/spec/models/agent_skill_post_spec.rb +6 -0
- data/spec/models/agent_skill_spec.rb +6 -0
- data/spec/models/ai_config_patch_spec.rb +12 -0
- data/spec/models/ai_config_post_spec.rb +6 -0
- data/spec/models/ai_config_spec.rb +6 -0
- data/spec/models/ai_config_targeting_environment_rule_clause_spec.rb +6 -0
- data/spec/models/ai_config_targeting_environment_rule_spec.rb +24 -0
- data/spec/models/ai_configs_metric_listing_rep_spec.rb +6 -0
- data/spec/models/{release_policy_spec.rb → create_flag_release_plan_request_spec.rb} +13 -19
- data/spec/models/{release_policies_access_allowed_reason_spec.rb → environment_release_plan_clause_spec.rb} +16 -16
- data/spec/models/{release_policies_access_rep_spec.rb → environment_release_plan_metric_spec.rb} +8 -8
- data/spec/models/environment_release_plan_phase_spec.rb +54 -0
- data/spec/models/environment_release_plan_progressive_release_rep_spec.rb +68 -0
- data/spec/models/environment_release_plan_progressive_release_spec.rb +68 -0
- data/spec/models/environment_release_plan_spec.rb +100 -0
- data/spec/models/{release_policies_access_allowed_rep_spec.rb → environment_release_plan_step_spec.rb} +14 -8
- data/spec/models/{release_policies_access_denied_spec.rb → environment_release_plans_link_spec.rb} +8 -8
- data/spec/models/{guarded_release_config_spec.rb → environment_release_plans_paginated_links_spec.rb} +11 -17
- data/spec/models/environment_release_plans_spec.rb +48 -0
- data/spec/models/environment_releases_metric_listing_rep_spec.rb +6 -0
- data/spec/models/{release_method_spec.rb → execution_mode_spec.rb} +6 -6
- data/spec/models/flag_release_plan_environment_spec.rb +54 -0
- data/spec/models/{release_policies_access_denied_reason_spec.rb → flag_release_plan_request_spec.rb} +18 -16
- data/spec/models/flag_release_plan_spec.rb +90 -0
- data/spec/models/{release_policy_scope_spec.rb → flag_release_plans_error_spec.rb} +8 -8
- data/spec/models/{release_policy_stage_spec.rb → flag_release_plans_link_spec.rb} +8 -8
- data/spec/models/{put_release_policy_request_spec.rb → flag_release_plans_paginated_links_spec.rb} +11 -11
- data/spec/models/list_flag_release_plans_response_spec.rb +48 -0
- data/spec/models/maintainer_identifier_member_spec.rb +46 -0
- data/spec/models/maintainer_identifier_spec.rb +44 -0
- data/spec/models/{progressive_release_config_spec.rb → maintainer_identifier_team_spec.rb} +12 -8
- data/spec/models/maintainer_response_member_spec.rb +64 -0
- data/spec/models/maintainer_response_spec.rb +44 -0
- data/spec/models/maintainer_response_team_spec.rb +52 -0
- data/spec/models/{release_policies_access_spec.rb → pinned_skill_tool_ref_spec.rb} +8 -8
- data/spec/models/{post_release_policy_request_spec.rb → post_environment_release_plan_request_spec.rb} +15 -17
- data/spec/models/put_default_environment_release_plan_request_spec.rb +36 -0
- data/spec/models/put_environment_release_plan_request_spec.rb +64 -0
- data/spec/models/put_flag_release_plan_request_spec.rb +78 -0
- data/spec/models/{release_policies_response_spec.rb → skill_tool_ref_spec.rb} +8 -8
- data/spec/models/tool_references_spec.rb +12 -0
- data/spec/models/tool_skill_reference_spec.rb +48 -0
- data/spec/models/trigger_type_spec.rb +30 -0
- metadata +141 -65
- data/docs/GuardedReleaseConfig.md +0 -28
- data/docs/PostReleasePolicyRequest.md +0 -28
- data/docs/ProgressiveReleaseConfig.md +0 -20
- data/docs/PutReleasePolicyRequest.md +0 -26
- data/docs/ReleasePoliciesAccess.md +0 -20
- data/docs/ReleasePoliciesAccessAllowedReason.md +0 -28
- data/docs/ReleasePoliciesAccessAllowedRep.md +0 -20
- data/docs/ReleasePoliciesAccessDenied.md +0 -20
- data/docs/ReleasePoliciesAccessDeniedReason.md +0 -28
- data/docs/ReleasePoliciesAccessRep.md +0 -20
- data/docs/ReleasePoliciesBetaApi.md +0 -466
- data/docs/ReleasePoliciesResponse.md +0 -20
- data/docs/ReleasePolicy.md +0 -34
- data/docs/ReleasePolicyScope.md +0 -20
- data/docs/ReleasePolicyStage.md +0 -20
- data/lib/launchdarkly_api/models/guarded_release_config.rb +0 -224
- data/lib/launchdarkly_api/models/release_policy_scope.rb +0 -181
data/docs/AgentControlApi.md
CHANGED
|
@@ -8,8 +8,8 @@ All URIs are relative to *https://app.launchdarkly.com*
|
|
|
8
8
|
| [**delete_agent_optimization**](AgentControlApi.md#delete_agent_optimization) | **DELETE** /api/v2/projects/{projectKey}/agent-optimizations/{optimizationKey} | Delete an agent optimization |
|
|
9
9
|
| [**delete_agent_optimization_run**](AgentControlApi.md#delete_agent_optimization_run) | **DELETE** /api/v2/projects/{projectKey}/agent-optimizations/{optimizationKey}/runs/{runId} | Delete an agent optimization run |
|
|
10
10
|
| [**delete_agent_skill**](AgentControlApi.md#delete_agent_skill) | **DELETE** /api/v2/projects/{projectKey}/ai-configs/skills/{skillKey} | Delete an agent skill |
|
|
11
|
-
| [**delete_ai_config**](AgentControlApi.md#delete_ai_config) | **DELETE** /api/v2/projects/{projectKey}/ai-configs/{configKey} | Delete
|
|
12
|
-
| [**delete_ai_config_variation**](AgentControlApi.md#delete_ai_config_variation) | **DELETE** /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey} | Delete
|
|
11
|
+
| [**delete_ai_config**](AgentControlApi.md#delete_ai_config) | **DELETE** /api/v2/projects/{projectKey}/ai-configs/{configKey} | Delete agent config |
|
|
12
|
+
| [**delete_ai_config_variation**](AgentControlApi.md#delete_ai_config_variation) | **DELETE** /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey} | Delete agent config variation |
|
|
13
13
|
| [**delete_ai_tool**](AgentControlApi.md#delete_ai_tool) | **DELETE** /api/v2/projects/{projectKey}/ai-tools/{toolKey} | Delete AI tool |
|
|
14
14
|
| [**delete_model_config**](AgentControlApi.md#delete_model_config) | **DELETE** /api/v2/projects/{projectKey}/ai-configs/model-configs/{modelConfigKey} | Delete an AI model config |
|
|
15
15
|
| [**delete_prompt_snippet**](AgentControlApi.md#delete_prompt_snippet) | **DELETE** /api/v2/projects/{projectKey}/ai-configs/prompt-snippets/{snippetKey} | Delete a prompt snippet |
|
|
@@ -17,13 +17,13 @@ All URIs are relative to *https://app.launchdarkly.com*
|
|
|
17
17
|
| [**get_agent_graph**](AgentControlApi.md#get_agent_graph) | **GET** /api/v2/projects/{projectKey}/agent-graphs/{graphKey} | Get agent graph |
|
|
18
18
|
| [**get_agent_optimization**](AgentControlApi.md#get_agent_optimization) | **GET** /api/v2/projects/{projectKey}/agent-optimizations/{optimizationKey} | Get an agent optimization |
|
|
19
19
|
| [**get_agent_skill**](AgentControlApi.md#get_agent_skill) | **GET** /api/v2/projects/{projectKey}/ai-configs/skills/{skillKey} | Get an agent skill |
|
|
20
|
-
| [**get_ai_config**](AgentControlApi.md#get_ai_config) | **GET** /api/v2/projects/{projectKey}/ai-configs/{configKey} | Get
|
|
21
|
-
| [**get_ai_config_metrics**](AgentControlApi.md#get_ai_config_metrics) | **GET** /api/v2/projects/{projectKey}/ai-configs/{configKey}/metrics | Get
|
|
22
|
-
| [**get_ai_config_metrics_by_variation**](AgentControlApi.md#get_ai_config_metrics_by_variation) | **GET** /api/v2/projects/{projectKey}/ai-configs/{configKey}/metrics-by-variation | Get
|
|
23
|
-
| [**get_ai_config_quick_stats**](AgentControlApi.md#get_ai_config_quick_stats) | **GET** /api/v2/projects/{projectKey}/ai-configs/quick-stats | Get
|
|
24
|
-
| [**get_ai_config_targeting**](AgentControlApi.md#get_ai_config_targeting) | **GET** /api/v2/projects/{projectKey}/ai-configs/{configKey}/targeting | Show an
|
|
25
|
-
| [**get_ai_config_variation**](AgentControlApi.md#get_ai_config_variation) | **GET** /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey} | Get
|
|
26
|
-
| [**get_ai_configs**](AgentControlApi.md#get_ai_configs) | **GET** /api/v2/projects/{projectKey}/ai-configs | List
|
|
20
|
+
| [**get_ai_config**](AgentControlApi.md#get_ai_config) | **GET** /api/v2/projects/{projectKey}/ai-configs/{configKey} | Get agent config |
|
|
21
|
+
| [**get_ai_config_metrics**](AgentControlApi.md#get_ai_config_metrics) | **GET** /api/v2/projects/{projectKey}/ai-configs/{configKey}/metrics | Get agent config metrics |
|
|
22
|
+
| [**get_ai_config_metrics_by_variation**](AgentControlApi.md#get_ai_config_metrics_by_variation) | **GET** /api/v2/projects/{projectKey}/ai-configs/{configKey}/metrics-by-variation | Get agent config metrics by variation |
|
|
23
|
+
| [**get_ai_config_quick_stats**](AgentControlApi.md#get_ai_config_quick_stats) | **GET** /api/v2/projects/{projectKey}/ai-configs/quick-stats | Get agent config quick stats |
|
|
24
|
+
| [**get_ai_config_targeting**](AgentControlApi.md#get_ai_config_targeting) | **GET** /api/v2/projects/{projectKey}/ai-configs/{configKey}/targeting | Show an agent config's targeting |
|
|
25
|
+
| [**get_ai_config_variation**](AgentControlApi.md#get_ai_config_variation) | **GET** /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey} | Get agent config variation |
|
|
26
|
+
| [**get_ai_configs**](AgentControlApi.md#get_ai_configs) | **GET** /api/v2/projects/{projectKey}/ai-configs | List agent configs |
|
|
27
27
|
| [**get_ai_tool**](AgentControlApi.md#get_ai_tool) | **GET** /api/v2/projects/{projectKey}/ai-tools/{toolKey} | Get AI tool |
|
|
28
28
|
| [**get_model_config**](AgentControlApi.md#get_model_config) | **GET** /api/v2/projects/{projectKey}/ai-configs/model-configs/{modelConfigKey} | Get AI model config |
|
|
29
29
|
| [**get_prompt_snippet**](AgentControlApi.md#get_prompt_snippet) | **GET** /api/v2/projects/{projectKey}/ai-configs/prompt-snippets/{snippetKey} | Get a prompt snippet |
|
|
@@ -48,9 +48,9 @@ All URIs are relative to *https://app.launchdarkly.com*
|
|
|
48
48
|
| [**patch_agent_optimization**](AgentControlApi.md#patch_agent_optimization) | **PATCH** /api/v2/projects/{projectKey}/agent-optimizations/{optimizationKey} | Update an agent optimization |
|
|
49
49
|
| [**patch_agent_optimization_result**](AgentControlApi.md#patch_agent_optimization_result) | **PATCH** /api/v2/projects/{projectKey}/agent-optimizations/{optimizationKey}/results/{resultId} | Update an agent optimization result |
|
|
50
50
|
| [**patch_agent_skill**](AgentControlApi.md#patch_agent_skill) | **PATCH** /api/v2/projects/{projectKey}/ai-configs/skills/{skillKey} | Update an agent skill |
|
|
51
|
-
| [**patch_ai_config**](AgentControlApi.md#patch_ai_config) | **PATCH** /api/v2/projects/{projectKey}/ai-configs/{configKey} | Update
|
|
52
|
-
| [**patch_ai_config_targeting**](AgentControlApi.md#patch_ai_config_targeting) | **PATCH** /api/v2/projects/{projectKey}/ai-configs/{configKey}/targeting | Update
|
|
53
|
-
| [**patch_ai_config_variation**](AgentControlApi.md#patch_ai_config_variation) | **PATCH** /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey} | Update
|
|
51
|
+
| [**patch_ai_config**](AgentControlApi.md#patch_ai_config) | **PATCH** /api/v2/projects/{projectKey}/ai-configs/{configKey} | Update agent config |
|
|
52
|
+
| [**patch_ai_config_targeting**](AgentControlApi.md#patch_ai_config_targeting) | **PATCH** /api/v2/projects/{projectKey}/ai-configs/{configKey}/targeting | Update agent config targeting |
|
|
53
|
+
| [**patch_ai_config_variation**](AgentControlApi.md#patch_ai_config_variation) | **PATCH** /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey} | Update agent config variation |
|
|
54
54
|
| [**patch_ai_tool**](AgentControlApi.md#patch_ai_tool) | **PATCH** /api/v2/projects/{projectKey}/ai-tools/{toolKey} | Update AI tool |
|
|
55
55
|
| [**patch_model_config**](AgentControlApi.md#patch_model_config) | **PATCH** /api/v2/projects/{projectKey}/ai-configs/model-configs/{modelConfigKey} | Update an AI model config |
|
|
56
56
|
| [**patch_prompt_snippet**](AgentControlApi.md#patch_prompt_snippet) | **PATCH** /api/v2/projects/{projectKey}/ai-configs/prompt-snippets/{snippetKey} | Update a prompt snippet |
|
|
@@ -58,8 +58,8 @@ All URIs are relative to *https://app.launchdarkly.com*
|
|
|
58
58
|
| [**post_agent_optimization**](AgentControlApi.md#post_agent_optimization) | **POST** /api/v2/projects/{projectKey}/agent-optimizations | Create agent optimization |
|
|
59
59
|
| [**post_agent_optimization_result**](AgentControlApi.md#post_agent_optimization_result) | **POST** /api/v2/projects/{projectKey}/agent-optimizations/{optimizationKey}/results | Create agent optimization result |
|
|
60
60
|
| [**post_agent_skill**](AgentControlApi.md#post_agent_skill) | **POST** /api/v2/projects/{projectKey}/ai-configs/skills | Create an agent skill |
|
|
61
|
-
| [**post_ai_config**](AgentControlApi.md#post_ai_config) | **POST** /api/v2/projects/{projectKey}/ai-configs | Create new
|
|
62
|
-
| [**post_ai_config_variation**](AgentControlApi.md#post_ai_config_variation) | **POST** /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations | Create
|
|
61
|
+
| [**post_ai_config**](AgentControlApi.md#post_ai_config) | **POST** /api/v2/projects/{projectKey}/ai-configs | Create new agent config |
|
|
62
|
+
| [**post_ai_config_variation**](AgentControlApi.md#post_ai_config_variation) | **POST** /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations | Create agent config variation |
|
|
63
63
|
| [**post_ai_tool**](AgentControlApi.md#post_ai_tool) | **POST** /api/v2/projects/{projectKey}/ai-tools | Create an AI tool |
|
|
64
64
|
| [**post_model_config**](AgentControlApi.md#post_model_config) | **POST** /api/v2/projects/{projectKey}/ai-configs/model-configs | Create an AI model config |
|
|
65
65
|
| [**post_prompt_snippet**](AgentControlApi.md#post_prompt_snippet) | **POST** /api/v2/projects/{projectKey}/ai-configs/prompt-snippets | Create a prompt snippet |
|
|
@@ -364,9 +364,9 @@ nil (empty response body)
|
|
|
364
364
|
|
|
365
365
|
> delete_ai_config(project_key, config_key)
|
|
366
366
|
|
|
367
|
-
Delete
|
|
367
|
+
Delete agent config
|
|
368
368
|
|
|
369
|
-
Delete an existing
|
|
369
|
+
Delete an existing agent config.
|
|
370
370
|
|
|
371
371
|
### Examples
|
|
372
372
|
|
|
@@ -383,10 +383,10 @@ end
|
|
|
383
383
|
|
|
384
384
|
api_instance = LaunchDarklyApi::AgentControlApi.new
|
|
385
385
|
project_key = 'default' # String | The project key
|
|
386
|
-
config_key = 'config_key_example' # String | The
|
|
386
|
+
config_key = 'config_key_example' # String | The agent config key
|
|
387
387
|
|
|
388
388
|
begin
|
|
389
|
-
# Delete
|
|
389
|
+
# Delete agent config
|
|
390
390
|
api_instance.delete_ai_config(project_key, config_key)
|
|
391
391
|
rescue LaunchDarklyApi::ApiError => e
|
|
392
392
|
puts "Error when calling AgentControlApi->delete_ai_config: #{e}"
|
|
@@ -401,7 +401,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
|
|
|
401
401
|
|
|
402
402
|
```ruby
|
|
403
403
|
begin
|
|
404
|
-
# Delete
|
|
404
|
+
# Delete agent config
|
|
405
405
|
data, status_code, headers = api_instance.delete_ai_config_with_http_info(project_key, config_key)
|
|
406
406
|
p status_code # => 2xx
|
|
407
407
|
p headers # => { ... }
|
|
@@ -416,7 +416,7 @@ end
|
|
|
416
416
|
| Name | Type | Description | Notes |
|
|
417
417
|
| ---- | ---- | ----------- | ----- |
|
|
418
418
|
| **project_key** | **String** | The project key | |
|
|
419
|
-
| **config_key** | **String** | The
|
|
419
|
+
| **config_key** | **String** | The agent config key | |
|
|
420
420
|
|
|
421
421
|
### Return type
|
|
422
422
|
|
|
@@ -436,9 +436,9 @@ nil (empty response body)
|
|
|
436
436
|
|
|
437
437
|
> delete_ai_config_variation(project_key, config_key, variation_key)
|
|
438
438
|
|
|
439
|
-
Delete
|
|
439
|
+
Delete agent config variation
|
|
440
440
|
|
|
441
|
-
Delete a specific variation of an
|
|
441
|
+
Delete a specific variation of an agent config by config key and variation key.
|
|
442
442
|
|
|
443
443
|
### Examples
|
|
444
444
|
|
|
@@ -455,11 +455,11 @@ end
|
|
|
455
455
|
|
|
456
456
|
api_instance = LaunchDarklyApi::AgentControlApi.new
|
|
457
457
|
project_key = 'project_key_example' # String | The project key
|
|
458
|
-
config_key = 'config_key_example' # String | The
|
|
459
|
-
variation_key = 'variation_key_example' # String | The
|
|
458
|
+
config_key = 'config_key_example' # String | The agent config key
|
|
459
|
+
variation_key = 'variation_key_example' # String | The agent config variation key
|
|
460
460
|
|
|
461
461
|
begin
|
|
462
|
-
# Delete
|
|
462
|
+
# Delete agent config variation
|
|
463
463
|
api_instance.delete_ai_config_variation(project_key, config_key, variation_key)
|
|
464
464
|
rescue LaunchDarklyApi::ApiError => e
|
|
465
465
|
puts "Error when calling AgentControlApi->delete_ai_config_variation: #{e}"
|
|
@@ -474,7 +474,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
|
|
|
474
474
|
|
|
475
475
|
```ruby
|
|
476
476
|
begin
|
|
477
|
-
# Delete
|
|
477
|
+
# Delete agent config variation
|
|
478
478
|
data, status_code, headers = api_instance.delete_ai_config_variation_with_http_info(project_key, config_key, variation_key)
|
|
479
479
|
p status_code # => 2xx
|
|
480
480
|
p headers # => { ... }
|
|
@@ -489,8 +489,8 @@ end
|
|
|
489
489
|
| Name | Type | Description | Notes |
|
|
490
490
|
| ---- | ---- | ----------- | ----- |
|
|
491
491
|
| **project_key** | **String** | The project key | |
|
|
492
|
-
| **config_key** | **String** | The
|
|
493
|
-
| **variation_key** | **String** | The
|
|
492
|
+
| **config_key** | **String** | The agent config key | |
|
|
493
|
+
| **variation_key** | **String** | The agent config variation key | |
|
|
494
494
|
|
|
495
495
|
### Return type
|
|
496
496
|
|
|
@@ -1019,9 +1019,9 @@ end
|
|
|
1019
1019
|
|
|
1020
1020
|
> <AIConfig> get_ai_config(project_key, config_key)
|
|
1021
1021
|
|
|
1022
|
-
Get
|
|
1022
|
+
Get agent config
|
|
1023
1023
|
|
|
1024
|
-
Retrieve a specific
|
|
1024
|
+
Retrieve a specific agent config by its key.
|
|
1025
1025
|
|
|
1026
1026
|
### Examples
|
|
1027
1027
|
|
|
@@ -1038,10 +1038,10 @@ end
|
|
|
1038
1038
|
|
|
1039
1039
|
api_instance = LaunchDarklyApi::AgentControlApi.new
|
|
1040
1040
|
project_key = 'project_key_example' # String | The project key
|
|
1041
|
-
config_key = 'config_key_example' # String | The
|
|
1041
|
+
config_key = 'config_key_example' # String | The agent config key
|
|
1042
1042
|
|
|
1043
1043
|
begin
|
|
1044
|
-
# Get
|
|
1044
|
+
# Get agent config
|
|
1045
1045
|
result = api_instance.get_ai_config(project_key, config_key)
|
|
1046
1046
|
p result
|
|
1047
1047
|
rescue LaunchDarklyApi::ApiError => e
|
|
@@ -1057,7 +1057,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
1057
1057
|
|
|
1058
1058
|
```ruby
|
|
1059
1059
|
begin
|
|
1060
|
-
# Get
|
|
1060
|
+
# Get agent config
|
|
1061
1061
|
data, status_code, headers = api_instance.get_ai_config_with_http_info(project_key, config_key)
|
|
1062
1062
|
p status_code # => 2xx
|
|
1063
1063
|
p headers # => { ... }
|
|
@@ -1072,7 +1072,7 @@ end
|
|
|
1072
1072
|
| Name | Type | Description | Notes |
|
|
1073
1073
|
| ---- | ---- | ----------- | ----- |
|
|
1074
1074
|
| **project_key** | **String** | The project key | |
|
|
1075
|
-
| **config_key** | **String** | The
|
|
1075
|
+
| **config_key** | **String** | The agent config key | |
|
|
1076
1076
|
|
|
1077
1077
|
### Return type
|
|
1078
1078
|
|
|
@@ -1092,9 +1092,9 @@ end
|
|
|
1092
1092
|
|
|
1093
1093
|
> <Metrics> get_ai_config_metrics(project_key, config_key, from, to, env, opts)
|
|
1094
1094
|
|
|
1095
|
-
Get
|
|
1095
|
+
Get agent config metrics
|
|
1096
1096
|
|
|
1097
|
-
Retrieve usage metrics for an
|
|
1097
|
+
Retrieve usage metrics for an agent config by config key.
|
|
1098
1098
|
|
|
1099
1099
|
### Examples
|
|
1100
1100
|
|
|
@@ -1111,7 +1111,7 @@ end
|
|
|
1111
1111
|
|
|
1112
1112
|
api_instance = LaunchDarklyApi::AgentControlApi.new
|
|
1113
1113
|
project_key = 'project_key_example' # String | The project key
|
|
1114
|
-
config_key = 'config_key_example' # String | The
|
|
1114
|
+
config_key = 'config_key_example' # String | The agent config key
|
|
1115
1115
|
from = 56 # Integer | The starting time, as milliseconds since epoch (inclusive).
|
|
1116
1116
|
to = 56 # Integer | The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`.
|
|
1117
1117
|
env = 'env_example' # String | An environment key. Only metrics from this environment will be included.
|
|
@@ -1121,7 +1121,7 @@ opts = {
|
|
|
1121
1121
|
}
|
|
1122
1122
|
|
|
1123
1123
|
begin
|
|
1124
|
-
# Get
|
|
1124
|
+
# Get agent config metrics
|
|
1125
1125
|
result = api_instance.get_ai_config_metrics(project_key, config_key, from, to, env, opts)
|
|
1126
1126
|
p result
|
|
1127
1127
|
rescue LaunchDarklyApi::ApiError => e
|
|
@@ -1137,7 +1137,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
1137
1137
|
|
|
1138
1138
|
```ruby
|
|
1139
1139
|
begin
|
|
1140
|
-
# Get
|
|
1140
|
+
# Get agent config metrics
|
|
1141
1141
|
data, status_code, headers = api_instance.get_ai_config_metrics_with_http_info(project_key, config_key, from, to, env, opts)
|
|
1142
1142
|
p status_code # => 2xx
|
|
1143
1143
|
p headers # => { ... }
|
|
@@ -1152,7 +1152,7 @@ end
|
|
|
1152
1152
|
| Name | Type | Description | Notes |
|
|
1153
1153
|
| ---- | ---- | ----------- | ----- |
|
|
1154
1154
|
| **project_key** | **String** | The project key | |
|
|
1155
|
-
| **config_key** | **String** | The
|
|
1155
|
+
| **config_key** | **String** | The agent config key | |
|
|
1156
1156
|
| **from** | **Integer** | The starting time, as milliseconds since epoch (inclusive). | |
|
|
1157
1157
|
| **to** | **Integer** | The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`. | |
|
|
1158
1158
|
| **env** | **String** | An environment key. Only metrics from this environment will be included. | |
|
|
@@ -1177,9 +1177,9 @@ end
|
|
|
1177
1177
|
|
|
1178
1178
|
> <Array<MetricByVariation>> get_ai_config_metrics_by_variation(project_key, config_key, from, to, env, opts)
|
|
1179
1179
|
|
|
1180
|
-
Get
|
|
1180
|
+
Get agent config metrics by variation
|
|
1181
1181
|
|
|
1182
|
-
Retrieve usage metrics for an
|
|
1182
|
+
Retrieve usage metrics for an agent config by config key, with results split by variation.
|
|
1183
1183
|
|
|
1184
1184
|
### Examples
|
|
1185
1185
|
|
|
@@ -1196,7 +1196,7 @@ end
|
|
|
1196
1196
|
|
|
1197
1197
|
api_instance = LaunchDarklyApi::AgentControlApi.new
|
|
1198
1198
|
project_key = 'project_key_example' # String | The project key
|
|
1199
|
-
config_key = 'config_key_example' # String | The
|
|
1199
|
+
config_key = 'config_key_example' # String | The agent config key
|
|
1200
1200
|
from = 56 # Integer | The starting time, as milliseconds since epoch (inclusive).
|
|
1201
1201
|
to = 56 # Integer | The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`.
|
|
1202
1202
|
env = 'env_example' # String | An environment key. Only metrics from this environment will be included.
|
|
@@ -1206,7 +1206,7 @@ opts = {
|
|
|
1206
1206
|
}
|
|
1207
1207
|
|
|
1208
1208
|
begin
|
|
1209
|
-
# Get
|
|
1209
|
+
# Get agent config metrics by variation
|
|
1210
1210
|
result = api_instance.get_ai_config_metrics_by_variation(project_key, config_key, from, to, env, opts)
|
|
1211
1211
|
p result
|
|
1212
1212
|
rescue LaunchDarklyApi::ApiError => e
|
|
@@ -1222,7 +1222,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
1222
1222
|
|
|
1223
1223
|
```ruby
|
|
1224
1224
|
begin
|
|
1225
|
-
# Get
|
|
1225
|
+
# Get agent config metrics by variation
|
|
1226
1226
|
data, status_code, headers = api_instance.get_ai_config_metrics_by_variation_with_http_info(project_key, config_key, from, to, env, opts)
|
|
1227
1227
|
p status_code # => 2xx
|
|
1228
1228
|
p headers # => { ... }
|
|
@@ -1237,7 +1237,7 @@ end
|
|
|
1237
1237
|
| Name | Type | Description | Notes |
|
|
1238
1238
|
| ---- | ---- | ----------- | ----- |
|
|
1239
1239
|
| **project_key** | **String** | The project key | |
|
|
1240
|
-
| **config_key** | **String** | The
|
|
1240
|
+
| **config_key** | **String** | The agent config key | |
|
|
1241
1241
|
| **from** | **Integer** | The starting time, as milliseconds since epoch (inclusive). | |
|
|
1242
1242
|
| **to** | **Integer** | The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`. | |
|
|
1243
1243
|
| **env** | **String** | An environment key. Only metrics from this environment will be included. | |
|
|
@@ -1262,9 +1262,9 @@ end
|
|
|
1262
1262
|
|
|
1263
1263
|
> <QuickStats> get_ai_config_quick_stats(project_key, env)
|
|
1264
1264
|
|
|
1265
|
-
Get
|
|
1265
|
+
Get agent config quick stats
|
|
1266
1266
|
|
|
1267
|
-
Retrieve aggregate quick stats for
|
|
1267
|
+
Retrieve aggregate quick stats for agent configs in a project.
|
|
1268
1268
|
|
|
1269
1269
|
### Examples
|
|
1270
1270
|
|
|
@@ -1284,7 +1284,7 @@ project_key = 'project_key_example' # String | The project key
|
|
|
1284
1284
|
env = 'env_example' # String | An environment key. Only metrics from this environment will be included.
|
|
1285
1285
|
|
|
1286
1286
|
begin
|
|
1287
|
-
# Get
|
|
1287
|
+
# Get agent config quick stats
|
|
1288
1288
|
result = api_instance.get_ai_config_quick_stats(project_key, env)
|
|
1289
1289
|
p result
|
|
1290
1290
|
rescue LaunchDarklyApi::ApiError => e
|
|
@@ -1300,7 +1300,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
1300
1300
|
|
|
1301
1301
|
```ruby
|
|
1302
1302
|
begin
|
|
1303
|
-
# Get
|
|
1303
|
+
# Get agent config quick stats
|
|
1304
1304
|
data, status_code, headers = api_instance.get_ai_config_quick_stats_with_http_info(project_key, env)
|
|
1305
1305
|
p status_code # => 2xx
|
|
1306
1306
|
p headers # => { ... }
|
|
@@ -1335,9 +1335,9 @@ end
|
|
|
1335
1335
|
|
|
1336
1336
|
> <AIConfigTargeting> get_ai_config_targeting(project_key, config_key)
|
|
1337
1337
|
|
|
1338
|
-
Show an
|
|
1338
|
+
Show an agent config's targeting
|
|
1339
1339
|
|
|
1340
|
-
Retrieves a specific
|
|
1340
|
+
Retrieves a specific agent config's targeting by its key
|
|
1341
1341
|
|
|
1342
1342
|
### Examples
|
|
1343
1343
|
|
|
@@ -1354,10 +1354,10 @@ end
|
|
|
1354
1354
|
|
|
1355
1355
|
api_instance = LaunchDarklyApi::AgentControlApi.new
|
|
1356
1356
|
project_key = 'project_key_example' # String | The project key
|
|
1357
|
-
config_key = 'config_key_example' # String | The
|
|
1357
|
+
config_key = 'config_key_example' # String | The agent config key
|
|
1358
1358
|
|
|
1359
1359
|
begin
|
|
1360
|
-
# Show an
|
|
1360
|
+
# Show an agent config's targeting
|
|
1361
1361
|
result = api_instance.get_ai_config_targeting(project_key, config_key)
|
|
1362
1362
|
p result
|
|
1363
1363
|
rescue LaunchDarklyApi::ApiError => e
|
|
@@ -1373,7 +1373,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
1373
1373
|
|
|
1374
1374
|
```ruby
|
|
1375
1375
|
begin
|
|
1376
|
-
# Show an
|
|
1376
|
+
# Show an agent config's targeting
|
|
1377
1377
|
data, status_code, headers = api_instance.get_ai_config_targeting_with_http_info(project_key, config_key)
|
|
1378
1378
|
p status_code # => 2xx
|
|
1379
1379
|
p headers # => { ... }
|
|
@@ -1388,7 +1388,7 @@ end
|
|
|
1388
1388
|
| Name | Type | Description | Notes |
|
|
1389
1389
|
| ---- | ---- | ----------- | ----- |
|
|
1390
1390
|
| **project_key** | **String** | The project key | |
|
|
1391
|
-
| **config_key** | **String** | The
|
|
1391
|
+
| **config_key** | **String** | The agent config key | |
|
|
1392
1392
|
|
|
1393
1393
|
### Return type
|
|
1394
1394
|
|
|
@@ -1408,9 +1408,9 @@ end
|
|
|
1408
1408
|
|
|
1409
1409
|
> <AIConfigVariationsResponse> get_ai_config_variation(project_key, config_key, variation_key)
|
|
1410
1410
|
|
|
1411
|
-
Get
|
|
1411
|
+
Get agent config variation
|
|
1412
1412
|
|
|
1413
|
-
Get an
|
|
1413
|
+
Get an agent config variation by key. The response includes all variation versions for the given variation key.
|
|
1414
1414
|
|
|
1415
1415
|
### Examples
|
|
1416
1416
|
|
|
@@ -1427,11 +1427,11 @@ end
|
|
|
1427
1427
|
|
|
1428
1428
|
api_instance = LaunchDarklyApi::AgentControlApi.new
|
|
1429
1429
|
project_key = 'default' # String | The project key
|
|
1430
|
-
config_key = 'default' # String | The
|
|
1431
|
-
variation_key = 'default' # String | The
|
|
1430
|
+
config_key = 'default' # String | The agent config key
|
|
1431
|
+
variation_key = 'default' # String | The agent config variation key
|
|
1432
1432
|
|
|
1433
1433
|
begin
|
|
1434
|
-
# Get
|
|
1434
|
+
# Get agent config variation
|
|
1435
1435
|
result = api_instance.get_ai_config_variation(project_key, config_key, variation_key)
|
|
1436
1436
|
p result
|
|
1437
1437
|
rescue LaunchDarklyApi::ApiError => e
|
|
@@ -1447,7 +1447,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
1447
1447
|
|
|
1448
1448
|
```ruby
|
|
1449
1449
|
begin
|
|
1450
|
-
# Get
|
|
1450
|
+
# Get agent config variation
|
|
1451
1451
|
data, status_code, headers = api_instance.get_ai_config_variation_with_http_info(project_key, config_key, variation_key)
|
|
1452
1452
|
p status_code # => 2xx
|
|
1453
1453
|
p headers # => { ... }
|
|
@@ -1462,8 +1462,8 @@ end
|
|
|
1462
1462
|
| Name | Type | Description | Notes |
|
|
1463
1463
|
| ---- | ---- | ----------- | ----- |
|
|
1464
1464
|
| **project_key** | **String** | The project key | |
|
|
1465
|
-
| **config_key** | **String** | The
|
|
1466
|
-
| **variation_key** | **String** | The
|
|
1465
|
+
| **config_key** | **String** | The agent config key | |
|
|
1466
|
+
| **variation_key** | **String** | The agent config variation key | |
|
|
1467
1467
|
|
|
1468
1468
|
### Return type
|
|
1469
1469
|
|
|
@@ -1483,9 +1483,9 @@ end
|
|
|
1483
1483
|
|
|
1484
1484
|
> <AIConfigs> get_ai_configs(project_key, opts)
|
|
1485
1485
|
|
|
1486
|
-
List
|
|
1486
|
+
List agent configs
|
|
1487
1487
|
|
|
1488
|
-
Get a list of all
|
|
1488
|
+
Get a list of all agent configs in the given project.
|
|
1489
1489
|
|
|
1490
1490
|
### Examples
|
|
1491
1491
|
|
|
@@ -1510,7 +1510,7 @@ opts = {
|
|
|
1510
1510
|
}
|
|
1511
1511
|
|
|
1512
1512
|
begin
|
|
1513
|
-
# List
|
|
1513
|
+
# List agent configs
|
|
1514
1514
|
result = api_instance.get_ai_configs(project_key, opts)
|
|
1515
1515
|
p result
|
|
1516
1516
|
rescue LaunchDarklyApi::ApiError => e
|
|
@@ -1526,7 +1526,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
1526
1526
|
|
|
1527
1527
|
```ruby
|
|
1528
1528
|
begin
|
|
1529
|
-
# List
|
|
1529
|
+
# List agent configs
|
|
1530
1530
|
data, status_code, headers = api_instance.get_ai_configs_with_http_info(project_key, opts)
|
|
1531
1531
|
p status_code # => 2xx
|
|
1532
1532
|
p headers # => { ... }
|
|
@@ -2103,7 +2103,7 @@ end
|
|
|
2103
2103
|
|
|
2104
2104
|
List agent optimizations
|
|
2105
2105
|
|
|
2106
|
-
Get a list of all agent optimizations in the given project.
|
|
2106
|
+
Get a list of all agent optimizations in the given project. ### Filtering optimizations The `filter` parameter supports the following fields and operators: - `query` with the `equals` operator: case-insensitive substring match on the optimization key, label, or AgentControl config key. - `aiConfigKey` with the `equals` operator: exact match on the key of the AgentControl config being optimized. Separate multiple fields with a comma, for example `filter=aiConfigKey equals \"my-agent\",query equals \"tone\"`.
|
|
2107
2107
|
|
|
2108
2108
|
### Examples
|
|
2109
2109
|
|
|
@@ -2421,7 +2421,7 @@ end
|
|
|
2421
2421
|
|
|
2422
2422
|
List AI tool references
|
|
2423
2423
|
|
|
2424
|
-
Get all AgentControl config variations that currently reference this tool.
|
|
2424
|
+
Get all AgentControl config variations that currently reference this tool, and every agent skill version that pins it. The same `limit` and `offset` apply to `items` and to `skills`, and each list is paged on its own. The pagination links follow whichever list has more entries, so keep requesting `next` until both lists are complete, or use `totalCount` and `skillsTotalCount`.
|
|
2425
2425
|
|
|
2426
2426
|
### Examples
|
|
2427
2427
|
|
|
@@ -3440,9 +3440,9 @@ end
|
|
|
3440
3440
|
|
|
3441
3441
|
> <AIConfig> patch_ai_config(project_key, config_key, opts)
|
|
3442
3442
|
|
|
3443
|
-
Update
|
|
3443
|
+
Update agent config
|
|
3444
3444
|
|
|
3445
|
-
Edit an existing
|
|
3445
|
+
Edit an existing agent config. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. Here's an example: ``` { \"description\": \"Example updated description\", \"tags\": [\"new-tag\"] } ```
|
|
3446
3446
|
|
|
3447
3447
|
### Examples
|
|
3448
3448
|
|
|
@@ -3459,13 +3459,13 @@ end
|
|
|
3459
3459
|
|
|
3460
3460
|
api_instance = LaunchDarklyApi::AgentControlApi.new
|
|
3461
3461
|
project_key = 'project_key_example' # String | The project key
|
|
3462
|
-
config_key = 'config_key_example' # String | The
|
|
3462
|
+
config_key = 'config_key_example' # String | The agent config key
|
|
3463
3463
|
opts = {
|
|
3464
|
-
ai_config_patch: LaunchDarklyApi::AIConfigPatch.new # AIConfigPatch |
|
|
3464
|
+
ai_config_patch: LaunchDarklyApi::AIConfigPatch.new # AIConfigPatch | Agent config object to update
|
|
3465
3465
|
}
|
|
3466
3466
|
|
|
3467
3467
|
begin
|
|
3468
|
-
# Update
|
|
3468
|
+
# Update agent config
|
|
3469
3469
|
result = api_instance.patch_ai_config(project_key, config_key, opts)
|
|
3470
3470
|
p result
|
|
3471
3471
|
rescue LaunchDarklyApi::ApiError => e
|
|
@@ -3481,7 +3481,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
3481
3481
|
|
|
3482
3482
|
```ruby
|
|
3483
3483
|
begin
|
|
3484
|
-
# Update
|
|
3484
|
+
# Update agent config
|
|
3485
3485
|
data, status_code, headers = api_instance.patch_ai_config_with_http_info(project_key, config_key, opts)
|
|
3486
3486
|
p status_code # => 2xx
|
|
3487
3487
|
p headers # => { ... }
|
|
@@ -3496,8 +3496,8 @@ end
|
|
|
3496
3496
|
| Name | Type | Description | Notes |
|
|
3497
3497
|
| ---- | ---- | ----------- | ----- |
|
|
3498
3498
|
| **project_key** | **String** | The project key | |
|
|
3499
|
-
| **config_key** | **String** | The
|
|
3500
|
-
| **ai_config_patch** | [**AIConfigPatch**](AIConfigPatch.md) |
|
|
3499
|
+
| **config_key** | **String** | The agent config key | |
|
|
3500
|
+
| **ai_config_patch** | [**AIConfigPatch**](AIConfigPatch.md) | Agent config object to update | [optional] |
|
|
3501
3501
|
|
|
3502
3502
|
### Return type
|
|
3503
3503
|
|
|
@@ -3517,9 +3517,9 @@ end
|
|
|
3517
3517
|
|
|
3518
3518
|
> <AIConfigTargeting> patch_ai_config_targeting(project_key, config_key, opts)
|
|
3519
3519
|
|
|
3520
|
-
Update
|
|
3520
|
+
Update agent config targeting
|
|
3521
3521
|
|
|
3522
|
-
Perform a partial update to an AI Config's targeting. The request body must be a valid semantic patch. ### Using semantic patches on an AI Config To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). The body of a semantic patch request for updating an AI Config's targeting takes the following properties: * `comment` (string): (Optional) A description of the update. * `environmentKey` (string): The key of the LaunchDarkly environment. * `instructions` (array): (Required) A list of actions the update should perform. Each action in the list must be an object with a `kind` property that indicates the instruction. If the action requires parameters, you must include those parameters as additional fields in the object. The body of a single semantic patch can contain many different instructions. ### Instructions Semantic patch requests support the following `kind` instructions for updating AI Configs. <details> <summary>Click to expand instructions for <strong>working with targeting and variations</strong> for AI Configs</summary> #### addClauses Adds the given clauses to the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the AI Config. - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addClauses\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauses\": [{ \"contextKind\": \"user\", \"attribute\": \"country\", \"op\": \"in\", \"negate\": false, \"values\": [\"USA\", \"Canada\"] }] }] } ``` #### addRule Adds a new targeting rule to the AI Config. The rule may contain `clauses` and serve the variation that `variationId` indicates, or serve a percentage rollout that `rolloutWeights`, `rolloutBucketBy`, and `rolloutContextKind` indicate. If you set `beforeRuleId`, this adds the new rule before the indicated rule. Otherwise, adds the new rule to the end of the list. ##### Parameters - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. - `beforeRuleId`: (Optional) ID of a rule. - Either - `variationId`: ID of a variation. or - `rolloutWeights`: (Optional) Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here's an example that uses a `variationId`: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addRule\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"clauses\": [{ \"contextKind\": \"organization\", \"attribute\": \"located_in\", \"op\": \"in\", \"negate\": false, \"values\": [\"Sweden\", \"Norway\"] }] }] } ``` Here's an example that uses a percentage rollout: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addRule\", \"clauses\": [{ \"contextKind\": \"organization\", \"attribute\": \"located_in\", \"op\": \"in\", \"negate\": false, \"values\": [\"Sweden\", \"Norway\"] }], \"rolloutContextKind\": \"organization\", \"rolloutWeights\": { \"2f43f67c-3e4e-4945-a18a-26559378ca00\": 15000, // serve 15% this variation \"e5830889-1ec5-4b0c-9cc9-c48790090c43\": 85000 // serve 85% this variation } }] } ``` #### addTargets Adds context keys to the individual context targets for the context kind that `contextKind` specifies and the variation that `variationId` specifies. Returns an error if this causes the AI Config to target the same context key in multiple variations. ##### Parameters - `values`: List of context keys. - `contextKind`: (Optional) Context kind to target, defaults to `user` - `variationId`: ID of a variation. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addTargets\", \"values\": [\"context-key-123abc\", \"context-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### addValuesToClause Adds `values` to the values of the clause that `ruleId` and `clauseId` indicate. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the AI Config. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addValuesToClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### clearTargets Removes all individual targets from the variation that `variationId` specifies. This includes both user and non-user targets. ##### Parameters - `variationId`: ID of a variation. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"clearTargets\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### removeClauses Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule. - `clauseIds`: Array of IDs of clauses in the rule. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeClauses\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseIds\": [\"10a58772-3121-400f-846b-b8a04e8944ed\", \"36a461dc-235e-4b08-97b9-73ce9365873e\"] }] } ``` #### removeRule Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist. ##### Parameters - `ruleId`: ID of a rule. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"removeRule\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" } ] } ``` #### removeTargets Removes context keys from the individual context targets for the context kind that `contextKind` specifies and the variation that `variationId` specifies. Does nothing if the flag does not target the context keys. ##### Parameters - `values`: List of context keys. - `contextKind`: (Optional) Context kind to target, defaults to `user` - `variationId`: ID of a variation. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeTargets\", \"values\": [\"context-key-123abc\", \"context-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### removeValuesFromClause Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeValuesFromClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### reorderRules Rearranges the rules to match the order given in `ruleIds`. Returns an error if `ruleIds` does not match the current set of rules on the AI Config. ##### Parameters - `ruleIds`: Array of IDs of all rules. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"reorderRules\", \"ruleIds\": [\"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"63c238d1-835d-435e-8f21-c8d5e40b2a3d\"] }] } ``` #### replaceRules Removes all targeting rules for the AI Config and replaces them with the list you provide. ##### Parameters - `rules`: A list of rules. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replaceRules\", \"rules\": [ { \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"description\": \"My new rule\", \"clauses\": [ { \"contextKind\": \"user\", \"attribute\": \"segmentMatch\", \"op\": \"segmentMatch\", \"values\": [\"test\"] } ] } ] } ] } ``` #### replaceTargets Removes all existing targeting and replaces it with the list of targets you provide. ##### Parameters - `targets`: A list of context targeting. Each item in the list includes an optional `contextKind` that defaults to `user`, a required `variationId`, and a required list of `values`. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replaceTargets\", \"targets\": [ { \"contextKind\": \"user\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"values\": [\"user-key-123abc\"] }, { \"contextKind\": \"device\", \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\", \"values\": [\"device-key-456def\"] } ] } ] } ``` #### updateClause Replaces the clause indicated by `ruleId` and `clauseId` with `clause`. ##### Parameters - `ruleId`: ID of a rule. - `clauseId`: ID of a clause in that rule. - `clause`: New `clause` object, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10c7462a-2062-45ba-a8bb-dfb3de0f8af5\", \"clause\": { \"contextKind\": \"user\", \"attribute\": \"country\", \"op\": \"in\", \"negate\": false, \"values\": [\"Mexico\", \"Canada\"] } }] } ``` #### updateDefaultVariation Updates the default on or off variation of the AI Config. ##### Parameters - `onVariationValue`: (Optional) The value of the variation of the new on variation. - `offVariationValue`: (Optional) The value of the variation of the new off variation Here's an example: ```json { \"instructions\": [ { \"kind\": \"updateDefaultVariation\", \"OnVariationValue\": true, \"OffVariationValue\": false } ] } ``` #### updateFallthroughVariationOrRollout Updates the default or \"fallthrough\" rule for the AI Config, which the AI Config serves when a context matches none of the targeting rules. The rule can serve either the variation that `variationId` indicates, or a percentage rollout that `rolloutWeights` and `rolloutBucketBy` indicate. ##### Parameters - `variationId`: ID of a variation. or - `rolloutWeights`: Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here's an example that uses a `variationId`: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateFallthroughVariationOrRollout\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` Here's an example that uses a percentage rollout: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateFallthroughVariationOrRollout\", \"rolloutContextKind\": \"user\", \"rolloutWeights\": { \"2f43f67c-3e4e-4945-a18a-26559378ca00\": 15000, // serve 15% this variation \"e5830889-1ec5-4b0c-9cc9-c48790090c43\": 85000 // serve 85% this variation } }] } ``` #### updateOffVariation Updates the default off variation to `variationId`. The AI Config serves the default off variation when the AI Config's targeting is **Off**. ##### Parameters - `variationId`: ID of a variation. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateOffVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### updateRuleDescription Updates the description of the targeting rule. ##### Parameters - `description`: The new human-readable description for this rule. - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the AI Config. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleDescription\", \"description\": \"New rule description\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### updateRuleTrackEvents Updates whether or not LaunchDarkly tracks events for the AI Config associated with this rule. ##### Parameters - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the AI Config. - `trackEvents`: Whether or not events are tracked. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleTrackEvents\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"trackEvents\": true }] } ``` #### updateRuleVariationOrRollout Updates what `ruleId` serves when its clauses evaluate to true. The rule can serve either the variation that `variationId` indicates, or a percent rollout that `rolloutWeights` and `rolloutBucketBy` indicate. ##### Parameters - `ruleId`: ID of a rule. - `variationId`: ID of a variation. or - `rolloutWeights`: Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleVariationOrRollout\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### updateTrackEvents Updates whether or not LaunchDarkly tracks events for the AI Config, for all rules. ##### Parameters - `trackEvents`: Whether or not events are tracked. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateTrackEvents\", \"trackEvents\": true } ] } ``` #### updateTrackEventsFallthrough Updates whether or not LaunchDarkly tracks events for the AI Config, for the default rule. ##### Parameters - `trackEvents`: Whether or not events are tracked. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateTrackEventsFallthrough\", \"trackEvents\": true } ] } ``` </details>
|
|
3522
|
+
Perform a partial update to an agent config's targeting. The request body must be a valid semantic patch. ### Using semantic patches on an agent config To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). The body of a semantic patch request for updating an agent config's targeting takes the following properties: * `comment` (string): (Optional) A description of the update. * `environmentKey` (string): The key of the LaunchDarkly environment. * `instructions` (array): (Required) A list of actions the update should perform. Each action in the list must be an object with a `kind` property that indicates the instruction. If the action requires parameters, you must include those parameters as additional fields in the object. The body of a single semantic patch can contain many different instructions. ### Instructions Semantic patch requests support the following `kind` instructions for updating agent configs. <details> <summary>Click to expand instructions for <strong>working with targeting and variations</strong> for agent configs</summary> #### addClauses Adds the given clauses to the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the agent config. - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addClauses\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauses\": [{ \"contextKind\": \"user\", \"attribute\": \"country\", \"op\": \"in\", \"negate\": false, \"values\": [\"USA\", \"Canada\"] }] }] } ``` #### addRule Adds a new targeting rule to the agent config. The rule may contain `clauses` and serve the variation that `variationId` indicates, or serve a percentage rollout that `rolloutWeights`, `rolloutBucketBy`, and `rolloutContextKind` indicate. If you set `beforeRuleId`, this adds the new rule before the indicated rule. Otherwise, adds the new rule to the end of the list. ##### Parameters - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. - `beforeRuleId`: (Optional) ID of a rule. - Either - `variationId`: ID of a variation. or - `rolloutWeights`: (Optional) Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here's an example that uses a `variationId`: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addRule\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"clauses\": [{ \"contextKind\": \"organization\", \"attribute\": \"located_in\", \"op\": \"in\", \"negate\": false, \"values\": [\"Sweden\", \"Norway\"] }] }] } ``` Here's an example that uses a percentage rollout: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addRule\", \"clauses\": [{ \"contextKind\": \"organization\", \"attribute\": \"located_in\", \"op\": \"in\", \"negate\": false, \"values\": [\"Sweden\", \"Norway\"] }], \"rolloutContextKind\": \"organization\", \"rolloutWeights\": { \"2f43f67c-3e4e-4945-a18a-26559378ca00\": 15000, // serve 15% this variation \"e5830889-1ec5-4b0c-9cc9-c48790090c43\": 85000 // serve 85% this variation } }] } ``` #### addTargets Adds context keys to the individual context targets for the context kind that `contextKind` specifies and the variation that `variationId` specifies. Returns an error if this causes the agent config to target the same context key in multiple variations. ##### Parameters - `values`: List of context keys. - `contextKind`: (Optional) Context kind to target, defaults to `user` - `variationId`: ID of a variation. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addTargets\", \"values\": [\"context-key-123abc\", \"context-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### addValuesToClause Adds `values` to the values of the clause that `ruleId` and `clauseId` indicate. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the agent config. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addValuesToClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### clearTargets Removes all individual targets from the variation that `variationId` specifies. This includes both user and non-user targets. ##### Parameters - `variationId`: ID of a variation. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"clearTargets\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### removeClauses Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule. - `clauseIds`: Array of IDs of clauses in the rule. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeClauses\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseIds\": [\"10a58772-3121-400f-846b-b8a04e8944ed\", \"36a461dc-235e-4b08-97b9-73ce9365873e\"] }] } ``` #### removeRule Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist. ##### Parameters - `ruleId`: ID of a rule. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"removeRule\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" } ] } ``` #### removeTargets Removes context keys from the individual context targets for the context kind that `contextKind` specifies and the variation that `variationId` specifies. Does nothing if the flag does not target the context keys. ##### Parameters - `values`: List of context keys. - `contextKind`: (Optional) Context kind to target, defaults to `user` - `variationId`: ID of a variation. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeTargets\", \"values\": [\"context-key-123abc\", \"context-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### removeValuesFromClause Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeValuesFromClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### reorderRules Rearranges the rules to match the order given in `ruleIds`. Returns an error if `ruleIds` does not match the current set of rules on the agent config. ##### Parameters - `ruleIds`: Array of IDs of all rules. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"reorderRules\", \"ruleIds\": [\"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"63c238d1-835d-435e-8f21-c8d5e40b2a3d\"] }] } ``` #### replaceRules Removes all targeting rules for the agent config and replaces them with the list you provide. ##### Parameters - `rules`: A list of rules. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replaceRules\", \"rules\": [ { \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"description\": \"My new rule\", \"clauses\": [ { \"contextKind\": \"user\", \"attribute\": \"segmentMatch\", \"op\": \"segmentMatch\", \"values\": [\"test\"] } ] } ] } ] } ``` #### replaceTargets Removes all existing targeting and replaces it with the list of targets you provide. ##### Parameters - `targets`: A list of context targeting. Each item in the list includes an optional `contextKind` that defaults to `user`, a required `variationId`, and a required list of `values`. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replaceTargets\", \"targets\": [ { \"contextKind\": \"user\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"values\": [\"user-key-123abc\"] }, { \"contextKind\": \"device\", \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\", \"values\": [\"device-key-456def\"] } ] } ] } ``` #### updateClause Replaces the clause indicated by `ruleId` and `clauseId` with `clause`. ##### Parameters - `ruleId`: ID of a rule. - `clauseId`: ID of a clause in that rule. - `clause`: New `clause` object, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10c7462a-2062-45ba-a8bb-dfb3de0f8af5\", \"clause\": { \"contextKind\": \"user\", \"attribute\": \"country\", \"op\": \"in\", \"negate\": false, \"values\": [\"Mexico\", \"Canada\"] } }] } ``` #### updateDefaultVariation Updates the default on or off variation of the agent config. ##### Parameters - `onVariationValue`: (Optional) The value of the variation of the new on variation. - `offVariationValue`: (Optional) The value of the variation of the new off variation Here's an example: ```json { \"instructions\": [ { \"kind\": \"updateDefaultVariation\", \"OnVariationValue\": true, \"OffVariationValue\": false } ] } ``` #### updateFallthroughVariationOrRollout Updates the default or \"fallthrough\" rule for the agent config, which the agent config serves when a context matches none of the targeting rules. The rule can serve either the variation that `variationId` indicates, or a percentage rollout that `rolloutWeights` and `rolloutBucketBy` indicate. ##### Parameters - `variationId`: ID of a variation. or - `rolloutWeights`: Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here's an example that uses a `variationId`: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateFallthroughVariationOrRollout\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` Here's an example that uses a percentage rollout: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateFallthroughVariationOrRollout\", \"rolloutContextKind\": \"user\", \"rolloutWeights\": { \"2f43f67c-3e4e-4945-a18a-26559378ca00\": 15000, // serve 15% this variation \"e5830889-1ec5-4b0c-9cc9-c48790090c43\": 85000 // serve 85% this variation } }] } ``` #### updateOffVariation Updates the default off variation to `variationId`. The agent config serves the default off variation when the agent config's targeting is **Off**. ##### Parameters - `variationId`: ID of a variation. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateOffVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### updateRuleDescription Updates the description of the targeting rule. ##### Parameters - `description`: The new human-readable description for this rule. - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the agent config. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleDescription\", \"description\": \"New rule description\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### updateRuleTrackEvents Updates whether or not LaunchDarkly tracks events for the agent config associated with this rule. ##### Parameters - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the agent config. - `trackEvents`: Whether or not events are tracked. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleTrackEvents\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"trackEvents\": true }] } ``` #### updateRuleVariationOrRollout Updates what `ruleId` serves when its clauses evaluate to true. The rule can serve either the variation that `variationId` indicates, or a percent rollout that `rolloutWeights` and `rolloutBucketBy` indicate. ##### Parameters - `ruleId`: ID of a rule. - `variationId`: ID of a variation. or - `rolloutWeights`: Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleVariationOrRollout\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### updateTrackEvents Updates whether or not LaunchDarkly tracks events for the agent config, for all rules. ##### Parameters - `trackEvents`: Whether or not events are tracked. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateTrackEvents\", \"trackEvents\": true } ] } ``` #### updateTrackEventsFallthrough Updates whether or not LaunchDarkly tracks events for the agent config, for the default rule. ##### Parameters - `trackEvents`: Whether or not events are tracked. Here's an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateTrackEventsFallthrough\", \"trackEvents\": true } ] } ``` </details>
|
|
3523
3523
|
|
|
3524
3524
|
### Examples
|
|
3525
3525
|
|
|
@@ -3536,13 +3536,13 @@ end
|
|
|
3536
3536
|
|
|
3537
3537
|
api_instance = LaunchDarklyApi::AgentControlApi.new
|
|
3538
3538
|
project_key = 'project_key_example' # String | The project key
|
|
3539
|
-
config_key = 'config_key_example' # String | The
|
|
3539
|
+
config_key = 'config_key_example' # String | The agent config key
|
|
3540
3540
|
opts = {
|
|
3541
|
-
ai_config_targeting_patch: LaunchDarklyApi::AIConfigTargetingPatch.new({environment_key: 'environment_key_example', instructions: [{ key: 3.56}]}) # AIConfigTargetingPatch |
|
|
3541
|
+
ai_config_targeting_patch: LaunchDarklyApi::AIConfigTargetingPatch.new({environment_key: 'environment_key_example', instructions: [{ key: 3.56}]}) # AIConfigTargetingPatch | Agent config targeting semantic patch instructions
|
|
3542
3542
|
}
|
|
3543
3543
|
|
|
3544
3544
|
begin
|
|
3545
|
-
# Update
|
|
3545
|
+
# Update agent config targeting
|
|
3546
3546
|
result = api_instance.patch_ai_config_targeting(project_key, config_key, opts)
|
|
3547
3547
|
p result
|
|
3548
3548
|
rescue LaunchDarklyApi::ApiError => e
|
|
@@ -3558,7 +3558,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
3558
3558
|
|
|
3559
3559
|
```ruby
|
|
3560
3560
|
begin
|
|
3561
|
-
# Update
|
|
3561
|
+
# Update agent config targeting
|
|
3562
3562
|
data, status_code, headers = api_instance.patch_ai_config_targeting_with_http_info(project_key, config_key, opts)
|
|
3563
3563
|
p status_code # => 2xx
|
|
3564
3564
|
p headers # => { ... }
|
|
@@ -3573,8 +3573,8 @@ end
|
|
|
3573
3573
|
| Name | Type | Description | Notes |
|
|
3574
3574
|
| ---- | ---- | ----------- | ----- |
|
|
3575
3575
|
| **project_key** | **String** | The project key | |
|
|
3576
|
-
| **config_key** | **String** | The
|
|
3577
|
-
| **ai_config_targeting_patch** | [**AIConfigTargetingPatch**](AIConfigTargetingPatch.md) |
|
|
3576
|
+
| **config_key** | **String** | The agent config key | |
|
|
3577
|
+
| **ai_config_targeting_patch** | [**AIConfigTargetingPatch**](AIConfigTargetingPatch.md) | Agent config targeting semantic patch instructions | [optional] |
|
|
3578
3578
|
|
|
3579
3579
|
### Return type
|
|
3580
3580
|
|
|
@@ -3594,9 +3594,9 @@ end
|
|
|
3594
3594
|
|
|
3595
3595
|
> <AIConfigVariation> patch_ai_config_variation(project_key, config_key, variation_key, opts)
|
|
3596
3596
|
|
|
3597
|
-
Update
|
|
3597
|
+
Update agent config variation
|
|
3598
3598
|
|
|
3599
|
-
Edit an existing variation of an
|
|
3599
|
+
Edit an existing variation of an agent config. This creates a new version of the variation. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. If the variation is in use in a project environment where approval settings require review for this agent config, this endpoint returns 403 and the change must be submitted through an approval request. Here's an example: ``` { \"messages\": [ { \"role\": \"system\", \"content\": \"The new message\" } ] } ```
|
|
3600
3600
|
|
|
3601
3601
|
### Examples
|
|
3602
3602
|
|
|
@@ -3613,14 +3613,14 @@ end
|
|
|
3613
3613
|
|
|
3614
3614
|
api_instance = LaunchDarklyApi::AgentControlApi.new
|
|
3615
3615
|
project_key = 'project_key_example' # String | The project key
|
|
3616
|
-
config_key = 'config_key_example' # String | The
|
|
3617
|
-
variation_key = 'variation_key_example' # String | The
|
|
3616
|
+
config_key = 'config_key_example' # String | The agent config key
|
|
3617
|
+
variation_key = 'variation_key_example' # String | The agent config variation key
|
|
3618
3618
|
opts = {
|
|
3619
|
-
ai_config_variation_patch: LaunchDarklyApi::AIConfigVariationPatch.new # AIConfigVariationPatch |
|
|
3619
|
+
ai_config_variation_patch: LaunchDarklyApi::AIConfigVariationPatch.new # AIConfigVariationPatch | Agent config variation object to update
|
|
3620
3620
|
}
|
|
3621
3621
|
|
|
3622
3622
|
begin
|
|
3623
|
-
# Update
|
|
3623
|
+
# Update agent config variation
|
|
3624
3624
|
result = api_instance.patch_ai_config_variation(project_key, config_key, variation_key, opts)
|
|
3625
3625
|
p result
|
|
3626
3626
|
rescue LaunchDarklyApi::ApiError => e
|
|
@@ -3636,7 +3636,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
3636
3636
|
|
|
3637
3637
|
```ruby
|
|
3638
3638
|
begin
|
|
3639
|
-
# Update
|
|
3639
|
+
# Update agent config variation
|
|
3640
3640
|
data, status_code, headers = api_instance.patch_ai_config_variation_with_http_info(project_key, config_key, variation_key, opts)
|
|
3641
3641
|
p status_code # => 2xx
|
|
3642
3642
|
p headers # => { ... }
|
|
@@ -3651,9 +3651,9 @@ end
|
|
|
3651
3651
|
| Name | Type | Description | Notes |
|
|
3652
3652
|
| ---- | ---- | ----------- | ----- |
|
|
3653
3653
|
| **project_key** | **String** | The project key | |
|
|
3654
|
-
| **config_key** | **String** | The
|
|
3655
|
-
| **variation_key** | **String** | The
|
|
3656
|
-
| **ai_config_variation_patch** | [**AIConfigVariationPatch**](AIConfigVariationPatch.md) |
|
|
3654
|
+
| **config_key** | **String** | The agent config key | |
|
|
3655
|
+
| **variation_key** | **String** | The agent config variation key | |
|
|
3656
|
+
| **ai_config_variation_patch** | [**AIConfigVariationPatch**](AIConfigVariationPatch.md) | Agent config variation object to update | [optional] |
|
|
3657
3657
|
|
|
3658
3658
|
### Return type
|
|
3659
3659
|
|
|
@@ -4196,9 +4196,9 @@ end
|
|
|
4196
4196
|
|
|
4197
4197
|
> <AIConfig> post_ai_config(project_key, ai_config_post)
|
|
4198
4198
|
|
|
4199
|
-
Create new
|
|
4199
|
+
Create new agent config
|
|
4200
4200
|
|
|
4201
|
-
Create a new
|
|
4201
|
+
Create a new agent config within the given project.
|
|
4202
4202
|
|
|
4203
4203
|
### Examples
|
|
4204
4204
|
|
|
@@ -4215,10 +4215,10 @@ end
|
|
|
4215
4215
|
|
|
4216
4216
|
api_instance = LaunchDarklyApi::AgentControlApi.new
|
|
4217
4217
|
project_key = 'project_key_example' # String | The project key
|
|
4218
|
-
ai_config_post = LaunchDarklyApi::AIConfigPost.new({key: 'key_example', name: 'name_example'}) # AIConfigPost |
|
|
4218
|
+
ai_config_post = LaunchDarklyApi::AIConfigPost.new({key: 'key_example', name: 'name_example'}) # AIConfigPost | Agent config object to create
|
|
4219
4219
|
|
|
4220
4220
|
begin
|
|
4221
|
-
# Create new
|
|
4221
|
+
# Create new agent config
|
|
4222
4222
|
result = api_instance.post_ai_config(project_key, ai_config_post)
|
|
4223
4223
|
p result
|
|
4224
4224
|
rescue LaunchDarklyApi::ApiError => e
|
|
@@ -4234,7 +4234,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
4234
4234
|
|
|
4235
4235
|
```ruby
|
|
4236
4236
|
begin
|
|
4237
|
-
# Create new
|
|
4237
|
+
# Create new agent config
|
|
4238
4238
|
data, status_code, headers = api_instance.post_ai_config_with_http_info(project_key, ai_config_post)
|
|
4239
4239
|
p status_code # => 2xx
|
|
4240
4240
|
p headers # => { ... }
|
|
@@ -4249,7 +4249,7 @@ end
|
|
|
4249
4249
|
| Name | Type | Description | Notes |
|
|
4250
4250
|
| ---- | ---- | ----------- | ----- |
|
|
4251
4251
|
| **project_key** | **String** | The project key | |
|
|
4252
|
-
| **ai_config_post** | [**AIConfigPost**](AIConfigPost.md) |
|
|
4252
|
+
| **ai_config_post** | [**AIConfigPost**](AIConfigPost.md) | Agent config object to create | |
|
|
4253
4253
|
|
|
4254
4254
|
### Return type
|
|
4255
4255
|
|
|
@@ -4269,9 +4269,9 @@ end
|
|
|
4269
4269
|
|
|
4270
4270
|
> <AIConfigVariation> post_ai_config_variation(project_key, config_key, ai_config_variation_post)
|
|
4271
4271
|
|
|
4272
|
-
Create
|
|
4272
|
+
Create agent config variation
|
|
4273
4273
|
|
|
4274
|
-
Create a new variation for a given
|
|
4274
|
+
Create a new variation for a given agent config. The <code>model</code> in the request body requires a <code>modelName</code> and <code>parameters</code>, for example: ``` \"model\": { \"modelName\": \"claude-3-opus-20240229\", \"parameters\": { \"max_tokens\": 1024 } } ```
|
|
4275
4275
|
|
|
4276
4276
|
### Examples
|
|
4277
4277
|
|
|
@@ -4288,11 +4288,11 @@ end
|
|
|
4288
4288
|
|
|
4289
4289
|
api_instance = LaunchDarklyApi::AgentControlApi.new
|
|
4290
4290
|
project_key = 'project_key_example' # String | The project key
|
|
4291
|
-
config_key = 'config_key_example' # String | The
|
|
4292
|
-
ai_config_variation_post = LaunchDarklyApi::AIConfigVariationPost.new({key: 'key_example', name: 'name_example'}) # AIConfigVariationPost |
|
|
4291
|
+
config_key = 'config_key_example' # String | The agent config key
|
|
4292
|
+
ai_config_variation_post = LaunchDarklyApi::AIConfigVariationPost.new({key: 'key_example', name: 'name_example'}) # AIConfigVariationPost | Agent config variation object to create
|
|
4293
4293
|
|
|
4294
4294
|
begin
|
|
4295
|
-
# Create
|
|
4295
|
+
# Create agent config variation
|
|
4296
4296
|
result = api_instance.post_ai_config_variation(project_key, config_key, ai_config_variation_post)
|
|
4297
4297
|
p result
|
|
4298
4298
|
rescue LaunchDarklyApi::ApiError => e
|
|
@@ -4308,7 +4308,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
4308
4308
|
|
|
4309
4309
|
```ruby
|
|
4310
4310
|
begin
|
|
4311
|
-
# Create
|
|
4311
|
+
# Create agent config variation
|
|
4312
4312
|
data, status_code, headers = api_instance.post_ai_config_variation_with_http_info(project_key, config_key, ai_config_variation_post)
|
|
4313
4313
|
p status_code # => 2xx
|
|
4314
4314
|
p headers # => { ... }
|
|
@@ -4323,8 +4323,8 @@ end
|
|
|
4323
4323
|
| Name | Type | Description | Notes |
|
|
4324
4324
|
| ---- | ---- | ----------- | ----- |
|
|
4325
4325
|
| **project_key** | **String** | The project key | |
|
|
4326
|
-
| **config_key** | **String** | The
|
|
4327
|
-
| **ai_config_variation_post** | [**AIConfigVariationPost**](AIConfigVariationPost.md) |
|
|
4326
|
+
| **config_key** | **String** | The agent config key | |
|
|
4327
|
+
| **ai_config_variation_post** | [**AIConfigVariationPost**](AIConfigVariationPost.md) | Agent config variation object to create | |
|
|
4328
4328
|
|
|
4329
4329
|
### Return type
|
|
4330
4330
|
|