@arizeai/phoenix-client
Version:
A client for the Phoenix API
19 lines • 713 B
TypeScript
import { ClientFn } from "../types/core.js";
import { PromptSelector, PromptVersion } from "../types/prompts.js";
/**
* Parameters for getting a prompt from Phoenix.
*/
export interface GetPromptParams extends ClientFn {
/**
* The prompt to get. Can be in the form of a prompt id, a prompt version id, a prompt name, or a prompt name + tag.
*/
prompt: PromptSelector;
}
/**
* Get a prompt from the Phoenix API.
*
* @param params - The parameters to get a prompt.
* @returns The prompt version, or null if it does not exist.
*/
export declare function getPrompt({ client: _client, prompt: _prompt, }: GetPromptParams): Promise<PromptVersion | null>;
//# sourceMappingURL=getPrompt.d.ts.map