Interface GetPromptInputParams

Parameters for the getPromptInput operation.

interface GetPromptInputParams {
    headers?: OutgoingHttpHeaders;
    input?: string;
    projectId?: string;
    promptId: string;
    promptVariables?: WatsonXAI.JsonObject;
    spaceId?: string;
}

Properties

headers? input? projectId? promptId promptVariables? spaceId?

Properties

Optional headers

headers?: OutgoingHttpHeaders

Optional input

input?: string

Override input string that will be used to generate the response. The string can contain template parameters.

Optional projectId

projectId?: string

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

promptId

promptId: string

Prompt ID.

Optional promptVariables

promptVariables?: WatsonXAI.JsonObject

Supply only to replace placeholders. Object content must be key:value pairs where the 'key' is the parameter to replace and 'value' is the value to use.

Optional spaceId

spaceId?: string

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

Settings

Member Visibility

Theme

On This Page

headersinputprojectIdpromptIdpromptVariablesspaceId