@orq-ai/node 3.9.0-rc.8 → 3.9.0

package/packages/orq-rc/src/models/errors/httpclienterrors.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/**
+ * Base class for all HTTP errors.
+ */
+export class HTTPClientError extends Error {
+  /** The underlying cause of the error. */
+  override readonly cause: unknown;
+  override name = "HTTPClientError";
+  constructor(message: string, opts?: { cause?: unknown }) {
+    let msg = message;
+    if (opts?.cause) {
+      msg += `: ${opts.cause}`;
+    }
+
+    super(msg, opts);
+    // In older runtimes, the cause field would not have been assigned through
+    // the super() call.
+    if (typeof this.cause === "undefined") {
+      this.cause = opts?.cause;
+    }
+  }
+}
+
+/**
+ * An error to capture unrecognised or unexpected errors when making HTTP calls.
+ */
+export class UnexpectedClientError extends HTTPClientError {
+  override name = "UnexpectedClientError";
+}
+
+/**
+ * An error that is raised when any inputs used to create a request are invalid.
+ */
+export class InvalidRequestError extends HTTPClientError {
+  override name = "InvalidRequestError";
+}
+
+/**
+ * An error that is raised when a HTTP request was aborted by the client error.
+ */
+export class RequestAbortedError extends HTTPClientError {
+  override readonly name = "RequestAbortedError";
+}
+
+/**
+ * An error that is raised when a HTTP request timed out due to an AbortSignal
+ * signal timeout.
+ */
+export class RequestTimeoutError extends HTTPClientError {
+  override readonly name = "RequestTimeoutError";
+}
+
+/**
+ * An error that is raised when a HTTP client is unable to make a request to
+ * a server.
+ */
+export class ConnectionError extends HTTPClientError {
+  override readonly name = "ConnectionError";
+}

package/packages/orq-rc/src/models/errors/index.ts

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./apierror.js";
+export * from "./createeval.js";
+export * from "./deletecontact.js";
+export * from "./deleteeval.js";
+export * from "./evalsageappropriate.js";
+export * from "./evalsbertscore.js";
+export * from "./evalsbleuscore.js";
+export * from "./evalsbotdetection.js";
+export * from "./evalscontains.js";
+export * from "./evalscontainsall.js";
+export * from "./evalscontainsany.js";
+export * from "./evalscontainsemail.js";
+export * from "./evalscontainsnone.js";
+export * from "./evalscontainsurl.js";
+export * from "./evalscontainsvalidlink.js";
+export * from "./evalsendswith.js";
+export * from "./evalsexactmatch.js";
+export * from "./evalsfactcheckingknowledgebase.js";
+export * from "./evalsgrammar.js";
+export * from "./evalslengthbetween.js";
+export * from "./evalslengthgreaterthan.js";
+export * from "./evalslengthlessthan.js";
+export * from "./evalslocalization.js";
+export * from "./evalspii.js";
+export * from "./evalsragascoherence.js";
+export * from "./evalsragasconciseness.js";
+export * from "./evalsragascontextentitiesrecall.js";
+export * from "./evalsragascontextprecision.js";
+export * from "./evalsragascontextrecall.js";
+export * from "./evalsragascorrectness.js";
+export * from "./evalsragasfaithfulness.js";
+export * from "./evalsragasharmfulness.js";
+export * from "./evalsragasmaliciousness.js";
+export * from "./evalsragasnoisesensitivity.js";
+export * from "./evalsragasresponserelevancy.js";
+export * from "./evalsragassummarization.js";
+export * from "./evalssentimentclassification.js";
+export * from "./evalssummarization.js";
+export * from "./evalstoneofvoice.js";
+export * from "./evalstranslation.js";
+export * from "./evalsvalidjson.js";
+export * from "./getevals.js";
+export * from "./getpromptversion.js";
+export * from "./honoapierror.js";
+export * from "./httpclienterrors.js";
+export * from "./invokeeval.js";
+export * from "./responsevalidationerror.js";
+export * from "./retrievecontact.js";
+export * from "./sdkvalidationerror.js";
+export * from "./updatecontact.js";
+export * from "./updateeval.js";
+export * from "./updateprompt.js";

package/packages/orq-rc/src/models/errors/invokeeval.ts

@@ -0,0 +1,154 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { OrqError } from "./orqerror.js";
+
+/**
+ * Error running the evaluator
+ */
+export type InvokeEvalEvalsResponseBodyData = {
+  message: string;
+};
+
+/**
+ * Error running the evaluator
+ */
+export class InvokeEvalEvalsResponseBody extends OrqError {
+  /** The original data that was passed to this error instance. */
+  data$: InvokeEvalEvalsResponseBodyData;
+
+  constructor(
+    err: InvokeEvalEvalsResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+
+    this.name = "InvokeEvalEvalsResponseBody";
+  }
+}
+
+/**
+ * Workspace ID is not found on the request
+ */
+export type InvokeEvalResponseBodyData = {
+  message: string;
+};
+
+/**
+ * Workspace ID is not found on the request
+ */
+export class InvokeEvalResponseBody extends OrqError {
+  /** The original data that was passed to this error instance. */
+  data$: InvokeEvalResponseBodyData;
+
+  constructor(
+    err: InvokeEvalResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+
+    this.name = "InvokeEvalResponseBody";
+  }
+}
+
+/** @internal */
+export const InvokeEvalEvalsResponseBody$inboundSchema: z.ZodType<
+  InvokeEvalEvalsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new InvokeEvalEvalsResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type InvokeEvalEvalsResponseBody$Outbound = {
+  message: string;
+};
+
+/** @internal */
+export const InvokeEvalEvalsResponseBody$outboundSchema: z.ZodType<
+  InvokeEvalEvalsResponseBody$Outbound,
+  z.ZodTypeDef,
+  InvokeEvalEvalsResponseBody
+> = z.instanceof(InvokeEvalEvalsResponseBody)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    message: z.string(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace InvokeEvalEvalsResponseBody$ {
+  /** @deprecated use `InvokeEvalEvalsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = InvokeEvalEvalsResponseBody$inboundSchema;
+  /** @deprecated use `InvokeEvalEvalsResponseBody$outboundSchema` instead. */
+  export const outboundSchema = InvokeEvalEvalsResponseBody$outboundSchema;
+  /** @deprecated use `InvokeEvalEvalsResponseBody$Outbound` instead. */
+  export type Outbound = InvokeEvalEvalsResponseBody$Outbound;
+}
+
+/** @internal */
+export const InvokeEvalResponseBody$inboundSchema: z.ZodType<
+  InvokeEvalResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new InvokeEvalResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type InvokeEvalResponseBody$Outbound = {
+  message: string;
+};
+
+/** @internal */
+export const InvokeEvalResponseBody$outboundSchema: z.ZodType<
+  InvokeEvalResponseBody$Outbound,
+  z.ZodTypeDef,
+  InvokeEvalResponseBody
+> = z.instanceof(InvokeEvalResponseBody)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    message: z.string(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace InvokeEvalResponseBody$ {
+  /** @deprecated use `InvokeEvalResponseBody$inboundSchema` instead. */
+  export const inboundSchema = InvokeEvalResponseBody$inboundSchema;
+  /** @deprecated use `InvokeEvalResponseBody$outboundSchema` instead. */
+  export const outboundSchema = InvokeEvalResponseBody$outboundSchema;
+  /** @deprecated use `InvokeEvalResponseBody$Outbound` instead. */
+  export type Outbound = InvokeEvalResponseBody$Outbound;
+}

package/packages/orq-rc/src/models/errors/orqerror.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/** The base class for all HTTP error responses */
+export class OrqError extends Error {
+  /** HTTP status code */
+  public readonly statusCode: number;
+  /** HTTP body */
+  public readonly body: string;
+  /** HTTP headers */
+  public readonly headers: Headers;
+  /** HTTP content type */
+  public readonly contentType: string;
+  /** Raw response */
+  public readonly rawResponse: Response;
+
+  constructor(
+    message: string,
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    super(message);
+    this.statusCode = httpMeta.response.status;
+    this.body = httpMeta.body;
+    this.headers = httpMeta.response.headers;
+    this.contentType = httpMeta.response.headers.get("content-type") || "";
+    this.rawResponse = httpMeta.response;
+
+    this.name = "OrqError";
+  }
+}

package/packages/orq-rc/src/models/errors/responsevalidationerror.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { OrqError } from "./orqerror.js";
+import { formatZodError } from "./sdkvalidationerror.js";
+
+export class ResponseValidationError extends OrqError {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  constructor(
+    message: string,
+    extra: {
+      response: Response;
+      request: Request;
+      body: string;
+      cause: unknown;
+      rawValue: unknown;
+      rawMessage: unknown;
+    },
+  ) {
+    super(message, extra);
+    this.name = "ResponseValidationError";
+    this.cause = extra.cause;
+    this.rawValue = extra.rawValue;
+    this.rawMessage = extra.rawMessage;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}

package/packages/orq-rc/src/models/errors/retrievecontact.ts

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { OrqError } from "./orqerror.js";
+
+/**
+ * Contact not found
+ */
+export type RetrieveContactResponseBodyData = {
+  /**
+   * Error message
+   */
+  error: string;
+};
+
+/**
+ * Contact not found
+ */
+export class RetrieveContactResponseBody extends OrqError {
+  /**
+   * Error message
+   */
+  error: string;
+
+  /** The original data that was passed to this error instance. */
+  data$: RetrieveContactResponseBodyData;
+
+  constructor(
+    err: RetrieveContactResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+
+    this.name = "RetrieveContactResponseBody";
+  }
+}
+
+/** @internal */
+export const RetrieveContactResponseBody$inboundSchema: z.ZodType<
+  RetrieveContactResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.string(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new RetrieveContactResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type RetrieveContactResponseBody$Outbound = {
+  error: string;
+};
+
+/** @internal */
+export const RetrieveContactResponseBody$outboundSchema: z.ZodType<
+  RetrieveContactResponseBody$Outbound,
+  z.ZodTypeDef,
+  RetrieveContactResponseBody
+> = z.instanceof(RetrieveContactResponseBody)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    error: z.string(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RetrieveContactResponseBody$ {
+  /** @deprecated use `RetrieveContactResponseBody$inboundSchema` instead. */
+  export const inboundSchema = RetrieveContactResponseBody$inboundSchema;
+  /** @deprecated use `RetrieveContactResponseBody$outboundSchema` instead. */
+  export const outboundSchema = RetrieveContactResponseBody$outboundSchema;
+  /** @deprecated use `RetrieveContactResponseBody$Outbound` instead. */
+  export type Outbound = RetrieveContactResponseBody$Outbound;
+}

package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts

@@ -0,0 +1,109 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export class SDKValidationError extends Error {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError`
+  static override [Symbol.hasInstance](
+    instance: unknown,
+  ): instance is SDKValidationError {
+    if (!(instance instanceof Error)) return false;
+    if (!("rawValue" in instance)) return false;
+    if (!("rawMessage" in instance)) return false;
+    if (!("pretty" in instance)) return false;
+    if (typeof instance.pretty !== "function") return false;
+    return true;
+  }
+
+  constructor(message: string, cause: unknown, rawValue: unknown) {
+    super(`${message}: ${cause}`);
+    this.name = "SDKValidationError";
+    this.cause = cause;
+    this.rawValue = rawValue;
+    this.rawMessage = message;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}
+
+export function formatZodError(err: z.ZodError, level = 0): string {
+  let pre = "  ".repeat(level);
+  pre = level > 0 ? `│${pre}` : pre;
+  pre += " ".repeat(level);
+
+  let message = "";
+  const append = (str: string) => (message += `\n${pre}${str}`);
+
+  const len = err.issues.length;
+  const headline = len === 1 ? `${len} issue found` : `${len} issues found`;
+
+  if (len) {
+    append(`┌ ${headline}:`);
+  }
+
+  for (const issue of err.issues) {
+    let path = issue.path.join(".");
+    path = path ? `<root>.${path}` : "<root>";
+    append(`│ • [${path}]: ${issue.message} (${issue.code})`);
+    switch (issue.code) {
+      case "invalid_literal":
+      case "invalid_type": {
+        append(`│     Want: ${issue.expected}`);
+        append(`│      Got: ${issue.received}`);
+        break;
+      }
+      case "unrecognized_keys": {
+        append(`│     Keys: ${issue.keys.join(", ")}`);
+        break;
+      }
+      case "invalid_enum_value": {
+        append(`│     Allowed: ${issue.options.join(", ")}`);
+        append(`│         Got: ${issue.received}`);
+        break;
+      }
+      case "invalid_union_discriminator": {
+        append(`│     Allowed: ${issue.options.join(", ")}`);
+        break;
+      }
+      case "invalid_union": {
+        const len = issue.unionErrors.length;
+        append(
+          `│   ✖︎ Attemped to deserialize into one of ${len} union members:`,
+        );
+        issue.unionErrors.forEach((err, i) => {
+          append(`│   ✖︎ Member ${i + 1} of ${len}`);
+          append(`${formatZodError(err, level + 1)}`);
+        });
+      }
+    }
+  }
+
+  if (err.issues.length) {
+    append(`└─*`);
+  }
+
+  return message.slice(1);
+}

package/packages/orq-rc/src/models/errors/updatecontact.ts

@@ -0,0 +1,83 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { OrqError } from "./orqerror.js";
+
+/**
+ * Contact not found
+ */
+export type UpdateContactResponseBodyData = {
+  /**
+   * Error message
+   */
+  message: string;
+};
+
+/**
+ * Contact not found
+ */
+export class UpdateContactResponseBody extends OrqError {
+  /** The original data that was passed to this error instance. */
+  data$: UpdateContactResponseBodyData;
+
+  constructor(
+    err: UpdateContactResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+
+    this.name = "UpdateContactResponseBody";
+  }
+}
+
+/** @internal */
+export const UpdateContactResponseBody$inboundSchema: z.ZodType<
+  UpdateContactResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new UpdateContactResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type UpdateContactResponseBody$Outbound = {
+  message: string;
+};
+
+/** @internal */
+export const UpdateContactResponseBody$outboundSchema: z.ZodType<
+  UpdateContactResponseBody$Outbound,
+  z.ZodTypeDef,
+  UpdateContactResponseBody
+> = z.instanceof(UpdateContactResponseBody)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    message: z.string(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateContactResponseBody$ {
+  /** @deprecated use `UpdateContactResponseBody$inboundSchema` instead. */
+  export const inboundSchema = UpdateContactResponseBody$inboundSchema;
+  /** @deprecated use `UpdateContactResponseBody$outboundSchema` instead. */
+  export const outboundSchema = UpdateContactResponseBody$outboundSchema;
+  /** @deprecated use `UpdateContactResponseBody$Outbound` instead. */
+  export type Outbound = UpdateContactResponseBody$Outbound;
+}