@aihubmix/ai-sdk-provider 0.0.3 → 0.0.5

package/dist/index.d.mts

@@ -1,28 +1,202 @@
 import { ProviderV2, LanguageModelV2, EmbeddingModelV2, ImageModelV2, TranscriptionModelV2, SpeechModelV2 } from '@ai-sdk/provider';
+import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { FetchFunction } from '@ai-sdk/provider-utils';
-import { z } from 'zod';
 import { OpenAIProviderSettings } from '@ai-sdk/openai';
 
-declare const WebSearchPreviewParameters: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
-declare function webSearchPreviewTool({ searchContextSize, userLocation, }?: {
-    searchContextSize?: 'low' | 'medium' | 'high';
+declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+    /**
+     * Filters for the search.
+     */
+    filters?: {
+        /**
+         * Allowed domains for the search.
+         * If not provided, all domains are allowed.
+         * Subdomains of the provided domains are allowed as well.
+         */
+        allowedDomains?: string[];
+    };
+    /**
+     * Search context size to use for the web search.
+     * - high: Most comprehensive context, highest cost, slower response
+     * - medium: Balanced context, cost, and latency (default)
+     * - low: Least context, lowest cost, fastest response
+     */
+    searchContextSize?: "low" | "medium" | "high";
+    /**
+     * User location information to provide geographically relevant search results.
+     */
     userLocation?: {
-        type?: 'approximate';
+        /**
+         * Type of location (always 'approximate')
+         */
+        type: "approximate";
+        /**
+         * Two-letter ISO country code (e.g., 'US', 'GB')
+         */
+        country?: string;
+        /**
+         * City name (free text, e.g., 'Minneapolis')
+         */
         city?: string;
+        /**
+         * Region name (free text, e.g., 'Minnesota')
+         */
         region?: string;
-        country?: string;
+        /**
+         * IANA timezone (e.g., 'America/Chicago')
+         */
         timezone?: string;
     };
-}): {
-    type: 'function';
-    function: {
-        name: string;
-        description: string;
-        parameters: typeof WebSearchPreviewParameters;
-    };
+}>;
+
+/**
+ * A filter used to compare a specified attribute key to a given value using a defined comparison operation.
+ */
+type OpenAIResponsesFileSearchToolComparisonFilter = {
+    /**
+     * The key to compare against the value.
+     */
+    key: string;
+    /**
+     * Specifies the comparison operator: eq, ne, gt, gte, lt, lte.
+     */
+    type: 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte';
+    /**
+     * The value to compare against the attribute key; supports string, number, or boolean types.
+     */
+    value: string | number | boolean;
+};
+/**
+ * Combine multiple filters using and or or.
+ */
+type OpenAIResponsesFileSearchToolCompoundFilter = {
+    /**
+     * Type of operation: and or or.
+     */
+    type: 'and' | 'or';
+    /**
+     * Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.
+     */
+    filters: Array<OpenAIResponsesFileSearchToolComparisonFilter | OpenAIResponsesFileSearchToolCompoundFilter>;
 };
+
 declare const aihubmixTools: {
-    webSearchPreview: typeof webSearchPreviewTool;
+    /**
+     * The Code Interpreter tool allows models to write and run Python code in a
+     * sandboxed environment to solve complex problems in domains like data analysis,
+     * coding, and math.
+     *
+     * @param container - The container to use for the code interpreter.
+     *
+     * Must have name `code_interpreter`.
+     */
+    codeInterpreter: (args?: {
+        container?: string | {
+            fileIds?: string[];
+        };
+    }) => _ai_sdk_provider_utils.Tool<{
+        code?: string | null;
+        containerId: string;
+    }, {
+        outputs?: Array<{
+            type: "logs";
+            logs: string;
+        } | {
+            type: "image";
+            url: string;
+        }> | null;
+    }>;
+    /**
+     * File search is a tool available in the Responses API. It enables models to
+     * retrieve information in a knowledge base of previously uploaded files through
+     * semantic and keyword search.
+     *
+     * Must have name `file_search`.
+     *
+     * @param vectorStoreIds - The vector store IDs to use for the file search.
+     * @param maxNumResults - The maximum number of results to return.
+     * @param ranking - The ranking options to use for the file search.
+     * @param filters - The filters to use for the file search.
+     */
+    fileSearch: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+        queries: string[];
+        results: null | {
+            attributes: Record<string, unknown>;
+            fileId: string;
+            filename: string;
+            score: number;
+            text: string;
+        }[];
+    }, {
+        vectorStoreIds: string[];
+        maxNumResults?: number;
+        ranking?: {
+            ranker?: string;
+            scoreThreshold?: number;
+        };
+        filters?: OpenAIResponsesFileSearchToolComparisonFilter | OpenAIResponsesFileSearchToolCompoundFilter;
+    }>;
+    /**
+     * The image generation tool allows you to generate images using a text prompt,
+     * and optionally image inputs. It leverages the GPT Image model,
+     * and automatically optimizes text inputs for improved performance.
+     *
+     * Must have name `image_generation`.
+     *
+     * @param size - Image dimensions (e.g., 1024x1024, 1024x1536)
+     * @param quality - Rendering quality (e.g. low, medium, high)
+     * @param format - File output format
+     * @param compression - Compression level (0-100%) for JPEG and WebP formats
+     * @param background - Transparent or opaque
+     */
+    imageGeneration: (args?: {
+        background?: "auto" | "opaque" | "transparent";
+        inputFidelity?: "low" | "high";
+        inputImageMask?: {
+            fileId?: string;
+            imageUrl?: string;
+        };
+        model?: string;
+        moderation?: "auto";
+        outputCompression?: number;
+        outputFormat?: "png" | "jpeg" | "webp";
+        quality?: "auto" | "low" | "medium" | "high";
+        size?: "auto" | "1024x1024" | "1024x1536" | "1536x1024";
+    }) => _ai_sdk_provider_utils.Tool<{}, {
+        result: string;
+    }>;
+    /**
+     * Web search allows models to access up-to-date information from the internet
+     * and provide answers with sourced citations.
+     *
+     * Must have name `web_search_preview`.
+     *
+     * @param searchContextSize - The search context size to use for the web search.
+     * @param userLocation - The user location to use for the web search.
+     *
+     * @deprecated Use `webSearch` instead.
+     */
+    webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+        searchContextSize?: "low" | "medium" | "high";
+        userLocation?: {
+            type: "approximate";
+            country?: string;
+            city?: string;
+            region?: string;
+            timezone?: string;
+        };
+    }>;
+    /**
+     * Web search allows models to access up-to-date information from the internet
+     * and provide answers with sourced citations.
+     *
+     * Must have name `web_search`.
+     *
+     * @param filters - The filters to use for the web search.
+     * @param searchContextSize - The search context size to use for the web search.
+     * @param userLocation - The user location to use for the web search.
+     */
+    webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
 };
 
 interface AihubmixProvider extends ProviderV2 {

package/dist/index.d.ts

@@ -1,28 +1,202 @@
 import { ProviderV2, LanguageModelV2, EmbeddingModelV2, ImageModelV2, TranscriptionModelV2, SpeechModelV2 } from '@ai-sdk/provider';
+import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { FetchFunction } from '@ai-sdk/provider-utils';
-import { z } from 'zod';
 import { OpenAIProviderSettings } from '@ai-sdk/openai';
 
-declare const WebSearchPreviewParameters: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
-declare function webSearchPreviewTool({ searchContextSize, userLocation, }?: {
-    searchContextSize?: 'low' | 'medium' | 'high';
+declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+    /**
+     * Filters for the search.
+     */
+    filters?: {
+        /**
+         * Allowed domains for the search.
+         * If not provided, all domains are allowed.
+         * Subdomains of the provided domains are allowed as well.
+         */
+        allowedDomains?: string[];
+    };
+    /**
+     * Search context size to use for the web search.
+     * - high: Most comprehensive context, highest cost, slower response
+     * - medium: Balanced context, cost, and latency (default)
+     * - low: Least context, lowest cost, fastest response
+     */
+    searchContextSize?: "low" | "medium" | "high";
+    /**
+     * User location information to provide geographically relevant search results.
+     */
     userLocation?: {
-        type?: 'approximate';
+        /**
+         * Type of location (always 'approximate')
+         */
+        type: "approximate";
+        /**
+         * Two-letter ISO country code (e.g., 'US', 'GB')
+         */
+        country?: string;
+        /**
+         * City name (free text, e.g., 'Minneapolis')
+         */
         city?: string;
+        /**
+         * Region name (free text, e.g., 'Minnesota')
+         */
         region?: string;
-        country?: string;
+        /**
+         * IANA timezone (e.g., 'America/Chicago')
+         */
         timezone?: string;
     };
-}): {
-    type: 'function';
-    function: {
-        name: string;
-        description: string;
-        parameters: typeof WebSearchPreviewParameters;
-    };
+}>;
+
+/**
+ * A filter used to compare a specified attribute key to a given value using a defined comparison operation.
+ */
+type OpenAIResponsesFileSearchToolComparisonFilter = {
+    /**
+     * The key to compare against the value.
+     */
+    key: string;
+    /**
+     * Specifies the comparison operator: eq, ne, gt, gte, lt, lte.
+     */
+    type: 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte';
+    /**
+     * The value to compare against the attribute key; supports string, number, or boolean types.
+     */
+    value: string | number | boolean;
+};
+/**
+ * Combine multiple filters using and or or.
+ */
+type OpenAIResponsesFileSearchToolCompoundFilter = {
+    /**
+     * Type of operation: and or or.
+     */
+    type: 'and' | 'or';
+    /**
+     * Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.
+     */
+    filters: Array<OpenAIResponsesFileSearchToolComparisonFilter | OpenAIResponsesFileSearchToolCompoundFilter>;
 };
+
 declare const aihubmixTools: {
-    webSearchPreview: typeof webSearchPreviewTool;
+    /**
+     * The Code Interpreter tool allows models to write and run Python code in a
+     * sandboxed environment to solve complex problems in domains like data analysis,
+     * coding, and math.
+     *
+     * @param container - The container to use for the code interpreter.
+     *
+     * Must have name `code_interpreter`.
+     */
+    codeInterpreter: (args?: {
+        container?: string | {
+            fileIds?: string[];
+        };
+    }) => _ai_sdk_provider_utils.Tool<{
+        code?: string | null;
+        containerId: string;
+    }, {
+        outputs?: Array<{
+            type: "logs";
+            logs: string;
+        } | {
+            type: "image";
+            url: string;
+        }> | null;
+    }>;
+    /**
+     * File search is a tool available in the Responses API. It enables models to
+     * retrieve information in a knowledge base of previously uploaded files through
+     * semantic and keyword search.
+     *
+     * Must have name `file_search`.
+     *
+     * @param vectorStoreIds - The vector store IDs to use for the file search.
+     * @param maxNumResults - The maximum number of results to return.
+     * @param ranking - The ranking options to use for the file search.
+     * @param filters - The filters to use for the file search.
+     */
+    fileSearch: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+        queries: string[];
+        results: null | {
+            attributes: Record<string, unknown>;
+            fileId: string;
+            filename: string;
+            score: number;
+            text: string;
+        }[];
+    }, {
+        vectorStoreIds: string[];
+        maxNumResults?: number;
+        ranking?: {
+            ranker?: string;
+            scoreThreshold?: number;
+        };
+        filters?: OpenAIResponsesFileSearchToolComparisonFilter | OpenAIResponsesFileSearchToolCompoundFilter;
+    }>;
+    /**
+     * The image generation tool allows you to generate images using a text prompt,
+     * and optionally image inputs. It leverages the GPT Image model,
+     * and automatically optimizes text inputs for improved performance.
+     *
+     * Must have name `image_generation`.
+     *
+     * @param size - Image dimensions (e.g., 1024x1024, 1024x1536)
+     * @param quality - Rendering quality (e.g. low, medium, high)
+     * @param format - File output format
+     * @param compression - Compression level (0-100%) for JPEG and WebP formats
+     * @param background - Transparent or opaque
+     */
+    imageGeneration: (args?: {
+        background?: "auto" | "opaque" | "transparent";
+        inputFidelity?: "low" | "high";
+        inputImageMask?: {
+            fileId?: string;
+            imageUrl?: string;
+        };
+        model?: string;
+        moderation?: "auto";
+        outputCompression?: number;
+        outputFormat?: "png" | "jpeg" | "webp";
+        quality?: "auto" | "low" | "medium" | "high";
+        size?: "auto" | "1024x1024" | "1024x1536" | "1536x1024";
+    }) => _ai_sdk_provider_utils.Tool<{}, {
+        result: string;
+    }>;
+    /**
+     * Web search allows models to access up-to-date information from the internet
+     * and provide answers with sourced citations.
+     *
+     * Must have name `web_search_preview`.
+     *
+     * @param searchContextSize - The search context size to use for the web search.
+     * @param userLocation - The user location to use for the web search.
+     *
+     * @deprecated Use `webSearch` instead.
+     */
+    webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+        searchContextSize?: "low" | "medium" | "high";
+        userLocation?: {
+            type: "approximate";
+            country?: string;
+            city?: string;
+            region?: string;
+            timezone?: string;
+        };
+    }>;
+    /**
+     * Web search allows models to access up-to-date information from the internet
+     * and provide answers with sourced citations.
+     *
+     * Must have name `web_search`.
+     *
+     * @param filters - The filters to use for the web search.
+     * @param searchContextSize - The search context size to use for the web search.
+     * @param userLocation - The user location to use for the web search.
+     */
+    webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
 };
 
 interface AihubmixProvider extends ProviderV2 {