@arizeai/phoenix-client
Version:
A client for the Phoenix API
35 lines • 2.6 kB
TypeScript
import { ClientFn } from "../types/core";
import { PromptSelector } from "../types/prompts";
/**
* Parameters for the getPromptBySelector function
*/
export type GetPromptBySelectorParams = 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.
*
* if the input is a prompt id, fetch the latest prompt version from the client.
* if the input is a prompt version id, fetch that prompt version.
* if the input is a prompt tag and name, fetch the prompt version that has that tag and name.
* if the input is a prompt name, fetch the latest prompt version from the client.
*
* @param params - The parameters to get a prompt.
* @returns The nearest prompt version that matches the selector, or null if it does not exist.
*/
export declare function getPromptBySelector({ client: _client, prompt, }: GetPromptBySelectorParams): Promise<{
description?: string | null;
model_provider: import("../__generated__/api/v1").components["schemas"]["ModelProvider"];
model_name: string;
template: import("../__generated__/api/v1").components["schemas"]["PromptChatTemplate"] | import("../__generated__/api/v1").components["schemas"]["PromptStringTemplate"];
template_type: import("../__generated__/api/v1").components["schemas"]["PromptTemplateType"];
template_format: import("../__generated__/api/v1").components["schemas"]["PromptTemplateFormat"];
invocation_parameters: import("../__generated__/api/v1").components["schemas"]["PromptOpenAIInvocationParameters"] | import("../__generated__/api/v1").components["schemas"]["PromptAzureOpenAIInvocationParameters"] | import("../__generated__/api/v1").components["schemas"]["PromptAnthropicInvocationParameters"] | import("../__generated__/api/v1").components["schemas"]["PromptGoogleInvocationParameters"] | import("../__generated__/api/v1").components["schemas"]["PromptDeepSeekInvocationParameters"] | import("../__generated__/api/v1").components["schemas"]["PromptXAIInvocationParameters"] | import("../__generated__/api/v1").components["schemas"]["PromptOllamaInvocationParameters"] | import("../__generated__/api/v1").components["schemas"]["PromptAwsInvocationParameters"];
tools?: import("../__generated__/api/v1").components["schemas"]["PromptTools"] | null;
response_format?: import("../__generated__/api/v1").components["schemas"]["PromptResponseFormatJSONSchema"] | null;
id: string;
} | null>;
//# sourceMappingURL=getPromptBySelector.d.ts.map