@orq-ai/node 4.13.13 → 4.13.16

package/packages/orq-rc/src/funcs/knowledgeToggleChunk.ts

@@ -0,0 +1,181 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OrqCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { OrqError } from "../models/errors/orqerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Set a chunk's enabled status
+ *
+ * @remarks
+ * Enables or disables a chunk for retrieval. If the vector-index document is missing, enabling the chunk queues it for embedding.
+ */
+export function knowledgeToggleChunk(
+  client: OrqCore,
+  request: operations.UpdateChunkEnabledRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.KnowledgeChunk,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OrqCore,
+  request: operations.UpdateChunkEnabledRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.KnowledgeChunk,
+      | OrqError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.UpdateChunkEnabledRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.ChunksServiceSetEnabledRequest, {
+    explode: true,
+  });
+
+  const pathParams = {
+    chunk_id: encodeSimple("chunk_id", payload.chunk_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    datasource_id: encodeSimple("datasource_id", payload.datasource_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    knowledge_id: encodeSimple("knowledge_id", payload.knowledge_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc(
+    "/v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/{chunk_id}/enabled",
+  )(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "UpdateChunkEnabled",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "PATCH",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    components.KnowledgeChunk,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.KnowledgeChunk$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/packages/orq-rc/src/funcs/knowledgeUpdate.ts

@@ -11,6 +11,7 @@ import { safeParse } from "../lib/schemas.js";
 import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -27,6 +28,9 @@ import { Result } from "../types/fp.js";
 
 /**
  * Updates a knowledge
+ *
+ * @remarks
+ * Updates a knowledge base. Omitted optional fields retain their current values.
  */
 export function knowledgeUpdate(
   client: OrqCore,
@@ -34,7 +38,7 @@ export function knowledgeUpdate(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.UpdateKnowledgeResponseBody,
+    components.Knowledge,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -59,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.UpdateKnowledgeResponseBody,
+      components.Knowledge,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -81,7 +85,9 @@ async function $do(
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+  const body = encodeJSON("body", payload.KnowledgeBasesServiceUpdateRequest, {
+    explode: true,
+  });
 
   const pathParams = {
     knowledge_id: encodeSimple("knowledge_id", payload.knowledge_id, {
@@ -143,7 +149,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.UpdateKnowledgeResponseBody,
+    components.Knowledge,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -153,7 +159,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.UpdateKnowledgeResponseBody$inboundSchema),
+    M.json(200, components.Knowledge$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);

package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts

@@ -11,6 +11,7 @@ import { safeParse } from "../lib/schemas.js";
 import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -27,6 +28,9 @@ import { Result } from "../types/fp.js";
 
 /**
  * Update a chunk
+ *
+ * @remarks
+ * Updates chunk text, metadata, or a supplied embedding. Changing text without an embedding queues the chunk for re-embedding.
  */
 export function knowledgeUpdateChunk(
   client: OrqCore,
@@ -34,7 +38,7 @@ export function knowledgeUpdateChunk(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.UpdateChunkResponseBody,
+    components.KnowledgeChunk,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -59,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.UpdateChunkResponseBody,
+      components.KnowledgeChunk,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -81,7 +85,9 @@ async function $do(
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+  const body = encodeJSON("body", payload.ChunksServiceUpdateRequest, {
+    explode: true,
+  });
 
   const pathParams = {
     chunk_id: encodeSimple("chunk_id", payload.chunk_id, {
@@ -153,7 +159,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.UpdateChunkResponseBody,
+    components.KnowledgeChunk,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -163,7 +169,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.UpdateChunkResponseBody$inboundSchema),
+    M.json(200, components.KnowledgeChunk$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);

package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts

@@ -11,6 +11,7 @@ import { safeParse } from "../lib/schemas.js";
 import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -27,6 +28,9 @@ import { Result } from "../types/fp.js";
 
 /**
  * Update a datasource
+ *
+ * @remarks
+ * Updates the display name of a datasource.
  */
 export function knowledgeUpdateDatasource(
   client: OrqCore,
@@ -34,7 +38,7 @@ export function knowledgeUpdateDatasource(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.UpdateDatasourceResponseBody,
+    components.Datasource,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -59,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.UpdateDatasourceResponseBody,
+      components.Datasource,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -81,7 +85,9 @@ async function $do(
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+  const body = encodeJSON("body", payload.DatasourcesServiceUpdateRequest, {
+    explode: true,
+  });
 
   const pathParams = {
     datasource_id: encodeSimple("datasource_id", payload.datasource_id, {
@@ -149,7 +155,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.UpdateDatasourceResponseBody,
+    components.Datasource,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -159,7 +165,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.UpdateDatasourceResponseBody$inboundSchema),
+    M.json(200, components.Datasource$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);

package/packages/orq-rc/src/funcs/memoryStoresCreate.ts

@@ -11,6 +11,7 @@ import { safeParse } from "../lib/schemas.js";
 import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -21,7 +22,6 @@ import {
 import { OrqError } from "../models/errors/orqerror.js";
 import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
-import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
@@ -30,11 +30,11 @@ import { Result } from "../types/fp.js";
  */
 export function memoryStoresCreate(
   client: OrqCore,
-  request?: operations.CreateMemoryStoreRequestBody | undefined,
+  request: components.CreateMemoryStoreRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.CreateMemoryStoreResponseBody,
+    components.MemoryStore,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -54,12 +54,12 @@ export function memoryStoresCreate(
 
 async function $do(
   client: OrqCore,
-  request?: operations.CreateMemoryStoreRequestBody | undefined,
+  request: components.CreateMemoryStoreRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.CreateMemoryStoreResponseBody,
+      components.MemoryStore,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -74,19 +74,14 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) =>
-      operations.CreateMemoryStoreRequestBody$outboundSchema.optional().parse(
-        value,
-      ),
+    (value) => components.CreateMemoryStoreRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = payload === undefined
-    ? null
-    : encodeJSON("body", payload, { explode: true });
+  const body = encodeJSON("body", payload, { explode: true });
 
   const path = pathToFunc("/v2/memory-stores")();
 
@@ -142,7 +137,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.CreateMemoryStoreResponseBody,
+    components.MemoryStore,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -152,7 +147,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(201, operations.CreateMemoryStoreResponseBody$inboundSchema),
+    M.json(201, components.MemoryStore$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);

package/packages/orq-rc/src/funcs/memoryStoresCreateDocument.ts

@@ -11,6 +11,7 @@ import { safeParse } from "../lib/schemas.js";
 import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -37,7 +38,7 @@ export function memoryStoresCreateDocument(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.CreateMemoryDocumentResponseBody,
+    components.MemoryDocument,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -62,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.CreateMemoryDocumentResponseBody,
+      components.MemoryDocument,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -85,7 +86,9 @@ async function $do(
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+  const body = encodeJSON("body", payload.CreateMemoryDocumentRequest, {
+    explode: true,
+  });
 
   const pathParams = {
     memory_entity_id: encodeSimple(
@@ -155,7 +158,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.CreateMemoryDocumentResponseBody,
+    components.MemoryDocument,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -165,7 +168,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(201, operations.CreateMemoryDocumentResponseBody$inboundSchema),
+    M.json(201, components.MemoryDocument$inboundSchema),
     M.fail([400, 401, 403, 404, "4XX"]),
     M.fail("5XX"),
   )(response, req);

package/packages/orq-rc/src/funcs/memoryStoresCreateMemory.ts

@@ -11,6 +11,7 @@ import { safeParse } from "../lib/schemas.js";
 import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -37,7 +38,7 @@ export function memoryStoresCreateMemory(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.CreateMemoryResponseBody,
+    components.Memory,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -62,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.CreateMemoryResponseBody,
+      components.Memory,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -84,7 +85,9 @@ async function $do(
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+  const body = encodeJSON("body", payload.CreateMemoryRequest, {
+    explode: true,
+  });
 
   const pathParams = {
     memory_store_key: encodeSimple(
@@ -149,7 +152,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.CreateMemoryResponseBody,
+    components.Memory,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -159,7 +162,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(201, operations.CreateMemoryResponseBody$inboundSchema),
+    M.json(201, components.Memory$inboundSchema),
     M.fail([400, 401, 403, "4XX"]),
     M.fail("5XX"),
   )(response, req);

package/packages/orq-rc/src/funcs/memoryStoresDeleteDocument.ts

@@ -32,10 +32,10 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Permanently deletes a specific memory document.
  *
- *         Use this endpoint to:
- *         - Remove a document from a memory
- *         - Clean up unused documents
- *         - Manage document storage space
+ * Use this endpoint to:
+ * - Remove a document from a memory
+ * - Clean up unused documents
+ * - Manage document storage space
  */
 export function memoryStoresDeleteDocument(
   client: OrqCore,

package/packages/orq-rc/src/funcs/memoryStoresDeleteMemory.ts

@@ -32,10 +32,10 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Permanently deletes a specific memory.
  *
- *         Use this endpoint to:
- *         - Remove a memory from the store
- *         - Clean up unused memories
- *         - Manage memory storage space
+ * Use this endpoint to:
+ * - Remove a memory from the store
+ * - Clean up unused memories
+ * - Manage memory storage space
  */
 export function memoryStoresDeleteMemory(
   client: OrqCore,

package/packages/orq-rc/src/funcs/memoryStoresList.ts

@@ -11,6 +11,7 @@ import { safeParse } from "../lib/schemas.js";
 import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -38,7 +39,7 @@ export function memoryStoresList(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.GetAllMemoryStoresResponseBody,
+    components.ListMemoryStoresResponse,
     | errors.HonoApiError
     | OrqError
     | ResponseValidationError
@@ -64,7 +65,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.GetAllMemoryStoresResponseBody,
+      components.ListMemoryStoresResponse,
       | errors.HonoApiError
       | OrqError
       | ResponseValidationError
@@ -159,7 +160,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.GetAllMemoryStoresResponseBody,
+    components.ListMemoryStoresResponse,
     | errors.HonoApiError
     | OrqError
     | ResponseValidationError
@@ -170,7 +171,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.GetAllMemoryStoresResponseBody$inboundSchema),
+    M.json(200, components.ListMemoryStoresResponse$inboundSchema),
     M.jsonErr(401, errors.HonoApiError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/packages/orq-rc/src/funcs/memoryStoresListDocuments.ts

@@ -11,6 +11,7 @@ import { safeParse } from "../lib/schemas.js";
 import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -37,7 +38,7 @@ export function memoryStoresListDocuments(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.GetAllMemoryDocumentsResponseBody,
+    components.ListMemoryDocumentsResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -62,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.GetAllMemoryDocumentsResponseBody,
+      components.ListMemoryDocumentsResponse,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -163,7 +164,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.GetAllMemoryDocumentsResponseBody,
+    components.ListMemoryDocumentsResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -173,7 +174,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.GetAllMemoryDocumentsResponseBody$inboundSchema),
+    M.json(200, components.ListMemoryDocumentsResponse$inboundSchema),
     M.fail([401, 403, 404, "4XX"]),
     M.fail("5XX"),
   )(response, req);