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

package/src/controlplane/models/metrics-period.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Time period granularity for metrics aggregation
+ */
+export const MetricsPeriod = {
+  Hour: "hour",
+  Day: "day",
+  Week: "week",
+} as const;
+/**
+ * Time period granularity for metrics aggregation
+ */
+export type MetricsPeriod = ClosedEnum<typeof MetricsPeriod>;
+
+/** @internal */
+export const MetricsPeriod$outboundSchema: z.ZodNativeEnum<
+  typeof MetricsPeriod
+> = z.nativeEnum(MetricsPeriod);

package/src/controlplane/models/model-authorization-type.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 a provider requires in order to be called.
+ *
+ * @remarks
+ *
+ * Distinct from ModelCredentialType, which says how to interpret a secret the
+ * caller has already supplied: this says what the provider demands in the first
+ * place.
+ */
+export const ModelAuthorizationType = {
+  ApiKey: "apiKey",
+  None: "none",
+} as const;
+/**
+ * What a provider requires in order to be called.
+ *
+ * @remarks
+ *
+ * Distinct from ModelCredentialType, which says how to interpret a secret the
+ * caller has already supplied: this says what the provider demands in the first
+ * place.
+ */
+export type ModelAuthorizationType = OpenEnum<typeof ModelAuthorizationType>;
+
+/** @internal */
+export const ModelAuthorizationType$inboundSchema: z.ZodType<
+  ModelAuthorizationType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ModelAuthorizationType);

package/src/controlplane/models/model-config-input.ts

@@ -0,0 +1,57 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  ModelCredentialsInput,
+  ModelCredentialsInput$Outbound,
+  ModelCredentialsInput$outboundSchema,
+} from "./model-credentials-input.js";
+
+/**
+ * Redis Cloud only. A model selection.
+ */
+export type ModelConfigInput = {
+  /**
+   * Redis Cloud only. A provider credential. Never returned by any operation.
+   */
+  credentials?: ModelCredentialsInput | undefined;
+  /**
+   * The model to use. Required on create. On update, omit it to keep the current
+   *
+   * @remarks
+   * model.
+   */
+  model?: string | undefined;
+  /**
+   * The model provider.
+   */
+  provider?: string | undefined;
+};
+
+/** @internal */
+export type ModelConfigInput$Outbound = {
+  credentials?: ModelCredentialsInput$Outbound | undefined;
+  model?: string | undefined;
+  provider?: string | undefined;
+};
+
+/** @internal */
+export const ModelConfigInput$outboundSchema: z.ZodType<
+  ModelConfigInput$Outbound,
+  z.ZodTypeDef,
+  ModelConfigInput
+> = z.object({
+  credentials: ModelCredentialsInput$outboundSchema.optional(),
+  model: z.string().optional(),
+  provider: z.string().optional(),
+});
+
+export function modelConfigInputToJSON(
+  modelConfigInput: ModelConfigInput,
+): string {
+  return JSON.stringify(
+    ModelConfigInput$outboundSchema.parse(modelConfigInput),
+  );
+}

package/src/controlplane/models/model-config-status.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";
+
+/**
+ * Redis Cloud only. The model a store uses.
+ */
+export type ModelConfigStatus = {
+  /**
+   * The model in use.
+   */
+  model: string;
+  /**
+   * The model provider in use.
+   */
+  provider: string;
+};
+
+/** @internal */
+export const ModelConfigStatus$inboundSchema: z.ZodType<
+  ModelConfigStatus,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  model: z.string(),
+  provider: z.string(),
+});
+
+export function modelConfigStatusFromJSON(
+  jsonString: string,
+): SafeParseResult<ModelConfigStatus, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ModelConfigStatus$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ModelConfigStatus' from JSON`,
+  );
+}

package/src/controlplane/models/model-credential-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";
+
+/**
+ * How the secret behind a model credential is to be interpreted.
+ */
+export const ModelCredentialType = {
+  ApiKey: "apiKey",
+} as const;
+/**
+ * How the secret behind a model credential is to be interpreted.
+ */
+export type ModelCredentialType = ClosedEnum<typeof ModelCredentialType>;
+
+/** @internal */
+export const ModelCredentialType$outboundSchema: z.ZodNativeEnum<
+  typeof ModelCredentialType
+> = z.nativeEnum(ModelCredentialType);

package/src/controlplane/models/model-credentials-input.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  ModelCredentialType,
+  ModelCredentialType$outboundSchema,
+} from "./model-credential-type.js";
+
+/**
+ * Redis Cloud only. A provider credential. Never returned by any operation.
+ */
+export type ModelCredentialsInput = {
+  /**
+   * The provider API key. Required on create. On update, omit it to keep the
+   *
+   * @remarks
+   * current key.
+   */
+  apiKey?: string | undefined;
+  /**
+   * How the secret behind a model credential is to be interpreted.
+   */
+  type: ModelCredentialType;
+};
+
+/** @internal */
+export type ModelCredentialsInput$Outbound = {
+  apiKey?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const ModelCredentialsInput$outboundSchema: z.ZodType<
+  ModelCredentialsInput$Outbound,
+  z.ZodTypeDef,
+  ModelCredentialsInput
+> = z.object({
+  apiKey: z.string().optional(),
+  type: ModelCredentialType$outboundSchema,
+});
+
+export function modelCredentialsInputToJSON(
+  modelCredentialsInput: ModelCredentialsInput,
+): string {
+  return JSON.stringify(
+    ModelCredentialsInput$outboundSchema.parse(modelCredentialsInput),
+  );
+}

package/src/controlplane/models/model-provider-item.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 {
+  ModelAuthorizationType,
+  ModelAuthorizationType$inboundSchema,
+} from "./model-authorization-type.js";
+import {
+  StoreModelItem,
+  StoreModelItem$inboundSchema,
+} from "./store-model-item.js";
+
+/**
+ * A model provider, what it requires in order to be called, and the models it
+ *
+ * @remarks
+ * offers.
+ */
+export type ModelProviderItem = {
+  /**
+   * What a provider requires in order to be called.
+   *
+   * @remarks
+   *
+   * Distinct from ModelCredentialType, which says how to interpret a secret the
+   * caller has already supplied: this says what the provider demands in the first
+   * place.
+   */
+  authorizationType: ModelAuthorizationType;
+  /**
+   * The provider identifier, as accepted by ModelConfigInput.provider.
+   */
+  id: string;
+  /**
+   * The provider's offerable models, tagged by what they are used for.
+   */
+  models: Array<StoreModelItem>;
+  /**
+   * Human-readable provider name, for display.
+   */
+  name: string;
+};
+
+/** @internal */
+export const ModelProviderItem$inboundSchema: z.ZodType<
+  ModelProviderItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  authorizationType: ModelAuthorizationType$inboundSchema,
+  id: z.string(),
+  models: z.array(StoreModelItem$inboundSchema),
+  name: z.string(),
+});
+
+export function modelProviderItemFromJSON(
+  jsonString: string,
+): SafeParseResult<ModelProviderItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ModelProviderItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ModelProviderItem' from JSON`,
+  );
+}

package/src/controlplane/models/model-purpose.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";
+
+/**
+ * What a model is used for.
+ */
+export const ModelPurpose = {
+  Embedding: "embedding",
+  Llm: "llm",
+  Classification: "classification",
+} as const;
+/**
+ * What a model is used for.
+ */
+export type ModelPurpose = OpenEnum<typeof ModelPurpose>;
+
+/** @internal */
+export const ModelPurpose$inboundSchema: z.ZodType<
+  ModelPurpose,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ModelPurpose);

package/src/controlplane/models/not-found-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 not-found errors.
+ */
+export const NotFoundErrorType = {
+  RootErrorsResourceNotFound: "/errors/resource-not-found",
+} as const;
+/**
+ * Problem type URI for not-found errors.
+ */
+export type NotFoundErrorType = ClosedEnum<typeof NotFoundErrorType>;
+
+/** @internal */
+export const NotFoundErrorType$inboundSchema: z.ZodNativeEnum<
+  typeof NotFoundErrorType
+> = z.nativeEnum(NotFoundErrorType);

package/src/controlplane/models/operations/create-extractor.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+
+export type CreateExtractorRequest = {
+  /**
+   * Memory store identifier (1-64 chars). Only letters (A-Z, a-z), digits (0-9), and dashes (-) are accepted.
+   */
+  storeId: string;
+  body: models.CreateExtractorRequestContent;
+};
+
+/** @internal */
+export type CreateExtractorRequest$Outbound = {
+  storeId: string;
+  body: models.CreateExtractorRequestContent$Outbound;
+};
+
+/** @internal */
+export const CreateExtractorRequest$outboundSchema: z.ZodType<
+  CreateExtractorRequest$Outbound,
+  z.ZodTypeDef,
+  CreateExtractorRequest
+> = z.object({
+  storeId: z.string(),
+  body: models.CreateExtractorRequestContent$outboundSchema,
+});
+
+export function createExtractorRequestToJSON(
+  createExtractorRequest: CreateExtractorRequest,
+): string {
+  return JSON.stringify(
+    CreateExtractorRequest$outboundSchema.parse(createExtractorRequest),
+  );
+}

package/src/controlplane/models/operations/delete-store.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DeleteStoreRequest = {
+  /**
+   * Memory store identifier (1-64 chars). Only letters (A-Z, a-z), digits (0-9), and dashes (-) are accepted.
+   */
+  storeId: string;
+  /**
+   * Whether to delete the store's short-term memory sessions together with the
+   *
+   * @remarks
+   * store. Long-term memories are not deleted.
+   */
+  flush?: boolean | undefined;
+};
+
+/** @internal */
+export type DeleteStoreRequest$Outbound = {
+  storeId: string;
+  flush: boolean;
+};
+
+/** @internal */
+export const DeleteStoreRequest$outboundSchema: z.ZodType<
+  DeleteStoreRequest$Outbound,
+  z.ZodTypeDef,
+  DeleteStoreRequest
+> = z.object({
+  storeId: z.string(),
+  flush: z.boolean().default(true),
+});
+
+export function deleteStoreRequestToJSON(
+  deleteStoreRequest: DeleteStoreRequest,
+): string {
+  return JSON.stringify(
+    DeleteStoreRequest$outboundSchema.parse(deleteStoreRequest),
+  );
+}

package/src/controlplane/models/operations/empty-store.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type EmptyStoreRequest = {
+  /**
+   * The ID of the memory store to empty
+   */
+  storeId: string;
+};
+
+/** @internal */
+export type EmptyStoreRequest$Outbound = {
+  storeId: string;
+};
+
+/** @internal */
+export const EmptyStoreRequest$outboundSchema: z.ZodType<
+  EmptyStoreRequest$Outbound,
+  z.ZodTypeDef,
+  EmptyStoreRequest
+> = z.object({
+  storeId: z.string(),
+});
+
+export function emptyStoreRequestToJSON(
+  emptyStoreRequest: EmptyStoreRequest,
+): string {
+  return JSON.stringify(
+    EmptyStoreRequest$outboundSchema.parse(emptyStoreRequest),
+  );
+}

package/src/controlplane/models/operations/flush-store-entries.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type FlushStoreEntriesRequest = {
+  /**
+   * The ID of the memory store whose entries should be flushed
+   */
+  storeId: string;
+};
+
+/** @internal */
+export type FlushStoreEntriesRequest$Outbound = {
+  storeId: string;
+};
+
+/** @internal */
+export const FlushStoreEntriesRequest$outboundSchema: z.ZodType<
+  FlushStoreEntriesRequest$Outbound,
+  z.ZodTypeDef,
+  FlushStoreEntriesRequest
+> = z.object({
+  storeId: z.string(),
+});
+
+export function flushStoreEntriesRequestToJSON(
+  flushStoreEntriesRequest: FlushStoreEntriesRequest,
+): string {
+  return JSON.stringify(
+    FlushStoreEntriesRequest$outboundSchema.parse(flushStoreEntriesRequest),
+  );
+}

package/src/controlplane/models/operations/get-extractor.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetExtractorRequest = {
+  /**
+   * Memory store identifier (1-64 chars). Only letters (A-Z, a-z), digits (0-9), and dashes (-) are accepted.
+   */
+  storeId: string;
+  /**
+   * Extractor identifier, unique within its store.
+   */
+  extractorId: string;
+};
+
+/** @internal */
+export type GetExtractorRequest$Outbound = {
+  storeId: string;
+  extractorId: string;
+};
+
+/** @internal */
+export const GetExtractorRequest$outboundSchema: z.ZodType<
+  GetExtractorRequest$Outbound,
+  z.ZodTypeDef,
+  GetExtractorRequest
+> = z.object({
+  storeId: z.string(),
+  extractorId: z.string(),
+});
+
+export function getExtractorRequestToJSON(
+  getExtractorRequest: GetExtractorRequest,
+): string {
+  return JSON.stringify(
+    GetExtractorRequest$outboundSchema.parse(getExtractorRequest),
+  );
+}

package/src/controlplane/models/operations/get-store-metrics.ts

@@ -0,0 +1,58 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+
+export type GetStoreMetricsRequest = {
+  /**
+   * The ID of the memory store
+   */
+  storeId: string;
+  /**
+   * Start time for the metrics query (ISO 8601 format)
+   */
+  from: Date;
+  /**
+   * End time for the metrics query (ISO 8601 format)
+   */
+  to: Date;
+  /**
+   * Time period granularity for metrics aggregation. The granularity bounds
+   *
+   * @remarks
+   * the window `from`/`to` may span: `hour` (1-minute resolution) and `day`
+   * (15-minute resolution) accept up to 7 days, while `week` (one point per
+   * day) accepts up to 92 days.
+   */
+  period: models.MetricsPeriod;
+};
+
+/** @internal */
+export type GetStoreMetricsRequest$Outbound = {
+  storeId: string;
+  from: string;
+  to: string;
+  period: string;
+};
+
+/** @internal */
+export const GetStoreMetricsRequest$outboundSchema: z.ZodType<
+  GetStoreMetricsRequest$Outbound,
+  z.ZodTypeDef,
+  GetStoreMetricsRequest
+> = z.object({
+  storeId: z.string(),
+  from: z.date().transform(v => v.toISOString()),
+  to: z.date().transform(v => v.toISOString()),
+  period: models.MetricsPeriod$outboundSchema,
+});
+
+export function getStoreMetricsRequestToJSON(
+  getStoreMetricsRequest: GetStoreMetricsRequest,
+): string {
+  return JSON.stringify(
+    GetStoreMetricsRequest$outboundSchema.parse(getStoreMetricsRequest),
+  );
+}

package/src/controlplane/models/operations/get-store.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetStoreRequest = {
+  /**
+   * Memory store identifier (1-64 chars). Only letters (A-Z, a-z), digits (0-9), and dashes (-) are accepted.
+   */
+  storeId: string;
+};
+
+/** @internal */
+export type GetStoreRequest$Outbound = {
+  storeId: string;
+};
+
+/** @internal */
+export const GetStoreRequest$outboundSchema: z.ZodType<
+  GetStoreRequest$Outbound,
+  z.ZodTypeDef,
+  GetStoreRequest
+> = z.object({
+  storeId: z.string(),
+});
+
+export function getStoreRequestToJSON(
+  getStoreRequest: GetStoreRequest,
+): string {
+  return JSON.stringify(GetStoreRequest$outboundSchema.parse(getStoreRequest));
+}

package/src/controlplane/models/operations/index.ts

@@ -0,0 +1,15 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./create-extractor.js";
+export * from "./delete-store.js";
+export * from "./empty-store.js";
+export * from "./flush-store-entries.js";
+export * from "./get-extractor.js";
+export * from "./get-store-metrics.js";
+export * from "./get-store.js";
+export * from "./list-extractors.js";
+export * from "./remove-extractor.js";
+export * from "./update-extractor.js";
+export * from "./update-store.js";

package/src/controlplane/models/operations/list-extractors.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type ListExtractorsRequest = {
+  /**
+   * Memory store identifier (1-64 chars). Only letters (A-Z, a-z), digits (0-9), and dashes (-) are accepted.
+   */
+  storeId: string;
+};
+
+/** @internal */
+export type ListExtractorsRequest$Outbound = {
+  storeId: string;
+};
+
+/** @internal */
+export const ListExtractorsRequest$outboundSchema: z.ZodType<
+  ListExtractorsRequest$Outbound,
+  z.ZodTypeDef,
+  ListExtractorsRequest
+> = z.object({
+  storeId: z.string(),
+});
+
+export function listExtractorsRequestToJSON(
+  listExtractorsRequest: ListExtractorsRequest,
+): string {
+  return JSON.stringify(
+    ListExtractorsRequest$outboundSchema.parse(listExtractorsRequest),
+  );
+}