@orq-ai/node 4.11.0-rc.3 → 4.11.0-rc.5

package/models/operations/createagentrequest.d.ts

@@ -208,6 +208,61 @@ export type Timeout = {
      */
     callTimeout: number;
 };
+/**
+ * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+ */
+export declare const CreateAgentRequestModelConfigurationType: {
+    readonly Ephemeral: "ephemeral";
+};
+/**
+ * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+ */
+export type CreateAgentRequestModelConfigurationType = ClosedEnum<typeof CreateAgentRequestModelConfigurationType>;
+/**
+ * The time-to-live for the cache control breakpoint. This may be one of the following values:
+ *
+ * @remarks
+ *
+ * - `5m`: 5 minutes
+ * - `1h`: 1 hour
+ *
+ * Defaults to `5m`. Only supported by `Anthropic` Claude models.
+ */
+export declare const ModelConfigurationTtl: {
+    readonly Fivem: "5m";
+    readonly Oneh: "1h";
+};
+/**
+ * The time-to-live for the cache control breakpoint. This may be one of the following values:
+ *
+ * @remarks
+ *
+ * - `5m`: 5 minutes
+ * - `1h`: 1 hour
+ *
+ * Defaults to `5m`. Only supported by `Anthropic` Claude models.
+ */
+export type ModelConfigurationTtl = ClosedEnum<typeof ModelConfigurationTtl>;
+/**
+ * Provider-level prompt caching configuration applied to the request. Creates a cache control breakpoint covering the request content. Only supported by `Anthropic` Claude models.
+ */
+export type ModelConfigurationCacheControl = {
+    /**
+     * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+     */
+    type: CreateAgentRequestModelConfigurationType;
+    /**
+     * The time-to-live for the cache control breakpoint. This may be one of the following values:
+     *
+     * @remarks
+     *
+     * - `5m`: 5 minutes
+     * - `1h`: 1 hour
+     *
+     * Defaults to `5m`. Only supported by `Anthropic` Claude models.
+     */
+    ttl?: ModelConfigurationTtl | undefined;
+};
 /**
  * Model behavior parameters that control how the model generates responses. Common parameters: `temperature` (0-1, randomness), `max_completion_tokens` (max output length), `top_p` (sampling diversity). Advanced: `frequency_penalty`, `presence_penalty`, `response_format` (JSON/structured), `reasoning_effort`, `seed` (reproducibility). Support varies by model - consult AI Gateway documentation.
  */
@@ -310,6 +365,14 @@ export type ParametersT = {
      * Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured.
      */
     timeout?: Timeout | undefined;
+    /**
+     * Provider-level prompt caching configuration applied to the request. Creates a cache control breakpoint covering the request content. Only supported by `Anthropic` Claude models.
+     */
+    cacheControl?: ModelConfigurationCacheControl | undefined;
+    /**
+     * Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching.
+     */
+    promptCacheKey?: string | undefined;
 };
 /**
  * Retry configuration for model requests. Retries are triggered for specific HTTP status codes (e.g., 500, 429, 502, 503, 504). Supports configurable retry count (1-5) and custom status codes.
@@ -552,6 +615,61 @@ export type FallbackModelConfigurationTimeout = {
      */
     callTimeout: number;
 };
+/**
+ * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+ */
+export declare const CreateAgentRequestFallbackModelConfigurationType: {
+    readonly Ephemeral: "ephemeral";
+};
+/**
+ * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+ */
+export type CreateAgentRequestFallbackModelConfigurationType = ClosedEnum<typeof CreateAgentRequestFallbackModelConfigurationType>;
+/**
+ * The time-to-live for the cache control breakpoint. This may be one of the following values:
+ *
+ * @remarks
+ *
+ * - `5m`: 5 minutes
+ * - `1h`: 1 hour
+ *
+ * Defaults to `5m`. Only supported by `Anthropic` Claude models.
+ */
+export declare const FallbackModelConfigurationTtl: {
+    readonly Fivem: "5m";
+    readonly Oneh: "1h";
+};
+/**
+ * The time-to-live for the cache control breakpoint. This may be one of the following values:
+ *
+ * @remarks
+ *
+ * - `5m`: 5 minutes
+ * - `1h`: 1 hour
+ *
+ * Defaults to `5m`. Only supported by `Anthropic` Claude models.
+ */
+export type FallbackModelConfigurationTtl = ClosedEnum<typeof FallbackModelConfigurationTtl>;
+/**
+ * Provider-level prompt caching configuration applied to the request. Creates a cache control breakpoint covering the request content. Only supported by `Anthropic` Claude models.
+ */
+export type FallbackModelConfigurationCacheControl = {
+    /**
+     * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+     */
+    type: CreateAgentRequestFallbackModelConfigurationType;
+    /**
+     * The time-to-live for the cache control breakpoint. This may be one of the following values:
+     *
+     * @remarks
+     *
+     * - `5m`: 5 minutes
+     * - `1h`: 1 hour
+     *
+     * Defaults to `5m`. Only supported by `Anthropic` Claude models.
+     */
+    ttl?: FallbackModelConfigurationTtl | undefined;
+};
 /**
  * Optional model parameters specific to this fallback model. Overrides primary model parameters if this fallback is used.
  */
@@ -654,6 +772,14 @@ export type FallbackModelConfigurationParameters = {
      * Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured.
      */
     timeout?: FallbackModelConfigurationTimeout | undefined;
+    /**
+     * Provider-level prompt caching configuration applied to the request. Creates a cache control breakpoint covering the request content. Only supported by `Anthropic` Claude models.
+     */
+    cacheControl?: FallbackModelConfigurationCacheControl | undefined;
+    /**
+     * Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching.
+     */
+    promptCacheKey?: string | undefined;
 };
 /**
  * Retry configuration for this fallback model. Allows customizing retry count (1-5) and HTTP status codes that trigger retries.
@@ -1598,6 +1724,61 @@ export type CreateAgentRequestTimeout = {
      */
     callTimeout: number;
 };
+/**
+ * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+ */
+export declare const CreateAgentRequestAgentsResponseType: {
+    readonly Ephemeral: "ephemeral";
+};
+/**
+ * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+ */
+export type CreateAgentRequestAgentsResponseType = ClosedEnum<typeof CreateAgentRequestAgentsResponseType>;
+/**
+ * The time-to-live for the cache control breakpoint. This may be one of the following values:
+ *
+ * @remarks
+ *
+ * - `5m`: 5 minutes
+ * - `1h`: 1 hour
+ *
+ * Defaults to `5m`. Only supported by `Anthropic` Claude models.
+ */
+export declare const CreateAgentRequestTtl: {
+    readonly Fivem: "5m";
+    readonly Oneh: "1h";
+};
+/**
+ * The time-to-live for the cache control breakpoint. This may be one of the following values:
+ *
+ * @remarks
+ *
+ * - `5m`: 5 minutes
+ * - `1h`: 1 hour
+ *
+ * Defaults to `5m`. Only supported by `Anthropic` Claude models.
+ */
+export type CreateAgentRequestTtl = ClosedEnum<typeof CreateAgentRequestTtl>;
+/**
+ * Provider-level prompt caching configuration applied to the request. Creates a cache control breakpoint covering the request content. Only supported by `Anthropic` Claude models.
+ */
+export type CreateAgentRequestCacheControl = {
+    /**
+     * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+     */
+    type: CreateAgentRequestAgentsResponseType;
+    /**
+     * The time-to-live for the cache control breakpoint. This may be one of the following values:
+     *
+     * @remarks
+     *
+     * - `5m`: 5 minutes
+     * - `1h`: 1 hour
+     *
+     * Defaults to `5m`. Only supported by `Anthropic` Claude models.
+     */
+    ttl: CreateAgentRequestTtl;
+};
 /**
  * Model behavior parameters (snake_case) stored as part of the agent configuration. These become the default parameters used when the agent is executed. Commonly used: temperature (0-1, controls randomness), max_completion_tokens (response length), top_p (nucleus sampling). Advanced: frequency_penalty, presence_penalty, response_format (JSON/structured output), reasoning_effort (for o1/thinking models), seed (reproducibility), stop sequences. Model-specific support varies. Runtime parameters in agent execution requests can override these defaults.
  */
@@ -1700,6 +1881,14 @@ export type CreateAgentRequestParameters = {
      * Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured.
      */
     timeout?: CreateAgentRequestTimeout | undefined;
+    /**
+     * Provider-level prompt caching configuration applied to the request. Creates a cache control breakpoint covering the request content. Only supported by `Anthropic` Claude models.
+     */
+    cacheControl?: CreateAgentRequestCacheControl | undefined;
+    /**
+     * Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching.
+     */
+    promptCacheKey?: string | undefined;
 };
 /**
  * Retry configuration for model requests. Allows customizing retry count (1-5) and HTTP status codes that trigger retries. Default codes: [429]. Common codes: 500 (internal error), 429 (rate limit), 502/503/504 (gateway errors).
@@ -1874,10 +2063,10 @@ export type CreateAgentRequestFallbackModelConfigurationFallbacks = {
      */
     model: string;
 };
-export declare const CreateAgentRequestFallbackModelConfigurationType: {
+export declare const CreateAgentRequestFallbackModelConfigurationAgentsType: {
     readonly ExactMatch: "exact_match";
 };
-export type CreateAgentRequestFallbackModelConfigurationType = ClosedEnum<typeof CreateAgentRequestFallbackModelConfigurationType>;
+export type CreateAgentRequestFallbackModelConfigurationAgentsType = ClosedEnum<typeof CreateAgentRequestFallbackModelConfigurationAgentsType>;
 /**
  * Cache configuration for the request.
  */
@@ -1886,7 +2075,7 @@ export type CreateAgentRequestFallbackModelConfigurationCache = {
      * Time to live for cached responses in seconds. Maximum 259200 seconds (3 days).
      */
     ttl: number;
-    type: CreateAgentRequestFallbackModelConfigurationType;
+    type: CreateAgentRequestFallbackModelConfigurationAgentsType;
 };
 export declare const CreateAgentRequestLoadBalancerAgentsResponseType: {
     readonly WeightBased: "weight_based";
@@ -1919,6 +2108,61 @@ export type CreateAgentRequestFallbackModelConfigurationTimeout = {
      */
     callTimeout: number;
 };
+/**
+ * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+ */
+export declare const CreateAgentRequestFallbackModelConfigurationAgentsResponseType: {
+    readonly Ephemeral: "ephemeral";
+};
+/**
+ * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+ */
+export type CreateAgentRequestFallbackModelConfigurationAgentsResponseType = ClosedEnum<typeof CreateAgentRequestFallbackModelConfigurationAgentsResponseType>;
+/**
+ * The time-to-live for the cache control breakpoint. This may be one of the following values:
+ *
+ * @remarks
+ *
+ * - `5m`: 5 minutes
+ * - `1h`: 1 hour
+ *
+ * Defaults to `5m`. Only supported by `Anthropic` Claude models.
+ */
+export declare const CreateAgentRequestFallbackModelConfigurationTtl: {
+    readonly Fivem: "5m";
+    readonly Oneh: "1h";
+};
+/**
+ * The time-to-live for the cache control breakpoint. This may be one of the following values:
+ *
+ * @remarks
+ *
+ * - `5m`: 5 minutes
+ * - `1h`: 1 hour
+ *
+ * Defaults to `5m`. Only supported by `Anthropic` Claude models.
+ */
+export type CreateAgentRequestFallbackModelConfigurationTtl = ClosedEnum<typeof CreateAgentRequestFallbackModelConfigurationTtl>;
+/**
+ * Provider-level prompt caching configuration applied to the request. Creates a cache control breakpoint covering the request content. Only supported by `Anthropic` Claude models.
+ */
+export type CreateAgentRequestFallbackModelConfigurationCacheControl = {
+    /**
+     * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+     */
+    type: CreateAgentRequestFallbackModelConfigurationAgentsResponseType;
+    /**
+     * The time-to-live for the cache control breakpoint. This may be one of the following values:
+     *
+     * @remarks
+     *
+     * - `5m`: 5 minutes
+     * - `1h`: 1 hour
+     *
+     * Defaults to `5m`. Only supported by `Anthropic` Claude models.
+     */
+    ttl: CreateAgentRequestFallbackModelConfigurationTtl;
+};
 /**
  * Optional model parameters specific to this fallback model. Overrides primary model parameters if this fallback is used.
  */
@@ -2021,6 +2265,14 @@ export type CreateAgentRequestFallbackModelConfigurationParameters = {
      * Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured.
      */
     timeout?: CreateAgentRequestFallbackModelConfigurationTimeout | undefined;
+    /**
+     * Provider-level prompt caching configuration applied to the request. Creates a cache control breakpoint covering the request content. Only supported by `Anthropic` Claude models.
+     */
+    cacheControl?: CreateAgentRequestFallbackModelConfigurationCacheControl | undefined;
+    /**
+     * Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching.
+     */
+    promptCacheKey?: string | undefined;
 };
 /**
  * Retry configuration for this fallback model. Allows customizing retry count (1-5) and HTTP status codes that trigger retries.
@@ -2287,6 +2539,18 @@ export type Timeout$Outbound = {
 export declare const Timeout$outboundSchema: z.ZodType<Timeout$Outbound, z.ZodTypeDef, Timeout>;
 export declare function timeoutToJSON(timeout: Timeout): string;
 /** @internal */
+export declare const CreateAgentRequestModelConfigurationType$outboundSchema: z.ZodNativeEnum<typeof CreateAgentRequestModelConfigurationType>;
+/** @internal */
+export declare const ModelConfigurationTtl$outboundSchema: z.ZodNativeEnum<typeof ModelConfigurationTtl>;
+/** @internal */
+export type ModelConfigurationCacheControl$Outbound = {
+    type: string;
+    ttl: string;
+};
+/** @internal */
+export declare const ModelConfigurationCacheControl$outboundSchema: z.ZodType<ModelConfigurationCacheControl$Outbound, z.ZodTypeDef, ModelConfigurationCacheControl>;
+export declare function modelConfigurationCacheControlToJSON(modelConfigurationCacheControl: ModelConfigurationCacheControl): string;
+/** @internal */
 export type ParametersT$Outbound = {
     name?: string | undefined;
     frequency_penalty?: number | null | undefined;
@@ -2310,6 +2574,8 @@ export type ParametersT$Outbound = {
     cache?: Cache$Outbound | undefined;
     load_balancer?: LoadBalancer1$Outbound | undefined;
     timeout?: Timeout$Outbound | undefined;
+    cache_control?: ModelConfigurationCacheControl$Outbound | undefined;
+    prompt_cache_key?: string | undefined;
 };
 /** @internal */
 export declare const ParametersT$outboundSchema: z.ZodType<ParametersT$Outbound, z.ZodTypeDef, ParametersT>;
@@ -2476,6 +2742,18 @@ export type FallbackModelConfigurationTimeout$Outbound = {
 export declare const FallbackModelConfigurationTimeout$outboundSchema: z.ZodType<FallbackModelConfigurationTimeout$Outbound, z.ZodTypeDef, FallbackModelConfigurationTimeout>;
 export declare function fallbackModelConfigurationTimeoutToJSON(fallbackModelConfigurationTimeout: FallbackModelConfigurationTimeout): string;
 /** @internal */
+export declare const CreateAgentRequestFallbackModelConfigurationType$outboundSchema: z.ZodNativeEnum<typeof CreateAgentRequestFallbackModelConfigurationType>;
+/** @internal */
+export declare const FallbackModelConfigurationTtl$outboundSchema: z.ZodNativeEnum<typeof FallbackModelConfigurationTtl>;
+/** @internal */
+export type FallbackModelConfigurationCacheControl$Outbound = {
+    type: string;
+    ttl: string;
+};
+/** @internal */
+export declare const FallbackModelConfigurationCacheControl$outboundSchema: z.ZodType<FallbackModelConfigurationCacheControl$Outbound, z.ZodTypeDef, FallbackModelConfigurationCacheControl>;
+export declare function fallbackModelConfigurationCacheControlToJSON(fallbackModelConfigurationCacheControl: FallbackModelConfigurationCacheControl): string;
+/** @internal */
 export type FallbackModelConfigurationParameters$Outbound = {
     name?: string | undefined;
     frequency_penalty?: number | null | undefined;
@@ -2499,6 +2777,8 @@ export type FallbackModelConfigurationParameters$Outbound = {
     cache?: FallbackModelConfigurationCache$Outbound | undefined;
     load_balancer?: CreateAgentRequestLoadBalancer1$Outbound | undefined;
     timeout?: FallbackModelConfigurationTimeout$Outbound | undefined;
+    cache_control?: FallbackModelConfigurationCacheControl$Outbound | undefined;
+    prompt_cache_key?: string | undefined;
 };
 /** @internal */
 export declare const FallbackModelConfigurationParameters$outboundSchema: z.ZodType<FallbackModelConfigurationParameters$Outbound, z.ZodTypeDef, FallbackModelConfigurationParameters>;
@@ -2899,6 +3179,13 @@ export declare function createAgentRequestLoadBalancerFromJSON(jsonString: strin
 export declare const CreateAgentRequestTimeout$inboundSchema: z.ZodType<CreateAgentRequestTimeout, z.ZodTypeDef, unknown>;
 export declare function createAgentRequestTimeoutFromJSON(jsonString: string): SafeParseResult<CreateAgentRequestTimeout, SDKValidationError>;
 /** @internal */
+export declare const CreateAgentRequestAgentsResponseType$inboundSchema: z.ZodNativeEnum<typeof CreateAgentRequestAgentsResponseType>;
+/** @internal */
+export declare const CreateAgentRequestTtl$inboundSchema: z.ZodNativeEnum<typeof CreateAgentRequestTtl>;
+/** @internal */
+export declare const CreateAgentRequestCacheControl$inboundSchema: z.ZodType<CreateAgentRequestCacheControl, z.ZodTypeDef, unknown>;
+export declare function createAgentRequestCacheControlFromJSON(jsonString: string): SafeParseResult<CreateAgentRequestCacheControl, SDKValidationError>;
+/** @internal */
 export declare const CreateAgentRequestParameters$inboundSchema: z.ZodType<CreateAgentRequestParameters, z.ZodTypeDef, unknown>;
 export declare function createAgentRequestParametersFromJSON(jsonString: string): SafeParseResult<CreateAgentRequestParameters, SDKValidationError>;
 /** @internal */
@@ -2956,7 +3243,7 @@ export declare function createAgentRequestFallbackModelConfigurationGuardrailsFr
 export declare const CreateAgentRequestFallbackModelConfigurationFallbacks$inboundSchema: z.ZodType<CreateAgentRequestFallbackModelConfigurationFallbacks, z.ZodTypeDef, unknown>;
 export declare function createAgentRequestFallbackModelConfigurationFallbacksFromJSON(jsonString: string): SafeParseResult<CreateAgentRequestFallbackModelConfigurationFallbacks, SDKValidationError>;
 /** @internal */
-export declare const CreateAgentRequestFallbackModelConfigurationType$inboundSchema: z.ZodNativeEnum<typeof CreateAgentRequestFallbackModelConfigurationType>;
+export declare const CreateAgentRequestFallbackModelConfigurationAgentsType$inboundSchema: z.ZodNativeEnum<typeof CreateAgentRequestFallbackModelConfigurationAgentsType>;
 /** @internal */
 export declare const CreateAgentRequestFallbackModelConfigurationCache$inboundSchema: z.ZodType<CreateAgentRequestFallbackModelConfigurationCache, z.ZodTypeDef, unknown>;
 export declare function createAgentRequestFallbackModelConfigurationCacheFromJSON(jsonString: string): SafeParseResult<CreateAgentRequestFallbackModelConfigurationCache, SDKValidationError>;
@@ -2975,6 +3262,13 @@ export declare function createAgentRequestFallbackModelConfigurationLoadBalancer
 export declare const CreateAgentRequestFallbackModelConfigurationTimeout$inboundSchema: z.ZodType<CreateAgentRequestFallbackModelConfigurationTimeout, z.ZodTypeDef, unknown>;
 export declare function createAgentRequestFallbackModelConfigurationTimeoutFromJSON(jsonString: string): SafeParseResult<CreateAgentRequestFallbackModelConfigurationTimeout, SDKValidationError>;
 /** @internal */
+export declare const CreateAgentRequestFallbackModelConfigurationAgentsResponseType$inboundSchema: z.ZodNativeEnum<typeof CreateAgentRequestFallbackModelConfigurationAgentsResponseType>;
+/** @internal */
+export declare const CreateAgentRequestFallbackModelConfigurationTtl$inboundSchema: z.ZodNativeEnum<typeof CreateAgentRequestFallbackModelConfigurationTtl>;
+/** @internal */
+export declare const CreateAgentRequestFallbackModelConfigurationCacheControl$inboundSchema: z.ZodType<CreateAgentRequestFallbackModelConfigurationCacheControl, z.ZodTypeDef, unknown>;
+export declare function createAgentRequestFallbackModelConfigurationCacheControlFromJSON(jsonString: string): SafeParseResult<CreateAgentRequestFallbackModelConfigurationCacheControl, SDKValidationError>;
+/** @internal */
 export declare const CreateAgentRequestFallbackModelConfigurationParameters$inboundSchema: z.ZodType<CreateAgentRequestFallbackModelConfigurationParameters, z.ZodTypeDef, unknown>;
 export declare function createAgentRequestFallbackModelConfigurationParametersFromJSON(jsonString: string): SafeParseResult<CreateAgentRequestFallbackModelConfigurationParameters, SDKValidationError>;
 /** @internal */