@orq-ai/node 4.17.0-rc.5 → 4.17.0-rc.51

package/src/models/operations/createclassify.ts

@@ -3,11 +3,30 @@
  */
 
 import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * The evaluation prompt for this question. A string, an object or an array.
+ */
+export type CreateClassifyQuestionsRouterClassifyInstructions = string | {
+  [k: string]: any;
+} | Array<any>;
+
+/**
+ * Beta, TypeSafe jev-preview only. Locates one target in an image from assets and returns its bounding box. Always returns a box; pair it with a noul question to check presence.
+ */
+export type BoxQuestion = {
+  /**
+   * The evaluation prompt for this question. A string, an object or an array.
+   */
+  instructions: string | { [k: string]: any } | Array<any>;
+  type: "box";
+};
+
 /**
  * The evaluation prompt for this question. A string, an object or an array.
  */
@@ -21,9 +40,9 @@ export type CreateClassifyQuestionsInstructions =
  */
 export type ScoreQuestion = {
   /**
-   * Ordered level descriptions from lowest to highest. At least two levels.
+   * Ordered level descriptions from lowest to highest. At least two levels. Each level can be a string, an object or an array.
    */
-  criteria: Array<string>;
+  criteria: Array<any>;
   /**
    * The evaluation prompt for this question. A string, an object or an array.
    */
@@ -31,6 +50,11 @@ export type ScoreQuestion = {
   type: "score";
 };
 
+/**
+ * The option description, or null.
+ */
+export type QuestionsCriteria = string | { [k: string]: any } | Array<any>;
+
 /**
  * The evaluation prompt for this question. A string, an object or an array.
  */
@@ -41,9 +65,9 @@ export type QuestionsInstructions = string | { [k: string]: any } | Array<any>;
  */
 export type ChoiceQuestion = {
   /**
-   * Options keyed by name, each mapped to a description or null.
+   * Options keyed by name, each mapped to a description or null. A description can be a string, an object or an array.
    */
-  criteria: { [k: string]: string | null };
+  criteria: { [k: string]: string | { [k: string]: any } | Array<any> | null };
   /**
    * The evaluation prompt for this question. A string, an object or an array.
    */
@@ -51,12 +75,28 @@ export type ChoiceQuestion = {
   type: "choice";
 };
 
+/**
+ * What false means. A string, an object or an array.
+ */
+export type False = string | { [k: string]: any } | Array<any>;
+
+/**
+ * What true means. A string, an object or an array.
+ */
+export type True = string | { [k: string]: any } | Array<any>;
+
 /**
  * Optional descriptions of what true and false mean.
  */
 export type Criteria = {
-  false?: string | undefined;
-  true?: string | undefined;
+  /**
+   * What false means. A string, an object or an array.
+   */
+  false?: string | { [k: string]: any } | Array<any> | undefined;
+  /**
+   * What true means. A string, an object or an array.
+   */
+  true?: string | { [k: string]: any } | Array<any> | undefined;
 };
 
 /**
@@ -79,16 +119,29 @@ export type NoulQuestion = {
   type: "noul";
 };
 
-export type Questions = NoulQuestion | ChoiceQuestion | ScoreQuestion;
+export type Questions =
+  | NoulQuestion
+  | ChoiceQuestion
+  | ScoreQuestion
+  | BoxQuestion;
 
 /**
- * The content to evaluate. A string, an object or an array. For OpenAI GPT-6 Luna, strings are passed as text and objects or ordinary JSON arrays are serialized as text. User-message arrays accept string content or input_text/input_image parts. Images must be inline base64 data URLs, with at most 128 images across the request. Remote image URLs, file IDs, audio, non-user roles, bare content parts and tool items are rejected.
+ * The content to evaluate. A string, an object or an array. For TypeSafe models, reference images declared in assets by writing their reference string. For OpenAI GPT-6 Luna, strings are passed as text and objects or ordinary JSON arrays are serialized as text. User-message arrays accept string content or input_text/input_image parts. Images must be inline base64 data URLs, with at most 128 images across the request. Remote image URLs, file IDs, audio, non-user roles, bare content parts and tool items are rejected.
  */
 export type State = string | { [k: string]: any } | Array<any>;
 
 export type CreateClassifyRequestBody = {
   /**
-   * Up to 10 fallback models in order. The gateway retries a model for matching error codes before trying the next model. Every model must support classification and satisfy access checks. Image requests require native OpenAI image-capable fallbacks.
+   * Beta, TypeSafe models only. Inline images keyed by a reference string. Write the reference in state, instructions or criteria wherever the image belongs; every asset must be referenced. Required for box questions.
+   */
+  assets?: { [k: string]: components.ClassifyAsset } | undefined;
+  cache?: components.ClassifyCacheConfig | undefined;
+  /**
+   * HTTP status codes that trigger fallback. Defaults to [408,429,500,502,503,504,529]. Each code must be unique and between 400 and 599.
+   */
+  fallbackOnCodes?: Array<number> | null | undefined;
+  /**
+   * Up to 10 fallback models in order. The gateway retries a model for matching error codes before trying the next model. Every model must support classification and satisfy access checks. Requests with images in state require native OpenAI image-capable fallbacks; requests with assets or box questions require TypeSafe fallbacks.
    */
   fallbacks?: Array<components.FallbackConfig> | null | undefined;
   identity?: components.ResponseIdentity | undefined;
@@ -107,12 +160,15 @@ export type CreateClassifyRequestBody = {
   /**
    * Typed questions keyed by an identifier of your choice. Each answer is returned under the same key.
    */
-  questions: { [k: string]: NoulQuestion | ChoiceQuestion | ScoreQuestion };
+  questions: {
+    [k: string]: NoulQuestion | ChoiceQuestion | ScoreQuestion | BoxQuestion;
+  };
   retry?: components.ClassifyRetryConfig | undefined;
   /**
-   * The content to evaluate. A string, an object or an array. For OpenAI GPT-6 Luna, strings are passed as text and objects or ordinary JSON arrays are serialized as text. User-message arrays accept string content or input_text/input_image parts. Images must be inline base64 data URLs, with at most 128 images across the request. Remote image URLs, file IDs, audio, non-user roles, bare content parts and tool items are rejected.
+   * The content to evaluate. A string, an object or an array. For TypeSafe models, reference images declared in assets by writing their reference string. For OpenAI GPT-6 Luna, strings are passed as text and objects or ordinary JSON arrays are serialized as text. User-message arrays accept string content or input_text/input_image parts. Images must be inline base64 data URLs, with at most 128 images across the request. Remote image URLs, file IDs, audio, non-user roles, bare content parts and tool items are rejected.
    */
   state: string | { [k: string]: any } | Array<any>;
+  timeout?: components.ClassifyTimeoutConfig | undefined;
 };
 
 /**
@@ -131,6 +187,51 @@ export type CreateClassifyResponseBody = {
   usage: components.ClassifyUsage;
 };
 
+/** @internal */
+export type CreateClassifyQuestionsRouterClassifyInstructions$Outbound =
+  | string
+  | { [k: string]: any }
+  | Array<any>;
+
+/** @internal */
+export const CreateClassifyQuestionsRouterClassifyInstructions$outboundSchema:
+  z.ZodType<
+    CreateClassifyQuestionsRouterClassifyInstructions$Outbound,
+    z.ZodTypeDef,
+    CreateClassifyQuestionsRouterClassifyInstructions
+  > = z.union([z.string(), z.record(z.any()), z.array(z.any())]);
+
+export function createClassifyQuestionsRouterClassifyInstructionsToJSON(
+  createClassifyQuestionsRouterClassifyInstructions:
+    CreateClassifyQuestionsRouterClassifyInstructions,
+): string {
+  return JSON.stringify(
+    CreateClassifyQuestionsRouterClassifyInstructions$outboundSchema.parse(
+      createClassifyQuestionsRouterClassifyInstructions,
+    ),
+  );
+}
+
+/** @internal */
+export type BoxQuestion$Outbound = {
+  instructions: string | { [k: string]: any } | Array<any>;
+  type: "box";
+};
+
+/** @internal */
+export const BoxQuestion$outboundSchema: z.ZodType<
+  BoxQuestion$Outbound,
+  z.ZodTypeDef,
+  BoxQuestion
+> = z.object({
+  instructions: z.union([z.string(), z.record(z.any()), z.array(z.any())]),
+  type: z.literal("box"),
+});
+
+export function boxQuestionToJSON(boxQuestion: BoxQuestion): string {
+  return JSON.stringify(BoxQuestion$outboundSchema.parse(boxQuestion));
+}
+
 /** @internal */
 export type CreateClassifyQuestionsInstructions$Outbound = string | {
   [k: string]: any;
@@ -155,7 +256,7 @@ export function createClassifyQuestionsInstructionsToJSON(
 
 /** @internal */
 export type ScoreQuestion$Outbound = {
-  criteria: Array<string>;
+  criteria: Array<any>;
   instructions: string | { [k: string]: any } | Array<any>;
   type: "score";
 };
@@ -166,7 +267,7 @@ export const ScoreQuestion$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ScoreQuestion
 > = z.object({
-  criteria: z.array(z.string()),
+  criteria: z.array(z.any()),
   instructions: z.union([z.string(), z.record(z.any()), z.array(z.any())]),
   type: z.literal("score"),
 });
@@ -175,6 +276,27 @@ export function scoreQuestionToJSON(scoreQuestion: ScoreQuestion): string {
   return JSON.stringify(ScoreQuestion$outboundSchema.parse(scoreQuestion));
 }
 
+/** @internal */
+export type QuestionsCriteria$Outbound =
+  | string
+  | { [k: string]: any }
+  | Array<any>;
+
+/** @internal */
+export const QuestionsCriteria$outboundSchema: z.ZodType<
+  QuestionsCriteria$Outbound,
+  z.ZodTypeDef,
+  QuestionsCriteria
+> = z.union([z.string(), z.record(z.any()), z.array(z.any())]);
+
+export function questionsCriteriaToJSON(
+  questionsCriteria: QuestionsCriteria,
+): string {
+  return JSON.stringify(
+    QuestionsCriteria$outboundSchema.parse(questionsCriteria),
+  );
+}
+
 /** @internal */
 export type QuestionsInstructions$Outbound =
   | string
@@ -198,7 +320,7 @@ export function questionsInstructionsToJSON(
 
 /** @internal */
 export type ChoiceQuestion$Outbound = {
-  criteria: { [k: string]: string | null };
+  criteria: { [k: string]: string | { [k: string]: any } | Array<any> | null };
   instructions: string | { [k: string]: any } | Array<any>;
   type: "choice";
 };
@@ -209,7 +331,9 @@ export const ChoiceQuestion$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ChoiceQuestion
 > = z.object({
-  criteria: z.record(z.nullable(z.string())),
+  criteria: z.record(
+    z.nullable(z.union([z.string(), z.record(z.any()), z.array(z.any())])),
+  ),
   instructions: z.union([z.string(), z.record(z.any()), z.array(z.any())]),
   type: z.literal("choice"),
 });
@@ -218,10 +342,35 @@ export function choiceQuestionToJSON(choiceQuestion: ChoiceQuestion): string {
   return JSON.stringify(ChoiceQuestion$outboundSchema.parse(choiceQuestion));
 }
 
+/** @internal */
+export type False$Outbound = string | { [k: string]: any } | Array<any>;
+
+/** @internal */
+export const False$outboundSchema: z.ZodType<
+  False$Outbound,
+  z.ZodTypeDef,
+  False
+> = z.union([z.string(), z.record(z.any()), z.array(z.any())]);
+
+export function falseToJSON(value: False): string {
+  return JSON.stringify(False$outboundSchema.parse(value));
+}
+
+/** @internal */
+export type True$Outbound = string | { [k: string]: any } | Array<any>;
+
+/** @internal */
+export const True$outboundSchema: z.ZodType<True$Outbound, z.ZodTypeDef, True> =
+  z.union([z.string(), z.record(z.any()), z.array(z.any())]);
+
+export function trueToJSON(value: True): string {
+  return JSON.stringify(True$outboundSchema.parse(value));
+}
+
 /** @internal */
 export type Criteria$Outbound = {
-  false?: string | undefined;
-  true?: string | undefined;
+  false?: string | { [k: string]: any } | Array<any> | undefined;
+  true?: string | { [k: string]: any } | Array<any> | undefined;
 };
 
 /** @internal */
@@ -230,8 +379,8 @@ export const Criteria$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Criteria
 > = z.object({
-  false: z.string().optional(),
-  true: z.string().optional(),
+  false: z.union([z.string(), z.record(z.any()), z.array(z.any())]).optional(),
+  true: z.union([z.string(), z.record(z.any()), z.array(z.any())]).optional(),
 });
 
 export function criteriaToJSON(criteria: Criteria): string {
@@ -278,7 +427,8 @@ export function noulQuestionToJSON(noulQuestion: NoulQuestion): string {
 export type Questions$Outbound =
   | NoulQuestion$Outbound
   | ChoiceQuestion$Outbound
-  | ScoreQuestion$Outbound;
+  | ScoreQuestion$Outbound
+  | BoxQuestion$Outbound;
 
 /** @internal */
 export const Questions$outboundSchema: z.ZodType<
@@ -289,6 +439,7 @@ export const Questions$outboundSchema: z.ZodType<
   z.lazy(() => NoulQuestion$outboundSchema),
   z.lazy(() => ChoiceQuestion$outboundSchema),
   z.lazy(() => ScoreQuestion$outboundSchema),
+  z.lazy(() => BoxQuestion$outboundSchema),
 ]);
 
 export function questionsToJSON(questions: Questions): string {
@@ -311,6 +462,9 @@ export function stateToJSON(state: State): string {
 
 /** @internal */
 export type CreateClassifyRequestBody$Outbound = {
+  assets?: { [k: string]: components.ClassifyAsset$Outbound } | undefined;
+  cache?: components.ClassifyCacheConfig$Outbound | undefined;
+  fallback_on_codes?: Array<number> | null | undefined;
   fallbacks?: Array<components.FallbackConfig$Outbound> | null | undefined;
   identity?: components.ResponseIdentity$Outbound | undefined;
   metadata?: { [k: string]: string } | undefined;
@@ -320,10 +474,12 @@ export type CreateClassifyRequestBody$Outbound = {
     [k: string]:
       | NoulQuestion$Outbound
       | ChoiceQuestion$Outbound
-      | ScoreQuestion$Outbound;
+      | ScoreQuestion$Outbound
+      | BoxQuestion$Outbound;
   };
   retry?: components.ClassifyRetryConfig$Outbound | undefined;
   state: string | { [k: string]: any } | Array<any>;
+  timeout?: components.ClassifyTimeoutConfig$Outbound | undefined;
 };
 
 /** @internal */
@@ -332,6 +488,9 @@ export const CreateClassifyRequestBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreateClassifyRequestBody
 > = z.object({
+  assets: z.record(components.ClassifyAsset$outboundSchema).optional(),
+  cache: components.ClassifyCacheConfig$outboundSchema.optional(),
+  fallbackOnCodes: z.nullable(z.array(z.number().int())).optional(),
   fallbacks: z.nullable(z.array(components.FallbackConfig$outboundSchema))
     .optional(),
   identity: components.ResponseIdentity$outboundSchema.optional(),
@@ -343,10 +502,16 @@ export const CreateClassifyRequestBody$outboundSchema: z.ZodType<
       z.lazy(() => NoulQuestion$outboundSchema),
       z.lazy(() => ChoiceQuestion$outboundSchema),
       z.lazy(() => ScoreQuestion$outboundSchema),
+      z.lazy(() => BoxQuestion$outboundSchema),
     ]),
   ),
   retry: components.ClassifyRetryConfig$outboundSchema.optional(),
   state: z.union([z.string(), z.record(z.any()), z.array(z.any())]),
+  timeout: components.ClassifyTimeoutConfig$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    fallbackOnCodes: "fallback_on_codes",
+  });
 });
 
 export function createClassifyRequestBodyToJSON(

package/src/models/operations/createcompletion.ts

@@ -635,6 +635,10 @@ export type CreateCompletionOrq = {
    * Retry configuration for the request
    */
   retry?: CreateCompletionRouterCompletionsRetry | undefined;
+  /**
+   * HTTP status codes that trigger fallback. Enter up to 20 unique integers from 400 to 599. When omitted or empty, defaults to [408, 429, 500, 502, 503, 504, 529].
+   */
+  fallbackOnCodes?: Array<number> | undefined;
   /**
    * Array of fallback models to use if primary model fails
    */
@@ -731,6 +735,10 @@ export type CreateCompletionRequestBody = {
    * The name to display on the trace. If not specified, the default system name will be used.
    */
   name?: string | undefined;
+  /**
+   * HTTP status codes that trigger fallback. Enter up to 20 unique integers from 400 to 599. When omitted or empty, defaults to [408, 429, 500, 502, 503, 504, 529].
+   */
+  fallbackOnCodes?: Array<number> | undefined;
   /**
    * Array of fallback models to use if primary model fails
    */
@@ -1087,7 +1095,7 @@ export const CreateCompletionCache$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreateCompletionCache
 > = z.object({
-  ttl: z.number().default(1800),
+  ttl: z.number().default(3600),
   type: CreateCompletionType$outboundSchema,
 });
 
@@ -1411,7 +1419,7 @@ export const CreateCompletionRouterCompletionsCache$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreateCompletionRouterCompletionsCache
 > = z.object({
-  ttl: z.number().default(1800),
+  ttl: z.number().default(3600),
   type: CreateCompletionRouterCompletionsType$outboundSchema,
 });
 
@@ -2787,6 +2795,7 @@ export function createCompletionRouterCompletionsTimeoutToJSON(
 export type CreateCompletionOrq$Outbound = {
   name?: string | undefined;
   retry?: CreateCompletionRouterCompletionsRetry$Outbound | undefined;
+  fallback_on_codes?: Array<number> | undefined;
   fallbacks?:
     | Array<CreateCompletionRouterCompletionsFallbacks$Outbound>
     | undefined;
@@ -2815,6 +2824,7 @@ export const CreateCompletionOrq$outboundSchema: z.ZodType<
   name: z.string().optional(),
   retry: z.lazy(() => CreateCompletionRouterCompletionsRetry$outboundSchema)
     .optional(),
+  fallbackOnCodes: z.array(z.number().int()).optional(),
   fallbacks: z.array(
     z.lazy(() => CreateCompletionRouterCompletionsFallbacks$outboundSchema),
   ).optional(),
@@ -2838,6 +2848,7 @@ export const CreateCompletionOrq$outboundSchema: z.ZodType<
     .optional(),
 }).transform((v) => {
   return remap$(v, {
+    fallbackOnCodes: "fallback_on_codes",
     knowledgeBases: "knowledge_bases",
     loadBalancer: "load_balancer",
   });
@@ -2866,6 +2877,7 @@ export type CreateCompletionRequestBody$Outbound = {
   n: number | null;
   user?: string | undefined;
   name?: string | undefined;
+  fallback_on_codes?: Array<number> | undefined;
   fallbacks?: Array<CreateCompletionFallbacks$Outbound> | undefined;
   retry?: CreateCompletionRetry$Outbound | undefined;
   cache?: CreateCompletionCache$Outbound | undefined;
@@ -2901,6 +2913,7 @@ export const CreateCompletionRequestBody$outboundSchema: z.ZodType<
   n: z.nullable(z.number().int().default(1)),
   user: z.string().optional(),
   name: z.string().optional(),
+  fallbackOnCodes: z.array(z.number().int()).optional(),
   fallbacks: z.array(z.lazy(() => CreateCompletionFallbacks$outboundSchema))
     .optional(),
   retry: z.lazy(() => CreateCompletionRetry$outboundSchema).optional(),
@@ -2924,6 +2937,7 @@ export const CreateCompletionRequestBody$outboundSchema: z.ZodType<
     maxTokens: "max_tokens",
     presencePenalty: "presence_penalty",
     topP: "top_p",
+    fallbackOnCodes: "fallback_on_codes",
     loadBalancer: "load_balancer",
   });
 });