Interface PatchPromptParams

Parameters for the patchPrompt operation.

interface PatchPromptParams {
    description?: string;
    governanceTracked?: boolean;
    headers?: OutgoingHttpHeaders;
    id?: string;
    inputMode?: string;
    modelVersion?: WatsonXAI.WxPromptPatchModelVersion;
    name: string;
    projectId?: string;
    prompt: WatsonXAI.Prompt;
    promptId: string;
    promptVariables?: WatsonXAI.JsonObject;
    signal?: AbortSignal;
    spaceId?: string;
    taskIds?: string[];
}

Hierarchy

  • DefaultParams
    • PatchPromptParams

Properties

description? governanceTracked? headers? id? inputMode? modelVersion? name projectId? prompt promptId promptVariables? signal? spaceId? taskIds?

Properties

Optional description

description?: string

An optional description for the prompt.

Optional governanceTracked

governanceTracked?: boolean

Optional headers

headers?: OutgoingHttpHeaders

Optional id

id?: string

The prompt's id. This value cannot be set. It is returned in responses only.

Optional inputMode

inputMode?: string

Input mode in use for the prompt.

Optional modelVersion

modelVersion?: WatsonXAI.WxPromptPatchModelVersion

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

promptId

promptId: string

Prompt ID.

Optional promptVariables

promptVariables?: WatsonXAI.JsonObject

Optional signal

signal?: AbortSignal

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

descriptiongovernanceTrackedheadersidinputModemodelVersionnameprojectIdpromptpromptIdpromptVariablessignalspaceIdtaskIds