@redis-iris/agent-memory 0.4.0-beta.1 → 0.4.0-beta.3

package/src/controlplane/models/store-operation-metrics.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 { TimeValue, TimeValue$inboundSchema } from "./time-value.js";
+
+/**
+ * Metrics for a category of memory operations
+ */
+export type StoreOperationMetrics = {
+  /**
+   * Average read/search latency timeseries (in seconds)
+   */
+  readLatency: Array<TimeValue>;
+  /**
+   * Total read/search requests timeseries
+   */
+  readRequests: Array<TimeValue>;
+};
+
+/** @internal */
+export const StoreOperationMetrics$inboundSchema: z.ZodType<
+  StoreOperationMetrics,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  readLatency: z.array(TimeValue$inboundSchema),
+  readRequests: z.array(TimeValue$inboundSchema),
+});
+
+export function storeOperationMetricsFromJSON(
+  jsonString: string,
+): SafeParseResult<StoreOperationMetrics, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StoreOperationMetrics$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StoreOperationMetrics' from JSON`,
+  );
+}

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

@@ -0,0 +1,158 @@
+/*
+ * 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 {
+  CustomMemoryType,
+  CustomMemoryType$inboundSchema,
+} from "./custom-memory-type.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+import {
+  ExtractionCadenceConfig,
+  ExtractionCadenceConfig$inboundSchema,
+} from "./extraction-cadence-config.js";
+import {
+  ExtractionStrategy,
+  ExtractionStrategy$inboundSchema,
+} from "./extraction-strategy.js";
+import {
+  LongTermMemoryConfigStatus,
+  LongTermMemoryConfigStatus$inboundSchema,
+} from "./long-term-memory-config-status.js";
+import {
+  LongTermMemoryExclusionsConfig,
+  LongTermMemoryExclusionsConfig$inboundSchema,
+} from "./long-term-memory-exclusions-config.js";
+import {
+  ShortMemoryConfigStatus,
+  ShortMemoryConfigStatus$inboundSchema,
+} from "./short-memory-config-status.js";
+import {
+  StoreDatabase,
+  StoreDatabase$inboundSchema,
+} from "./store-database.js";
+import {
+  StoreEndpoint,
+  StoreEndpoint$inboundSchema,
+} from "./store-endpoint.js";
+import { StoreFailure, StoreFailure$inboundSchema } from "./store-failure.js";
+import { StoreStatus, StoreStatus$inboundSchema } from "./store-status.js";
+import {
+  SummarizationConfig,
+  SummarizationConfig$inboundSchema,
+} from "./summarization-config.js";
+
+/**
+ * Memory store configuration and status.
+ */
+export type StoreOutput = {
+  /**
+   * The UTC timestamp when the memory store was created.
+   */
+  createdAt: Date;
+  /**
+   * Custom memory types registered on the store.
+   */
+  customMemoryTypes?: Array<CustomMemoryType> | undefined;
+  /**
+   * The database a memory store's data is stored in.
+   */
+  database: StoreDatabase;
+  /**
+   * Redis Cloud only. API endpoints for accessing the memory store.
+   */
+  endpoints?: Array<StoreEndpoint> | undefined;
+  /**
+   * Cadence configuration for the extraction pipeline.
+   */
+  extractionCadence?: ExtractionCadenceConfig | undefined;
+  /**
+   * Extraction strategy for promoting short-term memory to long-term memory. Defaults
+   *
+   * @remarks
+   * to `instruct`.
+   */
+  extractionStrategy: ExtractionStrategy;
+  /**
+   * Why the store failed to provision. Present only when the store's `status` is
+   *
+   * @remarks
+   * `UNAVAILABLE`. Not returned by ListStores.
+   */
+  failure?: StoreFailure | undefined;
+  /**
+   * Long-term memory configuration. On Redis Cloud, `embedding`, `llm`, and
+   *
+   * @remarks
+   * `classification` are present only when the store selected its own models.
+   */
+  longTermMemory: LongTermMemoryConfigStatus;
+  /**
+   * Store-level sensitive-data exclusions policy.
+   */
+  longTermMemoryExclusions?: LongTermMemoryExclusionsConfig | undefined;
+  /**
+   * Human-readable name of the memory store.
+   */
+  name: string;
+  /**
+   * Short-term memory configuration. Omitted when no TTL is set.
+   */
+  shortMemory?: ShortMemoryConfigStatus | undefined;
+  /**
+   * Status of a memory store.
+   */
+  status: StoreStatus;
+  /**
+   * Unique identifier for the memory store.
+   */
+  storeId: string;
+  /**
+   * Redis Cloud only. The memory store's database subscription ID.
+   */
+  subscriptionId?: string | undefined;
+  /**
+   * Configuration for session summarization. When enabled, long sessions are
+   *
+   * @remarks
+   * periodically condensed into a running summary while retaining the most recent events.
+   */
+  summarization?: SummarizationConfig | undefined;
+};
+
+/** @internal */
+export const StoreOutput$inboundSchema: z.ZodType<
+  StoreOutput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  customMemoryTypes: z.array(CustomMemoryType$inboundSchema).optional(),
+  database: StoreDatabase$inboundSchema,
+  endpoints: z.array(StoreEndpoint$inboundSchema).optional(),
+  extractionCadence: ExtractionCadenceConfig$inboundSchema.optional(),
+  extractionStrategy: ExtractionStrategy$inboundSchema,
+  failure: StoreFailure$inboundSchema.optional(),
+  longTermMemory: LongTermMemoryConfigStatus$inboundSchema,
+  longTermMemoryExclusions: LongTermMemoryExclusionsConfig$inboundSchema
+    .optional(),
+  name: z.string(),
+  shortMemory: ShortMemoryConfigStatus$inboundSchema.optional(),
+  status: StoreStatus$inboundSchema,
+  storeId: z.string(),
+  subscriptionId: z.string().optional(),
+  summarization: SummarizationConfig$inboundSchema.optional(),
+});
+
+export function storeOutputFromJSON(
+  jsonString: string,
+): SafeParseResult<StoreOutput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StoreOutput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StoreOutput' from JSON`,
+  );
+}

package/src/controlplane/models/store-status.ts

@@ -0,0 +1,27 @@
+/*
+ * 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";
+
+/**
+ * Status of a memory store.
+ */
+export const StoreStatus = {
+  Provisioning: "PROVISIONING",
+  Ready: "READY",
+  Unavailable: "UNAVAILABLE",
+} as const;
+/**
+ * Status of a memory store.
+ */
+export type StoreStatus = OpenEnum<typeof StoreStatus>;
+
+/** @internal */
+export const StoreStatus$inboundSchema: z.ZodType<
+  StoreStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(StoreStatus);

package/src/controlplane/models/store-token-usage-metrics.ts

@@ -0,0 +1,96 @@
+/*
+ * 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 {
+  TokenUsageSeries,
+  TokenUsageSeries$inboundSchema,
+} from "./token-usage-series.js";
+
+/**
+ * Per-consumer LLM and embedding token usage for a store
+ */
+export type StoreTokenUsageMetrics = {
+  /**
+   * Input and output token timeseries for one inference consumer
+   */
+  customExtraction: TokenUsageSeries;
+  /**
+   * Input and output token timeseries for one inference consumer
+   */
+  documentExtraction: TokenUsageSeries;
+  /**
+   * Input and output token timeseries for one inference consumer
+   */
+  embeddingQuery: TokenUsageSeries;
+  /**
+   * Input and output token timeseries for one inference consumer
+   */
+  embeddingWrite: TokenUsageSeries;
+  /**
+   * Input and output token timeseries for one inference consumer
+   */
+  extraction: TokenUsageSeries;
+  /**
+   * Input and output token timeseries for one inference consumer
+   */
+  memoryExtraction: TokenUsageSeries;
+  /**
+   * Input and output token timeseries for one inference consumer
+   */
+  namespaceRouting: TokenUsageSeries;
+  /**
+   * Input and output token timeseries for one inference consumer
+   */
+  sessionSummaryView: TokenUsageSeries;
+  /**
+   * Input and output token timeseries for one inference consumer
+   */
+  shortTermSummarization: TokenUsageSeries;
+  /**
+   * Input and output token timeseries for one inference consumer
+   */
+  summaryViewGeneration: TokenUsageSeries;
+  /**
+   * Input and output token timeseries for one inference consumer
+   */
+  totalEmbedding: TokenUsageSeries;
+  /**
+   * Input and output token timeseries for one inference consumer
+   */
+  totalLlm: TokenUsageSeries;
+};
+
+/** @internal */
+export const StoreTokenUsageMetrics$inboundSchema: z.ZodType<
+  StoreTokenUsageMetrics,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  customExtraction: TokenUsageSeries$inboundSchema,
+  documentExtraction: TokenUsageSeries$inboundSchema,
+  embeddingQuery: TokenUsageSeries$inboundSchema,
+  embeddingWrite: TokenUsageSeries$inboundSchema,
+  extraction: TokenUsageSeries$inboundSchema,
+  memoryExtraction: TokenUsageSeries$inboundSchema,
+  namespaceRouting: TokenUsageSeries$inboundSchema,
+  sessionSummaryView: TokenUsageSeries$inboundSchema,
+  shortTermSummarization: TokenUsageSeries$inboundSchema,
+  summaryViewGeneration: TokenUsageSeries$inboundSchema,
+  totalEmbedding: TokenUsageSeries$inboundSchema,
+  totalLlm: TokenUsageSeries$inboundSchema,
+});
+
+export function storeTokenUsageMetricsFromJSON(
+  jsonString: string,
+): SafeParseResult<StoreTokenUsageMetrics, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StoreTokenUsageMetrics$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StoreTokenUsageMetrics' from JSON`,
+  );
+}

package/src/controlplane/models/summarization-config.ts

@@ -0,0 +1,88 @@
+/*
+ * 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 {
+  SummarizationThresholdConfig,
+  SummarizationThresholdConfig$inboundSchema,
+  SummarizationThresholdConfig$Outbound,
+  SummarizationThresholdConfig$outboundSchema,
+} from "./summarization-threshold-config.js";
+import {
+  SummarizationTriggerStrategy,
+  SummarizationTriggerStrategy$inboundSchema,
+  SummarizationTriggerStrategy$outboundSchema,
+} from "./summarization-trigger-strategy.js";
+
+/**
+ * Configuration for session summarization. When enabled, long sessions are
+ *
+ * @remarks
+ * periodically condensed into a running summary while retaining the most recent events.
+ */
+export type SummarizationConfig = {
+  /**
+   * Whether summarization is enabled for this store.
+   */
+  enabled: boolean;
+  /**
+   * Configuration for a summarization trigger.
+   */
+  eventCount?: SummarizationThresholdConfig | undefined;
+  /**
+   * Strategy that determines when summarization is triggered. Defaults to
+   *
+   * @remarks
+   * `event_count`.
+   */
+  triggerStrategy?: SummarizationTriggerStrategy | undefined;
+};
+
+/** @internal */
+export const SummarizationConfig$inboundSchema: z.ZodType<
+  SummarizationConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  enabled: z.boolean(),
+  eventCount: SummarizationThresholdConfig$inboundSchema.optional(),
+  triggerStrategy: SummarizationTriggerStrategy$inboundSchema.optional(),
+});
+/** @internal */
+export type SummarizationConfig$Outbound = {
+  enabled: boolean;
+  eventCount?: SummarizationThresholdConfig$Outbound | undefined;
+  triggerStrategy?: string | undefined;
+};
+
+/** @internal */
+export const SummarizationConfig$outboundSchema: z.ZodType<
+  SummarizationConfig$Outbound,
+  z.ZodTypeDef,
+  SummarizationConfig
+> = z.object({
+  enabled: z.boolean(),
+  eventCount: SummarizationThresholdConfig$outboundSchema.optional(),
+  triggerStrategy: SummarizationTriggerStrategy$outboundSchema.optional(),
+});
+
+export function summarizationConfigToJSON(
+  summarizationConfig: SummarizationConfig,
+): string {
+  return JSON.stringify(
+    SummarizationConfig$outboundSchema.parse(summarizationConfig),
+  );
+}
+export function summarizationConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<SummarizationConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SummarizationConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SummarizationConfig' from JSON`,
+  );
+}

package/src/controlplane/models/summarization-threshold-config.ts

@@ -0,0 +1,66 @@
+/*
+ * 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";
+
+/**
+ * Configuration for a summarization trigger.
+ */
+export type SummarizationThresholdConfig = {
+  /**
+   * Number of most recent events to retain after each summarization cycle.
+   */
+  retainCount: number;
+  /**
+   * The threshold value that triggers summarization.
+   */
+  threshold: number;
+};
+
+/** @internal */
+export const SummarizationThresholdConfig$inboundSchema: z.ZodType<
+  SummarizationThresholdConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  retainCount: z.number().int(),
+  threshold: z.number().int(),
+});
+/** @internal */
+export type SummarizationThresholdConfig$Outbound = {
+  retainCount: number;
+  threshold: number;
+};
+
+/** @internal */
+export const SummarizationThresholdConfig$outboundSchema: z.ZodType<
+  SummarizationThresholdConfig$Outbound,
+  z.ZodTypeDef,
+  SummarizationThresholdConfig
+> = z.object({
+  retainCount: z.number().int(),
+  threshold: z.number().int(),
+});
+
+export function summarizationThresholdConfigToJSON(
+  summarizationThresholdConfig: SummarizationThresholdConfig,
+): string {
+  return JSON.stringify(
+    SummarizationThresholdConfig$outboundSchema.parse(
+      summarizationThresholdConfig,
+    ),
+  );
+}
+export function summarizationThresholdConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<SummarizationThresholdConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SummarizationThresholdConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SummarizationThresholdConfig' from JSON`,
+  );
+}

package/src/controlplane/models/summarization-trigger-strategy.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Strategy that determines when summarization is triggered. Defaults to
+ *
+ * @remarks
+ * `event_count`.
+ */
+export const SummarizationTriggerStrategy = {
+  EventCount: "event_count",
+} as const;
+/**
+ * Strategy that determines when summarization is triggered. Defaults to
+ *
+ * @remarks
+ * `event_count`.
+ */
+export type SummarizationTriggerStrategy = ClosedEnum<
+  typeof SummarizationTriggerStrategy
+>;
+
+/** @internal */
+export const SummarizationTriggerStrategy$inboundSchema: z.ZodNativeEnum<
+  typeof SummarizationTriggerStrategy
+> = z.nativeEnum(SummarizationTriggerStrategy);
+/** @internal */
+export const SummarizationTriggerStrategy$outboundSchema: z.ZodNativeEnum<
+  typeof SummarizationTriggerStrategy
+> = SummarizationTriggerStrategy$inboundSchema;

package/src/controlplane/models/system-memory-field.ts

@@ -0,0 +1,50 @@
+/*
+ * 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";
+
+/**
+ * A built-in field present on every memory record. It cannot be edited or
+ *
+ * @remarks
+ * removed when registering a custom type.
+ */
+export type SystemMemoryField = {
+  /**
+   * Human-readable description of the field.
+   */
+  description: string;
+  /**
+   * Field name as it appears on a memory record.
+   */
+  name: string;
+  /**
+   * Human-readable field data type (e.g. string, datetime, list[str]).
+   */
+  type: string;
+};
+
+/** @internal */
+export const SystemMemoryField$inboundSchema: z.ZodType<
+  SystemMemoryField,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  description: z.string(),
+  name: z.string(),
+  type: z.string(),
+});
+
+export function systemMemoryFieldFromJSON(
+  jsonString: string,
+): SafeParseResult<SystemMemoryField, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SystemMemoryField$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SystemMemoryField' from JSON`,
+  );
+}

package/src/controlplane/models/time-value.ts

@@ -0,0 +1,42 @@
+/*
+ * 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";
+
+/**
+ * A single point in a metrics timeseries
+ */
+export type TimeValue = {
+  /**
+   * Time of the metric point
+   */
+  time: Date;
+  /**
+   * Value of the metric at this time
+   */
+  value: number;
+};
+
+/** @internal */
+export const TimeValue$inboundSchema: z.ZodType<
+  TimeValue,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  time: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  value: z.number(),
+});
+
+export function timeValueFromJSON(
+  jsonString: string,
+): SafeParseResult<TimeValue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TimeValue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TimeValue' from JSON`,
+  );
+}

package/src/controlplane/models/token-usage-series.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 { TimeValue, TimeValue$inboundSchema } from "./time-value.js";
+
+/**
+ * Input and output token timeseries for one inference consumer
+ */
+export type TokenUsageSeries = {
+  /**
+   * Input (prompt) token counts over the window
+   */
+  inputTokens: Array<TimeValue>;
+  /**
+   * Output (completion) token counts over the window; empty for embeddings
+   */
+  outputTokens: Array<TimeValue>;
+};
+
+/** @internal */
+export const TokenUsageSeries$inboundSchema: z.ZodType<
+  TokenUsageSeries,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  inputTokens: z.array(TimeValue$inboundSchema),
+  outputTokens: z.array(TimeValue$inboundSchema),
+});
+
+export function tokenUsageSeriesFromJSON(
+  jsonString: string,
+): SafeParseResult<TokenUsageSeries, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TokenUsageSeries$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TokenUsageSeries' from JSON`,
+  );
+}

package/src/controlplane/models/unexpected-error-type.ts

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Problem type URI for unexpected internal errors.
+ */
+export const UnexpectedErrorType = {
+  RootErrorsUnexpectedError: "/errors/unexpected-error",
+} as const;
+/**
+ * Problem type URI for unexpected internal errors.
+ */
+export type UnexpectedErrorType = ClosedEnum<typeof UnexpectedErrorType>;
+
+/** @internal */
+export const UnexpectedErrorType$inboundSchema: z.ZodNativeEnum<
+  typeof UnexpectedErrorType
+> = z.nativeEnum(UnexpectedErrorType);