Interface PostPromptSessionEntryParams

Parameters for the postPromptSessionEntry operation.

interface PostPromptSessionEntryParams {
    createdAt: number;
    description?: string;
    headers?: OutgoingHttpHeaders;
    id?: string;
    inputMode?: string;
    isTemplate?: boolean;
    name: string;
    projectId?: string;
    prompt: WatsonXAI.Prompt;
    promptVariables?: WatsonXAI.JsonObject;
    sessionId: string;
    signal?: AbortSignal;
}

Hierarchy (view full)

Properties

createdAt description? headers? id? inputMode? isTemplate? name projectId? prompt promptVariables? sessionId signal?

Properties

createdAt

createdAt: number

Time the prompt was created.

Optional description

description?: string

An optional description for the prompt.

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 isTemplate

isTemplate?: boolean

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

Optional promptVariables

promptVariables?: WatsonXAI.JsonObject

sessionId

sessionId: string

Prompt Session ID.

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

createdAtdescriptionheadersidinputModeisTemplatenameprojectIdpromptpromptVariablessessionIdsignal