@orq-ai/node 4.5.0-rc.9 → 4.5.2

package/packages/orq-rc/src/models/operations/getallmemories.ts

@@ -0,0 +1,173 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetAllMemoriesRequest = {
+  /**
+   * The unique key identifier of the memory store
+   */
+  memoryStoreKey: string;
+  /**
+   * A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10
+   */
+  limit?: number | undefined;
+  /**
+   * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `after=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the next page of the list.
+   */
+  startingAfter?: string | undefined;
+  /**
+   * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `before=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the previous page of the list.
+   */
+  endingBefore?: string | undefined;
+  /**
+   * Search query to filter memories by entity_id
+   */
+  q?: string | undefined;
+};
+
+export const GetAllMemoriesObject = {
+  List: "list",
+} as const;
+export type GetAllMemoriesObject = ClosedEnum<typeof GetAllMemoriesObject>;
+
+export type GetAllMemoriesData = {
+  /**
+   * Unique identifier for the memory. This is automatically generated by the system.
+   */
+  id: string;
+  /**
+   * Customer provided entity ID for the memory. This is used to link the memory to a specific user/company/session/etc. Has to be unique within the memory store.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  entityId: string;
+  created: string;
+  updated: string;
+  createdById?: string | null | undefined;
+  updatedById?: string | null | undefined;
+  storeId: string;
+  workspaceId: string;
+  /**
+   * The number of memories in the entity
+   */
+  documentsCount: number;
+};
+
+/**
+ * Successfully retrieved the list of memories.
+ */
+export type GetAllMemoriesResponseBody = {
+  object: GetAllMemoriesObject;
+  data: Array<GetAllMemoriesData>;
+  hasMore: boolean;
+};
+
+/** @internal */
+export type GetAllMemoriesRequest$Outbound = {
+  memory_store_key: string;
+  limit: number;
+  starting_after?: string | undefined;
+  ending_before?: string | undefined;
+  q?: string | undefined;
+};
+
+/** @internal */
+export const GetAllMemoriesRequest$outboundSchema: z.ZodType<
+  GetAllMemoriesRequest$Outbound,
+  z.ZodTypeDef,
+  GetAllMemoriesRequest
+> = z.object({
+  memoryStoreKey: z.string(),
+  limit: z.number().int().default(10),
+  startingAfter: z.string().optional(),
+  endingBefore: z.string().optional(),
+  q: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    memoryStoreKey: "memory_store_key",
+    startingAfter: "starting_after",
+    endingBefore: "ending_before",
+  });
+});
+
+export function getAllMemoriesRequestToJSON(
+  getAllMemoriesRequest: GetAllMemoriesRequest,
+): string {
+  return JSON.stringify(
+    GetAllMemoriesRequest$outboundSchema.parse(getAllMemoriesRequest),
+  );
+}
+
+/** @internal */
+export const GetAllMemoriesObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetAllMemoriesObject
+> = z.nativeEnum(GetAllMemoriesObject);
+
+/** @internal */
+export const GetAllMemoriesData$inboundSchema: z.ZodType<
+  GetAllMemoriesData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  entity_id: z.string(),
+  created: z.string(),
+  updated: z.string(),
+  created_by_id: z.nullable(z.string()).optional(),
+  updated_by_id: z.nullable(z.string()).optional(),
+  store_id: z.string(),
+  workspace_id: z.string(),
+  documents_count: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "entity_id": "entityId",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+    "store_id": "storeId",
+    "workspace_id": "workspaceId",
+    "documents_count": "documentsCount",
+  });
+});
+
+export function getAllMemoriesDataFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAllMemoriesData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAllMemoriesData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAllMemoriesData' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetAllMemoriesResponseBody$inboundSchema: z.ZodType<
+  GetAllMemoriesResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: GetAllMemoriesObject$inboundSchema,
+  data: z.array(z.lazy(() => GetAllMemoriesData$inboundSchema)),
+  has_more: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function getAllMemoriesResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAllMemoriesResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAllMemoriesResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAllMemoriesResponseBody' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/operations/getallmemorydocuments.ts

@@ -0,0 +1,188 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetAllMemoryDocumentsRequest = {
+  /**
+   * The unique key identifier of the memory store
+   */
+  memoryStoreKey: string;
+  /**
+   * The unique identifier of the memory
+   */
+  memoryEntityId: string;
+  /**
+   * A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10
+   */
+  limit?: number | undefined;
+  /**
+   * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `after=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the next page of the list.
+   */
+  startingAfter?: string | undefined;
+  /**
+   * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `before=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the previous page of the list.
+   */
+  endingBefore?: string | undefined;
+  /**
+   * Filter documents updated after this ISO datetime
+   */
+  updatedAfter?: Date | undefined;
+  /**
+   * Filter documents updated before this ISO datetime
+   */
+  updatedBefore?: Date | undefined;
+};
+
+export const GetAllMemoryDocumentsObject = {
+  List: "list",
+} as const;
+export type GetAllMemoryDocumentsObject = ClosedEnum<
+  typeof GetAllMemoryDocumentsObject
+>;
+
+export type GetAllMemoryDocumentsData = {
+  id: string;
+  memoryId: string;
+  storeId: string;
+  /**
+   * The content of the memory document (whitespace trimmed).
+   */
+  text: string;
+  created: string;
+  updated: string;
+  createdById?: string | undefined;
+  updatedById?: string | undefined;
+  workspaceId: string;
+  /**
+   * Flexible key-value pairs for custom filtering and categorization. Clients can add arbitrary string metadata to enable future filtering of memory documents based on their specific needs (e.g., document type, source, topic, relevance score, or any custom taxonomy).
+   */
+  metadata?: { [k: string]: string } | undefined;
+};
+
+/**
+ * Successfully retrieved the list of memory documents.
+ */
+export type GetAllMemoryDocumentsResponseBody = {
+  object: GetAllMemoryDocumentsObject;
+  data: Array<GetAllMemoryDocumentsData>;
+  hasMore: boolean;
+};
+
+/** @internal */
+export type GetAllMemoryDocumentsRequest$Outbound = {
+  memory_store_key: string;
+  memory_entity_id: string;
+  limit: number;
+  starting_after?: string | undefined;
+  ending_before?: string | undefined;
+  updated_after?: string | undefined;
+  updated_before?: string | undefined;
+};
+
+/** @internal */
+export const GetAllMemoryDocumentsRequest$outboundSchema: z.ZodType<
+  GetAllMemoryDocumentsRequest$Outbound,
+  z.ZodTypeDef,
+  GetAllMemoryDocumentsRequest
+> = z.object({
+  memoryStoreKey: z.string(),
+  memoryEntityId: z.string(),
+  limit: z.number().int().default(10),
+  startingAfter: z.string().optional(),
+  endingBefore: z.string().optional(),
+  updatedAfter: z.date().transform(v => v.toISOString()).optional(),
+  updatedBefore: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    memoryStoreKey: "memory_store_key",
+    memoryEntityId: "memory_entity_id",
+    startingAfter: "starting_after",
+    endingBefore: "ending_before",
+    updatedAfter: "updated_after",
+    updatedBefore: "updated_before",
+  });
+});
+
+export function getAllMemoryDocumentsRequestToJSON(
+  getAllMemoryDocumentsRequest: GetAllMemoryDocumentsRequest,
+): string {
+  return JSON.stringify(
+    GetAllMemoryDocumentsRequest$outboundSchema.parse(
+      getAllMemoryDocumentsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const GetAllMemoryDocumentsObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetAllMemoryDocumentsObject
+> = z.nativeEnum(GetAllMemoryDocumentsObject);
+
+/** @internal */
+export const GetAllMemoryDocumentsData$inboundSchema: z.ZodType<
+  GetAllMemoryDocumentsData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  memory_id: z.string(),
+  store_id: z.string(),
+  text: z.string(),
+  created: z.string(),
+  updated: z.string(),
+  created_by_id: z.string().optional(),
+  updated_by_id: z.string().optional(),
+  workspace_id: z.string(),
+  metadata: z.record(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "memory_id": "memoryId",
+    "store_id": "storeId",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+    "workspace_id": "workspaceId",
+  });
+});
+
+export function getAllMemoryDocumentsDataFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAllMemoryDocumentsData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAllMemoryDocumentsData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAllMemoryDocumentsData' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetAllMemoryDocumentsResponseBody$inboundSchema: z.ZodType<
+  GetAllMemoryDocumentsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: GetAllMemoryDocumentsObject$inboundSchema,
+  data: z.array(z.lazy(() => GetAllMemoryDocumentsData$inboundSchema)),
+  has_more: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function getAllMemoryDocumentsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAllMemoryDocumentsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAllMemoryDocumentsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAllMemoryDocumentsResponseBody' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/operations/getallmemorystores.ts

@@ -0,0 +1,200 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetAllMemoryStoresRequest = {
+  /**
+   * A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10
+   */
+  limit?: number | undefined;
+  /**
+   * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `after=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the next page of the list.
+   */
+  startingAfter?: string | undefined;
+  /**
+   * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `before=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the previous page of the list.
+   */
+  endingBefore?: string | undefined;
+};
+
+export const GetAllMemoryStoresObject = {
+  List: "list",
+} as const;
+export type GetAllMemoryStoresObject = ClosedEnum<
+  typeof GetAllMemoryStoresObject
+>;
+
+export type GetAllMemoryStoresEmbeddingConfig = {
+  /**
+   * The embeddings model to use for the knowledge base in the format "provider/model" for public models or "workspaceKey@provider/model" for private workspace models. This model will be used to embed the chunks when they are added to the knowledge base. Refer to the (Supported models)[/docs/proxy/supported-models] to browse available models.
+   */
+  model: string;
+};
+
+export type GetAllMemoryStoresData = {
+  /**
+   * The unique identifier of the memory store
+   */
+  id: string;
+  /**
+   * The unique key of the memory store. The key is unique and inmmutable and cannot be repeated within the same workspace.
+   */
+  key: string;
+  /**
+   * The description of the memory store. Be as precise as possible to help the AI to understand the purpose of the memory store.
+   */
+  description: string;
+  /**
+   * The user ID of the creator
+   */
+  createdById?: string | undefined;
+  /**
+   * The user ID of the last updater
+   */
+  updatedById?: string | undefined;
+  /**
+   * The creation date of the memory store
+   */
+  created: string;
+  /**
+   * The last update date of the memory store
+   */
+  updated: string;
+  /**
+   * The default time to live of every memory document created within the memory store. Useful to control if the documents in the memory should be store for short or long term.
+   */
+  ttl?: number | undefined;
+  embeddingConfig: GetAllMemoryStoresEmbeddingConfig;
+};
+
+/**
+ * Successfully retrieved the list of memory stores.
+ */
+export type GetAllMemoryStoresResponseBody = {
+  object: GetAllMemoryStoresObject;
+  data: Array<GetAllMemoryStoresData>;
+  hasMore: boolean;
+};
+
+/** @internal */
+export type GetAllMemoryStoresRequest$Outbound = {
+  limit: number;
+  starting_after?: string | undefined;
+  ending_before?: string | undefined;
+};
+
+/** @internal */
+export const GetAllMemoryStoresRequest$outboundSchema: z.ZodType<
+  GetAllMemoryStoresRequest$Outbound,
+  z.ZodTypeDef,
+  GetAllMemoryStoresRequest
+> = z.object({
+  limit: z.number().int().default(10),
+  startingAfter: z.string().optional(),
+  endingBefore: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    startingAfter: "starting_after",
+    endingBefore: "ending_before",
+  });
+});
+
+export function getAllMemoryStoresRequestToJSON(
+  getAllMemoryStoresRequest: GetAllMemoryStoresRequest,
+): string {
+  return JSON.stringify(
+    GetAllMemoryStoresRequest$outboundSchema.parse(getAllMemoryStoresRequest),
+  );
+}
+
+/** @internal */
+export const GetAllMemoryStoresObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetAllMemoryStoresObject
+> = z.nativeEnum(GetAllMemoryStoresObject);
+
+/** @internal */
+export const GetAllMemoryStoresEmbeddingConfig$inboundSchema: z.ZodType<
+  GetAllMemoryStoresEmbeddingConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  model: z.string(),
+});
+
+export function getAllMemoryStoresEmbeddingConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAllMemoryStoresEmbeddingConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAllMemoryStoresEmbeddingConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAllMemoryStoresEmbeddingConfig' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetAllMemoryStoresData$inboundSchema: z.ZodType<
+  GetAllMemoryStoresData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  key: z.string(),
+  description: z.string(),
+  created_by_id: z.string().optional(),
+  updated_by_id: z.string().optional(),
+  created: z.string(),
+  updated: z.string(),
+  ttl: z.number().optional(),
+  embedding_config: z.lazy(() =>
+    GetAllMemoryStoresEmbeddingConfig$inboundSchema
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+    "embedding_config": "embeddingConfig",
+  });
+});
+
+export function getAllMemoryStoresDataFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAllMemoryStoresData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAllMemoryStoresData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAllMemoryStoresData' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetAllMemoryStoresResponseBody$inboundSchema: z.ZodType<
+  GetAllMemoryStoresResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: GetAllMemoryStoresObject$inboundSchema,
+  data: z.array(z.lazy(() => GetAllMemoryStoresData$inboundSchema)),
+  has_more: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function getAllMemoryStoresResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAllMemoryStoresResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAllMemoryStoresResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAllMemoryStoresResponseBody' from JSON`,
+  );
+}