@standardagents/openai 0.10.0-dev.ffffff

package/LICENSE.txt

@@ -0,0 +1,48 @@
+PROPRIETARY SOFTWARE LICENSE
+
+Copyright (c) 2024-2025 FormKit Inc. All Rights Reserved.
+
+UNLICENSED - DO NOT USE
+
+This software and associated documentation files (the "Software") are the sole
+and exclusive property of FormKit Inc. ("FormKit").
+
+USE RESTRICTIONS
+
+The Software is UNLICENSED and proprietary. NO PERMISSION is granted to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, or to permit persons to whom the Software is furnished to do so,
+under any circumstances, without prior written authorization from FormKit Inc.
+
+UNAUTHORIZED USE PROHIBITED
+
+Any use of this Software without a valid, written license agreement signed by
+authorized officers of FormKit Inc. is strictly prohibited and constitutes
+unauthorized use and infringement of FormKit's intellectual property rights.
+
+LICENSING INQUIRIES
+
+Organizations interested in licensing this Software should contact:
+enterprise@formkit.com
+
+A written license agreement must be executed before any use of this Software
+is authorized.
+
+NO WARRANTY
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+FORMKIT INC. BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
+AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+GOVERNING LAW
+
+This license shall be governed by and construed in accordance with the laws
+of the jurisdiction in which FormKit Inc. is incorporated, without regard to
+its conflict of law provisions.
+
+FormKit Inc.
+https://formkit.com
+enterprise@formkit.com

package/dist/index.d.ts

@@ -0,0 +1,177 @@
+import { LLMProviderInterface, ProviderFactoryConfig, ModelCapabilities, ToolDefinition, ToolArgs, ToolTenvs, ProviderModelInfo, ProviderRequest, ProviderResponse, ProviderStreamChunk, InspectedRequest, ProviderFactoryWithOptions } from '@standardagents/spec';
+import { z } from 'zod';
+
+/**
+ * OpenAI provider options schema.
+ *
+ * Defines typed providerOptions for OpenAI models, providing
+ * TypeScript autocompletion and runtime validation.
+ *
+ * @see https://platform.openai.com/docs/api-reference/chat/create
+ * @module
+ */
+
+/**
+ * OpenAI provider options schema.
+ *
+ * These options are passed directly to the OpenAI API and control
+ * various aspects of request handling and generation.
+ *
+ * @example
+ * ```typescript
+ * providerOptions: {
+ *   service_tier: 'default',
+ *   user: 'user-123',
+ *   seed: 42,
+ * }
+ * ```
+ */
+declare const openaiProviderOptions: z.ZodObject<{
+    service_tier: z.ZodOptional<z.ZodEnum<{
+        auto: "auto";
+        default: "default";
+        flex: "flex";
+    }>>;
+    user: z.ZodOptional<z.ZodString>;
+    seed: z.ZodOptional<z.ZodNumber>;
+    frequency_penalty: z.ZodOptional<z.ZodNumber>;
+    presence_penalty: z.ZodOptional<z.ZodNumber>;
+    logprobs: z.ZodOptional<z.ZodBoolean>;
+    top_logprobs: z.ZodOptional<z.ZodNumber>;
+    store: z.ZodOptional<z.ZodBoolean>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, z.core.$loose>;
+/**
+ * TypeScript type for OpenAI provider options.
+ * Inferred from the Zod schema for type-safe usage.
+ */
+type OpenAIProviderOptions = z.infer<typeof openaiProviderOptions>;
+
+/**
+ * OpenAI provider implementation for Standard Agents
+ *
+ * Uses the Responses API for all requests (stateless mode).
+ * Supports: gpt-4o, gpt-4-turbo, gpt-3.5-turbo, o1, o3, o4-mini, etc.
+ */
+declare class OpenAIProvider implements LLMProviderInterface {
+    readonly name = "openai";
+    readonly specificationVersion: "1";
+    private client;
+    private config;
+    /** Cache for models list to avoid repeated API calls */
+    private static modelsCache;
+    private static modelsCacheTime;
+    private static readonly CACHE_TTL;
+    constructor(config: ProviderFactoryConfig);
+    private getClient;
+    supportsModel(modelId: string): boolean;
+    /**
+     * Get the icon for this provider as a data URI.
+     * Always returns the OpenAI icon since all models are from OpenAI.
+     */
+    getIcon(_modelId?: string): string;
+    /**
+     * Hardcoded capability mappings for OpenAI models.
+     * OpenAI doesn't provide a capabilities API, so these are manually maintained.
+     */
+    private static readonly MODEL_CAPABILITIES;
+    /**
+     * Get capabilities for a specific model.
+     * Uses hardcoded mappings since OpenAI doesn't provide a capabilities API.
+     */
+    getModelCapabilities(modelId: string): Promise<ModelCapabilities | null>;
+    /**
+     * Human-readable names and descriptions for models.
+     * Used to enrich API response data.
+     */
+    private static readonly MODEL_METADATA;
+    /**
+     * Prefixes for chat-capable models (filter out embeddings, tts, whisper, dall-e, etc.)
+     */
+    private static readonly CHAT_MODEL_PREFIXES;
+    /**
+     * Provider-embedded tools using defineTool().
+     * These are OpenAI's built-in tools that execute on OpenAI's servers.
+     * The execute function is a no-op since execution is handled by the provider.
+     */
+    private static readonly TOOLS;
+    /**
+     * Which tools are available for each model.
+     */
+    private static readonly MODEL_TOOLS;
+    /**
+     * Get tools embedded in this provider.
+     * These are OpenAI's built-in tools with tenv requirements.
+     *
+     * @param modelId - Optional filter to get tools available for a specific model
+     * @returns Record of tool name to tool definition
+     */
+    getTools(modelId?: string): Record<string, ToolDefinition<any, ToolArgs | null, ToolTenvs | null>>;
+    /**
+     * Fetch models from OpenAI API with caching.
+     */
+    private fetchModelsWithCache;
+    /**
+     * Check if a model ID is a chat-capable model.
+     */
+    private isChatModel;
+    /**
+     * Get human-readable name for a model.
+     */
+    private getModelName;
+    /**
+     * Get description for a model.
+     */
+    private getModelDescription;
+    /**
+     * Map OpenAI model info to ProviderModelInfo.
+     */
+    private mapToProviderModelInfo;
+    /**
+     * Get list of available models from OpenAI.
+     * Fetches from the OpenAI API with caching.
+     *
+     * @param filter - Optional search string to filter models by name/id
+     */
+    getModels(filter?: string): Promise<ProviderModelInfo[]>;
+    generate(request: ProviderRequest): Promise<ProviderResponse>;
+    stream(request: ProviderRequest): Promise<AsyncIterable<ProviderStreamChunk>>;
+    private toProviderError;
+    /**
+     * Transform a ProviderRequest to OpenAI Responses API format for inspection.
+     * Returns the exact request body that would be sent to OpenAI, with base64 data truncated.
+     */
+    inspectRequest(request: ProviderRequest): Promise<InspectedRequest>;
+}
+
+/**
+ * OpenAI provider factory for Standard Agents
+ *
+ * Includes typed providerOptions for OpenAI-specific configuration.
+ *
+ * @example
+ * ```typescript
+ * import { defineModel } from '@standardagents/builder';
+ * import { openai } from '@standardagents/openai';
+ *
+ * export default defineModel({
+ *   name: 'gpt-4o',
+ *   provider: openai,
+ *   model: 'gpt-4o',
+ *   inputPrice: 2.5,
+ *   outputPrice: 10,
+ *   capabilities: {
+ *     supportsImages: true,
+ *     supportsToolCalls: true,
+ *     supportsJsonMode: true,
+ *     maxContextTokens: 128000,
+ *   },
+ *   providerOptions: {
+ *     service_tier: 'default',
+ *   },
+ * });
+ * ```
+ */
+declare const openai: ProviderFactoryWithOptions<typeof openaiProviderOptions>;
+
+export { OpenAIProvider, type OpenAIProviderOptions, openai, openaiProviderOptions };