weave-python 0.27.0__py3-none-any.whl → 0.28.1__py3-none-any.whl

weave/weaveapi/{modex → llmx}/v1/service_pb2.pyi

@@ -10,8 +10,8 @@ import google.protobuf.internal.containers
 import google.protobuf.message
 import google.protobuf.timestamp_pb2
 import typing
-import weaveapi.modex.v1.model_pb2
-import weaveapi.modex.v1.provider_pb2
+import weaveapi.llmx.v1.model_pb2
+import weaveapi.llmx.v1.provider_pb2
 
 DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
 
@@ -59,12 +59,12 @@ class ListProvidersResponse(google.protobuf.message.Message):
     def providers(
         self,
     ) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[
-        weaveapi.modex.v1.provider_pb2.Provider
+        weaveapi.llmx.v1.provider_pb2.Provider
     ]: ...
     def __init__(
         self,
         *,
-        providers: collections.abc.Iterable[weaveapi.modex.v1.provider_pb2.Provider]
+        providers: collections.abc.Iterable[weaveapi.llmx.v1.provider_pb2.Provider]
         | None = ...,
         next_page_token: builtins.str = ...,
         total_count: builtins.int = ...,
@@ -105,11 +105,11 @@ class GetProviderResponse(google.protobuf.message.Message):
 
     PROVIDER_FIELD_NUMBER: builtins.int
     @property
-    def provider(self) -> weaveapi.modex.v1.provider_pb2.Provider: ...
+    def provider(self) -> weaveapi.llmx.v1.provider_pb2.Provider: ...
     def __init__(
         self,
         *,
-        provider: weaveapi.modex.v1.provider_pb2.Provider | None = ...,
+        provider: weaveapi.llmx.v1.provider_pb2.Provider | None = ...,
     ) -> None: ...
     def HasField(
         self, field_name: typing.Literal["provider", b"provider"]
@@ -122,6 +122,8 @@ global___GetProviderResponse = GetProviderResponse
 
 @typing.final
 class ListModelsRequest(google.protobuf.message.Message):
+    """ListModelsRequest defines filters and pagination for listing models."""
+
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
 
     PAGE_SIZE_FIELD_NUMBER: builtins.int
@@ -139,26 +141,72 @@ class ListModelsRequest(google.protobuf.message.Message):
     ORDER_BY_FIELD_NUMBER: builtins.int
     DESCENDING_FIELD_NUMBER: builtins.int
     page_size: builtins.int
+    """Maximum number of models to return (1-100).
+    Example: 20 for paginated results
+    """
     page_token: builtins.str
+    """Token for fetching next page of results.
+    Example: "eyJvZmZzZXQiOjIwfQ==" from previous response
+    """
     provider: builtins.str
-    """Filters"""
+    """=== Provider and Type Filters ===
+
+    Filter by provider slug.
+    Example: "openai" to only show OpenAI models
+    """
     model_type: builtins.str
+    """Filter by model type.
+    Examples: "chat", "embedding", "image", "audio"
+    """
     active_only: builtins.bool
+    """Only show currently available models.
+    Example: true to exclude deprecated models
+    """
     vision_only: builtins.bool
-    """Capability filters"""
+    """=== Capability Filters (models must have these features) ===
+
+    Only models with vision/image understanding.
+    Example: true for GPT-4V, Claude-3 Vision
+    """
     tool_calls_only: builtins.bool
+    """Only models supporting function/tool calling.
+    Example: true for GPT-4, Claude-3
+    """
     reasoning_only: builtins.bool
+    """Only models with advanced reasoning capabilities.
+    Example: true for o1-preview, o1-mini
+    """
     open_source_only: builtins.bool
+    """Only open-source models with public weights.
+    Example: true for LLaMA, Mistral, false for GPT-4
+    """
     max_input_price: builtins.float
-    """Price filters (per 1M tokens)"""
+    """=== Price Filters (per 1M tokens) ===
+
+    Maximum acceptable input token price.
+    Example: 5.0 for models under $5/1M input tokens
+    """
     max_output_price: builtins.float
+    """Maximum acceptable output token price.
+    Example: 15.0 for models under $15/1M output tokens
+    """
     min_context_window: builtins.int
-    """Token filters"""
+    """=== Token Filters ===
+
+    Minimum required context window size.
+    Example: 32000 for models with 32k+ context
+    """
     order_by: builtins.str
-    """Sorting
-    "name", "release_date", "input_price", "context_window"
+    """=== Sorting Options ===
+
+    Field to sort results by.
+    Options: "name", "release_date", "input_price", "context_window"
+    Example: "release_date" for newest models first
     """
     descending: builtins.bool
+    """Sort in descending order.
+    Example: true for newest/highest first, false for oldest/lowest
+    """
     def __init__(
         self,
         *,
@@ -226,13 +274,12 @@ class ListModelsResponse(google.protobuf.message.Message):
     def models(
         self,
     ) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[
-        weaveapi.modex.v1.model_pb2.Model
+        weaveapi.llmx.v1.model_pb2.Model
     ]: ...
     def __init__(
         self,
         *,
-        models: collections.abc.Iterable[weaveapi.modex.v1.model_pb2.Model]
-        | None = ...,
+        models: collections.abc.Iterable[weaveapi.llmx.v1.model_pb2.Model] | None = ...,
         next_page_token: builtins.str = ...,
         total_count: builtins.int = ...,
     ) -> None: ...
@@ -279,11 +326,11 @@ class GetModelResponse(google.protobuf.message.Message):
 
     MODEL_FIELD_NUMBER: builtins.int
     @property
-    def model(self) -> weaveapi.modex.v1.model_pb2.Model: ...
+    def model(self) -> weaveapi.llmx.v1.model_pb2.Model: ...
     def __init__(
         self,
         *,
-        model: weaveapi.modex.v1.model_pb2.Model | None = ...,
+        model: weaveapi.llmx.v1.model_pb2.Model | None = ...,
     ) -> None: ...
     def HasField(
         self, field_name: typing.Literal["model", b"model"]
@@ -294,6 +341,8 @@ global___GetModelResponse = GetModelResponse
 
 @typing.final
 class SearchModelsRequest(google.protobuf.message.Message):
+    """SearchModelsRequest enables advanced model search with multiple filter criteria."""
+
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
 
     QUERY_FIELD_NUMBER: builtins.int
@@ -311,57 +360,94 @@ class SearchModelsRequest(google.protobuf.message.Message):
     ORDER_BY_FIELD_NUMBER: builtins.int
     DESCENDING_FIELD_NUMBER: builtins.int
     query: builtins.str
-    """Full-text search"""
+    """Full-text search across model names and descriptions.
+    Example: "code generation" to find coding-focused models
+    """
     page_size: builtins.int
-    """Pagination"""
+    """=== Pagination ===
+
+    Results per page (1-100).
+    Example: 25
+    """
     page_token: builtins.str
+    """Continuation token from previous response."""
     order_by: builtins.str
-    """Sorting"""
+    """=== Sorting ===
+
+    Sort field name.
+    Options: "relevance", "name", "release_date", "price", "performance"
+    """
     descending: builtins.bool
+    """Sort direction.
+    Example: true for descending (highest/newest first)
+    """
     @property
     def providers(
         self,
     ) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
-        """Advanced filters"""
+        """=== Advanced Filters (ANY match) ===
+
+        Filter by multiple providers.
+        Example: ["openai", "anthropic"] for models from either provider
+        """
 
     @property
     def model_types(
         self,
-    ) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[
-        builtins.str
-    ]: ...
+    ) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
+        """Filter by multiple model types.
+        Example: ["chat", "instruct"] for conversational models
+        """
+
     @property
     def architectures(
         self,
-    ) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[
-        builtins.str
-    ]: ...
+    ) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
+        """Filter by architecture families.
+        Example: ["GPT", "LLaMA", "Mistral"] for specific architectures
+        """
+
     @property
     def required_capabilities(
         self,
     ) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
-        """Capability requirements (ALL must be true)"""
+        """=== Capability Requirements (ALL must match) ===
+
+        Required capabilities (model must have all).
+        Example: ["function_calling", "vision"] for multi-modal tool-use models
+        """
 
     @property
     def required_input_modalities(
         self,
-    ) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[
-        builtins.str
-    ]: ...
+    ) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
+        """Required input modalities (model must support all).
+        Example: ["text", "image"] for vision-language models
+        """
+
     @property
     def required_output_modalities(
         self,
-    ) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[
-        builtins.str
-    ]: ...
+    ) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
+        """Required output modalities (model must support all).
+        Example: ["text", "code"] for code generation models
+        """
+
     @property
     def price_range(self) -> global___PriceRange:
-        """Numeric ranges"""
+        """=== Numeric Range Filters ===
+
+        Price range constraints per 1M tokens.
+        """
 
     @property
-    def token_range(self) -> global___TokenRange: ...
+    def token_range(self) -> global___TokenRange:
+        """Token limit constraints."""
+
     @property
-    def performance_range(self) -> global___PerformanceRange: ...
+    def performance_range(self) -> global___PerformanceRange:
+        """Minimum performance scores required."""
+
     def __init__(
         self,
         *,
@@ -429,6 +515,8 @@ global___SearchModelsRequest = SearchModelsRequest
 
 @typing.final
 class PriceRange(google.protobuf.message.Message):
+    """PriceRange defines min/max price constraints for filtering models."""
+
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
 
     MIN_INPUT_PRICE_FIELD_NUMBER: builtins.int
@@ -436,9 +524,21 @@ class PriceRange(google.protobuf.message.Message):
     MIN_OUTPUT_PRICE_FIELD_NUMBER: builtins.int
     MAX_OUTPUT_PRICE_FIELD_NUMBER: builtins.int
     min_input_price: builtins.float
+    """Minimum input token price per 1M tokens.
+    Example: 0.5 for at least $0.50/1M input tokens
+    """
     max_input_price: builtins.float
+    """Maximum input token price per 1M tokens.
+    Example: 10.0 for at most $10/1M input tokens
+    """
     min_output_price: builtins.float
+    """Minimum output token price per 1M tokens.
+    Example: 1.0 for at least $1/1M output tokens
+    """
     max_output_price: builtins.float
+    """Maximum output token price per 1M tokens.
+    Example: 30.0 for at most $30/1M output tokens
+    """
     def __init__(
         self,
         *,
@@ -465,6 +565,8 @@ global___PriceRange = PriceRange
 
 @typing.final
 class TokenRange(google.protobuf.message.Message):
+    """TokenRange defines min/max token constraints for filtering models."""
+
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
 
     MIN_CONTEXT_WINDOW_FIELD_NUMBER: builtins.int
@@ -472,9 +574,21 @@ class TokenRange(google.protobuf.message.Message):
     MIN_OUTPUT_TOKENS_FIELD_NUMBER: builtins.int
     MAX_OUTPUT_TOKENS_FIELD_NUMBER: builtins.int
     min_context_window: builtins.int
+    """Minimum context window size required.
+    Example: 8192 for at least 8k context
+    """
     max_context_window: builtins.int
+    """Maximum context window size allowed.
+    Example: 128000 for at most 128k context
+    """
     min_output_tokens: builtins.int
+    """Minimum output token limit required.
+    Example: 2048 for at least 2k output tokens
+    """
     max_output_tokens: builtins.int
+    """Maximum output token limit allowed.
+    Example: 16384 for at most 16k output tokens
+    """
     def __init__(
         self,
         *,
@@ -501,6 +615,8 @@ global___TokenRange = TokenRange
 
 @typing.final
 class PerformanceRange(google.protobuf.message.Message):
+    """PerformanceRange defines minimum performance scores for filtering."""
+
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
 
     MIN_REASONING_SCORE_FIELD_NUMBER: builtins.int
@@ -509,10 +625,25 @@ class PerformanceRange(google.protobuf.message.Message):
     MIN_FACTUAL_SCORE_FIELD_NUMBER: builtins.int
     MIN_MATH_SCORE_FIELD_NUMBER: builtins.int
     min_reasoning_score: builtins.float
+    """Minimum reasoning score (0-10).
+    Example: 7.5 for strong reasoning models only
+    """
     min_coding_score: builtins.float
+    """Minimum coding score (0-10).
+    Example: 8.0 for excellent coding models only
+    """
     min_creative_score: builtins.float
+    """Minimum creative writing score (0-10).
+    Example: 7.0 for good creative models only
+    """
     min_factual_score: builtins.float
+    """Minimum factual accuracy score (0-10).
+    Example: 8.5 for highly accurate models only
+    """
     min_math_score: builtins.float
+    """Minimum mathematical ability score (0-10).
+    Example: 9.0 for advanced math models only
+    """
     def __init__(
         self,
         *,
@@ -554,7 +685,7 @@ class SearchModelsResponse(google.protobuf.message.Message):
     def models(
         self,
     ) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[
-        weaveapi.modex.v1.model_pb2.Model
+        weaveapi.llmx.v1.model_pb2.Model
     ]: ...
     @property
     def facets(
@@ -565,8 +696,7 @@ class SearchModelsResponse(google.protobuf.message.Message):
     def __init__(
         self,
         *,
-        models: collections.abc.Iterable[weaveapi.modex.v1.model_pb2.Model]
-        | None = ...,
+        models: collections.abc.Iterable[weaveapi.llmx.v1.model_pb2.Model] | None = ...,
         next_page_token: builtins.str = ...,
         total_count: builtins.int = ...,
         facets: collections.abc.Iterable[global___FacetResult] | None = ...,
@@ -720,7 +850,7 @@ class ModelComparison(google.protobuf.message.Message):
     MODEL_FIELD_NUMBER: builtins.int
     HIGHLIGHTED_DIFFERENCES_FIELD_NUMBER: builtins.int
     @property
-    def model(self) -> weaveapi.modex.v1.model_pb2.Model: ...
+    def model(self) -> weaveapi.llmx.v1.model_pb2.Model: ...
     @property
     def highlighted_differences(
         self,
@@ -728,7 +858,7 @@ class ModelComparison(google.protobuf.message.Message):
     def __init__(
         self,
         *,
-        model: weaveapi.modex.v1.model_pb2.Model | None = ...,
+        model: weaveapi.llmx.v1.model_pb2.Model | None = ...,
         highlighted_differences: collections.abc.Mapping[builtins.str, builtins.str]
         | None = ...,
     ) -> None: ...
@@ -1106,11 +1236,11 @@ class TrendingModel(google.protobuf.message.Message):
     """Percentage"""
     rank: builtins.int
     @property
-    def model(self) -> weaveapi.modex.v1.model_pb2.Model: ...
+    def model(self) -> weaveapi.llmx.v1.model_pb2.Model: ...
     def __init__(
         self,
         *,
-        model: weaveapi.modex.v1.model_pb2.Model | None = ...,
+        model: weaveapi.llmx.v1.model_pb2.Model | None = ...,
         api_calls: builtins.int = ...,
         unique_users: builtins.int = ...,
         growth_rate: builtins.float = ...,