@redis-iris/agent-memory 0.1.1 → 0.2.0

package/src/models/attribute-filter-clause.ts

@@ -0,0 +1,135 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9e2e283a0e23
+ */
+
+import * as z from "zod/v3";
+
+export type List = {
+  /**
+   * Match a list attribute that contains all of these values.
+   */
+  list: Array<string>;
+};
+
+export type Boolean = {
+  /**
+   * Match a boolean attribute equal to this value.
+   */
+  boolean: boolean;
+};
+
+export type NumberT = {
+  /**
+   * Match a numeric attribute equal to this value.
+   */
+  number: number;
+};
+
+export type String = {
+  /**
+   * Match a string attribute equal to this value.
+   */
+  string: string;
+};
+
+/**
+ * Filter clause for a single record attribute. Exactly one member is set; the member must match the attribute's declared field type.
+ */
+export type AttributeFilterClause = String | NumberT | Boolean | List;
+
+/** @internal */
+export type List$Outbound = {
+  list: Array<string>;
+};
+
+/** @internal */
+export const List$outboundSchema: z.ZodType<List$Outbound, z.ZodTypeDef, List> =
+  z.object({
+    list: z.array(z.string()),
+  });
+
+export function listToJSON(list: List): string {
+  return JSON.stringify(List$outboundSchema.parse(list));
+}
+
+/** @internal */
+export type Boolean$Outbound = {
+  boolean: boolean;
+};
+
+/** @internal */
+export const Boolean$outboundSchema: z.ZodType<
+  Boolean$Outbound,
+  z.ZodTypeDef,
+  Boolean
+> = z.object({
+  boolean: z.boolean(),
+});
+
+export function booleanToJSON(value: Boolean): string {
+  return JSON.stringify(Boolean$outboundSchema.parse(value));
+}
+
+/** @internal */
+export type NumberT$Outbound = {
+  number: number;
+};
+
+/** @internal */
+export const NumberT$outboundSchema: z.ZodType<
+  NumberT$Outbound,
+  z.ZodTypeDef,
+  NumberT
+> = z.object({
+  number: z.number(),
+});
+
+export function numberToJSON(numberT: NumberT): string {
+  return JSON.stringify(NumberT$outboundSchema.parse(numberT));
+}
+
+/** @internal */
+export type String$Outbound = {
+  string: string;
+};
+
+/** @internal */
+export const String$outboundSchema: z.ZodType<
+  String$Outbound,
+  z.ZodTypeDef,
+  String
+> = z.object({
+  string: z.string(),
+});
+
+export function stringToJSON(string: String): string {
+  return JSON.stringify(String$outboundSchema.parse(string));
+}
+
+/** @internal */
+export type AttributeFilterClause$Outbound =
+  | String$Outbound
+  | NumberT$Outbound
+  | Boolean$Outbound
+  | List$Outbound;
+
+/** @internal */
+export const AttributeFilterClause$outboundSchema: z.ZodType<
+  AttributeFilterClause$Outbound,
+  z.ZodTypeDef,
+  AttributeFilterClause
+> = z.union([
+  z.lazy(() => String$outboundSchema),
+  z.lazy(() => NumberT$outboundSchema),
+  z.lazy(() => Boolean$outboundSchema),
+  z.lazy(() => List$outboundSchema),
+]);
+
+export function attributeFilterClauseToJSON(
+  attributeFilterClause: AttributeFilterClause,
+): string {
+  return JSON.stringify(
+    AttributeFilterClause$outboundSchema.parse(attributeFilterClause),
+  );
+}

package/src/models/create-memory-record.ts

@@ -4,7 +4,6 @@
  */
 
 import * as z from "zod/v3";
-import { MemoryType, MemoryType$outboundSchema } from "./memory-type.js";
 
 /**
  * A memory record to create.
@@ -19,9 +18,9 @@ export type CreateMemoryRecord = {
    */
   text: string;
   /**
-   * Type of long-term memory.
+   * Type of memory. Built-in or a custom type registered on the store.
    */
-  memoryType?: MemoryType | undefined;
+  memoryType?: string | undefined;
   /**
    * Session ID associated with this memory (1-64 chars, alphanumeric and dashes).
    */
@@ -29,15 +28,19 @@ export type CreateMemoryRecord = {
   /**
    * Owner ID associated with this memory (1-64 chars, alphanumeric and dashes).
    */
-  ownerId?: string | undefined;
+  ownerId: string;
   /**
-   * Namespace for logical grouping (1-64 chars, alphanumeric and dashes).
+   * Optional namespace for logical grouping (1-64 chars, alphanumeric and dashes). Omit to create the record without a namespace. Records created here are explicit writes, so this value is taken as given; extraction instead inherits the source session's namespace.
    */
   namespace?: string | undefined;
   /**
    * Topic tags for categorization (max 50 topics, each 1-100 chars).
    */
   topics?: Array<string> | undefined;
+  /**
+   * Structured record attributes: a map from the custom memory type's field name to that field's value. Values are arbitrary JSON matching the field's declared type (str, int, float, bool, list[str], list[float], or object).
+   */
+  attributes?: { [k: string]: any } | undefined;
 };
 
 /** @internal */
@@ -46,9 +49,10 @@ export type CreateMemoryRecord$Outbound = {
   text: string;
   memoryType?: string | undefined;
   sessionId?: string | undefined;
-  ownerId?: string | undefined;
+  ownerId: string;
   namespace?: string | undefined;
   topics?: Array<string> | undefined;
+  attributes?: { [k: string]: any } | undefined;
 };
 
 /** @internal */
@@ -59,11 +63,12 @@ export const CreateMemoryRecord$outboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   text: z.string(),
-  memoryType: MemoryType$outboundSchema.optional(),
+  memoryType: z.string().optional(),
   sessionId: z.string().optional(),
-  ownerId: z.string().optional(),
+  ownerId: z.string(),
   namespace: z.string().optional(),
   topics: z.array(z.string()).optional(),
+  attributes: z.record(z.any()).optional(),
 });
 
 export function createMemoryRecordToJSON(

package/src/models/get-long-term-memory-response-content.ts

@@ -7,7 +7,6 @@ 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 { MemoryType, MemoryType$inboundSchema } from "./memory-type.js";
 
 /**
  * A long-term memory record.
@@ -22,9 +21,9 @@ export type GetLongTermMemoryResponseContent = {
    */
   text: string;
   /**
-   * Type of long-term memory.
+   * Type of memory. Built-in or a custom type registered on the store.
    */
-  memoryType?: MemoryType | undefined;
+  memoryType?: string | undefined;
   /**
    * Session ID associated with this memory.
    */
@@ -34,13 +33,17 @@ export type GetLongTermMemoryResponseContent = {
    */
   ownerId?: string | undefined;
   /**
-   * Namespace for logical grouping.
+   * Namespace for logical grouping. Absent when the record has none: either it was written directly without one, or it was extracted from a session that has no namespace.
    */
   namespace?: string | undefined;
   /**
    * Topic tags for categorization.
    */
   topics?: Array<string> | undefined;
+  /**
+   * Structured record attributes: a map from the custom memory type's field name to that field's value. Values are arbitrary JSON matching the field's declared type (str, int, float, bool, list[str], list[float], or object).
+   */
+  attributes?: { [k: string]: any } | undefined;
   /**
    * Timestamp when the memory was created (UTC).
    */
@@ -59,11 +62,12 @@ export const GetLongTermMemoryResponseContent$inboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   text: z.string(),
-  memoryType: MemoryType$inboundSchema.optional(),
+  memoryType: z.string().optional(),
   sessionId: z.string().optional(),
   ownerId: z.string().optional(),
   namespace: z.string().optional(),
   topics: z.array(z.string()).optional(),
+  attributes: z.record(z.any()).optional(),
   createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
 });

package/src/models/get-session-memory-response-content.ts

@@ -8,6 +8,10 @@ import { safeParse } from "../lib/schemas.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdk-validation-error.js";
 import { SessionEvent, SessionEvent$inboundSchema } from "./session-event.js";
+import {
+  SessionSummary,
+  SessionSummary$inboundSchema,
+} from "./session-summary.js";
 
 /**
  * Session memory state for a session.
@@ -22,9 +26,21 @@ export type GetSessionMemoryResponseContent = {
    */
   ownerId: string;
   /**
-   * Events stored in this session.
+   * The namespace of the session, set from the namespace of the first event. Absent when the first event did not supply one; long-term memories extracted from this session then carry no namespace.
+   */
+  namespace?: string | undefined;
+  /**
+   * Conversation events retained for this session. When summarization is enabled, events already covered by the summary are excluded unless `includeSummarisedEvents` is set; the compacted summary is returned separately in `summary`.
    */
   events: Array<SessionEvent>;
+  /**
+   * Compacted summary of older session history for a session.
+   *
+   * @remarks
+   *
+   * This is derived session state maintained by the background summarization workflow, not a conversation event. It is present only after at least one summarization cycle has completed.
+   */
+  summary?: SessionSummary | undefined;
 };
 
 /** @internal */
@@ -35,7 +51,9 @@ export const GetSessionMemoryResponseContent$inboundSchema: z.ZodType<
 > = z.object({
   sessionId: z.string(),
   ownerId: z.string(),
+  namespace: z.string().optional(),
   events: z.array(SessionEvent$inboundSchema),
+  summary: SessionSummary$inboundSchema.optional(),
 });
 
 export function getSessionMemoryResponseContentFromJSON(

package/src/models/index.ts

@@ -5,6 +5,7 @@
 
 export * from "./add-session-event-request-content.js";
 export * from "./add-session-event-response-content.js";
+export * from "./attribute-filter-clause.js";
 export * from "./authentication-error-type.js";
 export * from "./bad-request-error-type.js";
 export * from "./bulk-create-long-term-memories-request-content.js";
@@ -28,7 +29,6 @@ export * from "./list-sessions-response-content.js";
 export * from "./long-term-memory-filter.js";
 export * from "./memory-record.js";
 export * from "./memory-type-filter.js";
-export * from "./memory-type.js";
 export * from "./message-role.js";
 export * from "./namespace-filter.js";
 export * from "./not-found-error-type.js";
@@ -39,9 +39,14 @@ export * from "./search-long-term-memory-response-content.js";
 export * from "./security.js";
 export * from "./session-event.js";
 export * from "./session-id-filter.js";
+export * from "./session-summary.js";
+export * from "./store-health-feature.js";
+export * from "./store-health-response-content.js";
+export * from "./store-health-status.js";
 export * from "./timeout-error-type.js";
 export * from "./too-many-requests-error-type.js";
 export * from "./topics-filter.js";
 export * from "./unexpected-error-type.js";
+export * from "./update-long-term-memory-fields-request-content.js";
 export * from "./update-long-term-memory-request-content.js";
 export * from "./update-long-term-memory-response-content.js";

package/src/models/long-term-memory-filter.ts

@@ -4,6 +4,11 @@
  */
 
 import * as z from "zod/v3";
+import {
+  AttributeFilterClause,
+  AttributeFilterClause$Outbound,
+  AttributeFilterClause$outboundSchema,
+} from "./attribute-filter-clause.js";
 import {
   CreatedAtFilter,
   CreatedAtFilter$Outbound,
@@ -40,29 +45,39 @@ import {
  */
 export type LongTermMemoryFilter = {
   /**
-   * Filter by the long-term memory sessionId field.
+   * Filter by the long-term memory sessionId field. Matching is case-sensitive.
    */
   sessionId?: SessionIdFilter | undefined;
   /**
-   * Filter by the long-term memory ownerId field.
+   * Filter by the long-term memory ownerId field. Matching is case-sensitive.
    */
   ownerId?: OwnerIdFilter | undefined;
   /**
-   * Filter by namespace.
+   * Filter by namespace. Matching is case-insensitive.
+   *
+   * @remarks
+   *
+   * Namespace is optional, so records without one need care. The positive operators (`eq`, `in`, `all`) require the field to be present and therefore never match a record that has no namespace — including memories extracted from a session that has none. `ne` is a plain negation and *does* match those records, so use `eq` or `in` when you need strict namespace isolation rather than `ne` against the namespaces you want to exclude.
+   *
+   * Omit this filter to search across every namespace, and use it to keep recall inside one project, workspace, team, environment, or tenant.
    */
   namespace?: NamespaceFilter | undefined;
   /**
-   * Filter by topics.
+   * Filter by topics. Matching is case-insensitive.
    */
   topics?: TopicsFilter | undefined;
   /**
-   * Filter by memory type.
+   * Filter by memory type. Matching is case-insensitive.
    */
   memoryType?: MemoryTypeFilter | undefined;
   /**
    * Filter by creation timestamp.
    */
   createdAt?: CreatedAtFilter | undefined;
+  /**
+   * Per-attribute filter clauses keyed by the custom memory type's field name.
+   */
+  attributes?: { [k: string]: AttributeFilterClause } | undefined;
 };
 
 /** @internal */
@@ -73,6 +88,7 @@ export type LongTermMemoryFilter$Outbound = {
   topics?: TopicsFilter$Outbound | undefined;
   memoryType?: MemoryTypeFilter$Outbound | undefined;
   createdAt?: CreatedAtFilter$Outbound | undefined;
+  attributes?: { [k: string]: AttributeFilterClause$Outbound } | undefined;
 };
 
 /** @internal */
@@ -87,6 +103,7 @@ export const LongTermMemoryFilter$outboundSchema: z.ZodType<
   topics: TopicsFilter$outboundSchema.optional(),
   memoryType: MemoryTypeFilter$outboundSchema.optional(),
   createdAt: CreatedAtFilter$outboundSchema.optional(),
+  attributes: z.record(AttributeFilterClause$outboundSchema).optional(),
 });
 
 export function longTermMemoryFilterToJSON(

package/src/models/memory-record.ts

@@ -7,7 +7,6 @@ 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 { MemoryType, MemoryType$inboundSchema } from "./memory-type.js";
 
 /**
  * A long-term memory record.
@@ -22,9 +21,9 @@ export type MemoryRecord = {
    */
   text: string;
   /**
-   * Type of long-term memory.
+   * Type of memory. Built-in or a custom type registered on the store.
    */
-  memoryType?: MemoryType | undefined;
+  memoryType?: string | undefined;
   /**
    * Session ID associated with this memory.
    */
@@ -34,13 +33,17 @@ export type MemoryRecord = {
    */
   ownerId?: string | undefined;
   /**
-   * Namespace for logical grouping.
+   * Namespace for logical grouping. Absent when the record has none: either it was written directly without one, or it was extracted from a session that has no namespace.
    */
   namespace?: string | undefined;
   /**
    * Topic tags for categorization.
    */
   topics?: Array<string> | undefined;
+  /**
+   * Structured record attributes: a map from the custom memory type's field name to that field's value. Values are arbitrary JSON matching the field's declared type (str, int, float, bool, list[str], list[float], or object).
+   */
+  attributes?: { [k: string]: any } | undefined;
   /**
    * Timestamp when the memory was created (UTC).
    */
@@ -59,11 +62,12 @@ export const MemoryRecord$inboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   text: z.string(),
-  memoryType: MemoryType$inboundSchema.optional(),
+  memoryType: z.string().optional(),
   sessionId: z.string().optional(),
   ownerId: z.string().optional(),
   namespace: z.string().optional(),
   topics: z.array(z.string()).optional(),
+  attributes: z.record(z.any()).optional(),
   createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
 });

package/src/models/memory-type-filter.ts

@@ -6,7 +6,7 @@
 import * as z from "zod/v3";
 
 /**
- * Filter by memory type.
+ * Filter by memory type. Matching is case-insensitive.
  */
 export type MemoryTypeFilter = {
   /**

package/src/models/namespace-filter.ts

@@ -6,7 +6,13 @@
 import * as z from "zod/v3";
 
 /**
- * Filter by namespace.
+ * Filter by namespace. Matching is case-insensitive.
+ *
+ * @remarks
+ *
+ * Namespace is optional, so records without one need care. The positive operators (`eq`, `in`, `all`) require the field to be present and therefore never match a record that has no namespace — including memories extracted from a session that has none. `ne` is a plain negation and *does* match those records, so use `eq` or `in` when you need strict namespace isolation rather than `ne` against the namespaces you want to exclude.
+ *
+ * Omit this filter to search across every namespace, and use it to keep recall inside one project, workspace, team, environment, or tenant.
  */
 export type NamespaceFilter = {
   /**

package/src/models/operations/get-session-memory.ts

@@ -14,11 +14,16 @@ export type GetSessionMemoryRequest = {
    * The session ID.
    */
   sessionId: string;
+  /**
+   * When true, the response includes events that have already been covered by the session summary and have not yet been cleaned up. This flag is not expected to be set under normal usage.
+   */
+  includeSummarisedEvents?: boolean | undefined;
 };
 
 /** @internal */
 export type GetSessionMemoryRequest$Outbound = {
   sessionId: string;
+  includeSummarisedEvents?: boolean | undefined;
 };
 
 /** @internal */
@@ -28,6 +33,7 @@ export const GetSessionMemoryRequest$outboundSchema: z.ZodType<
   GetSessionMemoryRequest
 > = z.object({
   sessionId: z.string(),
+  includeSummarisedEvents: z.boolean().optional(),
 });
 
 export function getSessionMemoryRequestToJSON(

package/src/models/operations/index.ts

@@ -13,4 +13,6 @@ export * from "./get-session-event.js";
 export * from "./get-session-memory.js";
 export * from "./list-sessions.js";
 export * from "./search-long-term-memory.js";
+export * from "./store-health.js";
+export * from "./update-long-term-memory-fields.js";
 export * from "./update-long-term-memory.js";

package/src/models/operations/list-sessions.ts

@@ -19,7 +19,7 @@ export type ListSessionsRequest = {
    */
   pageToken?: string | undefined;
   /**
-   * Filter sessions by owner. Mutually exclusive with includeAll.
+   * Filter sessions by owner. Matching is case-sensitive. Mutually exclusive with includeAll.
    */
   filterOwnerId?: string | undefined;
   /**

package/src/models/operations/store-health.ts

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3740112e1f1e
+ */
+
+import * as z from "zod/v3";
+
+export type StoreHealthGlobals = {
+  storeId?: string | undefined;
+};
+
+export type StoreHealthRequest = {};
+
+/** @internal */
+export type StoreHealthRequest$Outbound = {};
+
+/** @internal */
+export const StoreHealthRequest$outboundSchema: z.ZodType<
+  StoreHealthRequest$Outbound,
+  z.ZodTypeDef,
+  StoreHealthRequest
+> = z.object({});
+
+export function storeHealthRequestToJSON(
+  storeHealthRequest: StoreHealthRequest,
+): string {
+  return JSON.stringify(
+    StoreHealthRequest$outboundSchema.parse(storeHealthRequest),
+  );
+}

package/src/models/operations/update-long-term-memory-fields.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 16560932b47d
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+
+export type UpdateLongTermMemoryFieldsGlobals = {
+  storeId?: string | undefined;
+};
+
+export type UpdateLongTermMemoryFieldsRequest = {
+  /**
+   * The memory record ID.
+   */
+  memoryId: string;
+  body: models.UpdateLongTermMemoryFieldsRequestContent;
+};
+
+/** @internal */
+export type UpdateLongTermMemoryFieldsRequest$Outbound = {
+  memoryId: string;
+  body: models.UpdateLongTermMemoryFieldsRequestContent$Outbound;
+};
+
+/** @internal */
+export const UpdateLongTermMemoryFieldsRequest$outboundSchema: z.ZodType<
+  UpdateLongTermMemoryFieldsRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateLongTermMemoryFieldsRequest
+> = z.object({
+  memoryId: z.string(),
+  body: models.UpdateLongTermMemoryFieldsRequestContent$outboundSchema,
+});
+
+export function updateLongTermMemoryFieldsRequestToJSON(
+  updateLongTermMemoryFieldsRequest: UpdateLongTermMemoryFieldsRequest,
+): string {
+  return JSON.stringify(
+    UpdateLongTermMemoryFieldsRequest$outboundSchema.parse(
+      updateLongTermMemoryFieldsRequest,
+    ),
+  );
+}

package/src/models/owner-id-filter.ts

@@ -6,7 +6,7 @@
 import * as z from "zod/v3";
 
 /**
- * Filter by the long-term memory ownerId field.
+ * Filter by the long-term memory ownerId field. Matching is case-sensitive.
  */
 export type OwnerIdFilter = {
   /**

package/src/models/session-id-filter.ts

@@ -6,7 +6,7 @@
 import * as z from "zod/v3";
 
 /**
- * Filter by the long-term memory sessionId field.
+ * Filter by the long-term memory sessionId field. Matching is case-sensitive.
  */
 export type SessionIdFilter = {
   /**