Function listPrompts

  • listPrompts(
        __namedParameters: ClientFn,
    ): Promise<
        {
            description?: null
            | string;
            id: string;
            metadata?: null | { [key: string]: unknown };
            name: string;
            source_prompt_id?: null | string;
        }[],
    >

    List all prompts available to the client.

    Parameters

    Returns Promise<
        {
            description?: null
            | string;
            id: string;
            metadata?: null | { [key: string]: unknown };
            name: string;
            source_prompt_id?: null | string;
        }[],
    >

    Example

    import { listPrompts } from "@arizeai/phoenix-client/prompts";

    const prompts = await listPrompts({});
    console.log(prompts);

    Throws

    If the prompts cannot be listed or the response is invalid.

Settings

Member Visibility