@planqk/planqk-service-sdk 2.3.0 → 2.5.0

package/dist/datapool.d.ts

@@ -0,0 +1,11 @@
+export declare enum ReferenceType {
+    DATAPOOL = "DATAPOOL"
+}
+export interface DataPoolReference {
+    id: string;
+    ref: ReferenceType;
+}
+/**
+ * Factory function to create DataPoolReference objects with ref always set to DATAPOOL.
+ */
+export declare function withDataPoolReference(id: string): DataPoolReference;

package/dist/datapool.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReferenceType = void 0;
+exports.withDataPoolReference = withDataPoolReference;
+var ReferenceType;
+(function (ReferenceType) {
+    ReferenceType["DATAPOOL"] = "DATAPOOL";
+})(ReferenceType || (exports.ReferenceType = ReferenceType = {}));
+/**
+ * Factory function to create DataPoolReference objects with ref always set to DATAPOOL.
+ */
+function withDataPoolReference(id) {
+    return {
+        id,
+        ref: ReferenceType.DATAPOOL,
+    };
+}

package/notebooks/python-sdk.ipynb

@@ -83,6 +83,28 @@
     "print(f\"Service execution finished at '{ended_at}' with status '{status}'\")"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from planqk.service.datapool import DataPoolReference\n",
+    "\n",
+    "# Prepare your input and specify which data pool to use at runtime\n",
+    "data = {\"file_to_read\": \"example.txt\"}\n",
+    "dataset = DataPoolReference(id=\"89ae42e1-9697-4742-adfb-95bf018104c3\")\n",
+    "\n",
+    "service_execution = client.run(request={\"data\": data, \"dataset\": dataset})\n",
+    "\n",
+    "# Wait for the service execution to finish (blocking)\n",
+    "service_execution.wait_for_final_state()\n",
+    "\n",
+    "status = service_execution.status\n",
+    "ended_at = service_execution.ended_at\n",
+    "print(f\"Service execution finished at '{ended_at}' with status '{status}'\")"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -192,7 +214,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.11"
+   "version": "3.11.9"
   }
  },
  "nbformat": 4,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planqk/planqk-service-sdk",
-  "version": "2.3.0",
+  "version": "2.5.0",
   "description": "SDK to interact with PLANQK Managed Services.",
   "author": "Kipu Quantum GmbH",
   "contributors": [

package/planqk/service/_version.py

@@ -1 +1 @@
-__version__ = "2.3.0"
+__version__ = "2.5.0"

package/planqk/service/datapool.py

@@ -0,0 +1,24 @@
+import typing
+from enum import Enum
+
+import pydantic
+
+from .sdk.core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class ReferenceType(str, Enum):
+    DATAPOOL = "DATAPOOL"
+
+
+class DataPoolReference(UniversalBaseModel):
+    id: str
+    ref: ReferenceType = ReferenceType.DATAPOOL
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow",
+                                                                                 frozen=True)  # type: ignore # Pydantic v2
+    else:
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

package/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "planqk-service-sdk"
-version = "2.3.0"
+version = "2.5.0"
 description = "SDK to interact with PLANQK Managed Services."
 authors = [
     { name = "Kipu Quantum GmbH", email = "info@kipu-quantum.com" },

package/src/datapool.ts

@@ -0,0 +1,18 @@
+export enum ReferenceType {
+  DATAPOOL = "DATAPOOL"
+}
+
+export interface DataPoolReference {
+  id: string
+  ref: ReferenceType
+}
+
+/**
+ * Factory function to create DataPoolReference objects with ref always set to DATAPOOL.
+ */
+export function withDataPoolReference(id: string): DataPoolReference {
+  return {
+    id,
+    ref: ReferenceType.DATAPOOL,
+  }
+}

package/src/index.test.ts

@@ -2,29 +2,25 @@ import process from 'node:process'
 import {test} from 'vitest'
 import 'dotenv/config'
 import {PlanqkServiceClient} from "./client";
+import {withDataPoolReference} from "./datapool";
 
-test.skip('integration test', {timeout: 5 * 60 * 1000}, async () => {
-  const tokenEndpoint = process.env.TOKEN_ENDPOINT
-  const serviceEndpoint = process.env.SERVICE_ENDPOINT
-  const consumerKey = process.env.CONSUMER_KEY
-  const consumerSecret = process.env.CONSUMER_SECRET
+const tokenEndpoint = process.env.TOKEN_ENDPOINT
+const serviceEndpoint = process.env.SERVICE_ENDPOINT
+const consumerKey = process.env.CONSUMER_KEY
+const consumerSecret = process.env.CONSUMER_SECRET
 
-  console.log(`Token endpoint: ${tokenEndpoint}`)
-  console.log(`Service endpoint: ${serviceEndpoint}`)
-  console.log(`Consumer key: ${consumerKey}`)
-  console.log(`Consumer secret: ${consumerSecret}`)
+console.log(`Token endpoint: ${tokenEndpoint}`)
+console.log(`Service endpoint: ${serviceEndpoint}`)
+console.log(`Consumer key: ${consumerKey}`)
+console.log(`Consumer secret: ${consumerSecret}`)
 
+test.skip('integration test: coin toss', {timeout: 5 * 60 * 1000}, async () => {
   const client = new PlanqkServiceClient(serviceEndpoint!, consumerKey, consumerSecret, tokenEndpoint);
 
   let serviceExecutions = await client.api().getServiceExecutions()
   console.log(serviceExecutions)
 
   const data = {n_coin_tosses: 2}
-  // const dataRef = {
-  //   dataPoolId: "87cb778e-ac43-11ec-b909-0242ac120002",
-  //   dataSourceDescriptorId: "87cb778e-ac43-11ec-b909-0242ac120002",
-  //   fileId: "87cb778e-ac43-11ec-b909-0242ac120002"
-  // }
   const params = {shots: 100}
 
   let serviceExecution = await client.api().startExecution({data, params}, {timeoutInSeconds: 60})
@@ -54,3 +50,22 @@ test.skip('integration test', {timeout: 5 * 60 * 1000}, async () => {
   serviceExecutions = await client.api().getServiceExecutions()
   console.log(serviceExecutions)
 })
+
+test.skip('integration test: using data pools', {timeout: 5 * 60 * 1000}, async () => {
+  const client = new PlanqkServiceClient(serviceEndpoint!, consumerKey, consumerSecret, tokenEndpoint);
+
+  const data = {file_to_read: "example.txt"}
+  const dataset = withDataPoolReference("89ae42e1-9697-4742-adfb-95bf018104c3")
+
+  let serviceExecution = await client.api().startExecution({data, dataset}, {timeoutInSeconds: 60})
+  console.log(serviceExecution)
+
+  const finalStates = ["SUCCEEDED", "CANCELLED", "FAILED"]
+  while (!finalStates.includes(serviceExecution.status!)) {
+    serviceExecution = await client.api().getStatus(serviceExecution.id!)
+  }
+  console.log(serviceExecution)
+
+  const logs = await client.api().getLogs(serviceExecution.id!)
+  console.log(logs)
+})