@arizeai/phoenix-client
Version:
A client for the Phoenix API
119 lines • 5.02 kB
JavaScript
import invariant from "tiny-invariant";
import { safelyConvertMessageToProvider, safelyConvertToolChoiceToProvider, safelyConvertToolDefinitionToProvider, } from "../../schemas/llm/converters.js";
import { phoenixResponseFormatToOpenAI } from "../../schemas/llm/phoenixPrompt/converters.js";
import { isPromptToolRaw } from "../../types/prompts.js";
import { formatPromptMessages } from "../../utils/formatPromptMessages.js";
/**
* Convert a Phoenix prompt to OpenAI client sdk's chat completion parameters
*
* @returns The converted chat completion parameters
*/
export const toOpenAI = ({ prompt, variables, }) => {
try {
let invocationParameters;
switch (prompt.invocation_parameters.type) {
case "openai":
invocationParameters = prompt.invocation_parameters.openai;
break;
case "azure_openai":
invocationParameters = prompt.invocation_parameters.azure_openai;
break;
case "deepseek":
invocationParameters = prompt.invocation_parameters.deepseek;
break;
case "xai":
invocationParameters = prompt.invocation_parameters.xai;
break;
case "ollama":
invocationParameters = prompt.invocation_parameters.ollama;
break;
case "cerebras":
invocationParameters = prompt.invocation_parameters.cerebras;
break;
case "fireworks":
invocationParameters = prompt.invocation_parameters.fireworks;
break;
case "groq":
invocationParameters = prompt.invocation_parameters.groq;
break;
case "moonshot":
invocationParameters = prompt.invocation_parameters.moonshot;
break;
case "perplexity":
invocationParameters = prompt.invocation_parameters.perplexity;
break;
case "together":
invocationParameters = prompt.invocation_parameters.together;
break;
default:
// eslint-disable-next-line no-console
console.warn("Prompt is not an OpenAI-family prompt, falling back to default OpenAI invocation parameters");
invocationParameters = {};
break;
}
// parts of the prompt that can be directly converted to OpenAI params
const baseCompletionParams = {
model: prompt.model_name,
// Invocation parameters are validated on the phoenix-side
...invocationParameters,
};
if (!("messages" in prompt.template)) {
return null;
}
let formattedMessages = prompt.template.messages;
if (variables) {
formattedMessages = formatPromptMessages(prompt.template_format, formattedMessages, variables);
}
const messages = formattedMessages.map((message) => {
const openAIMessage = safelyConvertMessageToProvider({
message,
targetProvider: "OPENAI",
});
invariant(openAIMessage, "Message is not valid");
return openAIMessage;
});
const toolsList = prompt.tools?.tools ?? [];
// Cast: raw tools are `Record<string, unknown>` straight from the prompt
// store. We trust the upstream caller to have stored a shape OpenAI's
// SDK accepts; no validation here.
const tools = toolsList.length === 0
? undefined
: toolsList.map((tool) => {
if (isPromptToolRaw(tool)) {
return tool.raw;
}
const openAIToolDefinition = safelyConvertToolDefinitionToProvider({
toolDefinition: tool,
targetProvider: "OPENAI",
});
invariant(openAIToolDefinition, "Tool definition is not valid");
return openAIToolDefinition;
});
const tool_choice = tools
? (safelyConvertToolChoiceToProvider({
toolChoice: prompt?.tools?.tool_choice,
targetProvider: "OPENAI",
}) ?? undefined)
: undefined;
const response_format = prompt.response_format
? phoenixResponseFormatToOpenAI.parse(prompt.response_format)
: undefined;
// combine base and computed params
const completionParams = {
...baseCompletionParams,
messages,
tools,
tool_choice,
response_format,
};
return completionParams;
}
catch (e) {
// eslint-disable-next-line no-console
console.warn(`Failed to convert prompt to OpenAI params`);
// eslint-disable-next-line no-console
console.error(e);
return null;
}
};
//# sourceMappingURL=toOpenAI.js.map