@redis-iris/agent-memory 0.3.1 → 0.4.0-beta.2

package/src/controlplane/models/errors/not-found-error-response-content.ts

@@ -0,0 +1,113 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+import { AgentMemoryServiceError } from "./agent-memory-service-error.js";
+
+/**
+ * The requested resource does not exist.
+ */
+export type NotFoundErrorResponseContentData = {
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail?: string | undefined;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+   */
+  instance?: string | undefined;
+  /**
+   * The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
+   */
+  status?: number | undefined;
+  /**
+   * A short, human-readable summary of the problem
+   *
+   * @remarks
+   *                                       type.  It SHOULD NOT change from occurrence to occurrence of the
+   *                                       problem, except for purposes of localization (e.g., using
+   *                                       proactive content negotiation; see [RFC7231], Section 3.4).
+   */
+  title: string;
+  /**
+   * Problem type URI for not-found errors.
+   */
+  type: models.NotFoundErrorType;
+};
+
+/**
+ * The requested resource does not exist.
+ */
+export class NotFoundErrorResponseContent extends AgentMemoryServiceError {
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail?: string | undefined;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+   */
+  instance?: string | undefined;
+  /**
+   * The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
+   */
+  status?: number | undefined;
+  /**
+   * A short, human-readable summary of the problem
+   *
+   * @remarks
+   *                                       type.  It SHOULD NOT change from occurrence to occurrence of the
+   *                                       problem, except for purposes of localization (e.g., using
+   *                                       proactive content negotiation; see [RFC7231], Section 3.4).
+   */
+  title: string;
+  /**
+   * Problem type URI for not-found errors.
+   */
+  type: models.NotFoundErrorType;
+
+  /** The original data that was passed to this error instance. */
+  data$: NotFoundErrorResponseContentData;
+
+  constructor(
+    err: NotFoundErrorResponseContentData,
+    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;
+    if (err.detail != null) this.detail = err.detail;
+    if (err.instance != null) this.instance = err.instance;
+    if (err.status != null) this.status = err.status;
+    this.title = err.title;
+    this.type = err.type;
+
+    this.name = "NotFoundErrorResponseContent";
+  }
+}
+
+/** @internal */
+export const NotFoundErrorResponseContent$inboundSchema: z.ZodType<
+  NotFoundErrorResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  detail: z.string().optional(),
+  instance: z.string().optional(),
+  status: z.number().int().default(404),
+  title: z.string(),
+  type: models.NotFoundErrorType$inboundSchema,
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new NotFoundErrorResponseContent(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/controlplane/models/errors/response-validation-error.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { AgentMemoryServiceError } from "./agent-memory-service-error.js";
+import { formatZodError } from "./sdk-validation-error.js";
+
+export class ResponseValidationError extends AgentMemoryServiceError {
+  /**
+   * 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/src/controlplane/models/errors/sdk-validation-error.ts

@@ -0,0 +1,109 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+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/src/controlplane/models/errors/service-unavailable-error-response-content.ts

@@ -0,0 +1,103 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+import { AgentMemoryServiceError } from "./agent-memory-service-error.js";
+
+export type ServiceUnavailableErrorResponseContentData = {
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail?: string | undefined;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+   */
+  instance?: string | undefined;
+  /**
+   * The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
+   */
+  status?: number | undefined;
+  /**
+   * A short, human-readable summary of the problem
+   *
+   * @remarks
+   *                                       type.  It SHOULD NOT change from occurrence to occurrence of the
+   *                                       problem, except for purposes of localization (e.g., using
+   *                                       proactive content negotiation; see [RFC7231], Section 3.4).
+   */
+  title: string;
+  type: models.ServiceUnavailableErrorType;
+};
+
+export class ServiceUnavailableErrorResponseContent
+  extends AgentMemoryServiceError
+{
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail?: string | undefined;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+   */
+  instance?: string | undefined;
+  /**
+   * The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
+   */
+  status?: number | undefined;
+  /**
+   * A short, human-readable summary of the problem
+   *
+   * @remarks
+   *                                       type.  It SHOULD NOT change from occurrence to occurrence of the
+   *                                       problem, except for purposes of localization (e.g., using
+   *                                       proactive content negotiation; see [RFC7231], Section 3.4).
+   */
+  title: string;
+  type: models.ServiceUnavailableErrorType;
+
+  /** The original data that was passed to this error instance. */
+  data$: ServiceUnavailableErrorResponseContentData;
+
+  constructor(
+    err: ServiceUnavailableErrorResponseContentData,
+    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;
+    if (err.detail != null) this.detail = err.detail;
+    if (err.instance != null) this.instance = err.instance;
+    if (err.status != null) this.status = err.status;
+    this.title = err.title;
+    this.type = err.type;
+
+    this.name = "ServiceUnavailableErrorResponseContent";
+  }
+}
+
+/** @internal */
+export const ServiceUnavailableErrorResponseContent$inboundSchema: z.ZodType<
+  ServiceUnavailableErrorResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  detail: z.string().optional(),
+  instance: z.string().optional(),
+  status: z.number().int().default(503),
+  title: z.string(),
+  type: models.ServiceUnavailableErrorType$inboundSchema,
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ServiceUnavailableErrorResponseContent(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/controlplane/models/errors/unexpected-error-response-content.ts

@@ -0,0 +1,113 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+import { AgentMemoryServiceError } from "./agent-memory-service-error.js";
+
+/**
+ * The service failed with an unexpected internal error.
+ */
+export type UnexpectedErrorResponseContentData = {
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail?: string | undefined;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+   */
+  instance?: string | undefined;
+  /**
+   * The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
+   */
+  status?: number | undefined;
+  /**
+   * A short, human-readable summary of the problem
+   *
+   * @remarks
+   *                                       type.  It SHOULD NOT change from occurrence to occurrence of the
+   *                                       problem, except for purposes of localization (e.g., using
+   *                                       proactive content negotiation; see [RFC7231], Section 3.4).
+   */
+  title: string;
+  /**
+   * Problem type URI for unexpected internal errors.
+   */
+  type: models.UnexpectedErrorType;
+};
+
+/**
+ * The service failed with an unexpected internal error.
+ */
+export class UnexpectedErrorResponseContent extends AgentMemoryServiceError {
+  /**
+   * A human-readable explanation specific to this occurrence of the problem.
+   */
+  detail?: string | undefined;
+  /**
+   * A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+   */
+  instance?: string | undefined;
+  /**
+   * The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
+   */
+  status?: number | undefined;
+  /**
+   * A short, human-readable summary of the problem
+   *
+   * @remarks
+   *                                       type.  It SHOULD NOT change from occurrence to occurrence of the
+   *                                       problem, except for purposes of localization (e.g., using
+   *                                       proactive content negotiation; see [RFC7231], Section 3.4).
+   */
+  title: string;
+  /**
+   * Problem type URI for unexpected internal errors.
+   */
+  type: models.UnexpectedErrorType;
+
+  /** The original data that was passed to this error instance. */
+  data$: UnexpectedErrorResponseContentData;
+
+  constructor(
+    err: UnexpectedErrorResponseContentData,
+    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;
+    if (err.detail != null) this.detail = err.detail;
+    if (err.instance != null) this.instance = err.instance;
+    if (err.status != null) this.status = err.status;
+    this.title = err.title;
+    this.type = err.type;
+
+    this.name = "UnexpectedErrorResponseContent";
+  }
+}
+
+/** @internal */
+export const UnexpectedErrorResponseContent$inboundSchema: z.ZodType<
+  UnexpectedErrorResponseContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  detail: z.string().optional(),
+  instance: z.string().optional(),
+  status: z.number().int().default(500),
+  title: z.string(),
+  type: models.UnexpectedErrorType$inboundSchema,
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new UnexpectedErrorResponseContent(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/controlplane/models/exclusion-action.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+/**
+ * What to do with a memory a detector matched. Defaults to `redact`. When matching
+ *
+ * @remarks
+ * detectors disagree, `drop` wins.
+ */
+export const ExclusionAction = {
+  Redact: "redact",
+  Drop: "drop",
+} as const;
+/**
+ * What to do with a memory a detector matched. Defaults to `redact`. When matching
+ *
+ * @remarks
+ * detectors disagree, `drop` wins.
+ */
+export type ExclusionAction = OpenEnum<typeof ExclusionAction>;
+
+/** @internal */
+export const ExclusionAction$inboundSchema: z.ZodType<
+  ExclusionAction,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ExclusionAction);
+/** @internal */
+export const ExclusionAction$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ExclusionAction
+> = openEnums.outboundSchema(ExclusionAction);

package/src/controlplane/models/extraction-cadence-config.ts

@@ -0,0 +1,57 @@
+/*
+ * 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 { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+/**
+ * Cadence configuration for the extraction pipeline.
+ */
+export type ExtractionCadenceConfig = {
+  /**
+   * Interval in seconds between extraction runs while a session is active.
+   */
+  activeIntervalSeconds: number;
+};
+
+/** @internal */
+export const ExtractionCadenceConfig$inboundSchema: z.ZodType<
+  ExtractionCadenceConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  activeIntervalSeconds: z.number().int(),
+});
+/** @internal */
+export type ExtractionCadenceConfig$Outbound = {
+  activeIntervalSeconds: number;
+};
+
+/** @internal */
+export const ExtractionCadenceConfig$outboundSchema: z.ZodType<
+  ExtractionCadenceConfig$Outbound,
+  z.ZodTypeDef,
+  ExtractionCadenceConfig
+> = z.object({
+  activeIntervalSeconds: z.number().int(),
+});
+
+export function extractionCadenceConfigToJSON(
+  extractionCadenceConfig: ExtractionCadenceConfig,
+): string {
+  return JSON.stringify(
+    ExtractionCadenceConfig$outboundSchema.parse(extractionCadenceConfig),
+  );
+}
+export function extractionCadenceConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<ExtractionCadenceConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ExtractionCadenceConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ExtractionCadenceConfig' from JSON`,
+  );
+}

package/src/controlplane/models/extraction-strategy.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Extraction strategy for promoting short-term memory to long-term memory. Defaults
+ *
+ * @remarks
+ * to `instruct`.
+ */
+export const ExtractionStrategy = {
+  Instruct: "instruct",
+} as const;
+/**
+ * Extraction strategy for promoting short-term memory to long-term memory. Defaults
+ *
+ * @remarks
+ * to `instruct`.
+ */
+export type ExtractionStrategy = ClosedEnum<typeof ExtractionStrategy>;
+
+/** @internal */
+export const ExtractionStrategy$inboundSchema: z.ZodNativeEnum<
+  typeof ExtractionStrategy
+> = z.nativeEnum(ExtractionStrategy);
+/** @internal */
+export const ExtractionStrategy$outboundSchema: z.ZodNativeEnum<
+  typeof ExtractionStrategy
+> = ExtractionStrategy$inboundSchema;

package/src/controlplane/models/extractor-output.ts

@@ -0,0 +1,71 @@
+/*
+ * 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 { SDKValidationError } from "./errors/sdk-validation-error.js";
+import {
+  ExtractorSource,
+  ExtractorSource$inboundSchema,
+} from "./extractor-source.js";
+import {
+  ExtractorStrategy,
+  ExtractorStrategy$inboundSchema,
+} from "./extractor-strategy.js";
+
+export type ExtractorOutput = {
+  createdAt: Date;
+  /**
+   * Namespace identifier (1-64 chars): a namespace in the same memory store. Only letters (A-Z, a-z), digits (0-9), and dashes (-) are accepted.
+   */
+  destinationNamespaceId?: string | undefined;
+  enabled: boolean;
+  /**
+   * Extractor identifier, unique within its store.
+   */
+  id: string;
+  /**
+   * Name of a memory type or custom field (1-64 chars): a letter followed by letters, digits, underscores, or dashes.
+   */
+  memoryType: string;
+  /**
+   * Extractor display name.
+   */
+  name: string;
+  prompt: string;
+  revision: number;
+  source: ExtractorSource;
+  strategy: ExtractorStrategy;
+  updatedAt: Date;
+};
+
+/** @internal */
+export const ExtractorOutput$inboundSchema: z.ZodType<
+  ExtractorOutput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  destinationNamespaceId: z.string().optional(),
+  enabled: z.boolean(),
+  id: z.string(),
+  memoryType: z.string(),
+  name: z.string(),
+  prompt: z.string(),
+  revision: z.number().int(),
+  source: ExtractorSource$inboundSchema,
+  strategy: ExtractorStrategy$inboundSchema,
+  updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+});
+
+export function extractorOutputFromJSON(
+  jsonString: string,
+): SafeParseResult<ExtractorOutput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ExtractorOutput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ExtractorOutput' from JSON`,
+  );
+}