@scaleway/sdk-inference 1.0.1

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

@@ -0,0 +1,65 @@
+const CreateDeploymentRequest = {
+  maxSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 50
+  },
+  minSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 50
+  },
+  name: {
+    maxLength: 255,
+    minLength: 1,
+    pattern: /^[A-Za-z0-9-_]+$/
+  },
+  nodeTypeName: {
+    maxLength: 64,
+    minLength: 1
+  }
+};
+const CreateModelRequest = {
+  name: {
+    maxLength: 255,
+    minLength: 1,
+    pattern: /^[A-Za-z0-9-_/.:]+$/
+  }
+};
+const DeploymentQuantization = {
+  bits: {
+    lessThanOrEqual: 32
+  }
+};
+const ListDeploymentsRequest = {
+  name: {
+    maxLength: 255,
+    minLength: 1
+  }
+};
+const ListModelsRequest = {
+  name: {
+    maxLength: 255,
+    minLength: 1
+  }
+};
+const UpdateDeploymentRequest = {
+  maxSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 50
+  },
+  minSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 50
+  },
+  name: {
+    maxLength: 255,
+    minLength: 1
+  }
+};
+export {
+  CreateDeploymentRequest,
+  CreateModelRequest,
+  DeploymentQuantization,
+  ListDeploymentsRequest,
+  ListModelsRequest,
+  UpdateDeploymentRequest
+};

package/dist/v1beta1/api.gen.cjs

@@ -0,0 +1,301 @@
+"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 {
+  /** Lists the available regions of the API. */
+  static LOCALITIES = ["fr-par"];
+  pageOfListDeployments = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/inference/v1beta1/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/v1beta1/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/v1beta1/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/v1beta1/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/v1beta1/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/v1beta1/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/v1beta1/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/v1beta1/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/v1beta1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${sdkClient.validatePathParam("endpointId", request.endpointId)}`
+  });
+  pageOfListDeploymentACLRules = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/inference/v1beta1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${sdkClient.validatePathParam("deploymentId", request.deploymentId)}/acls`,
+      urlParams: sdkClient.urlParams(
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ]
+      )
+    },
+    marshalling_gen.unmarshalListDeploymentACLRulesResponse
+  );
+  /**
+   * List your ACLs. List ACLs for a specific deployment.
+   *
+   * @param request - The request {@link ListDeploymentACLRulesRequest}
+   * @returns A Promise of ListDeploymentACLRulesResponse
+   */
+  listDeploymentACLRules = (request) => sdkClient.enrichForPagination("rules", this.pageOfListDeploymentACLRules, request);
+  /**
+   * Add new ACLs. Add new ACL rules for a specific deployment.
+   *
+   * @param request - The request {@link AddDeploymentACLRulesRequest}
+   * @returns A Promise of AddDeploymentACLRulesResponse
+   */
+  addDeploymentACLRules = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalAddDeploymentACLRulesRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/inference/v1beta1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${sdkClient.validatePathParam("deploymentId", request.deploymentId)}/acls`
+    },
+    marshalling_gen.unmarshalAddDeploymentACLRulesResponse
+  );
+  /**
+   * Set new ACL. Set new ACL rules for a specific deployment.
+   *
+   * @param request - The request {@link SetDeploymentACLRulesRequest}
+   * @returns A Promise of SetDeploymentACLRulesResponse
+   */
+  setDeploymentACLRules = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalSetDeploymentACLRulesRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PUT",
+      path: `/inference/v1beta1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${sdkClient.validatePathParam("deploymentId", request.deploymentId)}/acls`
+    },
+    marshalling_gen.unmarshalSetDeploymentACLRulesResponse
+  );
+  /**
+   * Delete an existing ACL.
+   *
+   * @param request - The request {@link DeleteDeploymentACLRuleRequest}
+   */
+  deleteDeploymentACLRule = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/inference/v1beta1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/acls/${sdkClient.validatePathParam("aclId", request.aclId)}`
+  });
+  pageOfListModels = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/inference/v1beta1/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/v1beta1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/models/${sdkClient.validatePathParam("modelId", request.modelId)}`
+    },
+    marshalling_gen.unmarshalModel
+  );
+  getModelEula = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/inference/v1beta1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/models/${sdkClient.validatePathParam("modelId", request.modelId)}/eula`
+    },
+    marshalling_gen.unmarshalEula
+  );
+  pageOfListNodeTypes = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/inference/v1beta1/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/v1beta1/api.gen.d.ts

@@ -0,0 +1,148 @@
+import { API as ParentAPI } from '@scaleway/sdk-client';
+import type { Region as ScwRegion, WaitForOptions } from '@scaleway/sdk-client';
+import type { AddDeploymentACLRulesRequest, AddDeploymentACLRulesResponse, CreateDeploymentRequest, CreateEndpointRequest, DeleteDeploymentACLRuleRequest, DeleteDeploymentRequest, DeleteEndpointRequest, Deployment, Endpoint, Eula, GetDeploymentCertificateRequest, GetDeploymentRequest, GetModelEulaRequest, GetModelRequest, ListDeploymentACLRulesRequest, ListDeploymentACLRulesResponse, ListDeploymentsRequest, ListDeploymentsResponse, ListModelsRequest, ListModelsResponse, ListNodeTypesRequest, ListNodeTypesResponse, Model, SetDeploymentACLRulesRequest, SetDeploymentACLRulesResponse, UpdateDeploymentRequest, UpdateEndpointRequest } from './types.gen';
+/**
+ * Managed Inference API.
+
+This API allows you to manage your Inference services.
+ */
+export declare class API extends ParentAPI {
+    /** Lists the available regions of the API. */
+    static readonly LOCALITIES: ScwRegion[];
+    protected pageOfListDeployments: (request?: Readonly<ListDeploymentsRequest>) => Promise<ListDeploymentsResponse>;
+    /**
+     * List inference deployments. List all your inference deployments.
+     *
+     * @param request - The request {@link ListDeploymentsRequest}
+     * @returns A Promise of ListDeploymentsResponse
+     */
+    listDeployments: (request?: Readonly<ListDeploymentsRequest>) => Promise<ListDeploymentsResponse> & {
+        all: () => Promise<Deployment[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Deployment[], void, void>;
+    };
+    /**
+     * Get a deployment. Get the deployment for the given ID.
+     *
+     * @param request - The request {@link GetDeploymentRequest}
+     * @returns A Promise of Deployment
+     */
+    getDeployment: (request: Readonly<GetDeploymentRequest>) => Promise<Deployment>;
+    /**
+     * 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: Readonly<GetDeploymentRequest>, options?: Readonly<WaitForOptions<Deployment>>) => Promise<Deployment>;
+    /**
+     * 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: Readonly<CreateDeploymentRequest>) => Promise<Deployment>;
+    /**
+     * Update a deployment. Update an existing inference deployment.
+     *
+     * @param request - The request {@link UpdateDeploymentRequest}
+     * @returns A Promise of Deployment
+     */
+    updateDeployment: (request: Readonly<UpdateDeploymentRequest>) => Promise<Deployment>;
+    /**
+     * Delete a deployment. Delete an existing inference deployment.
+     *
+     * @param request - The request {@link DeleteDeploymentRequest}
+     * @returns A Promise of Deployment
+     */
+    deleteDeployment: (request: Readonly<DeleteDeploymentRequest>) => Promise<Deployment>;
+    /**
+     * 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: Readonly<GetDeploymentCertificateRequest>) => Promise<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: Readonly<CreateEndpointRequest>) => Promise<Endpoint>;
+    /**
+     * Update an endpoint. Update an existing Endpoint.
+     *
+     * @param request - The request {@link UpdateEndpointRequest}
+     * @returns A Promise of Endpoint
+     */
+    updateEndpoint: (request: Readonly<UpdateEndpointRequest>) => Promise<Endpoint>;
+    /**
+     * Delete an endpoint. Delete an existing Endpoint.
+     *
+     * @param request - The request {@link DeleteEndpointRequest}
+     */
+    deleteEndpoint: (request: Readonly<DeleteEndpointRequest>) => Promise<void>;
+    protected pageOfListDeploymentACLRules: (request: Readonly<ListDeploymentACLRulesRequest>) => Promise<ListDeploymentACLRulesResponse>;
+    /**
+     * List your ACLs. List ACLs for a specific deployment.
+     *
+     * @param request - The request {@link ListDeploymentACLRulesRequest}
+     * @returns A Promise of ListDeploymentACLRulesResponse
+     */
+    listDeploymentACLRules: (request: Readonly<ListDeploymentACLRulesRequest>) => Promise<ListDeploymentACLRulesResponse> & {
+        all: () => Promise<import("./types.gen").ACLRule[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").ACLRule[], void, void>;
+    };
+    /**
+     * Add new ACLs. Add new ACL rules for a specific deployment.
+     *
+     * @param request - The request {@link AddDeploymentACLRulesRequest}
+     * @returns A Promise of AddDeploymentACLRulesResponse
+     */
+    addDeploymentACLRules: (request: Readonly<AddDeploymentACLRulesRequest>) => Promise<AddDeploymentACLRulesResponse>;
+    /**
+     * Set new ACL. Set new ACL rules for a specific deployment.
+     *
+     * @param request - The request {@link SetDeploymentACLRulesRequest}
+     * @returns A Promise of SetDeploymentACLRulesResponse
+     */
+    setDeploymentACLRules: (request: Readonly<SetDeploymentACLRulesRequest>) => Promise<SetDeploymentACLRulesResponse>;
+    /**
+     * Delete an existing ACL.
+     *
+     * @param request - The request {@link DeleteDeploymentACLRuleRequest}
+     */
+    deleteDeploymentACLRule: (request: Readonly<DeleteDeploymentACLRuleRequest>) => Promise<void>;
+    protected pageOfListModels: (request?: Readonly<ListModelsRequest>) => Promise<ListModelsResponse>;
+    /**
+     * List models. List all available models.
+     *
+     * @param request - The request {@link ListModelsRequest}
+     * @returns A Promise of ListModelsResponse
+     */
+    listModels: (request?: Readonly<ListModelsRequest>) => Promise<ListModelsResponse> & {
+        all: () => Promise<Model[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Model[], void, void>;
+    };
+    /**
+     * Get a model. Get the model for the given ID.
+     *
+     * @param request - The request {@link GetModelRequest}
+     * @returns A Promise of Model
+     */
+    getModel: (request: Readonly<GetModelRequest>) => Promise<Model>;
+    getModelEula: (request: Readonly<GetModelEulaRequest>) => Promise<Eula>;
+    protected pageOfListNodeTypes: (request: Readonly<ListNodeTypesRequest>) => Promise<ListNodeTypesResponse>;
+    /**
+     * 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: Readonly<ListNodeTypesRequest>) => Promise<ListNodeTypesResponse> & {
+        all: () => Promise<import("./types.gen").NodeType[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").NodeType[], void, void>;
+    };
+}