promptlayer 1.0.60 → 1.1.0

package/dist/index.d.ts

@@ -42,14 +42,49 @@ interface GetPromptTemplateParams {
 }
 declare const templateFormat: readonly ["f-string", "jinja2"];
 type TemplateFormat = (typeof templateFormat)[number];
+type FileAnnotation = {
+    type: "file_citation";
+    index: number;
+    file_id: string;
+    filename: string;
+};
+type WebAnnotation = {
+    type: "url_citation";
+    title: string;
+    url: string;
+    start_index: number;
+    end_index: number;
+    cited_text?: string;
+    encrypted_index?: string;
+};
+type MapAnnotation = {
+    type: "map_citation";
+    title: string;
+    url: string;
+    place_id?: string;
+    start_index: number;
+    end_index: number;
+    cited_text?: string;
+};
+type ContainerFileAnnotation = {
+    type: "container_file_citation";
+    container_id: string;
+    start_index?: number;
+    end_index?: number;
+    filename?: string;
+    file_id?: string;
+};
+type Annotation = WebAnnotation | FileAnnotation | MapAnnotation | ContainerFileAnnotation;
 type ImageUrl = {
     url: string;
+    detail?: string;
 };
 type TextContent = {
     id?: string;
     type: "text";
     text: string;
-    annotations?: Record<string, unknown>[];
+    annotations?: Annotation[];
+    thought_signature?: string;
 };
 type ThinkingContent = {
     id?: string;
@@ -62,15 +97,18 @@ type CodeContent = {
     container_id?: string;
     type: "code";
     code: string;
+    language?: string;
 };
 type ImageContent = {
     type: "image_url";
     image_url: ImageUrl;
+    image_variable?: string;
 };
 type Media = {
     title: string;
     type: string;
-    url: string;
+    url?: string;
+    format?: "base64" | "url" | "neither";
 };
 type MediaContent = {
     type: "media";
@@ -80,22 +118,196 @@ type MediaVariable = {
     type: "media_variable";
     name: string;
 };
-type Content = TextContent | ThinkingContent | CodeContent | ImageContent | MediaContent | MediaVariable;
+type OutputMediaContent = {
+    type: "output_media";
+    id?: string;
+    url: string;
+    mime_type?: string;
+    media_type?: "image" | "video" | "audio";
+    provider_metadata?: Record<string, unknown>;
+};
+type ServerToolUseContent = {
+    type: "server_tool_use";
+    id: string;
+    name: string;
+    input?: Record<string, unknown>;
+};
+type WebSearchResult = {
+    type: "web_search_result";
+    url?: string;
+    title?: string;
+    encrypted_content?: string;
+    page_age?: string;
+};
+type WebSearchToolResultContent = {
+    type: "web_search_tool_result";
+    tool_use_id: string;
+    content?: WebSearchResult[];
+};
+type CodeExecutionResultContent = {
+    type: "code_execution_result";
+    output: string;
+    outcome?: string;
+};
+type McpListToolsContent = {
+    type: "mcp_list_tools";
+    id?: string;
+    server_label?: string;
+    tools?: Record<string, unknown>[];
+    error?: string | Record<string, unknown>;
+};
+type McpCallContent = {
+    type: "mcp_call";
+    id?: string;
+    name?: string;
+    server_label?: string;
+    arguments?: string;
+    output?: string;
+    error?: string | Record<string, unknown>;
+    approval_request_id?: string;
+};
+type McpApprovalRequestContent = {
+    type: "mcp_approval_request";
+    id?: string;
+    name?: string;
+    arguments?: string;
+    server_label?: string;
+};
+type McpApprovalResponseContent = {
+    type: "mcp_approval_response";
+    approval_request_id: string;
+    approve: boolean;
+};
+type BashCodeExecutionToolResultContent = {
+    type: "bash_code_execution_tool_result";
+    tool_use_id: string;
+    content?: Record<string, unknown>;
+};
+type TextEditorCodeExecutionToolResultContent = {
+    type: "text_editor_code_execution_tool_result";
+    tool_use_id: string;
+    content?: Record<string, unknown>;
+};
+type ShellCallContent = {
+    type: "shell_call";
+    id?: string;
+    call_id?: string;
+    action?: Record<string, unknown>;
+    status?: string;
+};
+type ShellCallOutputContent = {
+    type: "shell_call_output";
+    id?: string;
+    call_id?: string;
+    output?: Record<string, unknown>[];
+    status?: string;
+};
+type ApplyPatchCallContent = {
+    type: "apply_patch_call";
+    id?: string;
+    call_id?: string;
+    operation?: Record<string, unknown>;
+    status?: string;
+};
+type ApplyPatchCallOutputContent = {
+    type: "apply_patch_call_output";
+    id?: string;
+    call_id?: string;
+    output?: string;
+    status?: string;
+};
+type Content = TextContent | ThinkingContent | CodeContent | ImageContent | MediaContent | MediaVariable | OutputMediaContent | ServerToolUseContent | WebSearchToolResultContent | CodeExecutionResultContent | McpListToolsContent | McpCallContent | McpApprovalRequestContent | McpApprovalResponseContent | BashCodeExecutionToolResultContent | TextEditorCodeExecutionToolResultContent | ShellCallContent | ShellCallOutputContent | ApplyPatchCallContent | ApplyPatchCallOutputContent;
 type Function_ = {
     name: string;
     description: string;
+    strict?: boolean;
     parameters: Record<string, unknown>;
 };
-type Tool = {
-    id: string;
-    tool_id?: string;
+type FunctionCall = {
+    name: string;
+    arguments: string;
+};
+type WebSearchToolFilters = {
+    allowed_domains?: string[];
+};
+type WebSearchToolUserLocation = {
+    city?: string;
+    country?: string;
+    region?: string;
+    timezone?: string;
+    type: "approximate";
+};
+type OpenAIWebSearchToolConfig = {
+    type: "web_search" | "web_search_2025_08_26";
+    filters?: WebSearchToolFilters;
+    search_context_size?: "low" | "medium" | "high";
+    user_location?: WebSearchToolUserLocation;
+};
+type ComparisonFilter = {
+    key: string;
+    value: string | number | boolean;
+    operation: "eq" | "ne" | "gt" | "gte" | "lt" | "lte";
+};
+type CompoundFilter = {
+    operator: "and" | "or";
+    operands: (ComparisonFilter | CompoundFilter)[];
+};
+type RankingOptions = {
+    ranker?: "auto" | "default-2024-11-15";
+    score_threshold?: number;
+};
+type FileSearchToolConfig = {
+    type: "file_search";
+    vector_store_ids: string[];
+    filters?: ComparisonFilter | CompoundFilter;
+    max_num_results?: number;
+    ranking_options?: RankingOptions;
+};
+type CodeInterpreterToolConfig = {
+    type: "code_interpreter";
+    container?: Record<string, unknown>;
+};
+type ImageGenerationToolConfig = {
+    type: "image_generation";
+};
+type ShellToolConfig = {
+    type: "shell";
+    environment?: Record<string, unknown>;
+};
+type ApplyPatchToolConfig = {
+    type: "apply_patch";
+};
+type McpToolApprovalFilter = {
+    tool_names?: string[];
+};
+type McpToolApproval = {
+    never?: McpToolApprovalFilter;
+    always?: McpToolApprovalFilter;
+};
+type McpToolConfig = {
+    type: "mcp";
+    server_label: string;
+    server_url?: string;
+    server_description?: string;
+    connector_id?: string;
+    authorization?: string;
+    allowed_tools?: string[];
+    require_approval?: string | McpToolApproval;
+};
+type BuiltInToolConfig = OpenAIWebSearchToolConfig | FileSearchToolConfig | CodeInterpreterToolConfig | ImageGenerationToolConfig | McpToolConfig | ShellToolConfig | ApplyPatchToolConfig;
+type FunctionTool = {
     type: "function";
     function: Function_;
 };
-type FunctionCall = {
+type BuiltInTool = {
+    id: string;
     name: string;
-    arguments: string;
+    description: string;
+    provider: string;
+    type: "web_search" | "file_search" | "code_interpreter" | "image_generation" | "google_maps" | "url_context" | "mcp" | "bash" | "shell" | "apply_patch" | "text_editor";
+    config: BuiltInToolConfig;
 };
+type Tool = FunctionTool | BuiltInTool;
 type SystemMessage = {
     role: "system";
     input_variables?: string[];
@@ -112,6 +324,7 @@ type UserMessage = {
 };
 type ToolCall = {
     id: string;
+    tool_id?: string;
     type: "function";
     function: FunctionCall;
 };
@@ -135,7 +348,7 @@ type ToolMessage = {
     role: "tool";
     input_variables?: string[];
     template_format?: TemplateFormat;
-    content: Content[];
+    content?: Content[];
     tool_call_id: string;
     name?: string;
 };
@@ -177,8 +390,11 @@ type PromptTemplate = CompletionPromptTemplate | ChatPromptTemplate;
 type Model = {
     api_type?: string;
     provider: string;
+    model_config_display_name?: string;
+    base_model?: string;
     name: string;
     parameters: Record<string, unknown>;
+    display_params?: Record<string, string | boolean | null>;
 };
 type Metadata = {
     model?: Model;
@@ -191,6 +407,10 @@ type PromptBlueprint = {
     prompt_template: PromptTemplate;
     commit_message?: string;
     metadata?: Metadata;
+    provider_base_url_name?: string;
+    report_id?: number;
+    inference_client_name?: string;
+    provider_id?: number;
 };
 type PublishPromptTemplate = BasePromptTemplate & PromptBlueprint & {
     release_labels?: string[];