@nordlys-labs/nordlys-ai-provider 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,298 @@
+import { ProviderV3, LanguageModelV3, EmbeddingModelV3 } from '@ai-sdk/provider';
+import { FetchFunction } from '@ai-sdk/provider-utils';
+
+interface NordlysProvider extends ProviderV3 {
+    (modelId: string): LanguageModelV3;
+    /**
+     * Creates a model for text generation with Nordlys models.
+     */
+    languageModel: (modelId: string) => LanguageModelV3;
+    /**
+     * Creates a chat model with Nordlys models.
+     */
+    chat: (modelId: string) => LanguageModelV3;
+    /**
+     * Text embedding is not currently supported by the Nordlys provider.
+     */
+    embeddingModel: (modelId: string) => EmbeddingModelV3;
+}
+interface NordlysProviderSettings {
+    /**
+     * Use a different URL prefix for API calls, e.g. to use proxy servers.
+     * The default prefix is your Nordlys API endpoint.
+     */
+    baseURL?: string;
+    /**
+     * API key for the Nordlys service.
+     * It defaults to the `NORDLYS_API_KEY` environment variable.
+     */
+    apiKey?: string;
+    /**
+     * Custom headers to include in the requests.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Custom fetch implementation. You can use it as a middleware to intercept requests,
+     * or to provide a custom fetch implementation for e.g. testing.
+     */
+    fetch?: FetchFunction;
+}
+/**
+ * Create a Nordlys AI provider instance.
+ */
+declare function createNordlys(options?: NordlysProviderSettings): NordlysProvider;
+/**
+ * Default Nordlys provider instance.
+ */
+declare const nordlys: NordlysProvider;
+
+/**
+ * Request payload for Nordlys chat completion API.
+ */
+interface NordlysChatCompletionRequest {
+    messages: NordlysChatCompletionMessage[];
+    model: string;
+    max_tokens?: number;
+    max_completion_tokens?: number;
+    temperature?: number;
+    top_p?: number;
+    n?: number;
+    stream?: boolean;
+    stop?: string | string[];
+    presence_penalty?: number;
+    frequency_penalty?: number;
+    logit_bias?: Record<string, number>;
+    user?: string;
+    audio?: V2ChatCompletionAudioParam;
+    logprobs?: boolean;
+    metadata?: SharedMetadata;
+    modalities?: string[];
+    parallel_tool_calls?: boolean;
+    prediction?: V2ChatCompletionPredictionContentParam;
+    reasoning_effort?: string;
+    response_format?: V2ChatCompletionNewParamsResponseFormatUnion;
+    seed?: number;
+    service_tier?: string;
+    store?: boolean;
+    top_logprobs?: number;
+    web_search_options?: V2ChatCompletionNewParamsWebSearchOptions;
+    stream_options?: V2ChatCompletionStreamOptionsParam;
+    tools?: Array<{
+        type: 'function';
+        function: {
+            name: string;
+            description?: string;
+            parameters: unknown;
+        };
+    }>;
+    tool_choice?: {
+        type: 'function';
+        function: {
+            name: string;
+        };
+    } | 'auto' | 'none' | 'required';
+}
+interface NordlysChatCompletionDeveloperMessage {
+    role: 'developer';
+    content: string;
+}
+/**
+ * All possible message types for Nordlys chat completion.
+ */
+type NordlysChatCompletionMessage = NordlysChatCompletionSystemMessage | NordlysChatCompletionUserMessage | NordlysChatCompletionAssistantMessage | NordlysChatCompletionToolMessage | NordlysChatCompletionDeveloperMessage;
+/**
+ * System message for Nordlys chat completion.
+ */
+interface NordlysChatCompletionSystemMessage {
+    role: 'system';
+    content: string;
+}
+/**
+ * User message for Nordlys chat completion.
+ */
+interface NordlysChatCompletionUserMessage {
+    role: 'user';
+    content: string | Array<NordlysChatCompletionContentPart>;
+}
+/**
+ * Content part for user messages.
+ */
+type NordlysChatCompletionContentPart = {
+    type: 'text';
+    text: string;
+} | {
+    type: 'image_url';
+    image_url: {
+        url: string;
+    };
+} | {
+    type: 'input_audio';
+    input_audio: {
+        data: string;
+        format: 'wav' | 'mp3';
+    };
+} | {
+    type: 'file';
+    file: {
+        filename: string;
+        file_data: string;
+    };
+};
+/**
+ * Assistant message for Nordlys chat completion.
+ */
+interface NordlysChatCompletionAssistantMessage {
+    role: 'assistant';
+    content?: string | null;
+    tool_calls?: Array<NordlysChatCompletionMessageToolCall>;
+    reasoning_content?: string;
+    generated_files?: Array<{
+        media_type: string;
+        data: string;
+    }>;
+}
+/**
+ * Tool call for assistant messages.
+ */
+interface NordlysChatCompletionMessageToolCall {
+    type: 'function';
+    id: string;
+    function: {
+        arguments: string;
+        name: string;
+    };
+}
+/**
+ * Tool message for Nordlys chat completion.
+ */
+interface NordlysChatCompletionToolMessage {
+    role: 'tool';
+    content: string;
+    tool_call_id: string;
+}
+/**
+ * Response from Nordlys chat completion API.
+ */
+interface NordlysChatCompletionResponse {
+    id: string;
+    object: string;
+    created: number;
+    model: string;
+    choices: Array<{
+        index: number;
+        message: NordlysChatCompletionAssistantMessage;
+        finish_reason: string | null;
+    }>;
+    usage?: NordlysChatCompletionUsage;
+    provider: string;
+    service_tier?: string;
+    system_fingerprint?: string;
+}
+/**
+ * Usage statistics for Nordlys chat completion API.
+ */
+interface NordlysChatCompletionUsage {
+    prompt_tokens: number;
+    completion_tokens: number;
+    total_tokens: number;
+    reasoning_tokens?: number;
+    cached_input_tokens?: number;
+}
+/**
+ * Audio parameter for chat completion.
+ */
+interface V2ChatCompletionAudioParam {
+    format?: string;
+    voice?: string;
+}
+/**
+ * Shared metadata for requests.
+ */
+interface SharedMetadata {
+    [key: string]: string;
+}
+/**
+ * Prediction content parameter.
+ */
+interface V2ChatCompletionPredictionContentParam {
+    type?: string;
+    content?: V2ChatCompletionPredictionContentContentUnionParam;
+}
+/**
+ * Prediction content union parameter.
+ */
+interface V2ChatCompletionPredictionContentContentUnionParam {
+    OfString?: string;
+    OfArrayOfContentParts?: Array<{
+        type: 'text';
+        text: string;
+    }>;
+}
+/**
+ * Response format union parameter.
+ */
+interface V2ChatCompletionNewParamsResponseFormatUnion {
+    OfText?: SharedResponseFormatTextParam;
+    OfJSONObject?: SharedResponseFormatJSONObjectParam;
+    OfJSONSchema?: SharedResponseFormatJSONSchemaParam;
+}
+/**
+ * Text response format parameter.
+ */
+interface SharedResponseFormatTextParam {
+    type: string;
+}
+/**
+ * JSON object response format parameter.
+ */
+interface SharedResponseFormatJSONObjectParam {
+    type: string;
+}
+/**
+ * JSON schema response format parameter.
+ */
+interface SharedResponseFormatJSONSchemaParam {
+    type: string;
+    json_schema?: SharedResponseFormatJSONSchemaJSONSchemaParam;
+}
+/**
+ * JSON schema details parameter.
+ */
+interface SharedResponseFormatJSONSchemaJSONSchemaParam {
+    name: string;
+    schema: unknown;
+    description?: string;
+    strict?: boolean;
+}
+/**
+ * Web search options parameter.
+ */
+interface V2ChatCompletionNewParamsWebSearchOptions {
+    search_context_size?: string;
+    user_location?: V2ChatCompletionNewParamsWebSearchOptionsUserLocation;
+}
+/**
+ * User location for web search options.
+ */
+interface V2ChatCompletionNewParamsWebSearchOptionsUserLocation {
+    type?: string;
+    approximate?: V2ChatCompletionNewParamsWebSearchOptionsUserLocationApproximate;
+}
+/**
+ * Approximate user location for web search options.
+ */
+interface V2ChatCompletionNewParamsWebSearchOptionsUserLocationApproximate {
+    city?: string;
+    country?: string;
+    region?: string;
+    timezone?: string;
+}
+/**
+ * Stream options parameter.
+ */
+interface V2ChatCompletionStreamOptionsParam {
+    include_usage?: boolean;
+    include_obfuscation?: boolean;
+}
+
+export { type NordlysChatCompletionAssistantMessage, type NordlysChatCompletionContentPart, type NordlysChatCompletionDeveloperMessage, type NordlysChatCompletionMessage, type NordlysChatCompletionMessageToolCall, type NordlysChatCompletionRequest, type NordlysChatCompletionResponse, type NordlysChatCompletionSystemMessage, type NordlysChatCompletionToolMessage, type NordlysChatCompletionUsage, type NordlysChatCompletionUserMessage, type NordlysProvider, type NordlysProviderSettings, type SharedMetadata, type SharedResponseFormatJSONObjectParam, type SharedResponseFormatJSONSchemaJSONSchemaParam, type SharedResponseFormatJSONSchemaParam, type SharedResponseFormatTextParam, type V2ChatCompletionAudioParam, type V2ChatCompletionNewParamsResponseFormatUnion, type V2ChatCompletionNewParamsWebSearchOptions, type V2ChatCompletionNewParamsWebSearchOptionsUserLocation, type V2ChatCompletionNewParamsWebSearchOptionsUserLocationApproximate, type V2ChatCompletionPredictionContentContentUnionParam, type V2ChatCompletionPredictionContentParam, type V2ChatCompletionStreamOptionsParam, createNordlys, nordlys };