weave-typescript 0.8.0 → 0.10.0

package/dist/weaveapi/llmx/v1/provider.pb.d.ts

@@ -1,14 +1,53 @@
 import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
 export declare const protobufPackage = "weaveapi.llmx.v1";
+/** Provider represents an AI model provider/vendor organization. */
 export interface Provider {
+    /**
+     * Unique internal identifier for this provider.
+     * Example: "pvd_01234567-89ab-cdef-0123-456789abcdef"
+     */
     id: string;
+    /**
+     * URL-friendly identifier for routing.
+     * Examples: "openai", "anthropic", "google", "meta"
+     * Used in paths like /providers/openai
+     */
     slug: string;
+    /**
+     * Display name of the provider.
+     * Examples: "OpenAI", "Anthropic", "Google AI", "Meta AI"
+     */
     name: string;
+    /**
+     * Description of the provider and their focus.
+     * Example: "OpenAI develops general-purpose AI models including GPT-4,
+     * DALL-E, and Whisper, focusing on safe and beneficial AI."
+     */
     description: string;
+    /**
+     * Main website URL.
+     * Example: "https://openai.com"
+     */
     websiteUrl: string;
+    /**
+     * API documentation URL.
+     * Example: "https://platform.openai.com/docs"
+     */
     documentationUrl: string;
+    /**
+     * URL to provider's logo image.
+     * Example: "https://assets.example.com/logos/openai.svg"
+     */
     logoUrl: string;
+    /**
+     * Whether provider is currently operational.
+     * Example: false if provider has shut down or paused service
+     */
     isActive: boolean;
+    /**
+     * Number of models offered by this provider.
+     * Example: 25 for a provider with 25 different models
+     */
     modelCount: number;
 }
 export declare const Provider: MessageFns<Provider>;

package/dist/weaveapi/llmx/v1/service.pb.d.ts

@@ -20,25 +20,78 @@ export interface GetProviderRequest {
 export interface GetProviderResponse {
     provider: Provider | undefined;
 }
+/** ListModelsRequest defines filters and pagination for listing models. */
 export interface ListModelsRequest {
+    /**
+     * Maximum number of models to return (1-100).
+     * Example: 20 for paginated results
+     */
     pageSize: number;
+    /**
+     * Token for fetching next page of results.
+     * Example: "eyJvZmZzZXQiOjIwfQ==" from previous response
+     */
     pageToken: string;
-    /** Filters */
+    /**
+     * Filter by provider slug.
+     * Example: "openai" to only show OpenAI models
+     */
     provider: string;
+    /**
+     * Filter by model type.
+     * Examples: "chat", "embedding", "image", "audio"
+     */
     modelType: string;
+    /**
+     * Only show currently available models.
+     * Example: true to exclude deprecated models
+     */
     activeOnly: boolean;
-    /** Capability filters */
+    /**
+     * Only models with vision/image understanding.
+     * Example: true for GPT-4V, Claude-3 Vision
+     */
     visionOnly: boolean;
+    /**
+     * Only models supporting function/tool calling.
+     * Example: true for GPT-4, Claude-3
+     */
     toolCallsOnly: boolean;
+    /**
+     * Only models with advanced reasoning capabilities.
+     * Example: true for o1-preview, o1-mini
+     */
     reasoningOnly: boolean;
+    /**
+     * Only open-source models with public weights.
+     * Example: true for LLaMA, Mistral, false for GPT-4
+     */
     openSourceOnly: boolean;
-    /** Price filters (per 1M tokens) */
+    /**
+     * Maximum acceptable input token price.
+     * Example: 5.0 for models under $5/1M input tokens
+     */
     maxInputPrice: number;
+    /**
+     * Maximum acceptable output token price.
+     * Example: 15.0 for models under $15/1M output tokens
+     */
     maxOutputPrice: number;
-    /** Token filters */
+    /**
+     * Minimum required context window size.
+     * Example: 32000 for models with 32k+ context
+     */
     minContextWindow: number;
-    /** Sorting */
+    /**
+     * Field to sort results by.
+     * Options: "name", "release_date", "input_price", "context_window"
+     * Example: "release_date" for newest models first
+     */
     orderBy: string;
+    /**
+     * Sort in descending order.
+     * Example: true for newest/highest first, false for oldest/lowest
+     */
     descending: boolean;
 }
 export interface ListModelsResponse {
@@ -55,45 +108,139 @@ export interface GetModelRequest {
 export interface GetModelResponse {
     model: Model | undefined;
 }
+/** SearchModelsRequest enables advanced model search with multiple filter criteria. */
 export interface SearchModelsRequest {
-    /** Full-text search */
+    /**
+     * Full-text search across model names and descriptions.
+     * Example: "code generation" to find coding-focused models
+     */
     query: string;
-    /** Advanced filters */
+    /**
+     * Filter by multiple providers.
+     * Example: ["openai", "anthropic"] for models from either provider
+     */
     providers: string[];
+    /**
+     * Filter by multiple model types.
+     * Example: ["chat", "instruct"] for conversational models
+     */
     modelTypes: string[];
+    /**
+     * Filter by architecture families.
+     * Example: ["GPT", "LLaMA", "Mistral"] for specific architectures
+     */
     architectures: string[];
-    /** Capability requirements (ALL must be true) */
+    /**
+     * Required capabilities (model must have all).
+     * Example: ["function_calling", "vision"] for multi-modal tool-use models
+     */
     requiredCapabilities: string[];
+    /**
+     * Required input modalities (model must support all).
+     * Example: ["text", "image"] for vision-language models
+     */
     requiredInputModalities: string[];
+    /**
+     * Required output modalities (model must support all).
+     * Example: ["text", "code"] for code generation models
+     */
     requiredOutputModalities: string[];
-    /** Numeric ranges */
+    /** Price range constraints per 1M tokens. */
     priceRange: PriceRange | undefined;
+    /** Token limit constraints. */
     tokenRange: TokenRange | undefined;
+    /** Minimum performance scores required. */
     performanceRange: PerformanceRange | undefined;
-    /** Pagination */
+    /**
+     * Results per page (1-100).
+     * Example: 25
+     */
     pageSize: number;
+    /** Continuation token from previous response. */
     pageToken: string;
-    /** Sorting */
+    /**
+     * Sort field name.
+     * Options: "relevance", "name", "release_date", "price", "performance"
+     */
     orderBy: string;
+    /**
+     * Sort direction.
+     * Example: true for descending (highest/newest first)
+     */
     descending: boolean;
 }
+/** PriceRange defines min/max price constraints for filtering models. */
 export interface PriceRange {
+    /**
+     * Minimum input token price per 1M tokens.
+     * Example: 0.5 for at least $0.50/1M input tokens
+     */
     minInputPrice: number;
+    /**
+     * Maximum input token price per 1M tokens.
+     * Example: 10.0 for at most $10/1M input tokens
+     */
     maxInputPrice: number;
+    /**
+     * Minimum output token price per 1M tokens.
+     * Example: 1.0 for at least $1/1M output tokens
+     */
     minOutputPrice: number;
+    /**
+     * Maximum output token price per 1M tokens.
+     * Example: 30.0 for at most $30/1M output tokens
+     */
     maxOutputPrice: number;
 }
+/** TokenRange defines min/max token constraints for filtering models. */
 export interface TokenRange {
+    /**
+     * Minimum context window size required.
+     * Example: 8192 for at least 8k context
+     */
     minContextWindow: number;
+    /**
+     * Maximum context window size allowed.
+     * Example: 128000 for at most 128k context
+     */
     maxContextWindow: number;
+    /**
+     * Minimum output token limit required.
+     * Example: 2048 for at least 2k output tokens
+     */
     minOutputTokens: number;
+    /**
+     * Maximum output token limit allowed.
+     * Example: 16384 for at most 16k output tokens
+     */
     maxOutputTokens: number;
 }
+/** PerformanceRange defines minimum performance scores for filtering. */
 export interface PerformanceRange {
+    /**
+     * Minimum reasoning score (0-10).
+     * Example: 7.5 for strong reasoning models only
+     */
     minReasoningScore: number;
+    /**
+     * Minimum coding score (0-10).
+     * Example: 8.0 for excellent coding models only
+     */
     minCodingScore: number;
+    /**
+     * Minimum creative writing score (0-10).
+     * Example: 7.0 for good creative models only
+     */
     minCreativeScore: number;
+    /**
+     * Minimum factual accuracy score (0-10).
+     * Example: 8.5 for highly accurate models only
+     */
     minFactualScore: number;
+    /**
+     * Minimum mathematical ability score (0-10).
+     * Example: 9.0 for advanced math models only
+     */
     minMathScore: number;
 }
 export interface SearchModelsResponse {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "weave-typescript",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [