Interface PostPromptParams

Parameters for the postPrompt operation.

interface PostPromptParams {
    createdAt?: number;
    description?: string;
    headers?: OutgoingHttpHeaders;
    inputMode?: string;
    lock?: WatsonXAI.PromptLock;
    modelVersion?: WatsonXAI.WxPromptPostModelVersion;
    name: string;
    projectId?: string;
    prompt: WatsonXAI.PromptWithExternal;
    promptVariables?: WatsonXAI.JsonObject;
    spaceId?: string;
    taskIds?: string[];
}

Properties

createdAt? description? headers? inputMode? lock? modelVersion? name projectId? prompt promptVariables? spaceId? taskIds?

Properties

Optional createdAt

createdAt?: number

Time the prompt was created.

Optional description

description?: string

An optional description for the prompt.

Optional headers

headers?: OutgoingHttpHeaders

Optional inputMode

inputMode?: string

Input mode in use for the prompt.

Optional lock

lock?: WatsonXAI.PromptLock

Optional modelVersion

modelVersion?: WatsonXAI.WxPromptPostModelVersion

name

name: string

Name used to display the prompt.

Optional projectId

projectId?: string

[REQUIRED] Specifies the project ID as the target. One target must be supplied per request.

prompt

prompt: WatsonXAI.PromptWithExternal

Optional promptVariables

promptVariables?: WatsonXAI.JsonObject

Optional spaceId

spaceId?: string

[REQUIRED] Specifies the space ID as the target. One target must be supplied per request.

Optional taskIds

taskIds?: string[]

Settings

Member Visibility

Theme

On This Page

createdAtdescriptionheadersinputModelockmodelVersionnameprojectIdpromptpromptVariablesspaceIdtaskIds