@orq-ai/node 4.14.0-rc.20 → 4.14.0-rc.37

package/src/funcs/evalsInvoke.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,
@@ -18,7 +19,6 @@ import {
   RequestTimeoutError,
   UnexpectedClientError,
 } from "../models/errors/httpclienterrors.js";
-import * as errors from "../models/errors/index.js";
 import { OrqError } from "../models/errors/orqerror.js";
 import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
@@ -28,6 +28,9 @@ import { Result } from "../types/fp.js";
 
 /**
  * Invoke a Custom Evaluator
+ *
+ * @remarks
+ * Runs an evaluator that already exists in the workspace. Accepts either a conversation or the structured input and output fields; when both are present the conversation wins.
  */
 export function evalsInvoke(
   client: OrqCore,
@@ -35,10 +38,7 @@ export function evalsInvoke(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.InvokeEvalResponseBody,
-    | errors.InvokeEvalResponseBody
-    | errors.InvokeEvalEvalsResponseBody
-    | errors.InvokeEvalEvalsResponseResponseBody
+    components.InvokeEvaluatorResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -63,10 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.InvokeEvalResponseBody,
-      | errors.InvokeEvalResponseBody
-      | errors.InvokeEvalEvalsResponseBody
-      | errors.InvokeEvalEvalsResponseResponseBody
+      components.InvokeEvaluatorResponse,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -88,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.InvokeEvaluatorRequest, {
+    explode: true,
+  });
 
   const pathParams = {
     id: encodeSimple("id", payload.id, {
@@ -96,7 +95,7 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-  const path = pathToFunc("/v2/evaluators/{id}/invoke")(pathParams);
+  const path = pathToFunc("/v3/evaluators/{id}/invoke")(pathParams);
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -149,15 +148,8 @@ async function $do(
   }
   const response = doResult.value;
 
-  const responseFields = {
-    HttpMeta: { Response: response, Request: req },
-  };
-
   const [result] = await M.match<
-    operations.InvokeEvalResponseBody,
-    | errors.InvokeEvalResponseBody
-    | errors.InvokeEvalEvalsResponseBody
-    | errors.InvokeEvalEvalsResponseResponseBody
+    components.InvokeEvaluatorResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -167,13 +159,10 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.InvokeEvalResponseBody$inboundSchema),
-    M.jsonErr(400, errors.InvokeEvalResponseBody$inboundSchema),
-    M.jsonErr(404, errors.InvokeEvalEvalsResponseBody$inboundSchema),
-    M.jsonErr(500, errors.InvokeEvalEvalsResponseResponseBody$inboundSchema),
+    M.json(200, components.InvokeEvaluatorResponse$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
-  )(response, req, { extraFields: responseFields });
+  )(response, req);
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/funcs/evalsUpdate.ts

@@ -28,6 +28,9 @@ import { Result } from "../types/fp.js";
 
 /**
  * Update an Evaluator
+ *
+ * @remarks
+ * Update an evaluator by ID with the provided fields.
  */
 export function evalsUpdate(
   client: OrqCore,

package/src/funcs/guardrailRulesCreate.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * Create a guardrail rule
  *
  * @remarks
- * Creates a guardrail rule with metadata and optional evaluator, plugin, timeout, and matching configuration. Rules default to disabled when `enabled` is omitted.
+ * Creates a guardrail rule with metadata and optional evaluator, plugin, and matching configuration. Rules default to disabled when `enabled` is omitted.
  */
 export function guardrailRulesCreate(
   client: OrqCore,

package/src/funcs/knowledgeCreate.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,20 +22,22 @@ 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";
 
 /**
  * Create a knowledge
+ *
+ * @remarks
+ * Creates an internal or external knowledge base. Internal knowledge bases embed and index uploaded content; external knowledge bases query the configured external retrieval API.
  */
 export function knowledgeCreate(
   client: OrqCore,
-  request: operations.CreateKnowledgeRequestBody,
+  request: components.KnowledgeBasesServiceCreateRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.CreateKnowledgeResponseBody,
+    components.Knowledge,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -54,12 +57,12 @@ export function knowledgeCreate(
 
 async function $do(
   client: OrqCore,
-  request: operations.CreateKnowledgeRequestBody,
+  request: components.KnowledgeBasesServiceCreateRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.CreateKnowledgeResponseBody,
+      components.Knowledge,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -75,7 +78,7 @@ async function $do(
   const parsed = safeParse(
     request,
     (value) =>
-      operations.CreateKnowledgeRequestBody$outboundSchema.parse(value),
+      components.KnowledgeBasesServiceCreateRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -138,7 +141,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.CreateKnowledgeResponseBody,
+    components.Knowledge,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -148,7 +151,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.CreateKnowledgeResponseBody$inboundSchema),
+    M.json(200, components.Knowledge$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/knowledgeCreateChunks.ts

@@ -12,6 +12,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,
@@ -28,6 +29,9 @@ import { Result } from "../types/fp.js";
 
 /**
  * Create chunks for a datasource
+ *
+ * @remarks
+ * Creates between 1 and 100 chunks. Chunks with supplied embeddings are indexed immediately; chunks without embeddings are queued for embedding.
  */
 export function knowledgeCreateChunks(
   client: OrqCore,
@@ -35,7 +39,7 @@ export function knowledgeCreateChunks(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    Array<operations.ResponseBody>,
+    Array<components.KnowledgeChunk>,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -60,7 +64,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      Array<operations.ResponseBody>,
+      Array<components.KnowledgeChunk>,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -150,7 +154,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    Array<operations.ResponseBody>,
+    Array<components.KnowledgeChunk>,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -160,7 +164,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, z.array(operations.ResponseBody$inboundSchema)),
+    M.json(200, z.array(components.KnowledgeChunk$inboundSchema)),
     M.fail("4XX"),
     M.fail([500, "5XX"]),
   )(response, req);

package/src/funcs/knowledgeCreateDatasource.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";
 
 /**
  * Create a new datasource
+ *
+ * @remarks
+ * Creates a datasource shell when only a display name is provided. When file_id is provided, the uploaded file is queued for chunking and ingestion.
  */
 export function knowledgeCreateDatasource(
   client: OrqCore,
@@ -34,7 +38,7 @@ export function knowledgeCreateDatasource(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.CreateDatasourceResponseBody,
+    components.Datasource,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -59,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.CreateDatasourceResponseBody,
+      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.DatasourcesServiceCreateRequest, {
+    explode: true,
+  });
 
   const pathParams = {
     knowledge_id: encodeSimple("knowledge_id", payload.knowledge_id, {
@@ -145,7 +151,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.CreateDatasourceResponseBody,
+    components.Datasource,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -155,7 +161,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.CreateDatasourceResponseBody$inboundSchema),
+    M.json(200, components.Datasource$inboundSchema),
     M.fail("4XX"),
     M.fail([500, "5XX"]),
   )(response, req);

package/src/funcs/knowledgeDeleteChunk.ts

@@ -28,6 +28,9 @@ import { Result } from "../types/fp.js";
 
 /**
  * Delete a chunk
+ *
+ * @remarks
+ * Deletes a chunk from the datasource and its vector index.
  */
 export function knowledgeDeleteChunk(
   client: OrqCore,

package/src/funcs/knowledgeDeleteChunks.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";
 
 /**
  * Delete multiple chunks
+ *
+ * @remarks
+ * Deletes up to 100 chunks and reports IDs that were not found or could not be deleted.
  */
 export function knowledgeDeleteChunks(
   client: OrqCore,
@@ -34,7 +38,7 @@ export function knowledgeDeleteChunks(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.DeleteChunksResponseBody,
+    components.ChunksServiceDeleteManyResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -59,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.DeleteChunksResponseBody,
+      components.ChunksServiceDeleteManyResponse,
       | 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.ChunksServiceDeleteManyRequest, {
+    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.DeleteChunksResponseBody,
+    components.ChunksServiceDeleteManyResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -159,7 +165,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.DeleteChunksResponseBody$inboundSchema),
+    M.json(200, components.ChunksServiceDeleteManyResponse$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/knowledgeGetChunksCount.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 knowledgeGetChunksCount(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.GetChunksCountResponseBody,
+    components.ChunksServiceCountResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -62,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.GetChunksCountResponseBody,
+      components.ChunksServiceCountResponse,
       | 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.ChunksServiceCountRequest, {
+    explode: true,
+  });
 
   const pathParams = {
     datasource_id: encodeSimple("datasource_id", payload.datasource_id, {
@@ -152,7 +155,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.GetChunksCountResponseBody,
+    components.ChunksServiceCountResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -162,7 +165,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.GetChunksCountResponseBody$inboundSchema),
+    M.json(200, components.ChunksServiceCountResponse$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/knowledgeList.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 knowledgeList(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.ListKnowledgeBasesResponseBody,
+    components.KnowledgeBasesServiceListResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -62,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.ListKnowledgeBasesResponseBody,
+      components.KnowledgeBasesServiceListResponse,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -153,7 +154,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.ListKnowledgeBasesResponseBody,
+    components.KnowledgeBasesServiceListResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -163,7 +164,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.ListKnowledgeBasesResponseBody$inboundSchema),
+    M.json(200, components.KnowledgeBasesServiceListResponse$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/knowledgeListChunks.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";
 
 /**
  * List all chunks for a datasource
+ *
+ * @remarks
+ * Returns chunks using cursor pagination, with optional text and processing-status filters.
  */
 export function knowledgeListChunks(
   client: OrqCore,
@@ -34,7 +38,7 @@ export function knowledgeListChunks(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.ListChunksResponseBody,
+    components.ChunksServiceListResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -59,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.ListChunksResponseBody,
+      components.ChunksServiceListResponse,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -157,7 +161,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.ListChunksResponseBody,
+    components.ChunksServiceListResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -167,7 +171,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.ListChunksResponseBody$inboundSchema),
+    M.json(200, components.ChunksServiceListResponse$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/knowledgeListChunksPaginated.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";
 
 /**
  * List chunks with offset-based pagination
+ *
+ * @remarks
+ * Returns a page of chunks, with optional text, enabled-state, and processing-status filters.
  */
 export function knowledgeListChunksPaginated(
   client: OrqCore,
@@ -34,7 +38,7 @@ export function knowledgeListChunksPaginated(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.ListChunksPaginatedResponseBody,
+    components.ChunksServiceListPaginatedResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -59,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.ListChunksPaginatedResponseBody,
+      components.ChunksServiceListPaginatedResponse,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -82,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.ChunksServiceListPaginatedRequest, {
+    explode: true,
+  });
 
   const pathParams = {
     datasource_id: encodeSimple("datasource_id", payload.datasource_id, {
@@ -150,7 +156,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.ListChunksPaginatedResponseBody,
+    components.ChunksServiceListPaginatedResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -160,7 +166,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.ListChunksPaginatedResponseBody$inboundSchema),
+    M.json(200, components.ChunksServiceListPaginatedResponse$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/knowledgeListDatasources.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";
 
 /**
  * List all datasources
+ *
+ * @remarks
+ * Returns the datasources in a knowledge base. Use cursors to page through results and optional query or status filters to narrow the list.
  */
 export function knowledgeListDatasources(
   client: OrqCore,
@@ -34,7 +38,7 @@ export function knowledgeListDatasources(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.ListDatasourcesResponseBody,
+    components.DatasourcesServiceListResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -59,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.ListDatasourcesResponseBody,
+      components.DatasourcesServiceListResponse,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -96,7 +100,6 @@ async function $do(
   const query = encodeFormQuery({
     "ending_before": payload.ending_before,
     "limit": payload.limit,
-    "metadata": payload.metadata,
     "q": payload.q,
     "starting_after": payload.starting_after,
     "status": payload.status,
@@ -154,7 +157,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.ListDatasourcesResponseBody,
+    components.DatasourcesServiceListResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -164,7 +167,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.ListDatasourcesResponseBody$inboundSchema),
+    M.json(200, components.DatasourcesServiceListResponse$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);