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

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

@@ -0,0 +1,142 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CreateMemoryRequestBody = {
+  /**
+   * Unique identifier for the entity this memory is associated with (e.g., user ID, session ID, conversation ID).
+   */
+  entityId: string;
+};
+
+export type CreateMemoryRequest = {
+  /**
+   * The unique key identifier of the memory store
+   */
+  memoryStoreKey: string;
+  requestBody?: CreateMemoryRequestBody | undefined;
+};
+
+/**
+ * Memory successfully created.
+ */
+export type CreateMemoryResponseBody = {
+  /**
+   * 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;
+};
+
+/** @internal */
+export type CreateMemoryRequestBody$Outbound = {
+  entity_id: string;
+};
+
+/** @internal */
+export const CreateMemoryRequestBody$outboundSchema: z.ZodType<
+  CreateMemoryRequestBody$Outbound,
+  z.ZodTypeDef,
+  CreateMemoryRequestBody
+> = z.object({
+  entityId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    entityId: "entity_id",
+  });
+});
+
+export function createMemoryRequestBodyToJSON(
+  createMemoryRequestBody: CreateMemoryRequestBody,
+): string {
+  return JSON.stringify(
+    CreateMemoryRequestBody$outboundSchema.parse(createMemoryRequestBody),
+  );
+}
+
+/** @internal */
+export type CreateMemoryRequest$Outbound = {
+  memory_store_key: string;
+  RequestBody?: CreateMemoryRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const CreateMemoryRequest$outboundSchema: z.ZodType<
+  CreateMemoryRequest$Outbound,
+  z.ZodTypeDef,
+  CreateMemoryRequest
+> = z.object({
+  memoryStoreKey: z.string(),
+  requestBody: z.lazy(() => CreateMemoryRequestBody$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    memoryStoreKey: "memory_store_key",
+    requestBody: "RequestBody",
+  });
+});
+
+export function createMemoryRequestToJSON(
+  createMemoryRequest: CreateMemoryRequest,
+): string {
+  return JSON.stringify(
+    CreateMemoryRequest$outboundSchema.parse(createMemoryRequest),
+  );
+}
+
+/** @internal */
+export const CreateMemoryResponseBody$inboundSchema: z.ZodType<
+  CreateMemoryResponseBody,
+  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 createMemoryResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateMemoryResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateMemoryResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateMemoryResponseBody' from JSON`,
+  );
+}

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

@@ -0,0 +1,152 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CreateMemoryDocumentRequestBody = {
+  /**
+   * The content of the memory document (whitespace trimmed).
+   */
+  text: 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;
+};
+
+export type CreateMemoryDocumentRequest = {
+  /**
+   * The unique key identifier of the memory store
+   */
+  memoryStoreKey: string;
+  /**
+   * The unique entity_id provided during the memory store creation
+   */
+  memoryEntityId: string;
+  requestBody?: CreateMemoryDocumentRequestBody | undefined;
+};
+
+/**
+ * Memory document successfully created.
+ */
+export type CreateMemoryDocumentResponseBody = {
+  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;
+};
+
+/** @internal */
+export type CreateMemoryDocumentRequestBody$Outbound = {
+  text: string;
+  metadata?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export const CreateMemoryDocumentRequestBody$outboundSchema: z.ZodType<
+  CreateMemoryDocumentRequestBody$Outbound,
+  z.ZodTypeDef,
+  CreateMemoryDocumentRequestBody
+> = z.object({
+  text: z.string(),
+  metadata: z.record(z.string()).optional(),
+});
+
+export function createMemoryDocumentRequestBodyToJSON(
+  createMemoryDocumentRequestBody: CreateMemoryDocumentRequestBody,
+): string {
+  return JSON.stringify(
+    CreateMemoryDocumentRequestBody$outboundSchema.parse(
+      createMemoryDocumentRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateMemoryDocumentRequest$Outbound = {
+  memory_store_key: string;
+  memory_entity_id: string;
+  RequestBody?: CreateMemoryDocumentRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const CreateMemoryDocumentRequest$outboundSchema: z.ZodType<
+  CreateMemoryDocumentRequest$Outbound,
+  z.ZodTypeDef,
+  CreateMemoryDocumentRequest
+> = z.object({
+  memoryStoreKey: z.string(),
+  memoryEntityId: z.string(),
+  requestBody: z.lazy(() => CreateMemoryDocumentRequestBody$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    memoryStoreKey: "memory_store_key",
+    memoryEntityId: "memory_entity_id",
+    requestBody: "RequestBody",
+  });
+});
+
+export function createMemoryDocumentRequestToJSON(
+  createMemoryDocumentRequest: CreateMemoryDocumentRequest,
+): string {
+  return JSON.stringify(
+    CreateMemoryDocumentRequest$outboundSchema.parse(
+      createMemoryDocumentRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const CreateMemoryDocumentResponseBody$inboundSchema: z.ZodType<
+  CreateMemoryDocumentResponseBody,
+  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 createMemoryDocumentResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateMemoryDocumentResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateMemoryDocumentResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateMemoryDocumentResponseBody' from JSON`,
+  );
+}

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

@@ -0,0 +1,199 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type EmbeddingConfig = {
+  /**
+   * 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 CreateMemoryStoreRequestBody = {
+  /**
+   * The unique key of the memory store. The key is unique and inmmutable and cannot be repeated within the same workspace.
+   */
+  key: string;
+  embeddingConfig: EmbeddingConfig;
+  /**
+   * 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 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;
+  /**
+   * Entity storage path in the format: `project/folder/subfolder/...`
+   *
+   * @remarks
+   *
+   * The first element identifies the project, followed by nested folders (auto-created as needed).
+   *
+   * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
+   */
+  path: string;
+};
+
+export type CreateMemoryStoreEmbeddingConfig = {
+  /**
+   * 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;
+};
+
+/**
+ * Memory store successfully created with the specified configuration.
+ */
+export type CreateMemoryStoreResponseBody = {
+  /**
+   * 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: CreateMemoryStoreEmbeddingConfig;
+};
+
+/** @internal */
+export type EmbeddingConfig$Outbound = {
+  model: string;
+};
+
+/** @internal */
+export const EmbeddingConfig$outboundSchema: z.ZodType<
+  EmbeddingConfig$Outbound,
+  z.ZodTypeDef,
+  EmbeddingConfig
+> = z.object({
+  model: z.string(),
+});
+
+export function embeddingConfigToJSON(
+  embeddingConfig: EmbeddingConfig,
+): string {
+  return JSON.stringify(EmbeddingConfig$outboundSchema.parse(embeddingConfig));
+}
+
+/** @internal */
+export type CreateMemoryStoreRequestBody$Outbound = {
+  key: string;
+  embedding_config: EmbeddingConfig$Outbound;
+  description: string;
+  ttl?: number | undefined;
+  path: string;
+};
+
+/** @internal */
+export const CreateMemoryStoreRequestBody$outboundSchema: z.ZodType<
+  CreateMemoryStoreRequestBody$Outbound,
+  z.ZodTypeDef,
+  CreateMemoryStoreRequestBody
+> = z.object({
+  key: z.string(),
+  embeddingConfig: z.lazy(() => EmbeddingConfig$outboundSchema),
+  description: z.string(),
+  ttl: z.number().optional(),
+  path: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    embeddingConfig: "embedding_config",
+  });
+});
+
+export function createMemoryStoreRequestBodyToJSON(
+  createMemoryStoreRequestBody: CreateMemoryStoreRequestBody,
+): string {
+  return JSON.stringify(
+    CreateMemoryStoreRequestBody$outboundSchema.parse(
+      createMemoryStoreRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export const CreateMemoryStoreEmbeddingConfig$inboundSchema: z.ZodType<
+  CreateMemoryStoreEmbeddingConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  model: z.string(),
+});
+
+export function createMemoryStoreEmbeddingConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateMemoryStoreEmbeddingConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateMemoryStoreEmbeddingConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateMemoryStoreEmbeddingConfig' from JSON`,
+  );
+}
+
+/** @internal */
+export const CreateMemoryStoreResponseBody$inboundSchema: z.ZodType<
+  CreateMemoryStoreResponseBody,
+  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(() =>
+    CreateMemoryStoreEmbeddingConfig$inboundSchema
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+    "embedding_config": "embeddingConfig",
+  });
+});
+
+export function createMemoryStoreResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateMemoryStoreResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateMemoryStoreResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateMemoryStoreResponseBody' from JSON`,
+  );
+}