@orq-ai/node 3.6.5 → 3.6.6

package/docs/sdks/contacts/README.md

@@ -25,7 +25,6 @@ async function run() {
     externalId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -50,15 +49,12 @@ async function run() {
   const res = await contactsCreate(orq, {
     externalId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("contactsCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/datasets/README.md

@@ -35,7 +35,6 @@ const orq = new Orq({
 async function run() {
   const result = await orq.datasets.list({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -58,15 +57,12 @@ const orq = new OrqCore({
 
 async function run() {
   const res = await datasetsList(orq, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("datasetsList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -110,7 +106,6 @@ async function run() {
     path: "Default",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -136,15 +131,12 @@ async function run() {
     displayName: "Neva.Raynor10",
     path: "Default",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("datasetsCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -187,7 +179,6 @@ async function run() {
     datasetId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -212,15 +203,12 @@ async function run() {
   const res = await datasetsRetrieve(orq, {
     datasetId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("datasetsRetrieve failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -267,7 +255,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -295,15 +282,12 @@ async function run() {
       path: "Default",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("datasetsUpdate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -371,14 +355,12 @@ async function run() {
   const res = await datasetsDelete(orq, {
     datasetId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("datasetsDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -426,7 +408,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -456,15 +437,12 @@ async function run() {
       type: "dataset_experiment",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("datasetsCreateExperiment failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -507,7 +485,6 @@ async function run() {
     datasetId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -532,15 +509,12 @@ async function run() {
   const res = await datasetsListDatapoints(orq, {
     datasetId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("datasetsListDatapoints failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -583,7 +557,6 @@ async function run() {
     datasetId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -608,15 +581,12 @@ async function run() {
   const res = await datasetsCreateDatapoint(orq, {
     datasetId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("datasetsCreateDatapoint failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -660,7 +630,6 @@ async function run() {
     datapointId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -686,15 +655,12 @@ async function run() {
     datasetId: "<id>",
     datapointId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("datasetsRetrieveDatapoint failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -739,7 +705,6 @@ async function run() {
     datapointId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -765,15 +730,12 @@ async function run() {
     datasetId: "<id>",
     datapointId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("datasetsUpdateDatapoint failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -843,14 +805,12 @@ async function run() {
     datasetId: "<id>",
     datapointId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("datasetsDeleteDatapoint failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -894,7 +854,6 @@ async function run() {
     datasetId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -919,15 +878,12 @@ async function run() {
   const res = await datasetsCreateDatapoints(orq, {
     datasetId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("datasetsCreateDatapoints failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -994,14 +950,12 @@ async function run() {
   const res = await datasetsClear(orq, {
     datasetId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("datasetsClear failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();

package/docs/sdks/deployments/README.md

@@ -27,7 +27,6 @@ const orq = new Orq({
 async function run() {
   const result = await orq.deployments.list({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -50,15 +49,12 @@ const orq = new OrqCore({
 
 async function run() {
   const res = await deploymentsList(orq, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("deploymentsList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -102,7 +98,6 @@ async function run() {
     key: "<key>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -127,15 +122,12 @@ async function run() {
   const res = await deploymentsGetConfig(orq, {
     key: "<key>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("deploymentsGetConfig failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -170,6 +162,8 @@ Invoke a deployment with a given payload
 import { Orq } from "@orq-ai/node";
 
 const orq = new Orq({
+  environment: "<value>",
+  contactId: "<id>",
   apiKey: process.env["ORQ_API_KEY"] ?? "",
 });
 
@@ -178,7 +172,6 @@ async function run() {
     key: "<key>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -196,6 +189,8 @@ import { deploymentsInvoke } from "@orq-ai/node/funcs/deploymentsInvoke.js";
 // Use `OrqCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const orq = new OrqCore({
+  environment: "<value>",
+  contactId: "<id>",
   apiKey: process.env["ORQ_API_KEY"] ?? "",
 });
 
@@ -203,15 +198,12 @@ async function run() {
   const res = await deploymentsInvoke(orq, {
     key: "<key>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("deploymentsInvoke failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -246,6 +238,8 @@ Stream deployment generation. Only supported for completions and chat completion
 import { Orq } from "@orq-ai/node";
 
 const orq = new Orq({
+  environment: "<value>",
+  contactId: "<id>",
   apiKey: process.env["ORQ_API_KEY"] ?? "",
 });
 
@@ -274,6 +268,8 @@ import { deploymentsStream } from "@orq-ai/node/funcs/deploymentsStream.js";
 // Use `OrqCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const orq = new OrqCore({
+  environment: "<value>",
+  contactId: "<id>",
   apiKey: process.env["ORQ_API_KEY"] ?? "",
 });
 
@@ -281,17 +277,15 @@ async function run() {
   const res = await deploymentsStream(orq, {
     key: "<key>",
   });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  for await (const event of result) {
+  if (res.ok) {
+    const { value: result } = res;
+    for await (const event of result) {
     // Handle the event
     console.log(event);
   }
+  } else {
+    console.log("deploymentsStream failed:", res.error);
+  }
 }
 
 run();
@@ -340,7 +334,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -371,15 +364,12 @@ async function run() {
       type: "deployment_experiment",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("deploymentsCreateExperiment failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/feedback/README.md

@@ -29,7 +29,6 @@ async function run() {
     traceId: "67HTZ65Z9W91HSF51CW68KK1QH",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -58,15 +57,12 @@ async function run() {
     ],
     traceId: "67HTZ65Z9W91HSF51CW68KK1QH",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("feedbackCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/files/README.md

@@ -29,7 +29,6 @@ async function run() {
     file: await openAsBlob("example.file"),
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -55,15 +54,12 @@ async function run() {
   const res = await filesCreate(orq, {
     file: await openAsBlob("example.file"),
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("filesCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -104,7 +100,6 @@ const orq = new Orq({
 async function run() {
   const result = await orq.files.list({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -127,15 +122,12 @@ const orq = new OrqCore({
 
 async function run() {
   const res = await filesList(orq, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("filesList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -178,7 +170,6 @@ async function run() {
     fileId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -203,15 +194,12 @@ async function run() {
   const res = await filesGet(orq, {
     fileId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("filesGet failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -278,14 +266,12 @@ async function run() {
   const res = await filesDelete(orq, {
     fileId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("filesDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();