Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
258 changes: 207 additions & 51 deletions .openapi-generator/FILES

Large diffs are not rendered by default.

162 changes: 111 additions & 51 deletions README.md

Large diffs are not rendered by default.

15 changes: 8 additions & 7 deletions docs/AIConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access** | [**AiConfigsAccess**](AiConfigsAccess.md) | | [optional]
**links** | [**ParentAndSelfLinks**](ParentAndSelfLinks.md) | | [optional]
**description** | **str** | |
**key** | **str** | |
**site** | [**CoreLink**](CoreLink.md) | | [optional]
**description** | **str** | A description of the AI Config |
**key** | **str** | The AI Config key |
**maintainer** | [**AIConfigMaintainer**](AIConfigMaintainer.md) | | [optional]
**mode** | **str** | | [optional] [default to 'completion']
**name** | **str** | |
**tags** | **List[str]** | |
**version** | **int** | |
**variations** | [**List[AIConfigVariation]**](AIConfigVariation.md) | |
**mode** | **str** | The AI Config mode | [optional] [default to 'completion']
**name** | **str** | The AI Config name |
**tags** | **List[str]** | Tags for this resource |
**version** | **int** | The version number of this resource |
**variations** | [**List[AIConfigVariation]**](AIConfigVariation.md) | The variations of this AI Config |
**created_at** | **int** | |
**updated_at** | **int** | |
**evaluation_metric_key** | **str** | Evaluation metric key for this config | [optional]
Expand Down
15 changes: 8 additions & 7 deletions docs/AIConfigMaintainer.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
# AIConfigMaintainer

The member or team that maintains this resource

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**kind** | **str** | |
**id** | **str** | |
**email** | **str** | |
**first_name** | **str** | | [optional]
**last_name** | **str** | | [optional]
**role** | **str** | |
**key** | **str** | |
**name** | **str** | |
**id** | **str** | The member ID |
**email** | **str** | The member email address |
**first_name** | **str** | The member first name | [optional]
**last_name** | **str** | The member last name | [optional]
**role** | **str** | The member role |
**key** | **str** | The team key |
**name** | **str** | The team name |

## Example

Expand Down
11 changes: 6 additions & 5 deletions docs/AIConfigPatch.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | | [optional]
**maintainer_id** | **str** | | [optional]
**maintainer_team_key** | **str** | | [optional]
**name** | **str** | | [optional]
**tags** | **List[str]** | | [optional]
**default_variation_key** | **str** | Key of the variation this config serves by default | [optional]
**description** | **str** | A description of the AI Config | [optional]
**maintainer_id** | **str** | The ID of the member who maintains this resource | [optional]
**maintainer_team_key** | **str** | The key of the team that maintains this resource | [optional]
**name** | **str** | A human-readable name for the AI Config | [optional]
**tags** | **List[str]** | Tags for this resource | [optional]
**evaluation_metric_key** | **str** | Evaluation metric key for this config | [optional]
**is_inverted** | **bool** | Whether the evaluation metric is inverted, meaning a lower value is better if set as true | [optional]

Expand Down
16 changes: 8 additions & 8 deletions docs/AIConfigPost.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | | [optional] [default to '']
**key** | **str** | |
**maintainer_id** | **str** | | [optional]
**maintainer_team_key** | **str** | | [optional]
**mode** | **str** | | [optional] [default to 'completion']
**name** | **str** | |
**tags** | **List[str]** | | [optional]
**view_keys** | **List[str]** | | [optional]
**description** | **str** | A description of the AI Config | [optional] [default to '']
**key** | **str** | A unique key for the AI Config |
**maintainer_id** | **str** | The ID of the member who maintains this resource | [optional]
**maintainer_team_key** | **str** | The key of the team that maintains this resource | [optional]
**mode** | **str** | The AI Config mode | [optional] [default to 'completion']
**name** | **str** | A human-readable name for the AI Config |
**tags** | **List[str]** | Tags for this resource | [optional]
**view_keys** | **List[str]** | Keys of the views to add the AI Config to | [optional]
**default_variation** | [**AIConfigVariationPost**](AIConfigVariationPost.md) | | [optional]
**evaluation_metric_key** | **str** | Evaluation metric key for this config | [optional]
**is_inverted** | **bool** | Whether the evaluation metric is inverted, meaning a lower value is better if set as true | [optional]
Expand Down
12 changes: 6 additions & 6 deletions docs/AIConfigTargeting.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created_at** | **int** | Unix timestamp in milliseconds |
**defaults** | [**AIConfigTargetingDefaults**](AIConfigTargetingDefaults.md) | | [optional]
**environments** | [**Dict[str, AIConfigTargetingEnvironment]**](AIConfigTargetingEnvironment.md) | |
**environments** | [**Dict[str, AIConfigTargetingEnvironment]**](AIConfigTargetingEnvironment.md) | Targeting for each environment, keyed by environment key |
**experiments** | [**AiConfigsExperimentInfoRep**](AiConfigsExperimentInfoRep.md) | |
**key** | **str** | |
**name** | **str** | |
**tags** | **List[str]** | |
**variations** | [**List[AIConfigTargetingVariation]**](AIConfigTargetingVariation.md) | |
**version** | **int** | |
**key** | **str** | The AI Config key |
**name** | **str** | The AI Config name |
**tags** | **List[str]** | Tags for this resource |
**variations** | [**List[AIConfigTargetingVariation]**](AIConfigTargetingVariation.md) | The variations of this AI Config |
**version** | **int** | The version number of this resource |

## Example

Expand Down
4 changes: 2 additions & 2 deletions docs/AIConfigTargetingDefaults.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**on_variation** | **int** | |
**off_variation** | **int** | |
**on_variation** | **int** | Index of the variation served when targeting is on |
**off_variation** | **int** | Index of the variation served when targeting is off |

## Example

Expand Down
18 changes: 9 additions & 9 deletions docs/AIConfigTargetingEnvironment.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**context_targets** | [**List[AIConfigTargetingEnvironmentTarget]**](AIConfigTargetingEnvironmentTarget.md) | |
**enabled** | **bool** | |
**context_targets** | [**List[AIConfigTargetingEnvironmentTarget]**](AIConfigTargetingEnvironmentTarget.md) | Individual context targets for non-user context kinds |
**enabled** | **bool** | Whether targeting is on in this environment |
**fallthrough** | [**AIConfigTargetingEnvironmentFallthrough**](AIConfigTargetingEnvironmentFallthrough.md) | |
**last_modified** | **int** | |
**off_variation** | **int** | | [optional]
**rules** | [**List[AIConfigTargetingEnvironmentRule]**](AIConfigTargetingEnvironmentRule.md) | |
**targets** | [**List[AIConfigTargetingEnvironmentTarget]**](AIConfigTargetingEnvironmentTarget.md) | |
**track_events** | **bool** | |
**track_events_fallthrough** | **bool** | |
**environment_name** | **str** | |
**version** | **int** | |
**off_variation** | **int** | Index of the variation served when targeting is off | [optional]
**rules** | [**List[AIConfigTargetingEnvironmentRule]**](AIConfigTargetingEnvironmentRule.md) | The targeting rules |
**targets** | [**List[AIConfigTargetingEnvironmentTarget]**](AIConfigTargetingEnvironmentTarget.md) | Individual user targets |
**track_events** | **bool** | Whether to send detailed events for all evaluations |
**track_events_fallthrough** | **bool** | Whether to send detailed events for evaluations that fall through to the default rule |
**environment_name** | **str** | The environment name |
**version** | **int** | The version of the targeting in this environment |

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/AIConfigTargetingEnvironmentFallthrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**variation** | **int** | | [optional]
**variation** | **int** | Index of the variation served by the default rule | [optional]
**rollout** | [**AIConfigTargetingEnvironmentFallthroughRollout**](AIConfigTargetingEnvironmentFallthroughRollout.md) | | [optional]

## Example
Expand Down
8 changes: 4 additions & 4 deletions docs/AIConfigTargetingEnvironmentFallthroughRollout.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bucket_by** | **str** | | [optional]
**context_kind** | **str** | |
**bucket_by** | **str** | The context attribute used to bucket contexts | [optional]
**context_kind** | **str** | The context kind used to bucket contexts |
**experiment_allocation** | [**AIConfigTargetingEnvironmentFallthroughRolloutExperimentationAllocation**](AIConfigTargetingEnvironmentFallthroughRolloutExperimentationAllocation.md) | | [optional]
**seed** | **int** | | [optional]
**variations** | [**List[AIConfigTargetingEnvironmentFallthroughRolloutVariation]**](AIConfigTargetingEnvironmentFallthroughRolloutVariation.md) | |
**seed** | **int** | The seed used for bucketing | [optional]
**variations** | [**List[AIConfigTargetingEnvironmentFallthroughRolloutVariation]**](AIConfigTargetingEnvironmentFallthroughRolloutVariation.md) | The variations and their weights |

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**can_reshuffle** | **bool** | |
**default_variation** | **int** | |
**type** | **str** | |
**can_reshuffle** | **bool** | Whether contexts can be reassigned to new buckets |
**default_variation** | **int** | Index of the default variation |
**type** | **str** | The allocation type |

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**untracked** | **bool** | | [optional]
**variation** | **int** | |
**weight** | **int** | |
**untracked** | **bool** | Whether this variation is excluded from experiment tracking | [optional]
**variation** | **int** | Index of the variation |
**weight** | **int** | The weight of this variation, in thousandths of a percent |

## Example

Expand Down
4 changes: 2 additions & 2 deletions docs/AIConfigTargetingEnvironmentRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**clauses** | [**List[AIConfigTargetingEnvironmentRuleClause]**](AIConfigTargetingEnvironmentRuleClause.md) | |
**track_events** | **bool** | |
**clauses** | [**List[AIConfigTargetingEnvironmentRuleClause]**](AIConfigTargetingEnvironmentRuleClause.md) | The clauses a context must match |
**track_events** | **bool** | Whether to send detailed events for evaluations that match this rule |

## Example

Expand Down
10 changes: 5 additions & 5 deletions docs/AIConfigTargetingEnvironmentRuleClause.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attribute** | **str** | |
**id** | **str** | |
**negate** | **bool** | |
**op** | **str** | |
**values** | **List[object]** | |
**attribute** | **str** | The context attribute to match |
**id** | **str** | The clause ID |
**negate** | **bool** | Whether to negate the match |
**op** | **str** | The operator to use |
**values** | **List[object]** | The values to match against |

## Example

Expand Down
6 changes: 3 additions & 3 deletions docs/AIConfigTargetingEnvironmentTarget.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**context_kind** | **str** | |
**values** | **List[str]** | |
**variation** | **int** | |
**context_kind** | **str** | The context kind |
**values** | **List[str]** | The context keys to target |
**variation** | **int** | Index of the variation to serve |

## Example

Expand Down
6 changes: 3 additions & 3 deletions docs/AIConfigTargetingPatch.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comment** | **str** | | [optional]
**environment_key** | **str** | |
**instructions** | **List[Dict[str, object]]** | |
**comment** | **str** | A comment describing the change | [optional]
**environment_key** | **str** | The environment key |
**instructions** | **List[Dict[str, object]]** | The semantic patch instructions to apply |

## Example

Expand Down
6 changes: 3 additions & 3 deletions docs/AIConfigTargetingVariation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | |
**description** | **str** | |
**name** | **str** | |
**id** | **str** | The variation ID |
**description** | **str** | A description of the variation |
**name** | **str** | The variation name |
**value** | [**AIConfigTargetingVariationValue**](AIConfigTargetingVariationValue.md) | |

## Example
Expand Down
1 change: 1 addition & 0 deletions docs/AIConfigTargetingVariationValue.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# AIConfigTargetingVariationValue

The variation value

## Properties

Expand Down
28 changes: 15 additions & 13 deletions docs/AIConfigVariation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,28 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**ParentLink**](ParentLink.md) | | [optional]
**color** | **str** | | [optional]
**comment** | **str** | | [optional]
**color** | **str** | The color used for this variation in the UI | [optional]
**classifiers** | [**List[Classifier]**](Classifier.md) | Classifier rules for a judge variation. When this array is non-empty, messages must be empty. | [optional]
**comment** | **str** | A comment describing this version of the variation | [optional]
**description** | **str** | Returns the description for the agent. This is only returned for agent variations. | [optional]
**instructions** | **str** | Returns the instructions for the agent. This is only returned for agent variations. | [optional]
**key** | **str** | |
**id** | **str** | |
**messages** | [**List[Message]**](Message.md) | | [optional]
**model** | **object** | |
**model_config_key** | **str** | | [optional]
**name** | **str** | |
**key** | **str** | The variation key |
**id** | **str** | The variation ID |
**messages** | [**List[Message]**](Message.md) | The prompt messages for this variation | [optional]
**model** | **object** | Freeform JSON object. LaunchDarkly does not validate the keys. In a model config, `params` and `customParams` hold parameters that the provider's API accepts, for example `{\"temperature\": 0.7, \"maxTokens\": 4096}`. |
**model_config_key** | **str** | The key of the model config that this variation uses, not the provider model ID. Absent when the variation does not use a model config. | [optional]
**model_config_version** | **int** | The version of the model config that this variation is pinned to, when it references a custom model config. Absent when the variation does not reference a model config, when the variation is not pinned to a specific version, or when custom model config versioning is not enabled for the project. | [optional]
**name** | **str** | The variation name |
**output_format** | **Dict[str, object]** | JSON Schema defining the structured output format for the variation. | [optional]
**created_at** | **int** | |
**version** | **int** | |
**state** | **str** | | [optional]
**version** | **int** | The version number of this resource |
**state** | **str** | The state of the variation. - `archived`: The variation is archived. To restore it, update the variation with `state` set to `published`. - `published`: The variation is active. | [optional]
**archived_at** | **int** | | [optional]
**published_at** | **int** | | [optional]
**tools** | [**List[VariationTool]**](VariationTool.md) | | [optional]
**skills** | [**List[VariationSkill]**](VariationSkill.md) | | [optional]
**tools** | [**List[VariationTool]**](VariationTool.md) | The tools this variation can use | [optional]
**skills** | [**List[VariationSkill]**](VariationSkill.md) | The agent skills this variation can use | [optional]
**judge_configuration** | [**JudgeConfiguration**](JudgeConfiguration.md) | | [optional]
**judging_config_keys** | **List[str]** | | [optional]
**judging_config_keys** | **List[str]** | Keys of the judge AI Configs attached to this variation | [optional]

## Example

Expand Down
14 changes: 8 additions & 6 deletions docs/AIConfigVariationPatch.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,18 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**classifiers** | [**List[Classifier]**](Classifier.md) | Replaces classifier rules on a judge variation. An empty array clears them. When this array is non-empty, messages must be empty. | [optional]
**comment** | **str** | Human-readable description of what this patch changes | [optional]
**description** | **str** | Description for agent when the config is in agent mode. | [optional]
**instructions** | **str** | Instructions for agent when the config is in agent mode. | [optional]
**messages** | [**List[Message]**](Message.md) | | [optional]
**model** | **object** | | [optional]
**model_config_key** | **str** | | [optional]
**name** | **str** | | [optional]
**messages** | [**List[Message]**](Message.md) | The prompt messages for this variation | [optional]
**model** | **object** | Freeform JSON object. LaunchDarkly does not validate the keys. In a model config, `params` and `customParams` hold parameters that the provider's API accepts, for example `{\"temperature\": 0.7, \"maxTokens\": 4096}`. | [optional]
**model_config_key** | **str** | The key that GET /api/v2/projects/{projectKey}/ai-configs/model-configs returns for the model config. Do not use a custom model config's ID, which is the provider model ID. | [optional]
**model_config_version** | **int** | The exact model config version to set this variation to. Requires modelConfigKey to be set (either in this patch or already on the variation), and the version must exist for that model config. When omitted, the variation keeps the version it is currently set to, unless the patch changes modelConfigKey, in which case the variation records the new model config's current (latest) version. | [optional]
**name** | **str** | A human-readable name for the variation | [optional]
**output_format** | **Dict[str, object]** | JSON Schema defining the structured output format for the variation. | [optional]
**published** | **bool** | | [optional]
**state** | **str** | One of 'archived', 'published' | [optional]
**published** | **bool** | Whether to publish this version of the variation | [optional]
**state** | **str** | The state to move the variation to. Omit this field to keep the current state. - `archived`: Archive a published variation. You cannot archive a variation that is already archived. You also cannot archive the only variation of an AI Config. An AI Config itself cannot be archived. - `published`: Restore an archived variation. You cannot publish a variation that is already published. | [optional]
**tools** | [**List[VariationToolPost]**](VariationToolPost.md) | List of tools to use for this variation. The latest version of the tool will be used. | [optional]
**tool_keys** | **List[str]** | List of tool keys to use for this variation. The latest version of the tool will be used. | [optional]
**skills** | [**List[VariationSkillPost]**](VariationSkillPost.md) | List of agent skills to attach to this variation. Replaces the current attachments. | [optional]
Expand Down
Loading
Loading