Interface CreateDeploymentParams

Parameters for the createDeployment operation.

interface CreateDeploymentParams {
    asset?: WatsonXAI.Rel;
    baseDeploymentId?: string;
    baseModelId?: string;
    custom?: WatsonXAI.JsonObject;
    description?: string;
    hardwareRequest?: WatsonXAI.HardwareRequest;
    hardwareSpec?: WatsonXAI.HardwareSpec;
    headers?: OutgoingHttpHeaders;
    name: string;
    online: WatsonXAI.OnlineDeployment;
    projectId?: string;
    promptTemplate?: WatsonXAI.SimpleRel;
    signal?: AbortSignal;
    spaceId?: string;
    tags?: string[];
}

Hierarchy (view full)

Properties

asset? baseDeploymentId? baseModelId? custom? description? hardwareRequest? hardwareSpec? headers? name online projectId? promptTemplate? signal? spaceId? tags?

Properties

Optional asset

asset?: WatsonXAI.Rel

A reference to a resource.

Optional baseDeploymentId

baseDeploymentId?: string

The base deployment when this is a custom foundation model with a prompt template. The id must be the id of the custom foundation model deployment.

Optional baseModelId

baseModelId?: 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 description

description?: string

A description of the resource.

Optional hardwareRequest

hardwareRequest?: WatsonXAI.HardwareRequest

The requested hardware for deployment.

Optional hardwareSpec

hardwareSpec?: WatsonXAI.HardwareSpec

A hardware specification.

Optional headers

headers?: OutgoingHttpHeaders

name

name: string

The name of the resource.

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 projectId

projectId?: string

The project that contains the resource. Either space_id or project_id has to be given.

Optional promptTemplate

promptTemplate?: WatsonXAI.SimpleRel

A reference to a resource.

Optional signal

signal?: AbortSignal

Optional spaceId

spaceId?: string

The space that contains the resource. Either space_id or project_id has to be given.

Optional tags

tags?: string[]

A list of tags for this resource.

Settings

Member Visibility

Theme

On This Page

assetbaseDeploymentIdbaseModelIdcustomdescriptionhardwareRequesthardwareSpecheadersnameonlineprojectIdpromptTemplatesignalspaceIdtags