| Version | Changes | End of life (EOL) |
|---|---|---|
| `20240415` |
| Current |
| `20220603` |
| 2025-04-15 |
| `20210729` |
| 2023-06-03 |
| `20191212` |
| 2022-07-29 |
| `20160426` |
| 2020-12-12 |
| Version | Changes | End of life (EOL) |
|---|---|---|
| `20240415` |
| Current |
| `20220603` |
| 2025-04-15 |
| `20210729` |
| 2023-06-03 |
| `20191212` |
| 2022-07-29 |
| `20160426` |
| 2020-12-12 |
notifyMemberIds, resolved when the request was made. Team membership may have changed since then.
+ */
+ 'notifyTeamKeys'?: Arrayts for this value, or descending order by specifying -ts.
- */
- 'sort'?: string;
- /**
- * Specifies the maximum number of items in the collection to return (max: 50, default: 20)
- */
- 'limit'?: number;
- /**
- * Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the next link instead, because this value is an obfuscated string.
- */
- 'continuationToken'?: string;
-}
export interface ContextInstanceSegmentMembership {
/**
* A human-friendly name for the segment
@@ -2702,28 +3506,6 @@ export interface ContextInstanceSegmentMemberships {
*/
'_links': { [key: string]: Link; };
}
-export interface ContextInstances {
- /**
- * The location and content type of related resources
- */
- '_links'?: { [key: string]: Link; };
- /**
- * The number of unique context instances
- */
- 'totalCount'?: number;
- /**
- * The environment ID
- */
- '_environmentId': string;
- /**
- * An obfuscated string that references the last context instance on the previous page of results. You can use this for pagination, however, we recommend using the next link instead.
- */
- 'continuationToken'?: string;
- /**
- * A collection of context instances. Can include multiple versions of context instances that have the same id, but different applicationIds.
- */
- 'items': Arraynext link instead.
+ * An obfuscated string that references the last context on the previous page of results. You can use this for pagination, however, we recommend using the next link instead.
*/
'continuationToken'?: string;
/**
@@ -2876,6 +3659,15 @@ export interface CovariateInfoRep {
'fileName': string;
'createdAt': number;
}
+export interface CreateAdaptiveTriggerRequest {
+ 'name': string;
+ 'resourceKind': AdaptiveTriggerResourceKind;
+ 'resourceKey': string;
+ 'triggerSource': ObservabilityAlertSource;
+ 'task': AdaptiveTriggerTask;
+}
+
+
/**
* Create announcement request body
*/
@@ -3027,7 +3819,7 @@ export interface CreatePhaseInput {
'name': string;
'configuration'?: object;
}
-export interface CreateReleaseInput {
+export interface CreatePipelineReleaseInput {
/**
* The variation id to release to across all phases
*/
@@ -3251,6 +4043,127 @@ export interface CustomWorkflowsListingOutput {
*/
'_links': { [key: string]: Link; };
}
+export interface DataExportProjectIdentityIncompleteError {
+ 'message': string;
+ 'code': DataExportProjectIdentityIncompleteErrorCodeEnum;
+}
+
+export const DataExportProjectIdentityIncompleteErrorCodeEnum = {
+ DataExportProjectIdentityIncomplete: 'data_export_project_identity_incomplete'
+} as const;
+
+export type DataExportProjectIdentityIncompleteErrorCodeEnum = typeof DataExportProjectIdentityIncompleteErrorCodeEnum[keyof typeof DataExportProjectIdentityIncompleteErrorCodeEnum];
+
+export interface DataExportProjectIdentityIncompleteErrorRep {
+ 'code'?: string;
+ 'message'?: string;
+}
+export interface DataExportProjectRankComponentsRep {
+ /**
+ * Successful Streaming transfers attributed to this project in the requested range.
+ */
+ 'streaming': number;
+}
+export interface DataExportProjectRankRep {
+ /**
+ * The canonical project key.
+ */
+ 'projectKey': string;
+ /**
+ * The current project name.
+ */
+ 'projectName': string;
+ /**
+ * The one-based rank within all matching projects.
+ */
+ 'rank': number;
+ /**
+ * Successful Streaming transfers in the requested range.
+ */
+ 'usage': number;
+ 'components': DataExportProjectRankComponentsRep;
+}
+export interface DataExportProjectRankingPageRep {
+ /**
+ * The bounded page size requested.
+ */
+ 'limit': number;
+ /**
+ * The number of items on this page.
+ */
+ 'count': number;
+ /**
+ * The number of matching projects with usage.
+ */
+ 'totalCount': number;
+ /**
+ * An opaque cursor for the next page.
+ */
+ 'nextCursor'?: string;
+}
+/**
+ * A bounded Streaming project ranking.
+ */
+export interface DataExportProjectRankingRep {
+ /**
+ * Projects in deterministic rank order.
+ */
+ 'items': Arraymetadata.
+ */
+ 'series': Array<{ [key: string]: number; }>;
+ /**
+ * The end of the latest hour written by this source\'s usage pipeline, as an RFC 3339 UTC timestamp. It is measured across all accounts, not only yours, and usage after this time is not counted yet. Omitted when the watermark is unavailable.
+ */
+ 'dataThrough'?: string;
+ /**
+ * Whether this source\'s usage pipeline is late: it wrote every hour of the 24 hours ending at dataThrough, and more than three hours have passed since dataThrough. Always false for a source with gaps in those 24 hours, where gaps usually mean no usage rather than a stalled pipeline. Omitted when dataThrough is omitted.
+ */
+ 'delayed'?: boolean;
+}
export interface DefaultClientSideAvailability {
/**
* Whether to enable availability for mobile SDKs
@@ -3390,9 +4303,129 @@ export interface DependentFlagsByEnvironment {
'_links': { [key: string]: Link; };
'_site': Link;
}
-export interface DependentMeasuredRolloutRep {
+export interface DependentMetricGroupRep {
+ /**
+ * A unique key to reference the metric group
+ */
+ 'key': string;
+ /**
+ * A human-friendly name for the metric group
+ */
+ 'name': string;
+ /**
+ * The type of the metric group
+ */
+ 'kind': DependentMetricGroupRepKindEnum;
+ /**
+ * The location and content type of related resources
+ */
+ '_links': { [key: string]: Link; };
+}
+
+export const DependentMetricGroupRepKindEnum = {
+ Funnel: 'funnel',
+ Standard: 'standard'
+} as const;
+
+export type DependentMetricGroupRepKindEnum = typeof DependentMetricGroupRepKindEnum[keyof typeof DependentMetricGroupRepKindEnum];
+
+export interface DependentMetricGroupRepWithMetrics {
+ /**
+ * A unique key to reference the metric group
+ */
+ 'key': string;
+ /**
+ * A human-friendly name for the metric group
+ */
+ 'name': string;
+ /**
+ * The type of the metric group
+ */
+ 'kind': DependentMetricGroupRepWithMetricsKindEnum;
+ /**
+ * The location and content type of related resources
+ */
+ '_links': { [key: string]: Link; };
+ /**
+ * The metrics in the metric group
+ */
+ 'metrics'?: Arraytrue) or to track a conversion when an end user takes an action (false).
+ */
+ 'isNumeric'?: boolean;
+ /**
+ * The event key sent with the metric. Only relevant for custom metrics.
+ */
+ 'eventKey'?: string;
+ /**
+ * The location and content type of related resources
+ */
+ '_links': { [key: string]: Link; };
+ /**
+ * Whether this is a metric group or a metric
+ */
+ 'isGroup': boolean;
+ /**
+ * An ordered list of the metrics in this metric group
+ */
+ 'metrics'?: Arraytrue) or to track a conversion when an end user takes an action (false).
- */
- 'isNumeric'?: boolean;
- /**
- * The event key sent with the metric. Only relevant for custom metrics.
- */
- 'eventKey'?: string;
- /**
- * The location and content type of related resources
- */
- '_links': { [key: string]: Link; };
- /**
- * Whether this is a metric group or a metric
- */
- 'isGroup': boolean;
- /**
- * An ordered list of the metrics in this metric group
- */
- 'metrics'?: Arraytrue) or to track a conversion when an end user takes an action (false).
+ */
+ 'isNumeric'?: boolean;
+ /**
+ * For custom and trace metrics, the success criteria
+ */
+ 'successCriteria'?: EnvironmentReleasesMetricListingRepSuccessCriteriaEnum;
+ /**
+ * For numeric custom and trace metrics, the unit of measure
+ */
+ 'unit'?: string;
+ /**
+ * For custom metrics, the event key to use in your code
+ */
+ 'eventKey'?: string;
+ /**
+ * Deprecated, use analysisUnits instead.
+ * @deprecated
+ */
+ 'randomizationUnits'?: ArrayanalysisType is percentile.
+ */
+ 'percentileValue'?: number;
+ 'eventDefault'?: MetricEventDefaultRep;
+ 'dataSource': MetricDataSourceRefRep;
+ 'lastSeen'?: number;
+ /**
+ * Whether the metric version is archived
+ */
+ 'archived'?: boolean;
+ 'archivedAt'?: number;
+ /**
+ * For click metrics, the CSS selectors
+ */
+ 'selector'?: string;
+ 'urls'?: Array<{ [key: string]: any; }>;
+ /**
+ * Not yet implemented - The start of the measurement window, in milliseconds relative to the unit\'s first exposure to a flag variation
+ */
+ 'windowStartOffset'?: number;
+ /**
+ * Not yet implemented - The end of the measurement window, in milliseconds relative to the unit\'s first exposure to a flag variation
+ */
+ 'windowEndOffset'?: number;
+ /**
+ * Lower winsorization percentile, expressed as a percent in the open interval (0, 100). When both bounds are set, defines a two-sided clamp range. Otherwise lower-only winsorization.
+ */
+ 'winsorLowerPercentile'?: number;
+ /**
+ * Upper winsorization percentile, expressed as a percent in the open interval (0, 100). When both bounds are set, must be greater than winsorLowerPercentile.
+ */
+ 'winsorUpperPercentile'?: number;
+ /**
+ * When true, the percentile bound calculation includes imputed zeros. Only meaningful when at least one bound is set and the metric includes units that didn\'t send events.
+ */
+ 'winsorIncludeImputed'?: boolean;
+ /**
+ * For trace metrics, the trace query to use for the metric.
+ */
+ 'traceQuery'?: string;
+ /**
+ * For trace metrics, the location in the trace to use for numeric values.
+ */
+ 'traceValueLocation'?: string;
+ /**
+ * For count_distinct metrics, the column to count distinct values of
+ */
+ 'unitAggregationField'?: string;
+ 'denominator'?: EnvironmentReleasesMetricDenominatorRep;
+}
+
+export const EnvironmentReleasesMetricListingRepKindEnum = {
+ Pageview: 'pageview',
+ Click: 'click',
+ Custom: 'custom',
+ Trace: 'trace'
+} as const;
+
+export type EnvironmentReleasesMetricListingRepKindEnum = typeof EnvironmentReleasesMetricListingRepKindEnum[keyof typeof EnvironmentReleasesMetricListingRepKindEnum];
+export const EnvironmentReleasesMetricListingRepSuccessCriteriaEnum = {
+ HigherThanBaseline: 'HigherThanBaseline',
+ LowerThanBaseline: 'LowerThanBaseline'
+} as const;
+
+export type EnvironmentReleasesMetricListingRepSuccessCriteriaEnum = typeof EnvironmentReleasesMetricListingRepSuccessCriteriaEnum[keyof typeof EnvironmentReleasesMetricListingRepSuccessCriteriaEnum];
+export const EnvironmentReleasesMetricListingRepUnitAggregationTypeEnum = {
+ Average: 'average',
+ Sum: 'sum',
+ CountDistinct: 'count_distinct'
+} as const;
+
+export type EnvironmentReleasesMetricListingRepUnitAggregationTypeEnum = typeof EnvironmentReleasesMetricListingRepUnitAggregationTypeEnum[keyof typeof EnvironmentReleasesMetricListingRepUnitAggregationTypeEnum];
+export const EnvironmentReleasesMetricListingRepAnalysisTypeEnum = {
+ Mean: 'mean',
+ Percentile: 'percentile'
+} as const;
+
+export type EnvironmentReleasesMetricListingRepAnalysisTypeEnum = typeof EnvironmentReleasesMetricListingRepAnalysisTypeEnum[keyof typeof EnvironmentReleasesMetricListingRepAnalysisTypeEnum];
+
+export interface EnvironmentReleasesModification {
+ 'date'?: string;
+}
export interface EnvironmentSummary {
/**
* The location and content type of related resources
@@ -3958,6 +5401,10 @@ export interface ExpandableApprovalRequestResponse {
* An array of member IDs. These members are notified to review the approval request.
*/
'notifyMemberIds': ArraynotifyMemberIds, resolved when the request was made. Team membership may have changed since then.
+ */
+ 'notifyTeamKeys'?: ArraynotifyMemberIds, resolved when the request was made. Team membership may have changed since then.
+ */
+ 'notifyTeamKeys'?: Arraymodel in the request body requires a modelName and parameters, for example: ``` \"model\": { \"modelName\": \"claude-3-opus-20240229\", \"parameters\": { \"max_tokens\": 1024 } } ```
* @summary Create AI Config variation
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {AIConfigVariationPost} aIConfigVariationPost AI Config variation object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -19492,7 +22137,7 @@ export const AgentControlApiAxiosParamCreator = function (configuration?: Config
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -19508,7 +22153,7 @@ export const AgentControlApiAxiosParamCreator = function (configuration?: Config
/**
* Create an AI tool
* @summary Create an AI tool
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {AIToolPost} aIToolPost AI tool object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -19541,7 +22186,7 @@ export const AgentControlApiAxiosParamCreator = function (configuration?: Config
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -19558,7 +22203,7 @@ export const AgentControlApiAxiosParamCreator = function (configuration?: Config
* Create a new agent graph within the given project.
* @summary Create new agent graph
* @param {PostAgentGraphLDAPIVersionEnum} lDAPIVersion Version of the endpoint.
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {AgentGraphPost} agentGraphPost Agent graph object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -19593,7 +22238,7 @@ export const AgentControlApiAxiosParamCreator = function (configuration?: Config
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
if (lDAPIVersion != null) {
@@ -19612,7 +22257,7 @@ export const AgentControlApiAxiosParamCreator = function (configuration?: Config
/**
* Create a new agent optimization within the given project.
* @summary Create agent optimization
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {AgentOptimizationPost} agentOptimizationPost Agent optimization object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -19645,7 +22290,7 @@ export const AgentControlApiAxiosParamCreator = function (configuration?: Config
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -19661,8 +22306,8 @@ export const AgentControlApiAxiosParamCreator = function (configuration?: Config
/**
* Create a new result for an agent optimization run.
* @summary Create agent optimization result
- * @param {string} projectKey
- * @param {string} optimizationKey
+ * @param {string} projectKey The project key
+ * @param {string} optimizationKey The agent optimization key
* @param {AgentOptimizationResultPost} agentOptimizationResultPost Agent optimization result to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -19698,7 +22343,7 @@ export const AgentControlApiAxiosParamCreator = function (configuration?: Config
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -19714,7 +22359,7 @@ export const AgentControlApiAxiosParamCreator = function (configuration?: Config
/**
* Create a new agent skill within the given project.
* @summary Create an agent skill
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {AgentSkillPost} agentSkillPost Agent skill object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -19747,7 +22392,7 @@ export const AgentControlApiAxiosParamCreator = function (configuration?: Config
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -19763,7 +22408,7 @@ export const AgentControlApiAxiosParamCreator = function (configuration?: Config
/**
* Create an AI model config. You can use this in any variation for any config in your project.
* @summary Create an AI model config
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {ModelConfigPost} modelConfigPost AI model config object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -19796,7 +22441,7 @@ export const AgentControlApiAxiosParamCreator = function (configuration?: Config
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -19812,7 +22457,7 @@ export const AgentControlApiAxiosParamCreator = function (configuration?: Config
/**
* Create a new prompt snippet within the given project.
* @summary Create a prompt snippet
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {PromptSnippetPost} promptSnippetPost Prompt snippet object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -19845,7 +22490,7 @@ export const AgentControlApiAxiosParamCreator = function (configuration?: Config
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -19861,7 +22506,7 @@ export const AgentControlApiAxiosParamCreator = function (configuration?: Config
/**
* Add AI models, by key, to the restricted list. Keys are included in the response from the [List AI model configs](https://launchdarkly.com/docs/api/agent-control/list-model-configs) endpoint.
* @summary Add AI models to the restricted list
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {RestrictedModelsRequest} restrictedModelsRequest List of AI model keys to add to the restricted list.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -19894,7 +22539,7 @@ export const AgentControlApiAxiosParamCreator = function (configuration?: Config
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -19919,8 +22564,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Delete an existing AI Config.
* @summary Delete AI Config
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -19933,9 +22578,9 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Delete a specific variation of an AI Config by config key and variation key.
* @summary Delete AI Config variation
- * @param {string} projectKey
- * @param {string} configKey
- * @param {string} variationKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
+ * @param {string} variationKey The AI Config variation key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -19948,8 +22593,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Delete an existing AI tool.
* @summary Delete AI tool
- * @param {string} projectKey
- * @param {string} toolKey
+ * @param {string} projectKey The project key
+ * @param {string} toolKey The AI tool key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -19963,8 +22608,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
* Delete an existing agent graph and all of its edges.
* @summary Delete agent graph
* @param {DeleteAgentGraphLDAPIVersionEnum} lDAPIVersion Version of the endpoint.
- * @param {string} projectKey
- * @param {string} graphKey
+ * @param {string} projectKey The project key
+ * @param {string} graphKey The agent graph key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -19977,8 +22622,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Delete an existing agent optimization.
* @summary Delete an agent optimization
- * @param {string} projectKey
- * @param {string} optimizationKey
+ * @param {string} projectKey The project key
+ * @param {string} optimizationKey The agent optimization key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -19992,9 +22637,9 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
* Delete all results for a specific run of an agent optimization. Returns a 404 if the optimization does not exist or if the run has no results. A run whose results have already been deleted is indistinguishable from a run that never existed, so repeating this request also returns a 404.
* @summary Delete an agent optimization run
* @param {DeleteAgentOptimizationRunLDAPIVersionEnum} lDAPIVersion Version of the endpoint.
- * @param {string} projectKey
- * @param {string} optimizationKey
- * @param {string} runId
+ * @param {string} projectKey The project key
+ * @param {string} optimizationKey The agent optimization key
+ * @param {string} runId The agent optimization run ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20007,8 +22652,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Delete an agent skill, including all of its versions.
* @summary Delete an agent skill
- * @param {string} projectKey
- * @param {string} skillKey
+ * @param {string} projectKey The project key
+ * @param {string} skillKey The agent skill key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20021,8 +22666,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Delete an AI model config.
* @summary Delete an AI model config
- * @param {string} projectKey
- * @param {string} modelConfigKey
+ * @param {string} projectKey The project key
+ * @param {string} modelConfigKey The AI model config key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20035,8 +22680,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Delete an existing prompt snippet.
* @summary Delete a prompt snippet
- * @param {string} projectKey
- * @param {string} snippetKey
+ * @param {string} projectKey The project key
+ * @param {string} snippetKey The prompt snippet key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20049,7 +22694,7 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Remove AI models, by key, from the restricted list.
* @summary Remove AI models from the restricted list
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {RestrictedModelsRequest} restrictedModelsRequest List of AI model keys to remove from the restricted list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -20063,8 +22708,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Retrieve a specific AI Config by its key.
* @summary Get AI Config
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20077,8 +22722,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Retrieve usage metrics for an AI Config by config key.
* @summary Get AI Config metrics
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {number} from The starting time, as milliseconds since epoch (inclusive).
* @param {number} to The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`.
* @param {string} env An environment key. Only metrics from this environment will be included.
@@ -20096,8 +22741,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Retrieve usage metrics for an AI Config by config key, with results split by variation.
* @summary Get AI Config metrics by variation
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {number} from The starting time, as milliseconds since epoch (inclusive).
* @param {number} to The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`.
* @param {string} env An environment key. Only metrics from this environment will be included.
@@ -20115,7 +22760,7 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Retrieve aggregate quick stats for AI Configs in a project.
* @summary Get AI Config quick stats
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {string} env An environment key. Only metrics from this environment will be included.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -20129,8 +22774,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Retrieves a specific AI Config\'s targeting by its key
* @summary Show an AI Config\'s targeting
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20143,9 +22788,9 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Get an AI Config variation by key. The response includes all variation versions for the given variation key.
* @summary Get AI Config variation
- * @param {string} projectKey
- * @param {string} configKey
- * @param {string} variationKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
+ * @param {string} variationKey The AI Config variation key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20158,7 +22803,7 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Get a list of all AI Configs in the given project.
* @summary List AI Configs
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {string} [sort] A sort to apply to the list of AgentControl configs.
* @param {number} [limit] The number of resources to return.
* @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
@@ -20175,8 +22820,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Retrieve a specific AI tool by its key.
* @summary Get AI tool
- * @param {string} projectKey
- * @param {string} toolKey
+ * @param {string} projectKey The project key
+ * @param {string} toolKey The AI tool key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20190,8 +22835,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
* Retrieve a specific agent graph by its key, including its edges.
* @summary Get agent graph
* @param {GetAgentGraphLDAPIVersionEnum} lDAPIVersion Version of the endpoint.
- * @param {string} projectKey
- * @param {string} graphKey
+ * @param {string} projectKey The project key
+ * @param {string} graphKey The agent graph key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20204,8 +22849,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Retrieve a specific agent optimization by its key.
* @summary Get an agent optimization
- * @param {string} projectKey
- * @param {string} optimizationKey
+ * @param {string} projectKey The project key
+ * @param {string} optimizationKey The agent optimization key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20218,8 +22863,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Retrieve a specific agent skill by its key.
* @summary Get an agent skill
- * @param {string} projectKey
- * @param {string} skillKey
+ * @param {string} projectKey The project key
+ * @param {string} skillKey The agent skill key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20232,8 +22877,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Get an AI model config by key. Specify a version to retrieve a historical custom model config version. Global model configs accept version 0 or 1 and return their current representation.
* @summary Get AI model config
- * @param {string} projectKey
- * @param {string} modelConfigKey
+ * @param {string} projectKey The project key
+ * @param {string} modelConfigKey The AI model config key
* @param {number} [version] Specific model config version to return. Omit to return the latest version.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -20247,8 +22892,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Retrieve a specific prompt snippet by its key.
* @summary Get a prompt snippet
- * @param {string} projectKey
- * @param {string} snippetKey
+ * @param {string} projectKey The project key
+ * @param {string} snippetKey The prompt snippet key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20258,11 +22903,27 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
const localVarOperationServerBasePath = operationServerMap['AgentControlApi.getPromptSnippet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
+ /**
+ * Get all AgentControl config variations that currently reference this tool.
+ * @summary List AI tool references
+ * @param {string} projectKey The project key
+ * @param {string} toolKey The AI tool key
+ * @param {number} [limit] The number of resources to return.
+ * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
+ * @param {*} [options] Override http request option.
+ * @throws {RequiredError}
+ */
+ async listAIToolReferences(projectKey: string, toolKey: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromisemodel in the request body requires a modelName and parameters, for example: ``` \"model\": { \"modelName\": \"claude-3-opus-20240229\", \"parameters\": { \"max_tokens\": 1024 } } ```
* @summary Create AI Config variation
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {AIConfigVariationPost} aIConfigVariationPost AI Config variation object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -20683,7 +23362,7 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Create an AI tool
* @summary Create an AI tool
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {AIToolPost} aIToolPost AI tool object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -20698,7 +23377,7 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
* Create a new agent graph within the given project.
* @summary Create new agent graph
* @param {PostAgentGraphLDAPIVersionEnum} lDAPIVersion Version of the endpoint.
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {AgentGraphPost} agentGraphPost Agent graph object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -20712,7 +23391,7 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Create a new agent optimization within the given project.
* @summary Create agent optimization
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {AgentOptimizationPost} agentOptimizationPost Agent optimization object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -20726,8 +23405,8 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Create a new result for an agent optimization run.
* @summary Create agent optimization result
- * @param {string} projectKey
- * @param {string} optimizationKey
+ * @param {string} projectKey The project key
+ * @param {string} optimizationKey The agent optimization key
* @param {AgentOptimizationResultPost} agentOptimizationResultPost Agent optimization result to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -20741,7 +23420,7 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Create a new agent skill within the given project.
* @summary Create an agent skill
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {AgentSkillPost} agentSkillPost Agent skill object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -20755,7 +23434,7 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Create an AI model config. You can use this in any variation for any config in your project.
* @summary Create an AI model config
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {ModelConfigPost} modelConfigPost AI model config object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -20769,7 +23448,7 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Create a new prompt snippet within the given project.
* @summary Create a prompt snippet
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {PromptSnippetPost} promptSnippetPost Prompt snippet object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -20783,7 +23462,7 @@ export const AgentControlApiFp = function(configuration?: Configuration) {
/**
* Add AI models, by key, to the restricted list. Keys are included in the response from the [List AI model configs](https://launchdarkly.com/docs/api/agent-control/list-model-configs) endpoint.
* @summary Add AI models to the restricted list
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {RestrictedModelsRequest} restrictedModelsRequest List of AI model keys to add to the restricted list.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -20806,8 +23485,8 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Delete an existing AI Config.
* @summary Delete AI Config
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20817,9 +23496,9 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Delete a specific variation of an AI Config by config key and variation key.
* @summary Delete AI Config variation
- * @param {string} projectKey
- * @param {string} configKey
- * @param {string} variationKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
+ * @param {string} variationKey The AI Config variation key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20829,8 +23508,8 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Delete an existing AI tool.
* @summary Delete AI tool
- * @param {string} projectKey
- * @param {string} toolKey
+ * @param {string} projectKey The project key
+ * @param {string} toolKey The AI tool key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20841,8 +23520,8 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
* Delete an existing agent graph and all of its edges.
* @summary Delete agent graph
* @param {DeleteAgentGraphLDAPIVersionEnum} lDAPIVersion Version of the endpoint.
- * @param {string} projectKey
- * @param {string} graphKey
+ * @param {string} projectKey The project key
+ * @param {string} graphKey The agent graph key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20852,8 +23531,8 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Delete an existing agent optimization.
* @summary Delete an agent optimization
- * @param {string} projectKey
- * @param {string} optimizationKey
+ * @param {string} projectKey The project key
+ * @param {string} optimizationKey The agent optimization key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20864,9 +23543,9 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
* Delete all results for a specific run of an agent optimization. Returns a 404 if the optimization does not exist or if the run has no results. A run whose results have already been deleted is indistinguishable from a run that never existed, so repeating this request also returns a 404.
* @summary Delete an agent optimization run
* @param {DeleteAgentOptimizationRunLDAPIVersionEnum} lDAPIVersion Version of the endpoint.
- * @param {string} projectKey
- * @param {string} optimizationKey
- * @param {string} runId
+ * @param {string} projectKey The project key
+ * @param {string} optimizationKey The agent optimization key
+ * @param {string} runId The agent optimization run ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20876,8 +23555,8 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Delete an agent skill, including all of its versions.
* @summary Delete an agent skill
- * @param {string} projectKey
- * @param {string} skillKey
+ * @param {string} projectKey The project key
+ * @param {string} skillKey The agent skill key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20887,8 +23566,8 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Delete an AI model config.
* @summary Delete an AI model config
- * @param {string} projectKey
- * @param {string} modelConfigKey
+ * @param {string} projectKey The project key
+ * @param {string} modelConfigKey The AI model config key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20898,8 +23577,8 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Delete an existing prompt snippet.
* @summary Delete a prompt snippet
- * @param {string} projectKey
- * @param {string} snippetKey
+ * @param {string} projectKey The project key
+ * @param {string} snippetKey The prompt snippet key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20909,7 +23588,7 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Remove AI models, by key, from the restricted list.
* @summary Remove AI models from the restricted list
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {RestrictedModelsRequest} restrictedModelsRequest List of AI model keys to remove from the restricted list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -20920,8 +23599,8 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Retrieve a specific AI Config by its key.
* @summary Get AI Config
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20931,8 +23610,8 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Retrieve usage metrics for an AI Config by config key.
* @summary Get AI Config metrics
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {number} from The starting time, as milliseconds since epoch (inclusive).
* @param {number} to The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`.
* @param {string} env An environment key. Only metrics from this environment will be included.
@@ -20947,8 +23626,8 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Retrieve usage metrics for an AI Config by config key, with results split by variation.
* @summary Get AI Config metrics by variation
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {number} from The starting time, as milliseconds since epoch (inclusive).
* @param {number} to The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`.
* @param {string} env An environment key. Only metrics from this environment will be included.
@@ -20963,7 +23642,7 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Retrieve aggregate quick stats for AI Configs in a project.
* @summary Get AI Config quick stats
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {string} env An environment key. Only metrics from this environment will be included.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -20974,8 +23653,8 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Retrieves a specific AI Config\'s targeting by its key
* @summary Show an AI Config\'s targeting
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20985,9 +23664,9 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Get an AI Config variation by key. The response includes all variation versions for the given variation key.
* @summary Get AI Config variation
- * @param {string} projectKey
- * @param {string} configKey
- * @param {string} variationKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
+ * @param {string} variationKey The AI Config variation key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -20997,7 +23676,7 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Get a list of all AI Configs in the given project.
* @summary List AI Configs
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {string} [sort] A sort to apply to the list of AgentControl configs.
* @param {number} [limit] The number of resources to return.
* @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
@@ -21011,8 +23690,8 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Retrieve a specific AI tool by its key.
* @summary Get AI tool
- * @param {string} projectKey
- * @param {string} toolKey
+ * @param {string} projectKey The project key
+ * @param {string} toolKey The AI tool key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21023,8 +23702,8 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
* Retrieve a specific agent graph by its key, including its edges.
* @summary Get agent graph
* @param {GetAgentGraphLDAPIVersionEnum} lDAPIVersion Version of the endpoint.
- * @param {string} projectKey
- * @param {string} graphKey
+ * @param {string} projectKey The project key
+ * @param {string} graphKey The agent graph key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21034,8 +23713,8 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Retrieve a specific agent optimization by its key.
* @summary Get an agent optimization
- * @param {string} projectKey
- * @param {string} optimizationKey
+ * @param {string} projectKey The project key
+ * @param {string} optimizationKey The agent optimization key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21045,8 +23724,8 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Retrieve a specific agent skill by its key.
* @summary Get an agent skill
- * @param {string} projectKey
- * @param {string} skillKey
+ * @param {string} projectKey The project key
+ * @param {string} skillKey The agent skill key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21056,8 +23735,8 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Get an AI model config by key. Specify a version to retrieve a historical custom model config version. Global model configs accept version 0 or 1 and return their current representation.
* @summary Get AI model config
- * @param {string} projectKey
- * @param {string} modelConfigKey
+ * @param {string} projectKey The project key
+ * @param {string} modelConfigKey The AI model config key
* @param {number} [version] Specific model config version to return. Omit to return the latest version.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -21068,19 +23747,32 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Retrieve a specific prompt snippet by its key.
* @summary Get a prompt snippet
- * @param {string} projectKey
- * @param {string} snippetKey
+ * @param {string} projectKey The project key
+ * @param {string} snippetKey The prompt snippet key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPromptSnippet(projectKey: string, snippetKey: string, options?: RawAxiosRequestConfig): AxiosPromisemodel in the request body requires a modelName and parameters, for example: ``` \"model\": { \"modelName\": \"claude-3-opus-20240229\", \"parameters\": { \"max_tokens\": 1024 } } ```
* @summary Create AI Config variation
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {AIConfigVariationPost} aIConfigVariationPost AI Config variation object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -21420,7 +24127,7 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Create an AI tool
* @summary Create an AI tool
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {AIToolPost} aIToolPost AI tool object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -21432,7 +24139,7 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
* Create a new agent graph within the given project.
* @summary Create new agent graph
* @param {PostAgentGraphLDAPIVersionEnum} lDAPIVersion Version of the endpoint.
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {AgentGraphPost} agentGraphPost Agent graph object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -21443,7 +24150,7 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Create a new agent optimization within the given project.
* @summary Create agent optimization
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {AgentOptimizationPost} agentOptimizationPost Agent optimization object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -21454,8 +24161,8 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Create a new result for an agent optimization run.
* @summary Create agent optimization result
- * @param {string} projectKey
- * @param {string} optimizationKey
+ * @param {string} projectKey The project key
+ * @param {string} optimizationKey The agent optimization key
* @param {AgentOptimizationResultPost} agentOptimizationResultPost Agent optimization result to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -21466,7 +24173,7 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Create a new agent skill within the given project.
* @summary Create an agent skill
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {AgentSkillPost} agentSkillPost Agent skill object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -21477,7 +24184,7 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Create an AI model config. You can use this in any variation for any config in your project.
* @summary Create an AI model config
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {ModelConfigPost} modelConfigPost AI model config object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -21488,7 +24195,7 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Create a new prompt snippet within the given project.
* @summary Create a prompt snippet
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {PromptSnippetPost} promptSnippetPost Prompt snippet object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -21499,7 +24206,7 @@ export const AgentControlApiFactory = function (configuration?: Configuration, b
/**
* Add AI models, by key, to the restricted list. Keys are included in the response from the [List AI model configs](https://launchdarkly.com/docs/api/agent-control/list-model-configs) endpoint.
* @summary Add AI models to the restricted list
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {RestrictedModelsRequest} restrictedModelsRequest List of AI model keys to add to the restricted list.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -21517,8 +24224,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Delete an existing AI Config.
* @summary Delete AI Config
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21529,9 +24236,9 @@ export class AgentControlApi extends BaseAPI {
/**
* Delete a specific variation of an AI Config by config key and variation key.
* @summary Delete AI Config variation
- * @param {string} projectKey
- * @param {string} configKey
- * @param {string} variationKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
+ * @param {string} variationKey The AI Config variation key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21542,8 +24249,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Delete an existing AI tool.
* @summary Delete AI tool
- * @param {string} projectKey
- * @param {string} toolKey
+ * @param {string} projectKey The project key
+ * @param {string} toolKey The AI tool key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21555,8 +24262,8 @@ export class AgentControlApi extends BaseAPI {
* Delete an existing agent graph and all of its edges.
* @summary Delete agent graph
* @param {DeleteAgentGraphLDAPIVersionEnum} lDAPIVersion Version of the endpoint.
- * @param {string} projectKey
- * @param {string} graphKey
+ * @param {string} projectKey The project key
+ * @param {string} graphKey The agent graph key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21567,8 +24274,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Delete an existing agent optimization.
* @summary Delete an agent optimization
- * @param {string} projectKey
- * @param {string} optimizationKey
+ * @param {string} projectKey The project key
+ * @param {string} optimizationKey The agent optimization key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21580,9 +24287,9 @@ export class AgentControlApi extends BaseAPI {
* Delete all results for a specific run of an agent optimization. Returns a 404 if the optimization does not exist or if the run has no results. A run whose results have already been deleted is indistinguishable from a run that never existed, so repeating this request also returns a 404.
* @summary Delete an agent optimization run
* @param {DeleteAgentOptimizationRunLDAPIVersionEnum} lDAPIVersion Version of the endpoint.
- * @param {string} projectKey
- * @param {string} optimizationKey
- * @param {string} runId
+ * @param {string} projectKey The project key
+ * @param {string} optimizationKey The agent optimization key
+ * @param {string} runId The agent optimization run ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21593,8 +24300,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Delete an agent skill, including all of its versions.
* @summary Delete an agent skill
- * @param {string} projectKey
- * @param {string} skillKey
+ * @param {string} projectKey The project key
+ * @param {string} skillKey The agent skill key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21605,8 +24312,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Delete an AI model config.
* @summary Delete an AI model config
- * @param {string} projectKey
- * @param {string} modelConfigKey
+ * @param {string} projectKey The project key
+ * @param {string} modelConfigKey The AI model config key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21617,8 +24324,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Delete an existing prompt snippet.
* @summary Delete a prompt snippet
- * @param {string} projectKey
- * @param {string} snippetKey
+ * @param {string} projectKey The project key
+ * @param {string} snippetKey The prompt snippet key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21629,7 +24336,7 @@ export class AgentControlApi extends BaseAPI {
/**
* Remove AI models, by key, from the restricted list.
* @summary Remove AI models from the restricted list
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {RestrictedModelsRequest} restrictedModelsRequest List of AI model keys to remove from the restricted list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -21641,8 +24348,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Retrieve a specific AI Config by its key.
* @summary Get AI Config
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21653,8 +24360,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Retrieve usage metrics for an AI Config by config key.
* @summary Get AI Config metrics
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {number} from The starting time, as milliseconds since epoch (inclusive).
* @param {number} to The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`.
* @param {string} env An environment key. Only metrics from this environment will be included.
@@ -21670,8 +24377,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Retrieve usage metrics for an AI Config by config key, with results split by variation.
* @summary Get AI Config metrics by variation
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {number} from The starting time, as milliseconds since epoch (inclusive).
* @param {number} to The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`.
* @param {string} env An environment key. Only metrics from this environment will be included.
@@ -21687,7 +24394,7 @@ export class AgentControlApi extends BaseAPI {
/**
* Retrieve aggregate quick stats for AI Configs in a project.
* @summary Get AI Config quick stats
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {string} env An environment key. Only metrics from this environment will be included.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -21699,8 +24406,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Retrieves a specific AI Config\'s targeting by its key
* @summary Show an AI Config\'s targeting
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21711,9 +24418,9 @@ export class AgentControlApi extends BaseAPI {
/**
* Get an AI Config variation by key. The response includes all variation versions for the given variation key.
* @summary Get AI Config variation
- * @param {string} projectKey
- * @param {string} configKey
- * @param {string} variationKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
+ * @param {string} variationKey The AI Config variation key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21724,7 +24431,7 @@ export class AgentControlApi extends BaseAPI {
/**
* Get a list of all AI Configs in the given project.
* @summary List AI Configs
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {string} [sort] A sort to apply to the list of AgentControl configs.
* @param {number} [limit] The number of resources to return.
* @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
@@ -21739,8 +24446,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Retrieve a specific AI tool by its key.
* @summary Get AI tool
- * @param {string} projectKey
- * @param {string} toolKey
+ * @param {string} projectKey The project key
+ * @param {string} toolKey The AI tool key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21752,8 +24459,8 @@ export class AgentControlApi extends BaseAPI {
* Retrieve a specific agent graph by its key, including its edges.
* @summary Get agent graph
* @param {GetAgentGraphLDAPIVersionEnum} lDAPIVersion Version of the endpoint.
- * @param {string} projectKey
- * @param {string} graphKey
+ * @param {string} projectKey The project key
+ * @param {string} graphKey The agent graph key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21764,8 +24471,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Retrieve a specific agent optimization by its key.
* @summary Get an agent optimization
- * @param {string} projectKey
- * @param {string} optimizationKey
+ * @param {string} projectKey The project key
+ * @param {string} optimizationKey The agent optimization key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21776,8 +24483,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Retrieve a specific agent skill by its key.
* @summary Get an agent skill
- * @param {string} projectKey
- * @param {string} skillKey
+ * @param {string} projectKey The project key
+ * @param {string} skillKey The agent skill key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21788,8 +24495,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Get an AI model config by key. Specify a version to retrieve a historical custom model config version. Global model configs accept version 0 or 1 and return their current representation.
* @summary Get AI model config
- * @param {string} projectKey
- * @param {string} modelConfigKey
+ * @param {string} projectKey The project key
+ * @param {string} modelConfigKey The AI model config key
* @param {number} [version] Specific model config version to return. Omit to return the latest version.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -21801,8 +24508,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Retrieve a specific prompt snippet by its key.
* @summary Get a prompt snippet
- * @param {string} projectKey
- * @param {string} snippetKey
+ * @param {string} projectKey The project key
+ * @param {string} snippetKey The prompt snippet key
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21810,11 +24517,25 @@ export class AgentControlApi extends BaseAPI {
return AgentControlApiFp(this.configuration).getPromptSnippet(projectKey, snippetKey, options).then((request) => request(this.axios, this.basePath));
}
+ /**
+ * Get all AgentControl config variations that currently reference this tool.
+ * @summary List AI tool references
+ * @param {string} projectKey The project key
+ * @param {string} toolKey The AI tool key
+ * @param {number} [limit] The number of resources to return.
+ * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
+ * @param {*} [options] Override http request option.
+ * @throws {RequiredError}
+ */
+ public listAIToolReferences(projectKey: string, toolKey: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) {
+ return AgentControlApiFp(this.configuration).listAIToolReferences(projectKey, toolKey, limit, offset, options).then((request) => request(this.axios, this.basePath));
+ }
+
/**
* Get a list of all versions of an AI tool in the given project.
* @summary List AI tool versions
- * @param {string} projectKey
- * @param {string} toolKey
+ * @param {string} projectKey The project key
+ * @param {string} toolKey The AI tool key
* @param {string} [sort] A sort to apply to the list of AgentControl configs.
* @param {number} [limit] The number of resources to return.
* @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
@@ -21828,7 +24549,7 @@ export class AgentControlApi extends BaseAPI {
/**
* Get a list of all AI tools in the given project.
* @summary List AI tools
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {string} [sort] A sort to apply to the list of AgentControl configs.
* @param {number} [limit] The number of resources to return.
* @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
@@ -21844,7 +24565,7 @@ export class AgentControlApi extends BaseAPI {
* Get a list of all agent graphs in the given project. Returns metadata only, without edge data.
* @summary List agent graphs
* @param {ListAgentGraphsLDAPIVersionEnum} lDAPIVersion Version of the endpoint.
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {number} [limit] The number of resources to return.
* @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
* @param {string} [filter] A filter to apply to the list.
@@ -21857,9 +24578,9 @@ export class AgentControlApi extends BaseAPI {
/**
* Get the most recent result for each unique run of an agent optimization.
- * @summary List agent optimization runs
- * @param {string} projectKey
- * @param {string} optimizationKey
+ * @summary List latest agent optimization result per run
+ * @param {string} projectKey The project key
+ * @param {string} optimizationKey The agent optimization key
* @param {number} [limit] The number of resources to return.
* @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
* @param {*} [options] Override http request option.
@@ -21872,9 +24593,9 @@ export class AgentControlApi extends BaseAPI {
/**
* Get all results for a specific run of an agent optimization, sorted by iteration descending.
* @summary List agent optimization results for a run
- * @param {string} projectKey
- * @param {string} optimizationKey
- * @param {string} runId
+ * @param {string} projectKey The project key
+ * @param {string} optimizationKey The agent optimization key
+ * @param {string} runId The agent optimization run ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@@ -21882,10 +24603,24 @@ export class AgentControlApi extends BaseAPI {
return AgentControlApiFp(this.configuration).listAgentOptimizationResultsByRunId(projectKey, optimizationKey, runId, options).then((request) => request(this.axios, this.basePath));
}
+ /**
+ * Get one run summary per distinct run_id across all versions of an agent optimization config, ordered by created_at DESC.
+ * @summary List agent optimization runs
+ * @param {string} projectKey The project key
+ * @param {string} optimizationKey The agent optimization key
+ * @param {number} [limit] The number of resources to return.
+ * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
+ * @param {*} [options] Override http request option.
+ * @throws {RequiredError}
+ */
+ public listAgentOptimizationRuns(projectKey: string, optimizationKey: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) {
+ return AgentControlApiFp(this.configuration).listAgentOptimizationRuns(projectKey, optimizationKey, limit, offset, options).then((request) => request(this.axios, this.basePath));
+ }
+
/**
* Get a list of all agent optimizations in the given project.
* @summary List agent optimizations
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {number} [limit] The number of resources to return.
* @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
* @param {string} [filter] A filter to apply to the list.
@@ -21899,8 +24634,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Get all config variations that currently reference this agent skill.
* @summary List agent skill references
- * @param {string} projectKey
- * @param {string} skillKey
+ * @param {string} projectKey The project key
+ * @param {string} skillKey The agent skill key
* @param {number} [limit] The number of resources to return.
* @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
* @param {*} [options] Override http request option.
@@ -21913,8 +24648,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Get all versions of an agent skill in the given project, ordered by version descending.
* @summary List agent skill versions
- * @param {string} projectKey
- * @param {string} skillKey
+ * @param {string} projectKey The project key
+ * @param {string} skillKey The agent skill key
* @param {number} [limit] The number of resources to return.
* @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
* @param {*} [options] Override http request option.
@@ -21927,7 +24662,7 @@ export class AgentControlApi extends BaseAPI {
/**
* Get a list of all agent skills in the given project.
* @summary List agent skills
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {number} [limit] The number of resources to return.
* @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
* @param {string} [filter] A filter to apply to the list.
@@ -21941,8 +24676,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Get all results across all versions of an agent optimization.
* @summary List all agent optimization results across versions
- * @param {string} projectKey
- * @param {string} optimizationKey
+ * @param {string} projectKey The project key
+ * @param {string} optimizationKey The agent optimization key
* @param {number} [limit] The number of resources to return.
* @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
* @param {*} [options] Override http request option.
@@ -21955,8 +24690,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Get a paginated list of all available versions of an AI model config, ordered from newest to oldest. Global model configs return their single current representation.
* @summary List AI model config versions
- * @param {string} projectKey
- * @param {string} modelConfigKey
+ * @param {string} projectKey The project key
+ * @param {string} modelConfigKey The AI model config key
* @param {number} [limit] The number of resources to return.
* @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
* @param {*} [options] Override http request option.
@@ -21969,20 +24704,22 @@ export class AgentControlApi extends BaseAPI {
/**
* Get all AI model configs for a project.
* @summary List AI model configs
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {boolean} [restricted] Whether to return only restricted models
+ * @param {string} [sort] A sort to apply to the list of AgentControl configs.
+ * @param {string} [filter] A filter to apply to the list.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
- public listModelConfigs(projectKey: string, restricted?: boolean, options?: RawAxiosRequestConfig) {
- return AgentControlApiFp(this.configuration).listModelConfigs(projectKey, restricted, options).then((request) => request(this.axios, this.basePath));
+ public listModelConfigs(projectKey: string, restricted?: boolean, sort?: string, filter?: string, options?: RawAxiosRequestConfig) {
+ return AgentControlApiFp(this.configuration).listModelConfigs(projectKey, restricted, sort, filter, options).then((request) => request(this.axios, this.basePath));
}
/**
* Get all config variations that currently reference this prompt snippet.
* @summary List prompt snippet references
- * @param {string} projectKey
- * @param {string} snippetKey
+ * @param {string} projectKey The project key
+ * @param {string} snippetKey The prompt snippet key
* @param {number} [limit] The number of resources to return.
* @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
* @param {*} [options] Override http request option.
@@ -21995,8 +24732,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Get all versions of a prompt snippet in the given project, ordered by version descending.
* @summary List prompt snippet versions
- * @param {string} projectKey
- * @param {string} snippetKey
+ * @param {string} projectKey The project key
+ * @param {string} snippetKey The prompt snippet key
* @param {number} [limit] The number of resources to return.
* @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
* @param {*} [options] Override http request option.
@@ -22009,7 +24746,7 @@ export class AgentControlApi extends BaseAPI {
/**
* Get a list of all prompt snippets in the given project.
* @summary List prompt snippets
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {number} [limit] The number of resources to return.
* @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
* @param {string} [filter] A filter to apply to the list.
@@ -22023,8 +24760,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Edit an existing AI 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\"] } ```
* @summary Update AI Config
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {AIConfigPatch} [aIConfigPatch] AI Config object to update
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -22036,8 +24773,8 @@ export class AgentControlApi extends BaseAPI {
/**
* 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. model in the request body requires a modelName and parameters, for example: ``` \"model\": { \"modelName\": \"claude-3-opus-20240229\", \"parameters\": { \"max_tokens\": 1024 } } ```
* @summary Create AI Config variation
- * @param {string} projectKey
- * @param {string} configKey
+ * @param {string} projectKey The project key
+ * @param {string} configKey The AI Config key
* @param {AIConfigVariationPost} aIConfigVariationPost AI Config variation object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -22181,7 +24918,7 @@ export class AgentControlApi extends BaseAPI {
/**
* Create an AI tool
* @summary Create an AI tool
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {AIToolPost} aIToolPost AI tool object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -22194,7 +24931,7 @@ export class AgentControlApi extends BaseAPI {
* Create a new agent graph within the given project.
* @summary Create new agent graph
* @param {PostAgentGraphLDAPIVersionEnum} lDAPIVersion Version of the endpoint.
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {AgentGraphPost} agentGraphPost Agent graph object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -22206,7 +24943,7 @@ export class AgentControlApi extends BaseAPI {
/**
* Create a new agent optimization within the given project.
* @summary Create agent optimization
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {AgentOptimizationPost} agentOptimizationPost Agent optimization object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -22218,8 +24955,8 @@ export class AgentControlApi extends BaseAPI {
/**
* Create a new result for an agent optimization run.
* @summary Create agent optimization result
- * @param {string} projectKey
- * @param {string} optimizationKey
+ * @param {string} projectKey The project key
+ * @param {string} optimizationKey The agent optimization key
* @param {AgentOptimizationResultPost} agentOptimizationResultPost Agent optimization result to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -22231,7 +24968,7 @@ export class AgentControlApi extends BaseAPI {
/**
* Create a new agent skill within the given project.
* @summary Create an agent skill
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {AgentSkillPost} agentSkillPost Agent skill object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -22243,7 +24980,7 @@ export class AgentControlApi extends BaseAPI {
/**
* Create an AI model config. You can use this in any variation for any config in your project.
* @summary Create an AI model config
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {ModelConfigPost} modelConfigPost AI model config object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -22255,7 +24992,7 @@ export class AgentControlApi extends BaseAPI {
/**
* Create a new prompt snippet within the given project.
* @summary Create a prompt snippet
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {PromptSnippetPost} promptSnippetPost Prompt snippet object to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -22267,7 +25004,7 @@ export class AgentControlApi extends BaseAPI {
/**
* Add AI models, by key, to the restricted list. Keys are included in the response from the [List AI model configs](https://launchdarkly.com/docs/api/agent-control/list-model-configs) endpoint.
* @summary Add AI models to the restricted list
- * @param {string} projectKey
+ * @param {string} projectKey The project key
* @param {RestrictedModelsRequest} restrictedModelsRequest List of AI model keys to add to the restricted list.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@@ -22340,7 +25077,7 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration?: Confi
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -22385,7 +25122,7 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration?: Confi
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -22440,7 +25177,7 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration?: Confi
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -22488,7 +25225,7 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration?: Confi
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -22717,7 +25454,7 @@ export const ApplicationsBetaApiAxiosParamCreator = function (configuration?: Co
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -22765,7 +25502,7 @@ export const ApplicationsBetaApiAxiosParamCreator = function (configuration?: Co
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -22814,7 +25551,7 @@ export const ApplicationsBetaApiAxiosParamCreator = function (configuration?: Co
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -22878,7 +25615,7 @@ export const ApplicationsBetaApiAxiosParamCreator = function (configuration?: Co
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -22943,7 +25680,7 @@ export const ApplicationsBetaApiAxiosParamCreator = function (configuration?: Co
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -22991,7 +25728,7 @@ export const ApplicationsBetaApiAxiosParamCreator = function (configuration?: Co
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -23044,7 +25781,7 @@ export const ApplicationsBetaApiAxiosParamCreator = function (configuration?: Co
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -23399,7 +26136,7 @@ export const ApprovalsApiAxiosParamCreator = function (configuration?: Configura
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -23455,7 +26192,7 @@ export const ApprovalsApiAxiosParamCreator = function (configuration?: Configura
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -23511,7 +26248,7 @@ export const ApprovalsApiAxiosParamCreator = function (configuration?: Configura
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -23560,7 +26297,7 @@ export const ApprovalsApiAxiosParamCreator = function (configuration?: Configura
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -23620,7 +26357,7 @@ export const ApprovalsApiAxiosParamCreator = function (configuration?: Configura
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -23672,7 +26409,7 @@ export const ApprovalsApiAxiosParamCreator = function (configuration?: Configura
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -23716,7 +26453,7 @@ export const ApprovalsApiAxiosParamCreator = function (configuration?: Configura
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -23765,7 +26502,7 @@ export const ApprovalsApiAxiosParamCreator = function (configuration?: Configura
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -23826,7 +26563,7 @@ export const ApprovalsApiAxiosParamCreator = function (configuration?: Configura
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -23883,7 +26620,7 @@ export const ApprovalsApiAxiosParamCreator = function (configuration?: Configura
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -23932,7 +26669,7 @@ export const ApprovalsApiAxiosParamCreator = function (configuration?: Configura
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -23993,7 +26730,7 @@ export const ApprovalsApiAxiosParamCreator = function (configuration?: Configura
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -24050,7 +26787,7 @@ export const ApprovalsApiAxiosParamCreator = function (configuration?: Configura
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -24672,7 +27409,7 @@ export const ApprovalsBetaApiAxiosParamCreator = function (configuration?: Confi
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
if (lDAPIVersion != null) {
@@ -24723,7 +27460,7 @@ export const ApprovalsBetaApiAxiosParamCreator = function (configuration?: Confi
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -24773,7 +27510,7 @@ export const ApprovalsBetaApiAxiosParamCreator = function (configuration?: Confi
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
if (lDAPIVersion != null) {
@@ -24833,7 +27570,7 @@ export const ApprovalsBetaApiAxiosParamCreator = function (configuration?: Confi
// Set default API version.
localVarHeaderParameter['LD-API-Version'] = '20240415';
// Set a custom LaunchDarkly user agent header.
- localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/24.0.0/typescript';
+ localVarHeaderParameter['X-LaunchDarkly-User-Agent'] = 'OpenAPI-Generator/25.0.0/typescript';
// CUSTOM-END
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -25053,17 +27790,19 @@ export type PatchApprovalRequestSettingsLDAPIVersionEnum = typeof PatchApprovalR
export const AuditLogApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
- * Get a list of all audit log entries. The query parameters let you restrict the results that return by date ranges, resource specifiers, or a full-text search query. LaunchDarkly uses a resource specifier syntax to name resources or collections of resources. To learn more, read [About the resource specifier syntax](https://launchdarkly.com/docs/home/account/role-resources#about-the-resource-specifier-syntax).
+ * Get a list of all audit log entries. The query parameters let you restrict the results that return by date ranges, resource specifiers, or a full-text search query. LaunchDarkly uses a resource specifier syntax to name resources or collections of resources. To learn more, read [Specifying resources in the advanced editor](https://launchdarkly.com/docs/home/account/roles/role-resources#specifying-resources-in-the-advanced-editor).
* @summary List audit log entries
* @param {number} [before] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred before the timestamp.
* @param {number} [after] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred after the timestamp.
* @param {string} [q] Text to search for. You can search for the full or partial name of the resource.
* @param {number} [limit] A limit on the number of audit log entries that return. Set between 1 and 20. The default is 10.
* @param {string} [spec] A resource specifier that lets you filter audit log listings by resource
+ * @param {string} [member] A member ID that lets you filter audit log listings by the member who made the change. Repeat the parameter to filter by multiple members.
+ * @param {string} [token] An access token ID that lets you filter audit log listings by the token that made the change. Repeat the parameter to filter by multiple tokens.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
- getAuditLogEntries: async (before?: number, after?: number, q?: string, limit?: number, spec?: string, options: RawAxiosRequestConfig = {}): Promise