prompt

Functions

addPrompt

addPrompt(prompt: PromptCreateDTO, options?: { account?: Account }): Promise<TestPromptDTO>

Add new prompt

Parameters:

NameType
promptPromptCreateDTO
options?object
options.account?Account

Returns: Promise<TestPromptDTO>

the properties of a newly-created prompt


addPromptVersion

addPromptVersion(promptId: string, version: PromptVersionCreateDTO, options?: { account?: Account }): Promise<PromptVersionDTO>

Add new prompt version

Parameters:

NameType
promptIdstring
versionPromptVersionCreateDTO
options?object
options.account?Account

Returns: Promise<PromptVersionDTO>

the properties of a newly-created prompt


deletePrompt

deletePrompt(promptId: string, options?: { account?: Account }): Promise<TestPromptDTO>

Delete prompt

Parameters:

NameType
promptIdstring
options?object
options.account?Account

Returns: Promise<TestPromptDTO>

deleted entry


deletePromptVersion

deletePromptVersion(versionId: string, options?: { account?: Account }): Promise<PromptVersionDTO>

Delete prompt version

Parameters:

NameType
versionIdstring
options?object
options.account?Account

Returns: Promise<PromptVersionDTO>

deleted entry


getPrompt

getPrompt(id: string, options?: { account?: Account }): Promise<TestPromptDTO>

Add new prompt

Parameters:

NameType
idstring
options?object
options.account?Account

Returns: Promise<TestPromptDTO>

the properties of a newly-created prompt


listPromptVersions

listPromptVersions(promptId: string, skip?: number, take?: number, options?: { account?: Account }): Promise<PromptVersionDTO[]>

List prompt versions

Parameters:

NameType
promptIdstring
skip?number
take?number
options?object
options.account?Account

Returns: Promise<PromptVersionDTO[]>

list of prompt version with options


listPrompts

listPrompts(skip?: number, take?: number, options?: { account?: Account }): Promise<TestPromptDTO[]>

List prompts

Parameters:

NameType
skip?number
take?number
options?object
options.account?Account

Returns: Promise<TestPromptDTO[]>

list of prompts with options


updatePrompt

updatePrompt(promptId: string, dto: PromptPatchDTO, options?: { account?: Account }): Promise<TestPromptDTO>

Delete prompt

Parameters:

NameType
promptIdstring
dtoPromptPatchDTO
options?object
options.account?Account

Returns: Promise<TestPromptDTO>

deleted entry

Found a mistake? Let us know.

Enroll in beta

Request invite to our private Beta program for developers to join the waitlist. No spam, we promise.