@orq-ai/node 4.16.0-rc.3 → 4.16.0-rc.30

package/src/models/operations/createclassify.ts

@@ -0,0 +1,373 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 CreateClassifyQuestionsInstructions =
+  | string
+  | { [k: string]: any }
+  | Array<any>;
+
+/**
+ * Places the state on an ordered scale and returns the probability of each level.
+ */
+export type ScoreQuestion = {
+  /**
+   * Ordered level descriptions from lowest to highest. At least two levels.
+   */
+  criteria: Array<string>;
+  /**
+   * The evaluation prompt for this question. A string, an object or an array.
+   */
+  instructions: string | { [k: string]: any } | Array<any>;
+  type: "score";
+};
+
+/**
+ * The evaluation prompt for this question. A string, an object or an array.
+ */
+export type QuestionsInstructions = string | { [k: string]: any } | Array<any>;
+
+/**
+ * Picks one of the given options and returns the probability of each.
+ */
+export type ChoiceQuestion = {
+  /**
+   * Options keyed by name, each mapped to a description or null.
+   */
+  criteria: { [k: string]: string | null };
+  /**
+   * The evaluation prompt for this question. A string, an object or an array.
+   */
+  instructions: string | { [k: string]: any } | Array<any>;
+  type: "choice";
+};
+
+/**
+ * Optional descriptions of what true and false mean.
+ */
+export type Criteria = {
+  false?: string | undefined;
+  true?: string | undefined;
+};
+
+/**
+ * The evaluation prompt for this question. A string, an object or an array.
+ */
+export type Instructions = string | { [k: string]: any } | Array<any>;
+
+/**
+ * Answers with a probability between 0 and 1 that the statement holds.
+ */
+export type NoulQuestion = {
+  /**
+   * Optional descriptions of what true and false mean.
+   */
+  criteria?: Criteria | undefined;
+  /**
+   * The evaluation prompt for this question. A string, an object or an array.
+   */
+  instructions: string | { [k: string]: any } | Array<any>;
+  type: "noul";
+};
+
+export type Questions = NoulQuestion | ChoiceQuestion | ScoreQuestion;
+
+/**
+ * The content to evaluate. A string, an object or an array.
+ */
+export type State = string | { [k: string]: any } | Array<any>;
+
+export type CreateClassifyRequestBody = {
+  identity?: components.ResponseIdentity | undefined;
+  /**
+   * Key-value metadata attached to the trace.
+   */
+  metadata?: { [k: string]: string } | undefined;
+  /**
+   * ID of the model to use: the native classify model typesafe/jev-latest, or a chat model that supports classify.
+   */
+  model: string;
+  /**
+   * The name to display on the trace. If not specified, the default system name will be used.
+   */
+  name?: string | undefined;
+  /**
+   * Typed questions keyed by an identifier of your choice. Each answer is returned under the same key.
+   */
+  questions: { [k: string]: NoulQuestion | ChoiceQuestion | ScoreQuestion };
+  retry?: components.ClassifyRetryConfig | undefined;
+  /**
+   * The content to evaluate. A string, an object or an array.
+   */
+  state: string | { [k: string]: any } | Array<any>;
+};
+
+/**
+ * Returns one answer per question.
+ */
+export type CreateClassifyResponseBody = {
+  /**
+   * Answers keyed by the question identifiers from the request.
+   */
+  answers: { [k: string]: components.ClassifyAnswer };
+  /**
+   * The model ID from the request.
+   */
+  model: string;
+  telemetry?: components.ResponseTelemetry | undefined;
+  usage: components.ClassifyUsage;
+};
+
+/** @internal */
+export type CreateClassifyQuestionsInstructions$Outbound = string | {
+  [k: string]: any;
+} | Array<any>;
+
+/** @internal */
+export const CreateClassifyQuestionsInstructions$outboundSchema: z.ZodType<
+  CreateClassifyQuestionsInstructions$Outbound,
+  z.ZodTypeDef,
+  CreateClassifyQuestionsInstructions
+> = z.union([z.string(), z.record(z.any()), z.array(z.any())]);
+
+export function createClassifyQuestionsInstructionsToJSON(
+  createClassifyQuestionsInstructions: CreateClassifyQuestionsInstructions,
+): string {
+  return JSON.stringify(
+    CreateClassifyQuestionsInstructions$outboundSchema.parse(
+      createClassifyQuestionsInstructions,
+    ),
+  );
+}
+
+/** @internal */
+export type ScoreQuestion$Outbound = {
+  criteria: Array<string>;
+  instructions: string | { [k: string]: any } | Array<any>;
+  type: "score";
+};
+
+/** @internal */
+export const ScoreQuestion$outboundSchema: z.ZodType<
+  ScoreQuestion$Outbound,
+  z.ZodTypeDef,
+  ScoreQuestion
+> = z.object({
+  criteria: z.array(z.string()),
+  instructions: z.union([z.string(), z.record(z.any()), z.array(z.any())]),
+  type: z.literal("score"),
+});
+
+export function scoreQuestionToJSON(scoreQuestion: ScoreQuestion): string {
+  return JSON.stringify(ScoreQuestion$outboundSchema.parse(scoreQuestion));
+}
+
+/** @internal */
+export type QuestionsInstructions$Outbound =
+  | string
+  | { [k: string]: any }
+  | Array<any>;
+
+/** @internal */
+export const QuestionsInstructions$outboundSchema: z.ZodType<
+  QuestionsInstructions$Outbound,
+  z.ZodTypeDef,
+  QuestionsInstructions
+> = z.union([z.string(), z.record(z.any()), z.array(z.any())]);
+
+export function questionsInstructionsToJSON(
+  questionsInstructions: QuestionsInstructions,
+): string {
+  return JSON.stringify(
+    QuestionsInstructions$outboundSchema.parse(questionsInstructions),
+  );
+}
+
+/** @internal */
+export type ChoiceQuestion$Outbound = {
+  criteria: { [k: string]: string | null };
+  instructions: string | { [k: string]: any } | Array<any>;
+  type: "choice";
+};
+
+/** @internal */
+export const ChoiceQuestion$outboundSchema: z.ZodType<
+  ChoiceQuestion$Outbound,
+  z.ZodTypeDef,
+  ChoiceQuestion
+> = z.object({
+  criteria: z.record(z.nullable(z.string())),
+  instructions: z.union([z.string(), z.record(z.any()), z.array(z.any())]),
+  type: z.literal("choice"),
+});
+
+export function choiceQuestionToJSON(choiceQuestion: ChoiceQuestion): string {
+  return JSON.stringify(ChoiceQuestion$outboundSchema.parse(choiceQuestion));
+}
+
+/** @internal */
+export type Criteria$Outbound = {
+  false?: string | undefined;
+  true?: string | undefined;
+};
+
+/** @internal */
+export const Criteria$outboundSchema: z.ZodType<
+  Criteria$Outbound,
+  z.ZodTypeDef,
+  Criteria
+> = z.object({
+  false: z.string().optional(),
+  true: z.string().optional(),
+});
+
+export function criteriaToJSON(criteria: Criteria): string {
+  return JSON.stringify(Criteria$outboundSchema.parse(criteria));
+}
+
+/** @internal */
+export type Instructions$Outbound = string | { [k: string]: any } | Array<any>;
+
+/** @internal */
+export const Instructions$outboundSchema: z.ZodType<
+  Instructions$Outbound,
+  z.ZodTypeDef,
+  Instructions
+> = z.union([z.string(), z.record(z.any()), z.array(z.any())]);
+
+export function instructionsToJSON(instructions: Instructions): string {
+  return JSON.stringify(Instructions$outboundSchema.parse(instructions));
+}
+
+/** @internal */
+export type NoulQuestion$Outbound = {
+  criteria?: Criteria$Outbound | undefined;
+  instructions: string | { [k: string]: any } | Array<any>;
+  type: "noul";
+};
+
+/** @internal */
+export const NoulQuestion$outboundSchema: z.ZodType<
+  NoulQuestion$Outbound,
+  z.ZodTypeDef,
+  NoulQuestion
+> = z.object({
+  criteria: z.lazy(() => Criteria$outboundSchema).optional(),
+  instructions: z.union([z.string(), z.record(z.any()), z.array(z.any())]),
+  type: z.literal("noul"),
+});
+
+export function noulQuestionToJSON(noulQuestion: NoulQuestion): string {
+  return JSON.stringify(NoulQuestion$outboundSchema.parse(noulQuestion));
+}
+
+/** @internal */
+export type Questions$Outbound =
+  | NoulQuestion$Outbound
+  | ChoiceQuestion$Outbound
+  | ScoreQuestion$Outbound;
+
+/** @internal */
+export const Questions$outboundSchema: z.ZodType<
+  Questions$Outbound,
+  z.ZodTypeDef,
+  Questions
+> = z.union([
+  z.lazy(() => NoulQuestion$outboundSchema),
+  z.lazy(() => ChoiceQuestion$outboundSchema),
+  z.lazy(() => ScoreQuestion$outboundSchema),
+]);
+
+export function questionsToJSON(questions: Questions): string {
+  return JSON.stringify(Questions$outboundSchema.parse(questions));
+}
+
+/** @internal */
+export type State$Outbound = string | { [k: string]: any } | Array<any>;
+
+/** @internal */
+export const State$outboundSchema: z.ZodType<
+  State$Outbound,
+  z.ZodTypeDef,
+  State
+> = z.union([z.string(), z.record(z.any()), z.array(z.any())]);
+
+export function stateToJSON(state: State): string {
+  return JSON.stringify(State$outboundSchema.parse(state));
+}
+
+/** @internal */
+export type CreateClassifyRequestBody$Outbound = {
+  identity?: components.ResponseIdentity$Outbound | undefined;
+  metadata?: { [k: string]: string } | undefined;
+  model: string;
+  name?: string | undefined;
+  questions: {
+    [k: string]:
+      | NoulQuestion$Outbound
+      | ChoiceQuestion$Outbound
+      | ScoreQuestion$Outbound;
+  };
+  retry?: components.ClassifyRetryConfig$Outbound | undefined;
+  state: string | { [k: string]: any } | Array<any>;
+};
+
+/** @internal */
+export const CreateClassifyRequestBody$outboundSchema: z.ZodType<
+  CreateClassifyRequestBody$Outbound,
+  z.ZodTypeDef,
+  CreateClassifyRequestBody
+> = z.object({
+  identity: components.ResponseIdentity$outboundSchema.optional(),
+  metadata: z.record(z.string()).optional(),
+  model: z.string(),
+  name: z.string().optional(),
+  questions: z.record(
+    z.union([
+      z.lazy(() => NoulQuestion$outboundSchema),
+      z.lazy(() => ChoiceQuestion$outboundSchema),
+      z.lazy(() => ScoreQuestion$outboundSchema),
+    ]),
+  ),
+  retry: components.ClassifyRetryConfig$outboundSchema.optional(),
+  state: z.union([z.string(), z.record(z.any()), z.array(z.any())]),
+});
+
+export function createClassifyRequestBodyToJSON(
+  createClassifyRequestBody: CreateClassifyRequestBody,
+): string {
+  return JSON.stringify(
+    CreateClassifyRequestBody$outboundSchema.parse(createClassifyRequestBody),
+  );
+}
+
+/** @internal */
+export const CreateClassifyResponseBody$inboundSchema: z.ZodType<
+  CreateClassifyResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  answers: z.record(components.ClassifyAnswer$inboundSchema),
+  model: z.string(),
+  telemetry: components.ResponseTelemetry$inboundSchema.optional(),
+  usage: components.ClassifyUsage$inboundSchema,
+});
+
+export function createClassifyResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateClassifyResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateClassifyResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateClassifyResponseBody' from JSON`,
+  );
+}

package/src/models/operations/createcompletion.ts

@@ -470,7 +470,7 @@ export type CreateCompletionFilterBy1 =
   | CreateCompletion1Nin;
 
 /**
- * The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
+ * The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
  */
 export type CreateCompletionFilterBy =
   | CreateCompletionFilterByAnd
@@ -510,7 +510,7 @@ export type CreateCompletionSearchOptions = {
  */
 export type CreateCompletionRerankConfig = {
   /**
-   * The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/docs/ai-gateway/supported-models#rerank-models).
+   * The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/ai-gateway/supported-models#rerank-models).
    */
   model: string;
   /**
@@ -528,7 +528,7 @@ export type CreateCompletionRerankConfig = {
  */
 export type CreateCompletionAgenticRagConfig = {
   /**
-   * The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/docs/ai-gateway/supported-models#chat-models).
+   * The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/ai-gateway/supported-models#chat-models).
    */
   model: string;
 };
@@ -547,7 +547,7 @@ export type CreateCompletionKnowledgeBases = {
    */
   searchType?: CreateCompletionSearchType | null | undefined;
   /**
-   * The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
+   * The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
    */
   filterBy?: CreateCompletionFilterByAnd | CreateCompletionFilterByOr | {
     [k: string]:
@@ -606,7 +606,7 @@ export type CreateCompletionLoadBalancerRouterCompletions1 = {
 };
 
 /**
- * Array of models with weights for load balancing requests
+ * Load balancer configuration for the request.
  */
 export type CreateCompletionRouterCompletionsLoadBalancer =
   CreateCompletionLoadBalancerRouterCompletions1;
@@ -669,7 +669,7 @@ export type CreateCompletionOrq = {
   cache?: CreateCompletionRouterCompletionsCache | undefined;
   knowledgeBases?: Array<CreateCompletionKnowledgeBases> | undefined;
   /**
-   * Array of models with weights for load balancing requests
+   * Load balancer configuration for the request.
    */
   loadBalancer?: CreateCompletionLoadBalancerRouterCompletions1 | undefined;
   /**
@@ -724,7 +724,7 @@ export type CreateCompletionRequestBody = {
    */
   n?: number | null | undefined;
   /**
-   * A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
+   * A unique identifier representing your end-user, which can help monitor and detect abuse.
    */
   user?: string | undefined;
   /**