@scaleway/sdk-inference 1.3.0 → 2.2.0

package/README.md

@@ -0,0 +1,96 @@
+# @scaleway/sdk-inference
+
+[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-inference.svg)](https://www.npmjs.com/package/@scaleway/sdk-inference)
+[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-inference.svg)](https://www.npmjs.com/package/@scaleway/sdk-inference)
+[![license](https://img.shields.io/npm/l/@scaleway/sdk-inference.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
+
+Scaleway SDK for Inference API.
+
+> **Note**  
+> This is an automatically generated package that is part of the [Scaleway SDK for JavaScript](https://github.com/scaleway/scaleway-sdk-js).
+
+## Installation
+
+```bash
+npm install @scaleway/sdk-inference @scaleway/sdk-client
+```
+
+or with pnpm:
+
+```bash
+pnpm add @scaleway/sdk-inference @scaleway/sdk-client
+```
+
+or with yarn:
+
+```bash
+yarn add @scaleway/sdk-inference @scaleway/sdk-client
+```
+
+## Getting Started
+
+You'll need a pair of access and secret keys to connect to Scaleway API. Please check the [documentation](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/) on how to retrieve them.
+
+### Basic Usage
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { Inference } from '@scaleway/sdk-inference'
+
+const client = createClient({
+  accessKey: 'SCWXXXXXXXXXXXXXXXXX',
+  secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultRegion: 'fr-par',
+  defaultZone: 'fr-par-1',
+})
+
+const api = new Inference.v1.API(client)
+
+// Use the API
+// Example: await api.listServers()
+```
+
+### Using Configuration Loader
+
+For a simpler setup, you can load credentials from the configuration file or environment variables:
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
+import { Inference } from '@scaleway/sdk-inference'
+
+const profile = loadProfileFromConfigurationFile()
+const client = createClient(profile)
+const api = new Inference.v1.API(client)
+```
+
+## Documentation
+
+- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
+- 🌐 [Scaleway Inference API Documentation](https://www.scaleway.com/en/developers/api/inference/)
+- 📖 [Main Repository](https://github.com/scaleway/scaleway-sdk-js)
+- 💡 [Example Projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
+
+## Features
+
+- ✅ Full TypeScript support with complete type definitions
+- ✅ Promise-based API
+- ✅ Automatic pagination helpers
+- ✅ Built-in error handling
+- ✅ Compatible with Node.js ≥ 20
+
+## Support
+
+We love feedback! Feel free to reach us on:
+- [Scaleway Slack community](https://slack.scaleway.com/) - Join us on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource)
+- [GitHub Issues](https://github.com/scaleway/scaleway-sdk-js/issues)
+
+## Contributing
+
+This repository is at its early stage and is still in active development. If you are looking for a way to contribute, please read [CONTRIBUTING.md](https://github.com/scaleway/scaleway-sdk-js/blob/master/CONTRIBUTING.md).
+
+## License
+
+This project is Apache 2.0 licensed. See the [LICENSE](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) file for details.
+

package/dist/v1/api.gen.d.ts

@@ -1,5 +1,5 @@
-import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
+import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { CreateDeploymentRequest, CreateEndpointRequest, CreateModelRequest, DeleteDeploymentRequest, DeleteEndpointRequest, DeleteModelRequest, Deployment, Endpoint, GetDeploymentCertificateRequest, GetDeploymentRequest, GetModelRequest, ListDeploymentsRequest, ListDeploymentsResponse, ListModelsRequest, ListModelsResponse, ListNodeTypesRequest, ListNodeTypesResponse, Model, UpdateDeploymentRequest, UpdateEndpointRequest } from './types.gen.js';
 /**
  * Managed Inference API.

package/dist/v1/index.gen.d.ts

@@ -1,5 +1,5 @@
 export { API } from './api.gen.js';
 export * from './content.gen.js';
 export * from './marshalling.gen.js';
-export type { CreateDeploymentRequest, CreateEndpointRequest, CreateModelRequest, DeleteDeploymentRequest, DeleteEndpointRequest, DeleteModelRequest, Deployment, DeploymentQuantization, DeploymentStatus, Endpoint, EndpointPrivateNetworkDetails, EndpointPublicNetworkDetails, EndpointSpec, GetDeploymentCertificateRequest, GetDeploymentRequest, GetModelRequest, ListDeploymentsRequest, ListDeploymentsRequestOrderBy, ListDeploymentsResponse, ListModelsRequest, ListModelsRequestOrderBy, ListModelsResponse, ListNodeTypesRequest, ListNodeTypesResponse, Model, ModelSource, ModelStatus, ModelSupportInfo, ModelSupportedNode, ModelSupportedQuantization, NodeType, NodeTypeStock, UpdateDeploymentRequest, UpdateEndpointRequest, } from './types.gen.js';
+export type { CreateDeploymentRequest, CreateEndpointRequest, CreateModelRequest, DeleteDeploymentRequest, DeleteEndpointRequest, DeleteModelRequest, Deployment, DeploymentQuantization, DeploymentStatus, Endpoint, EndpointPrivateNetworkDetails, EndpointPublicNetworkDetails, EndpointSpec, GetDeploymentCertificateRequest, GetDeploymentRequest, GetModelRequest, ListDeploymentsRequest, ListDeploymentsRequestOrderBy, ListDeploymentsResponse, ListModelsRequest, ListModelsRequestOrderBy, ListModelsResponse, ListNodeTypesRequest, ListNodeTypesResponse, Model, ModelSource, ModelStatus, ModelSupportedNode, ModelSupportedQuantization, ModelSupportInfo, NodeType, NodeTypeStock, UpdateDeploymentRequest, UpdateEndpointRequest, } from './types.gen.js';
 export * as ValidationRules from './validation-rules.gen.js';

package/dist/v1/validation-rules.gen.d.ts

@@ -53,5 +53,6 @@ export declare const UpdateDeploymentRequest: {
     name: {
         maxLength: number;
         minLength: number;
+        pattern: RegExp;
     };
 };

package/dist/v1/validation-rules.gen.js

@@ -52,7 +52,8 @@ const UpdateDeploymentRequest = {
   },
   name: {
     maxLength: 255,
-    minLength: 1
+    minLength: 1,
+    pattern: /^[A-Za-z0-9-_]+$/
   }
 };
 export {

package/package.json

@@ -1,23 +1,20 @@
 {
   "name": "@scaleway/sdk-inference",
-  "version": "1.3.0",
+  "version": "2.2.0",
   "description": "Scaleway SDK inference",
   "license": "Apache-2.0",
   "files": [
+    "README.md",
     "dist"
   ],
   "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.gen.d.ts",
-      "import": "./dist/index.gen.js",
-      "require": "./dist/index.gen.cjs",
       "default": "./dist/index.gen.js"
     },
     "./*": {
       "types": "./dist/*/index.gen.d.ts",
-      "import": "./dist/*/index.gen.js",
-      "require": "./dist/*/index.gen.cjs",
       "default": "./dist/*/index.gen.js"
     }
   },
@@ -26,17 +23,17 @@
     "directory": "packages_generated/inference"
   },
   "engines": {
-    "node": ">=20.19.4"
+    "node": ">=20.19.6"
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.2",
-    "@scaleway/sdk-std": "1.2.0"
+    "@scaleway/sdk-std": "2.1.0"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.3.3"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.3.3"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "scripts": {
     "package:check": "pnpm publint",

package/dist/index.gen.cjs

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const index_gen = require("./v1/index.gen.cjs");
-const index_gen$1 = require("./v1beta1/index.gen.cjs");
-exports.Inferencev1 = index_gen;
-exports.Inferencev1beta1 = index_gen$1;

package/dist/v1/api.gen.cjs

@@ -1,276 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const sdkClient = require("@scaleway/sdk-client");
-const content_gen = require("./content.gen.cjs");
-const marshalling_gen = require("./marshalling.gen.cjs");
-const jsonContentHeaders = {
-  "Content-Type": "application/json; charset=utf-8"
-};
-class API extends sdkClient.API {
-  /**
-   * Locality of this API.
-   * type ∈ {'zone','region','global','unspecified'}
-   */
-  static LOCALITY = sdkClient.toApiLocality({
-    regions: ["fr-par"]
-  });
-  pageOfListDeployments = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/inference/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments`,
-      urlParams: sdkClient.urlParams(
-        ["name", request.name],
-        ["order_by", request.orderBy],
-        ["organization_id", request.organizationId],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ["project_id", request.projectId],
-        ["tags", request.tags]
-      )
-    },
-    marshalling_gen.unmarshalListDeploymentsResponse
-  );
-  /**
-   * List inference deployments. List all your inference deployments.
-   *
-   * @param request - The request {@link ListDeploymentsRequest}
-   * @returns A Promise of ListDeploymentsResponse
-   */
-  listDeployments = (request = {}) => sdkClient.enrichForPagination("deployments", this.pageOfListDeployments, request);
-  /**
-   * Get a deployment. Get the deployment for the given ID.
-   *
-   * @param request - The request {@link GetDeploymentRequest}
-   * @returns A Promise of Deployment
-   */
-  getDeployment = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/inference/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${sdkClient.validatePathParam("deploymentId", request.deploymentId)}`
-    },
-    marshalling_gen.unmarshalDeployment
-  );
-  /**
-   * Waits for {@link Deployment} to be in a final state.
-   *
-   * @param request - The request {@link GetDeploymentRequest}
-   * @param options - The waiting options
-   * @returns A Promise of Deployment
-   */
-  waitForDeployment = (request, options) => sdkClient.waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !content_gen.DEPLOYMENT_TRANSIENT_STATUSES.includes(res.status)
-    )),
-    this.getDeployment,
-    request,
-    options
-  );
-  /**
-   * Create a deployment. Create a new inference deployment related to a specific model.
-   *
-   * @param request - The request {@link CreateDeploymentRequest}
-   * @returns A Promise of Deployment
-   */
-  createDeployment = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalCreateDeploymentRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/inference/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments`
-    },
-    marshalling_gen.unmarshalDeployment
-  );
-  /**
-   * Update a deployment. Update an existing inference deployment.
-   *
-   * @param request - The request {@link UpdateDeploymentRequest}
-   * @returns A Promise of Deployment
-   */
-  updateDeployment = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalUpdateDeploymentRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "PATCH",
-      path: `/inference/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${sdkClient.validatePathParam("deploymentId", request.deploymentId)}`
-    },
-    marshalling_gen.unmarshalDeployment
-  );
-  /**
-   * Delete a deployment. Delete an existing inference deployment.
-   *
-   * @param request - The request {@link DeleteDeploymentRequest}
-   * @returns A Promise of Deployment
-   */
-  deleteDeployment = (request) => this.client.fetch(
-    {
-      method: "DELETE",
-      path: `/inference/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${sdkClient.validatePathParam("deploymentId", request.deploymentId)}`
-    },
-    marshalling_gen.unmarshalDeployment
-  );
-  /**
-     * Get the CA certificate. Get the CA certificate used for the deployment of private endpoints.
-  The CA certificate will be returned as a PEM file.
-     *
-     * @param request - The request {@link GetDeploymentCertificateRequest}
-     * @returns A Promise of Blob
-     */
-  getDeploymentCertificate = (request) => this.client.fetch({
-    method: "GET",
-    path: `/inference/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${sdkClient.validatePathParam("deploymentId", request.deploymentId)}/certificate`,
-    urlParams: sdkClient.urlParams(["dl", 1]),
-    responseType: "blob"
-  });
-  /**
-   * Create an endpoint. Create a new Endpoint related to a specific deployment.
-   *
-   * @param request - The request {@link CreateEndpointRequest}
-   * @returns A Promise of Endpoint
-   */
-  createEndpoint = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalCreateEndpointRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/inference/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints`
-    },
-    marshalling_gen.unmarshalEndpoint
-  );
-  /**
-   * Update an endpoint. Update an existing Endpoint.
-   *
-   * @param request - The request {@link UpdateEndpointRequest}
-   * @returns A Promise of Endpoint
-   */
-  updateEndpoint = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalUpdateEndpointRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "PATCH",
-      path: `/inference/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${sdkClient.validatePathParam("endpointId", request.endpointId)}`
-    },
-    marshalling_gen.unmarshalEndpoint
-  );
-  /**
-   * Delete an endpoint. Delete an existing Endpoint.
-   *
-   * @param request - The request {@link DeleteEndpointRequest}
-   */
-  deleteEndpoint = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/inference/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${sdkClient.validatePathParam("endpointId", request.endpointId)}`
-  });
-  pageOfListModels = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/inference/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/models`,
-      urlParams: sdkClient.urlParams(
-        ["name", request.name],
-        ["order_by", request.orderBy],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ["project_id", request.projectId],
-        ["tags", request.tags]
-      )
-    },
-    marshalling_gen.unmarshalListModelsResponse
-  );
-  /**
-   * List models. List all available models.
-   *
-   * @param request - The request {@link ListModelsRequest}
-   * @returns A Promise of ListModelsResponse
-   */
-  listModels = (request = {}) => sdkClient.enrichForPagination("models", this.pageOfListModels, request);
-  /**
-   * Get a model. Get the model for the given ID.
-   *
-   * @param request - The request {@link GetModelRequest}
-   * @returns A Promise of Model
-   */
-  getModel = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/inference/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/models/${sdkClient.validatePathParam("modelId", request.modelId)}`
-    },
-    marshalling_gen.unmarshalModel
-  );
-  /**
-   * Waits for {@link Model} to be in a final state.
-   *
-   * @param request - The request {@link GetModelRequest}
-   * @param options - The waiting options
-   * @returns A Promise of Model
-   */
-  waitForModel = (request, options) => sdkClient.waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !content_gen.MODEL_TRANSIENT_STATUSES.includes(res.status)
-    )),
-    this.getModel,
-    request,
-    options
-  );
-  /**
-   * Import a model. Import a new model to your model library.
-   *
-   * @param request - The request {@link CreateModelRequest}
-   * @returns A Promise of Model
-   */
-  createModel = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalCreateModelRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/inference/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/models`
-    },
-    marshalling_gen.unmarshalModel
-  );
-  /**
-   * Delete a model. Delete an existing model from your model library.
-   *
-   * @param request - The request {@link DeleteModelRequest}
-   */
-  deleteModel = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/inference/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/models/${sdkClient.validatePathParam("modelId", request.modelId)}`
-  });
-  pageOfListNodeTypes = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/inference/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/node-types`,
-      urlParams: sdkClient.urlParams(
-        ["include_disabled_types", request.includeDisabledTypes],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ]
-      )
-    },
-    marshalling_gen.unmarshalListNodeTypesResponse
-  );
-  /**
-   * List available node types. List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
-   *
-   * @param request - The request {@link ListNodeTypesRequest}
-   * @returns A Promise of ListNodeTypesResponse
-   */
-  listNodeTypes = (request) => sdkClient.enrichForPagination("nodeTypes", this.pageOfListNodeTypes, request);
-}
-exports.API = API;

package/dist/v1/content.gen.cjs

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const DEPLOYMENT_TRANSIENT_STATUSES = [
-  "creating",
-  "deploying",
-  "deleting",
-  "scaling"
-];
-const MODEL_TRANSIENT_STATUSES = [
-  "preparing",
-  "downloading"
-];
-exports.DEPLOYMENT_TRANSIENT_STATUSES = DEPLOYMENT_TRANSIENT_STATUSES;
-exports.MODEL_TRANSIENT_STATUSES = MODEL_TRANSIENT_STATUSES;

package/dist/v1/index.gen.cjs

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const api_gen = require("./api.gen.cjs");
-const content_gen = require("./content.gen.cjs");
-const marshalling_gen = require("./marshalling.gen.cjs");
-const validationRules_gen = require("./validation-rules.gen.cjs");
-exports.API = api_gen.API;
-exports.DEPLOYMENT_TRANSIENT_STATUSES = content_gen.DEPLOYMENT_TRANSIENT_STATUSES;
-exports.MODEL_TRANSIENT_STATUSES = content_gen.MODEL_TRANSIENT_STATUSES;
-exports.marshalCreateDeploymentRequest = marshalling_gen.marshalCreateDeploymentRequest;
-exports.marshalCreateEndpointRequest = marshalling_gen.marshalCreateEndpointRequest;
-exports.marshalCreateModelRequest = marshalling_gen.marshalCreateModelRequest;
-exports.marshalUpdateDeploymentRequest = marshalling_gen.marshalUpdateDeploymentRequest;
-exports.marshalUpdateEndpointRequest = marshalling_gen.marshalUpdateEndpointRequest;
-exports.unmarshalDeployment = marshalling_gen.unmarshalDeployment;
-exports.unmarshalEndpoint = marshalling_gen.unmarshalEndpoint;
-exports.unmarshalListDeploymentsResponse = marshalling_gen.unmarshalListDeploymentsResponse;
-exports.unmarshalListModelsResponse = marshalling_gen.unmarshalListModelsResponse;
-exports.unmarshalListNodeTypesResponse = marshalling_gen.unmarshalListNodeTypesResponse;
-exports.unmarshalModel = marshalling_gen.unmarshalModel;
-exports.ValidationRules = validationRules_gen;