parser.d.ts 3.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. import { ChatCompletion, ChatCompletionCreateParams, ChatCompletionCreateParamsBase, ChatCompletionFunctionTool, ChatCompletionMessage, ChatCompletionMessageFunctionToolCall, ChatCompletionStreamingToolRunnerParams, ChatCompletionStreamParams, ChatCompletionToolRunnerParams, ParsedChatCompletion } from "../resources/chat/completions.js";
  2. import { type ResponseFormatTextJSONSchemaConfig } from "../resources/responses/responses.js";
  3. import { ResponseFormatJSONSchema } from "../resources/shared.js";
  4. type AnyChatCompletionCreateParams = ChatCompletionCreateParams | ChatCompletionToolRunnerParams<any> | ChatCompletionStreamingToolRunnerParams<any> | ChatCompletionStreamParams;
  5. type Unpacked<T> = T extends (infer U)[] ? U : T;
  6. type ToolCall = Unpacked<ChatCompletionCreateParamsBase['tools']>;
  7. export declare function isChatCompletionFunctionTool(tool: ToolCall): tool is ChatCompletionFunctionTool;
  8. export type ExtractParsedContentFromParams<Params extends AnyChatCompletionCreateParams> = Params['response_format'] extends AutoParseableResponseFormat<infer P> ? P : null;
  9. export type AutoParseableResponseFormat<ParsedT> = ResponseFormatJSONSchema & {
  10. __output: ParsedT;
  11. $brand: 'auto-parseable-response-format';
  12. $parseRaw(content: string): ParsedT;
  13. };
  14. export declare function makeParseableResponseFormat<ParsedT>(response_format: ResponseFormatJSONSchema, parser: (content: string) => ParsedT): AutoParseableResponseFormat<ParsedT>;
  15. export type AutoParseableTextFormat<ParsedT> = ResponseFormatTextJSONSchemaConfig & {
  16. __output: ParsedT;
  17. $brand: 'auto-parseable-response-format';
  18. $parseRaw(content: string): ParsedT;
  19. };
  20. export declare function makeParseableTextFormat<ParsedT>(response_format: ResponseFormatTextJSONSchemaConfig, parser: (content: string) => ParsedT): AutoParseableTextFormat<ParsedT>;
  21. export declare function isAutoParsableResponseFormat<ParsedT>(response_format: any): response_format is AutoParseableResponseFormat<ParsedT>;
  22. type ToolOptions = {
  23. name: string;
  24. arguments: any;
  25. function?: ((args: any) => any) | undefined;
  26. };
  27. export type AutoParseableTool<OptionsT extends ToolOptions, HasFunction = OptionsT['function'] extends Function ? true : false> = ChatCompletionFunctionTool & {
  28. __arguments: OptionsT['arguments'];
  29. __name: OptionsT['name'];
  30. __hasFunction: HasFunction;
  31. $brand: 'auto-parseable-tool';
  32. $callback: ((args: OptionsT['arguments']) => any) | undefined;
  33. $parseRaw(args: string): OptionsT['arguments'];
  34. };
  35. export declare function makeParseableTool<OptionsT extends ToolOptions>(tool: ChatCompletionFunctionTool, { parser, callback, }: {
  36. parser: (content: string) => OptionsT['arguments'];
  37. callback: ((args: any) => any) | undefined;
  38. }): AutoParseableTool<OptionsT['arguments']>;
  39. export declare function isAutoParsableTool(tool: any): tool is AutoParseableTool<any>;
  40. export declare function maybeParseChatCompletion<Params extends ChatCompletionCreateParams | null, ParsedT = Params extends null ? null : ExtractParsedContentFromParams<NonNullable<Params>>>(completion: ChatCompletion, params: Params): ParsedChatCompletion<ParsedT>;
  41. export declare function parseChatCompletion<Params extends ChatCompletionCreateParams, ParsedT = ExtractParsedContentFromParams<Params>>(completion: ChatCompletion, params: Params): ParsedChatCompletion<ParsedT>;
  42. export declare function shouldParseToolCall(params: ChatCompletionCreateParams | null | undefined, toolCall: ChatCompletionMessageFunctionToolCall): boolean;
  43. export declare function hasAutoParseableInput(params: AnyChatCompletionCreateParams): boolean;
  44. export declare function assertToolCallsAreChatCompletionFunctionToolCalls(toolCalls: ChatCompletionMessage['tool_calls']): asserts toolCalls is ChatCompletionMessageFunctionToolCall[];
  45. export declare function validateInputTools(tools: ChatCompletionCreateParamsBase['tools']): void;
  46. export {};
  47. //# sourceMappingURL=parser.d.ts.map