Interface DeploymentEntity

The definition of the deployment.

interface DeploymentEntity {
    asset?: WatsonXAI.ModelRel;
    base_model_id?: string;
    custom?: WatsonXAI.JsonObject;
    deployed_asset_type?: string;
    hardware_request?: WatsonXAI.HardwareRequest;
    hardware_spec?: WatsonXAI.HardwareSpec;
    online: WatsonXAI.OnlineDeployment;
    prompt_template?: WatsonXAI.SimpleRel;
    status?: WatsonXAI.DeploymentStatus;
    verbalizer?: string;
}

Properties

asset? base_model_id? custom? deployed_asset_type? hardware_request? hardware_spec? online prompt_template? status? verbalizer?

Properties

Optional asset

asset?: WatsonXAI.ModelRel

A reference to a resource.

Optional base_model_id

base_model_id?: string

The base model that is required for this deployment if this is for a prompt template or a prompt tune for an IBM foundation model.

Optional custom

custom?: WatsonXAI.JsonObject

User defined properties specified as key-value pairs.

Optional deployed_asset_type

deployed_asset_type?: string

The type of the deployed model. The possible values are the following:

  1. prompt_tune - when a prompt tuned model is deployed.

  2. foundation_model - when a prompt template is used on a pre-deployed IBM provided model.

  3. custom_foundation_model - when a custom foundation model is deployed.

Optional hardware_request

hardware_request?: WatsonXAI.HardwareRequest

The requested hardware for deployment.

Optional hardware_spec

hardware_spec?: WatsonXAI.HardwareSpec

A hardware specification.

online

online: WatsonXAI.OnlineDeployment

Indicates that this is an online deployment. An object has to be specified but can be empty. The serving_name can be provided in the online.parameters.

Optional prompt_template

prompt_template?: WatsonXAI.SimpleRel

A reference to a resource.

Optional status

status?: WatsonXAI.DeploymentStatus

Specifies the current status, additional information about the deployment and any failure messages in case of deployment failures.

Optional verbalizer

verbalizer?: string

The verbalizer that was used to train this model if the deployment has deployed_asset_type of prompt_tune.

Settings

Member Visibility

Theme

On This Page

assetbase_model_idcustomdeployed_asset_typehardware_requesthardware_speconlineprompt_templatestatusverbalizer