Interface Prompts

interface Prompts {
    clearPromptCache(options?: ClearPromptCacheOptions): void;
    createPrompt(
        promptId: string,
        template: string | PromptTemplateItem[],
        options?: CreatePromptOptions,
    ): Promise<PromptResponse>;
    createPromptVersion(
        promptId: string,
        template: string | PromptTemplateItem[],
        options?: CreatePromptVersionOptions,
    ): Promise<PromptVersionResponse>;
    deletePrompt(promptId: string): Promise<DeletedPromptResponse>;
    getPrompt(
        promptId: string,
        options?: GetPromptOptions,
    ): Promise<ManagedPrompt>;
    listPrompts(): Promise<PromptResponse[]>;
    listPromptVersions(promptId: string): Promise<PromptVersionResponse[]>;
    refreshPrompt(promptId: string): Promise<ManagedPrompt | undefined>;
    updatePrompt(
        promptId: string,
        options: UpdatePromptOptions,
    ): Promise<PromptResponse>;
    updatePromptVersion(
        promptId: string,
        version: number,
        options: UpdatePromptVersionOptions,
    ): Promise<PromptVersionResponse>;
}

Index

Methods

clearPromptCache createPrompt createPromptVersion deletePrompt getPrompt listPrompts listPromptVersions refreshPrompt updatePrompt updatePromptVersion

Methods

clearPromptCache

clearPromptCache(options?: ClearPromptCacheOptions): void
Clear the in-memory and/or persistent prompt caches.
Parameters
- Optionaloptions: ClearPromptCacheOptions
Returns void
- Defined in index.d.ts:3886

createPrompt

createPrompt(
    promptId: string,
    template: string | PromptTemplateItem[],
    options?: CreatePromptOptions,
): Promise<PromptResponse>
Create a text or chat prompt and its first version.
Parameters
- promptId: string
- template: string | PromptTemplateItem[]
- Optionaloptions: CreatePromptOptions
Returns Promise<PromptResponse>
- Defined in index.d.ts:3888

createPromptVersion

createPromptVersion(
    promptId: string,
    template: string | PromptTemplateItem[],
    options?: CreatePromptVersionOptions,
): Promise<PromptVersionResponse>
Add a text or chat version to an existing prompt.
Parameters
- promptId: string
- template: string | PromptTemplateItem[]
- Optionaloptions: CreatePromptVersionOptions
Returns Promise<PromptVersionResponse>
- Defined in index.d.ts:3894

deletePrompt

deletePrompt(promptId: string): Promise<DeletedPromptResponse>
Delete a prompt.
Parameters
- promptId: string
Returns Promise<DeletedPromptResponse>
- Defined in index.d.ts:3908

getPrompt

getPrompt(promptId: string, options?: GetPromptOptions): Promise<ManagedPrompt>
Resolve an exact, environment-targeted, or latest managed prompt.
Parameters
- promptId: string
- Optionaloptions: GetPromptOptions
Returns Promise<ManagedPrompt>
- Defined in index.d.ts:3882

listPrompts

listPrompts(): Promise<PromptResponse[]>
List prompts.

Returns Promise<PromptResponse[]>
- Defined in index.d.ts:3910

listPromptVersions

listPromptVersions(promptId: string): Promise<PromptVersionResponse[]>
List versions for a prompt.
Parameters
- promptId: string
Returns Promise<PromptVersionResponse[]>
- Defined in index.d.ts:3912

refreshPrompt

refreshPrompt(promptId: string): Promise<ManagedPrompt | undefined>
Refresh the prompt selected by the current environment.
Parameters
- promptId: string
Returns Promise<ManagedPrompt | undefined>
- Defined in index.d.ts:3884

updatePrompt

updatePrompt(
promptId: string,
options: UpdatePromptOptions,
): Promise<PromptResponse>
Update prompt metadata.
Parameters
- promptId: string
- options: UpdatePromptOptions
Returns Promise<PromptResponse>
- Defined in index.d.ts:3900

updatePromptVersion

updatePromptVersion(
    promptId: string,
    version: number,
    options: UpdatePromptVersionOptions,
): Promise<PromptVersionResponse>
Update prompt-version metadata or environment assignments.
Parameters
- promptId: string
- version: number
- options: UpdatePromptVersionOptions
Returns Promise<PromptVersionResponse>
- Defined in index.d.ts:3902