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

package/models/operations/updateprompt.d.ts

@@ -535,6 +535,61 @@ export type UpdatePromptTimeout = {
      */
     callTimeout: number;
 };
+/**
+ * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+ */
+export declare const UpdatePromptPromptsType: {
+    readonly Ephemeral: "ephemeral";
+};
+/**
+ * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+ */
+export type UpdatePromptPromptsType = ClosedEnum<typeof UpdatePromptPromptsType>;
+/**
+ * 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 UpdatePromptTtl: {
+    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 UpdatePromptTtl = ClosedEnum<typeof UpdatePromptTtl>;
+/**
+ * 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 UpdatePromptCacheControl = {
+    /**
+     * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+     */
+    type: UpdatePromptPromptsType;
+    /**
+     * 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?: UpdatePromptTtl | undefined;
+};
 /**
  * Prompt configuration with model and messages. Use this to update the prompt.
  */
@@ -669,6 +724,14 @@ export type UpdatePromptPromptInput = {
      * 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?: UpdatePromptTimeout | 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?: UpdatePromptCacheControl | 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;
 };
 export declare const UpdatePromptUseCases: {
     readonly AgentsSimulations: "Agents simulations";
@@ -719,7 +782,10 @@ export type UpdatePromptMetadata = {
      */
     language?: UpdatePromptLanguage | null | undefined;
 };
-export type UpdatePromptRequestBody = {
+/**
+ * Request body for updating an existing prompt. All fields are optional.
+ */
+export type UpdatePromptUpdatePromptRequest = {
     owner?: string | undefined;
     domainId?: string | undefined;
     created?: string | undefined;
@@ -755,12 +821,12 @@ export type UpdatePromptRequest = {
      * Unique identifier of the prompt
      */
     id: string;
-    requestBody?: UpdatePromptRequestBody | undefined;
+    requestBody?: UpdatePromptUpdatePromptRequest | undefined;
 };
-export declare const UpdatePromptPromptsType: {
+export declare const UpdatePromptPromptsResponseType: {
     readonly Prompt: "prompt";
 };
-export type UpdatePromptPromptsType = ClosedEnum<typeof UpdatePromptPromptsType>;
+export type UpdatePromptPromptsResponseType = ClosedEnum<typeof UpdatePromptPromptsResponseType>;
 /**
  * The modality of the model
  */
@@ -835,7 +901,7 @@ export declare const UpdatePromptResponseFormatPromptsResponse200ApplicationJSON
 export type UpdatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyType = ClosedEnum<typeof UpdatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyType>;
 export type UpdatePromptResponseFormatPromptsResponse200ApplicationJSONJSONSchema = {
     name: string;
-    description?: string | undefined;
+    description?: string | null | undefined;
     strict?: boolean | undefined;
     schema: {
         [k: string]: any;
@@ -858,6 +924,61 @@ export type UpdatePromptResponseFormat1 = {
  * Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.
  */
 export type UpdatePromptPromptsResponseResponseFormat = UpdatePromptResponseFormat1 | UpdatePromptResponseFormat2 | UpdatePromptResponseFormat3 | UpdatePromptResponseFormat4 | UpdatePromptResponseFormat5 | UpdatePromptResponseFormat6;
+/**
+ * Create a cache control breakpoint. Accepts only the value "ephemeral".
+ */
+export declare const UpdatePromptPromptsResponse200ApplicationJSONResponseBodyType: {
+    readonly Ephemeral: "ephemeral";
+};
+/**
+ * Create a cache control breakpoint. Accepts only the value "ephemeral".
+ */
+export type UpdatePromptPromptsResponse200ApplicationJSONResponseBodyType = ClosedEnum<typeof UpdatePromptPromptsResponse200ApplicationJSONResponseBodyType>;
+/**
+ * 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 UpdatePromptPromptsResponseTtl: {
+    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 UpdatePromptPromptsResponseTtl = ClosedEnum<typeof UpdatePromptPromptsResponseTtl>;
+/**
+ * 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 UpdatePromptPromptsResponseCacheControl = {
+    /**
+     * Create a cache control breakpoint. Accepts only the value "ephemeral".
+     */
+    type: UpdatePromptPromptsResponse200ApplicationJSONResponseBodyType;
+    /**
+     * 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: UpdatePromptPromptsResponseTtl;
+};
 /**
  * The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider
  */
@@ -983,6 +1104,10 @@ export type UpdatePromptModelParameters = {
      * Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.
      */
     responseFormat?: UpdatePromptResponseFormat1 | UpdatePromptResponseFormat2 | UpdatePromptResponseFormat3 | UpdatePromptResponseFormat4 | UpdatePromptResponseFormat5 | UpdatePromptResponseFormat6 | null | 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?: UpdatePromptPromptsResponseCacheControl | null | undefined;
     /**
      * The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider
      */
@@ -1122,10 +1247,10 @@ export type UpdatePromptContentPromptsResponse2 = UpdatePrompt21 | UpdatePrompt2
  * The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Can be null for tool messages in certain scenarios.
  */
 export type UpdatePromptContent = string | Array<UpdatePrompt21 | UpdatePrompt22 | UpdatePrompt23>;
-export declare const UpdatePromptPromptsResponse200Type: {
+export declare const UpdatePromptPromptsResponse200ApplicationJSONResponseBodyPromptConfigType: {
     readonly Function: "function";
 };
-export type UpdatePromptPromptsResponse200Type = ClosedEnum<typeof UpdatePromptPromptsResponse200Type>;
+export type UpdatePromptPromptsResponse200ApplicationJSONResponseBodyPromptConfigType = ClosedEnum<typeof UpdatePromptPromptsResponse200ApplicationJSONResponseBodyPromptConfigType>;
 export type UpdatePromptFunction = {
     name: string;
     /**
@@ -1136,7 +1261,7 @@ export type UpdatePromptFunction = {
 export type UpdatePromptToolCalls = {
     id?: string | undefined;
     index?: number | undefined;
-    type: UpdatePromptPromptsResponse200Type;
+    type: UpdatePromptPromptsResponse200ApplicationJSONResponseBodyPromptConfigType;
     function: UpdatePromptFunction;
 };
 export type UpdatePromptPromptsMessages = {
@@ -1403,10 +1528,10 @@ export type UpdatePromptPromptsRetry = {
      */
     onCodes?: Array<number> | undefined;
 };
-export declare const UpdatePromptPromptsResponseType: {
+export declare const UpdatePromptPromptsResponse200Type: {
     readonly ExactMatch: "exact_match";
 };
-export type UpdatePromptPromptsResponseType = ClosedEnum<typeof UpdatePromptPromptsResponseType>;
+export type UpdatePromptPromptsResponse200Type = ClosedEnum<typeof UpdatePromptPromptsResponse200Type>;
 /**
  * Cache configuration for the request.
  */
@@ -1415,7 +1540,7 @@ export type UpdatePromptPromptsCache = {
      * Time to live for cached responses in seconds. Maximum 259200 seconds (3 days).
      */
     ttl: number;
-    type: UpdatePromptPromptsResponseType;
+    type: UpdatePromptPromptsResponse200Type;
 };
 export declare const UpdatePromptLoadBalancerPromptsType: {
     readonly WeightBased: "weight_based";
@@ -1448,6 +1573,61 @@ export type UpdatePromptPromptsTimeout = {
      */
     callTimeout: number;
 };
+/**
+ * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+ */
+export declare const UpdatePromptPromptsResponse200ApplicationJSONType: {
+    readonly Ephemeral: "ephemeral";
+};
+/**
+ * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+ */
+export type UpdatePromptPromptsResponse200ApplicationJSONType = ClosedEnum<typeof UpdatePromptPromptsResponse200ApplicationJSONType>;
+/**
+ * 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 UpdatePromptPromptsTtl: {
+    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 UpdatePromptPromptsTtl = ClosedEnum<typeof UpdatePromptPromptsTtl>;
+/**
+ * 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 UpdatePromptPromptsCacheControl = {
+    /**
+     * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+     */
+    type: UpdatePromptPromptsResponse200ApplicationJSONType;
+    /**
+     * 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: UpdatePromptPromptsTtl;
+};
 export type UpdatePromptContentPromptsResponse200ApplicationJSONResponseBody2 = components.TextContentPartSchema;
 /**
  * The contents of the tool message.
@@ -1837,6 +2017,14 @@ export type UpdatePromptPromptField = {
      * 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?: UpdatePromptPromptsTimeout | 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?: UpdatePromptPromptsCacheControl | 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;
     /**
      * Array of messages that make up the conversation. Each message has a role (system, user, assistant, or tool) and content.
      */
@@ -1901,7 +2089,7 @@ export type UpdatePromptPromptsMetadata = {
  */
 export type UpdatePromptPrompt = {
     id: string;
-    type: UpdatePromptPromptsType;
+    type: UpdatePromptPromptsResponseType;
     owner: string;
     domainId: string;
     created: string;
@@ -2247,6 +2435,18 @@ export type UpdatePromptTimeout$Outbound = {
 export declare const UpdatePromptTimeout$outboundSchema: z.ZodType<UpdatePromptTimeout$Outbound, z.ZodTypeDef, UpdatePromptTimeout>;
 export declare function updatePromptTimeoutToJSON(updatePromptTimeout: UpdatePromptTimeout): string;
 /** @internal */
+export declare const UpdatePromptPromptsType$outboundSchema: z.ZodNativeEnum<typeof UpdatePromptPromptsType>;
+/** @internal */
+export declare const UpdatePromptTtl$outboundSchema: z.ZodNativeEnum<typeof UpdatePromptTtl>;
+/** @internal */
+export type UpdatePromptCacheControl$Outbound = {
+    type: string;
+    ttl: string;
+};
+/** @internal */
+export declare const UpdatePromptCacheControl$outboundSchema: z.ZodType<UpdatePromptCacheControl$Outbound, z.ZodTypeDef, UpdatePromptCacheControl>;
+export declare function updatePromptCacheControlToJSON(updatePromptCacheControl: UpdatePromptCacheControl): string;
+/** @internal */
 export type UpdatePromptPromptInput$Outbound = {
     messages?: Array<UpdatePromptMessagesSystemMessage$Outbound | UpdatePromptMessagesUserMessage$Outbound | UpdatePromptMessagesAssistantMessage$Outbound | UpdatePromptMessagesToolMessage$Outbound> | undefined;
     model?: string | null | undefined;
@@ -2278,6 +2478,8 @@ export type UpdatePromptPromptInput$Outbound = {
     cache?: UpdatePromptCache$Outbound | undefined;
     load_balancer?: UpdatePromptLoadBalancer1$Outbound | undefined;
     timeout?: UpdatePromptTimeout$Outbound | undefined;
+    cache_control?: UpdatePromptCacheControl$Outbound | undefined;
+    prompt_cache_key?: string | undefined;
 };
 /** @internal */
 export declare const UpdatePromptPromptInput$outboundSchema: z.ZodType<UpdatePromptPromptInput$Outbound, z.ZodTypeDef, UpdatePromptPromptInput>;
@@ -2295,7 +2497,7 @@ export type UpdatePromptMetadata$Outbound = {
 export declare const UpdatePromptMetadata$outboundSchema: z.ZodType<UpdatePromptMetadata$Outbound, z.ZodTypeDef, UpdatePromptMetadata>;
 export declare function updatePromptMetadataToJSON(updatePromptMetadata: UpdatePromptMetadata): string;
 /** @internal */
-export type UpdatePromptRequestBody$Outbound = {
+export type UpdatePromptUpdatePromptRequest$Outbound = {
     owner?: string | undefined;
     domain_id?: string | undefined;
     created?: string | undefined;
@@ -2309,18 +2511,18 @@ export type UpdatePromptRequestBody$Outbound = {
     path?: string | undefined;
 };
 /** @internal */
-export declare const UpdatePromptRequestBody$outboundSchema: z.ZodType<UpdatePromptRequestBody$Outbound, z.ZodTypeDef, UpdatePromptRequestBody>;
-export declare function updatePromptRequestBodyToJSON(updatePromptRequestBody: UpdatePromptRequestBody): string;
+export declare const UpdatePromptUpdatePromptRequest$outboundSchema: z.ZodType<UpdatePromptUpdatePromptRequest$Outbound, z.ZodTypeDef, UpdatePromptUpdatePromptRequest>;
+export declare function updatePromptUpdatePromptRequestToJSON(updatePromptUpdatePromptRequest: UpdatePromptUpdatePromptRequest): string;
 /** @internal */
 export type UpdatePromptRequest$Outbound = {
     id: string;
-    RequestBody?: UpdatePromptRequestBody$Outbound | undefined;
+    RequestBody?: UpdatePromptUpdatePromptRequest$Outbound | undefined;
 };
 /** @internal */
 export declare const UpdatePromptRequest$outboundSchema: z.ZodType<UpdatePromptRequest$Outbound, z.ZodTypeDef, UpdatePromptRequest>;
 export declare function updatePromptRequestToJSON(updatePromptRequest: UpdatePromptRequest): string;
 /** @internal */
-export declare const UpdatePromptPromptsType$inboundSchema: z.ZodNativeEnum<typeof UpdatePromptPromptsType>;
+export declare const UpdatePromptPromptsResponseType$inboundSchema: z.ZodNativeEnum<typeof UpdatePromptPromptsResponseType>;
 /** @internal */
 export declare const UpdatePromptModelType$inboundSchema: z.ZodNativeEnum<typeof UpdatePromptModelType>;
 /** @internal */
@@ -2353,6 +2555,13 @@ export declare function updatePromptResponseFormat1FromJSON(jsonString: string):
 export declare const UpdatePromptPromptsResponseResponseFormat$inboundSchema: z.ZodType<UpdatePromptPromptsResponseResponseFormat, z.ZodTypeDef, unknown>;
 export declare function updatePromptPromptsResponseResponseFormatFromJSON(jsonString: string): SafeParseResult<UpdatePromptPromptsResponseResponseFormat, SDKValidationError>;
 /** @internal */
+export declare const UpdatePromptPromptsResponse200ApplicationJSONResponseBodyType$inboundSchema: z.ZodNativeEnum<typeof UpdatePromptPromptsResponse200ApplicationJSONResponseBodyType>;
+/** @internal */
+export declare const UpdatePromptPromptsResponseTtl$inboundSchema: z.ZodNativeEnum<typeof UpdatePromptPromptsResponseTtl>;
+/** @internal */
+export declare const UpdatePromptPromptsResponseCacheControl$inboundSchema: z.ZodType<UpdatePromptPromptsResponseCacheControl, z.ZodTypeDef, unknown>;
+export declare function updatePromptPromptsResponseCacheControlFromJSON(jsonString: string): SafeParseResult<UpdatePromptPromptsResponseCacheControl, SDKValidationError>;
+/** @internal */
 export declare const UpdatePromptPhotoRealVersion$inboundSchema: z.ZodNativeEnum<typeof UpdatePromptPhotoRealVersion>;
 /** @internal */
 export declare const UpdatePromptEncodingFormat$inboundSchema: z.ZodNativeEnum<typeof UpdatePromptEncodingFormat>;
@@ -2391,7 +2600,7 @@ export declare function updatePromptContentPromptsResponse2FromJSON(jsonString:
 export declare const UpdatePromptContent$inboundSchema: z.ZodType<UpdatePromptContent, z.ZodTypeDef, unknown>;
 export declare function updatePromptContentFromJSON(jsonString: string): SafeParseResult<UpdatePromptContent, SDKValidationError>;
 /** @internal */
-export declare const UpdatePromptPromptsResponse200Type$inboundSchema: z.ZodNativeEnum<typeof UpdatePromptPromptsResponse200Type>;
+export declare const UpdatePromptPromptsResponse200ApplicationJSONResponseBodyPromptConfigType$inboundSchema: z.ZodNativeEnum<typeof UpdatePromptPromptsResponse200ApplicationJSONResponseBodyPromptConfigType>;
 /** @internal */
 export declare const UpdatePromptFunction$inboundSchema: z.ZodType<UpdatePromptFunction, z.ZodTypeDef, unknown>;
 export declare function updatePromptFunctionFromJSON(jsonString: string): SafeParseResult<UpdatePromptFunction, SDKValidationError>;
@@ -2469,7 +2678,7 @@ export declare function updatePromptPromptsFallbacksFromJSON(jsonString: string)
 export declare const UpdatePromptPromptsRetry$inboundSchema: z.ZodType<UpdatePromptPromptsRetry, z.ZodTypeDef, unknown>;
 export declare function updatePromptPromptsRetryFromJSON(jsonString: string): SafeParseResult<UpdatePromptPromptsRetry, SDKValidationError>;
 /** @internal */
-export declare const UpdatePromptPromptsResponseType$inboundSchema: z.ZodNativeEnum<typeof UpdatePromptPromptsResponseType>;
+export declare const UpdatePromptPromptsResponse200Type$inboundSchema: z.ZodNativeEnum<typeof UpdatePromptPromptsResponse200Type>;
 /** @internal */
 export declare const UpdatePromptPromptsCache$inboundSchema: z.ZodType<UpdatePromptPromptsCache, z.ZodTypeDef, unknown>;
 export declare function updatePromptPromptsCacheFromJSON(jsonString: string): SafeParseResult<UpdatePromptPromptsCache, SDKValidationError>;
@@ -2488,6 +2697,13 @@ export declare function updatePromptPromptsLoadBalancerFromJSON(jsonString: stri
 export declare const UpdatePromptPromptsTimeout$inboundSchema: z.ZodType<UpdatePromptPromptsTimeout, z.ZodTypeDef, unknown>;
 export declare function updatePromptPromptsTimeoutFromJSON(jsonString: string): SafeParseResult<UpdatePromptPromptsTimeout, SDKValidationError>;
 /** @internal */
+export declare const UpdatePromptPromptsResponse200ApplicationJSONType$inboundSchema: z.ZodNativeEnum<typeof UpdatePromptPromptsResponse200ApplicationJSONType>;
+/** @internal */
+export declare const UpdatePromptPromptsTtl$inboundSchema: z.ZodNativeEnum<typeof UpdatePromptPromptsTtl>;
+/** @internal */
+export declare const UpdatePromptPromptsCacheControl$inboundSchema: z.ZodType<UpdatePromptPromptsCacheControl, z.ZodTypeDef, unknown>;
+export declare function updatePromptPromptsCacheControlFromJSON(jsonString: string): SafeParseResult<UpdatePromptPromptsCacheControl, SDKValidationError>;
+/** @internal */
 export declare const UpdatePromptContentPromptsResponse200ApplicationJSONResponseBody2$inboundSchema: z.ZodType<UpdatePromptContentPromptsResponse200ApplicationJSONResponseBody2, z.ZodTypeDef, unknown>;
 export declare function updatePromptContentPromptsResponse200ApplicationJSONResponseBody2FromJSON(jsonString: string): SafeParseResult<UpdatePromptContentPromptsResponse200ApplicationJSONResponseBody2, SDKValidationError>;
 /** @internal */