@orq-ai/node 4.13.13 → 4.13.16

package/packages/orq-rc/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);

package/packages/orq-rc/src/funcs/knowledgeRetrieve.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 knowledgeRetrieve(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.GetOneKnowledgeResponseBody,
+    components.Knowledge,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -62,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.GetOneKnowledgeResponseBody,
+      components.Knowledge,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -145,7 +146,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.GetOneKnowledgeResponseBody,
+    components.Knowledge,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -155,7 +156,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.GetOneKnowledgeResponseBody$inboundSchema),
+    M.json(200, components.Knowledge$inboundSchema),
     M.fail([404, "4XX"]),
     M.fail("5XX"),
   )(response, req);

package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.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";
 
 /**
  * Retrieve a chunk
+ *
+ * @remarks
+ * Retrieves a chunk by its chunk identifier.
  */
 export function knowledgeRetrieveChunk(
   client: OrqCore,
@@ -34,7 +38,7 @@ export function knowledgeRetrieveChunk(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.GetOneChunkResponseBody,
+    components.KnowledgeChunk,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -59,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.GetOneChunkResponseBody,
+      components.KnowledgeChunk,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -152,7 +156,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.GetOneChunkResponseBody,
+    components.KnowledgeChunk,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -162,7 +166,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.GetOneChunkResponseBody$inboundSchema),
+    M.json(200, components.KnowledgeChunk$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);

package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.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";
 
 /**
  * Retrieve a datasource
+ *
+ * @remarks
+ * Retrieves a datasource and its current processing status and chunk count.
  */
 export function knowledgeRetrieveDatasource(
   client: OrqCore,
@@ -34,7 +38,7 @@ export function knowledgeRetrieveDatasource(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.RetrieveDatasourceResponseBody,
+    components.Datasource,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -59,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.RetrieveDatasourceResponseBody,
+      components.Datasource,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -148,7 +152,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.RetrieveDatasourceResponseBody,
+    components.Datasource,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -158,7 +162,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.RetrieveDatasourceResponseBody$inboundSchema),
+    M.json(200, components.Datasource$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);

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

@@ -0,0 +1,187 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OrqCore } from "../core.js";
+import { encodeFormQuery, 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 * 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";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Retrieve a file upload URL
+ *
+ * @remarks
+ * Creates a presigned upload policy for a file that will be attached to a knowledge-base datasource. Submit the returned form fields and file directly to the returned URL.
+ */
+export function knowledgeRetrieveFileUrl(
+  client: OrqCore,
+  request: operations.GetOneFileUploadUrlRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.GetUploadFileUrlResponse,
+    | errors.KnowledgeApiError
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OrqCore,
+  request: operations.GetOneFileUploadUrlRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.GetUploadFileUrlResponse,
+      | errors.KnowledgeApiError
+      | OrqError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetOneFileUploadUrlRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    knowledge_id: encodeSimple("knowledge_id", payload.knowledge_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/v2/knowledge/{knowledge_id}/upload-file")(
+    pathParams,
+  );
+
+  const query = encodeFormQuery({
+    "contentType": payload.contentType,
+    "datasourceId": payload.datasourceId,
+    "fileName": payload.fileName,
+  });
+
+  const headers = new Headers(compactMap({
+    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: "GetOneFileUploadUrl",
+    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: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    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 responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.GetUploadFileUrlResponse,
+    | errors.KnowledgeApiError
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.GetUploadFileUrlResponse$inboundSchema),
+    M.jsonErr(500, errors.KnowledgeApiError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

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

@@ -0,0 +1,180 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OrqCore } from "../core.js";
+import { 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";
+
+/**
+ * Retrieve datasource processing status
+ *
+ * @remarks
+ * Returns aggregate queued, completed, passed, and failed chunk counts together with the datasource and chunk processing attempts.
+ */
+export function knowledgeRetrieveProcessingStatus(
+  client: OrqCore,
+  request: operations.GetOneDatasourceProcessingStatusRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.DatasourcesServiceGetProcessingStatusResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OrqCore,
+  request: operations.GetOneDatasourceProcessingStatusRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.DatasourcesServiceGetProcessingStatusResponse,
+      | OrqError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetOneDatasourceProcessingStatusRequest$outboundSchema.parse(
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    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}/datasource-processing-status",
+  )(pathParams);
+
+  const headers = new Headers(compactMap({
+    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: "GetOneDatasourceProcessingStatus",
+    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: "GET",
+    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.DatasourcesServiceGetProcessingStatusResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      components.DatasourcesServiceGetProcessingStatusResponse$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/knowledgeSearch.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 knowledgeSearch(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.SearchKnowledgeResponseBody,
+    components.SearchKnowledgeResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -62,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.SearchKnowledgeResponseBody,
+      components.SearchKnowledgeResponse,
       | 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.SearchKnowledgeRequest, {
+    explode: true,
+  });
 
   const pathParams = {
     knowledge_id: encodeSimple("knowledge_id", payload.knowledge_id, {
@@ -146,7 +149,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.SearchKnowledgeResponseBody,
+    components.SearchKnowledgeResponse,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -156,7 +159,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.SearchKnowledgeResponseBody$inboundSchema),
+    M.json(200, components.SearchKnowledgeResponse$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);