Class API

constructor

• new API(client: Client): Inference.v1.API

• Parameters

  • client: Client

  Returns Inference.v1.API

Static ReadonlyLOCALITIES

createDeployment

• createDeployment(
      request: Readonly<Inference.v1.CreateDeploymentRequest>,
  ): Promise<Inference.v1.Deployment>

• Create a deployment. Create a new inference deployment related to a specific model.

  Parameters

  • request: Readonly<Inference.v1.CreateDeploymentRequest>

    The request CreateDeploymentRequest

  Returns Promise<Inference.v1.Deployment>

  A Promise of Deployment

createEndpoint

• createEndpoint(
      request: Readonly<Inference.v1.CreateEndpointRequest>,
  ): Promise<Inference.v1.Endpoint>

• Create an endpoint. Create a new Endpoint related to a specific deployment.

  Parameters

  • request: Readonly<Inference.v1.CreateEndpointRequest>

    The request CreateEndpointRequest

  Returns Promise<Inference.v1.Endpoint>

  A Promise of Endpoint

createModel

• createModel(
      request: Readonly<Inference.v1.CreateModelRequest>,
  ): Promise<Inference.v1.Model>

• Import a model. Import a new model to your model library.

  Parameters

  • request: Readonly<Inference.v1.CreateModelRequest>

    The request CreateModelRequest

  Returns Promise<Inference.v1.Model>

  A Promise of Model

deleteDeployment

• deleteDeployment(
      request: Readonly<Inference.v1.DeleteDeploymentRequest>,
  ): Promise<Inference.v1.Deployment>

• Delete a deployment. Delete an existing inference deployment.

  Parameters

  • request: Readonly<Inference.v1.DeleteDeploymentRequest>

    The request DeleteDeploymentRequest

  Returns Promise<Inference.v1.Deployment>

  A Promise of Deployment

deleteEndpoint

• deleteEndpoint(
      request: Readonly<Inference.v1.DeleteEndpointRequest>,
  ): Promise<void>

• Delete an endpoint. Delete an existing Endpoint.

  Parameters

  • request: Readonly<Inference.v1.DeleteEndpointRequest>

    The request DeleteEndpointRequest

  Returns Promise<void>

deleteModel

• deleteModel(request: Readonly<DeleteModelRequest>): Promise<void>

• Delete a model. Delete an existing model from your model library.

  Parameters

  • request: Readonly<DeleteModelRequest>

    The request DeleteModelRequest

  Returns Promise<void>

getDeployment

• getDeployment(
      request: Readonly<Inference.v1.GetDeploymentRequest>,
  ): Promise<Inference.v1.Deployment>

• Get a deployment. Get the deployment for the given ID.

  Parameters

  • request: Readonly<Inference.v1.GetDeploymentRequest>

    The request GetDeploymentRequest

  Returns Promise<Inference.v1.Deployment>

  A Promise of Deployment

getDeploymentCertificate

• getDeploymentCertificate(
      request: Readonly<Inference.v1.GetDeploymentCertificateRequest>,
  ): Promise<Blob>

• 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.

  Parameters

  • request: Readonly<Inference.v1.GetDeploymentCertificateRequest>

    The request GetDeploymentCertificateRequest

  Returns Promise<Blob>

  A Promise of Blob

getModel

• getModel(
      request: Readonly<Inference.v1.GetModelRequest>,
  ): Promise<Inference.v1.Model>

• Get a model. Get the model for the given ID.

  Parameters

  • request: Readonly<Inference.v1.GetModelRequest>

    The request GetModelRequest

  Returns Promise<Inference.v1.Model>

  A Promise of Model

listDeployments

• listDeployments(
      request?: Readonly<Inference.v1.ListDeploymentsRequest>,
  ): Promise<Inference.v1.ListDeploymentsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Inference.v1.Deployment[],
          void,
          void,
      >;
      all: () => Promise<Inference.v1.Deployment[]>;
  }

• List inference deployments. List all your inference deployments.

  Parameters

  • request: Readonly<Inference.v1.ListDeploymentsRequest> = {}

    The request ListDeploymentsRequest

  Returns Promise<Inference.v1.ListDeploymentsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Inference.v1.Deployment[],
          void,
          void,
      >;
      all: () => Promise<Inference.v1.Deployment[]>;
  }

  A Promise of ListDeploymentsResponse

listModels

• listModels(
      request?: Readonly<Inference.v1.ListModelsRequest>,
  ): Promise<Inference.v1.ListModelsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Inference.v1.Model[],
          void,
          void,
      >;
      all: () => Promise<Inference.v1.Model[]>;
  }

• List models. List all available models.

  Parameters

  • request: Readonly<Inference.v1.ListModelsRequest> = {}

    The request ListModelsRequest

  Returns Promise<Inference.v1.ListModelsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Inference.v1.Model[],
          void,
          void,
      >;
      all: () => Promise<Inference.v1.Model[]>;
  }

  A Promise of ListModelsResponse

listNodeTypes

• listNodeTypes(
      request: Readonly<Inference.v1.ListNodeTypesRequest>,
  ): Promise<Inference.v1.ListNodeTypesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Inference.v1.NodeType[],
          void,
          void,
      >;
      all: () => Promise<Inference.v1.NodeType[]>;
  }

• 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.

  Parameters

  • request: Readonly<Inference.v1.ListNodeTypesRequest>

    The request ListNodeTypesRequest

  Returns Promise<Inference.v1.ListNodeTypesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Inference.v1.NodeType[],
          void,
          void,
      >;
      all: () => Promise<Inference.v1.NodeType[]>;
  }

  A Promise of ListNodeTypesResponse

updateDeployment

• updateDeployment(
      request: Readonly<Inference.v1.UpdateDeploymentRequest>,
  ): Promise<Inference.v1.Deployment>

• Update a deployment. Update an existing inference deployment.

  Parameters

  • request: Readonly<Inference.v1.UpdateDeploymentRequest>

    The request UpdateDeploymentRequest

  Returns Promise<Inference.v1.Deployment>

  A Promise of Deployment

updateEndpoint

• updateEndpoint(
      request: Readonly<Inference.v1.UpdateEndpointRequest>,
  ): Promise<Inference.v1.Endpoint>

• Update an endpoint. Update an existing Endpoint.

  Parameters

  • request: Readonly<Inference.v1.UpdateEndpointRequest>

    The request UpdateEndpointRequest

  Returns Promise<Inference.v1.Endpoint>

  A Promise of Endpoint

waitForDeployment

• waitForDeployment(
      request: Readonly<Inference.v1.GetDeploymentRequest>,
      options?: Readonly<WaitForOptions<Inference.v1.Deployment>>,
  ): Promise<Inference.v1.Deployment>

• Waits for Deployment to be in a final state.

  Parameters

  • request: Readonly<Inference.v1.GetDeploymentRequest>

    The request GetDeploymentRequest
  • Optionaloptions: Readonly<WaitForOptions<Inference.v1.Deployment>>

    The waiting options

  Returns Promise<Inference.v1.Deployment>

  A Promise of Deployment

waitForModel

• waitForModel(
      request: Readonly<Inference.v1.GetModelRequest>,
      options?: Readonly<WaitForOptions<Inference.v1.Model>>,
  ): Promise<Inference.v1.Model>

• Waits for Model to be in a final state.

  Parameters

  • request: Readonly<Inference.v1.GetModelRequest>

    The request GetModelRequest
  • Optionaloptions: Readonly<WaitForOptions<Inference.v1.Model>>

    The waiting options

  Returns Promise<Inference.v1.Model>

  A Promise of Model