@scaleway/sdk 2.26.0 → 2.28.0

package/dist/api/lb/v1/types.utils.d.ts

@@ -0,0 +1,13 @@
+import type { Region, Zone } from '../../../scw/locality';
+export type WaitForLbPrivateNetworksRequest = {
+    /** Region to target. If none is passed will use default region from the config */
+    region?: Region;
+    /** Load balancer ID */
+    lbId: string;
+};
+export type ZonedWaitForLbPrivateNetworksRequest = {
+    /** Zone to target. If none is passed will use default zone from the config */
+    zone?: Zone;
+    /** Load balancer ID */
+    lbId: string;
+};

package/dist/api/llm_inference/index.cjs

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

package/dist/api/llm_inference/index.d.ts

@@ -0,0 +1 @@
+export * as v1beta1 from './v1beta1/index.gen';

package/dist/api/llm_inference/index.js

@@ -1,2 +1,4 @@
-import * as index_gen from './v1beta1/index.gen.js';
-export { index_gen as v1beta1 };
+import * as index_gen from "./v1beta1/index.gen.js";
+export {
+  index_gen as v1beta1
+};

package/dist/api/llm_inference/v1beta1/api.gen.cjs

@@ -0,0 +1,305 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const intervalRetrier = require("../../../internal/async/interval-retrier.cjs");
+const api = require("../../../scw/api.cjs");
+const marshalling = require("../../../helpers/marshalling.cjs");
+const resourcePaginator = require("../../../scw/fetch/resource-paginator.cjs");
+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 api.API {
+  /** Lists the available regions of the API. */
+  static LOCALITIES = ["fr-par"];
+  pageOfListDeployments = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/llm-inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments`,
+      urlParams: marshalling.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 = {}) => resourcePaginator.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: `/llm-inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${marshalling.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) => intervalRetrier.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: `/llm-inference/v1beta1/regions/${marshalling.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: `/llm-inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${marshalling.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: `/llm-inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${marshalling.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: `/llm-inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${marshalling.validatePathParam("deploymentId", request.deploymentId)}/certificate`,
+    urlParams: marshalling.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: `/llm-inference/v1beta1/regions/${marshalling.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: `/llm-inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${marshalling.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: `/llm-inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${marshalling.validatePathParam("endpointId", request.endpointId)}`
+  });
+  pageOfListDeploymentACLRules = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/llm-inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${marshalling.validatePathParam("deploymentId", request.deploymentId)}/acls`,
+      urlParams: marshalling.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) => resourcePaginator.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: `/llm-inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${marshalling.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: `/llm-inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${marshalling.validatePathParam("deploymentId", request.deploymentId)}/acls`
+    },
+    marshalling_gen.unmarshalSetDeploymentACLRulesResponse
+  );
+  /**
+   * Delete an exising ACL.
+   *
+   * @param request - The request {@link DeleteDeploymentACLRuleRequest}
+   */
+  deleteDeploymentACLRule = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/llm-inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/acls/${marshalling.validatePathParam("aclId", request.aclId)}`
+  });
+  pageOfListModels = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/llm-inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/models`,
+      urlParams: marshalling.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 LLM models.
+   *
+   * @param request - The request {@link ListModelsRequest}
+   * @returns A Promise of ListModelsResponse
+   */
+  listModels = (request = {}) => resourcePaginator.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: `/llm-inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/models/${marshalling.validatePathParam("modelId", request.modelId)}`
+    },
+    marshalling_gen.unmarshalModel
+  );
+  getModelEula = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/llm-inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/models/${marshalling.validatePathParam("modelId", request.modelId)}/eula`
+    },
+    marshalling_gen.unmarshalEula
+  );
+  pageOfListNodeTypes = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/llm-inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/node-types`,
+      urlParams: marshalling.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) => resourcePaginator.enrichForPagination("nodeTypes", this.pageOfListNodeTypes, request);
+}
+exports.API = API;

package/dist/api/llm_inference/v1beta1/api.gen.d.ts

@@ -0,0 +1,151 @@
+import { API as ParentAPI } from '../../../bridge';
+import type { Region, WaitForOptions } from '../../../bridge';
+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';
+/**
+ * LLM Inference API.
+ *
+ * This API allows you to manage your LLM Inference services.
+ */
+export declare class API extends ParentAPI {
+    /** Lists the available regions of the API. */
+    static readonly LOCALITIES: Region[];
+    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 exising 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 LLM 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>;
+    };
+}