@ever-works/vllm-plugin 1.0.0 → 1.0.3

package/dist/index.d.cts

@@ -0,0 +1,43 @@
+import { BaseAiProvider } from '@ever-works/plugin/abstract';
+import { JsonSchema, PluginContext, ChatCompletionOptions, ChatCompletionResponse, ChatCompletionChunk, EmbeddingOptions, EmbeddingResponse, PluginSettings, AiModel, AiModelCapabilities, PluginHealthCheck, PluginManifest } from '@ever-works/plugin';
+
+/**
+ * vLLM AI provider plugin
+ *
+ * Provides AI capabilities through a self-hosted vLLM server. vLLM serves an
+ * OpenAI-compatible API on `/v1`, so it reuses the same `AiOperations`
+ * (LangChain) backend as the other AI providers.
+ *
+ * Uses 'user-required' configuration mode - users point the plugin at their
+ * vLLM server URL. An unsecured vLLM server accepts any key, so `apiKey`
+ * defaults to vLLM's documented `EMPTY` placeholder; when the server is
+ * started with `--api-key`, users enter that token (stored encrypted via
+ * `x-secret`).
+ *
+ * vLLM serves whatever model it was launched with (`--model ...`), so there is
+ * no canonical default model. The model fields ship without a hardcoded
+ * default and are populated by the `model-select` widget once the connection
+ * is established and `listModels()` returns.
+ */
+declare class VllmPlugin extends BaseAiProvider {
+    readonly id = "vllm";
+    readonly name = "vLLM";
+    readonly version = "1.0.0";
+    readonly providerType = "vllm";
+    readonly providerName = "vLLM";
+    readonly configurationMode: 'admin-only' | 'user-required' | 'hybrid';
+    readonly settingsSchema: JsonSchema;
+    onLoad(context: PluginContext): Promise<void>;
+    onUnload(): Promise<void>;
+    createChatCompletion(options: ChatCompletionOptions): Promise<ChatCompletionResponse>;
+    createStreamingChatCompletion(options: ChatCompletionOptions): AsyncIterable<ChatCompletionChunk>;
+    createEmbedding(options: EmbeddingOptions): Promise<EmbeddingResponse>;
+    listModels(settings?: PluginSettings): Promise<readonly AiModel[]>;
+    isAvailable(settings?: PluginSettings): Promise<boolean>;
+    getCapabilities(): AiModelCapabilities;
+    protected getDefaultModelId(): string;
+    healthCheck(): Promise<PluginHealthCheck>;
+    getManifest(): PluginManifest;
+}
+
+export { VllmPlugin, VllmPlugin as default };

package/dist/index.d.ts

@@ -0,0 +1,43 @@
+import { BaseAiProvider } from '@ever-works/plugin/abstract';
+import { JsonSchema, PluginContext, ChatCompletionOptions, ChatCompletionResponse, ChatCompletionChunk, EmbeddingOptions, EmbeddingResponse, PluginSettings, AiModel, AiModelCapabilities, PluginHealthCheck, PluginManifest } from '@ever-works/plugin';
+
+/**
+ * vLLM AI provider plugin
+ *
+ * Provides AI capabilities through a self-hosted vLLM server. vLLM serves an
+ * OpenAI-compatible API on `/v1`, so it reuses the same `AiOperations`
+ * (LangChain) backend as the other AI providers.
+ *
+ * Uses 'user-required' configuration mode - users point the plugin at their
+ * vLLM server URL. An unsecured vLLM server accepts any key, so `apiKey`
+ * defaults to vLLM's documented `EMPTY` placeholder; when the server is
+ * started with `--api-key`, users enter that token (stored encrypted via
+ * `x-secret`).
+ *
+ * vLLM serves whatever model it was launched with (`--model ...`), so there is
+ * no canonical default model. The model fields ship without a hardcoded
+ * default and are populated by the `model-select` widget once the connection
+ * is established and `listModels()` returns.
+ */
+declare class VllmPlugin extends BaseAiProvider {
+    readonly id = "vllm";
+    readonly name = "vLLM";
+    readonly version = "1.0.0";
+    readonly providerType = "vllm";
+    readonly providerName = "vLLM";
+    readonly configurationMode: 'admin-only' | 'user-required' | 'hybrid';
+    readonly settingsSchema: JsonSchema;
+    onLoad(context: PluginContext): Promise<void>;
+    onUnload(): Promise<void>;
+    createChatCompletion(options: ChatCompletionOptions): Promise<ChatCompletionResponse>;
+    createStreamingChatCompletion(options: ChatCompletionOptions): AsyncIterable<ChatCompletionChunk>;
+    createEmbedding(options: EmbeddingOptions): Promise<EmbeddingResponse>;
+    listModels(settings?: PluginSettings): Promise<readonly AiModel[]>;
+    isAvailable(settings?: PluginSettings): Promise<boolean>;
+    getCapabilities(): AiModelCapabilities;
+    protected getDefaultModelId(): string;
+    healthCheck(): Promise<PluginHealthCheck>;
+    getManifest(): PluginManifest;
+}
+
+export { VllmPlugin, VllmPlugin as default };