Merge pull request #882 from Mirascope/fix-cost-imports-docs

Fix cost imports and API docs

Author: willbakst

docs/api/core/base/types.md

@@ -0,0 +1,3 @@
+# mirascope.core.base.types
+
+::: mirascope.core.base.types

docs/api/core/costs/calculate_cost.md

@@ -0,0 +1,3 @@
+# mirascope.core.costs.calculate_cost
+
+::: mirascope.core.costs.calculate_cost

mirascope/core/__init__.py

@@ -14,6 +14,7 @@
     BaseTool,
     BaseToolKit,
     CacheControlPart,
+    CostMetadata,
     DocumentPart,
     FromCallArgs,
     ImagePart,
@@ -74,6 +75,7 @@
     "BaseTool",
     "BaseToolKit",
     "CacheControlPart",
+    "CostMetadata",
     "DocumentPart",
     "FromCallArgs",
     "ImagePart",

mirascope/core/base/__init__.py

@@ -30,7 +30,14 @@
 from .structured_stream import BaseStructuredStream
 from .tool import BaseTool, GenerateJsonSchemaNoTitles, ToolConfig
 from .toolkit import BaseToolKit, toolkit_tool
-from .types import AudioSegment, JsonableType, LocalProvider, Provider, Usage
+from .types import (
+    AudioSegment,
+    CostMetadata,
+    JsonableType,
+    LocalProvider,
+    Provider,
+    Usage,
+)
 
 __all__ = [
     "AudioPart",
@@ -50,6 +57,7 @@
     "BaseType",
     "CacheControlPart",
     "CommonCallParams",
+    "CostMetadata",
     "DocumentPart",
     "FromCallArgs",
     "GenerateJsonSchemaNoTitles",

mirascope/llm/__init__.py

@@ -1,10 +1,11 @@
-from ..core import LocalProvider, Provider, calculate_cost
+from ..core import CostMetadata, LocalProvider, Provider, calculate_cost
 from .call_response import CallResponse
 from .llm_call import call
 from .llm_override import override
 
 __all__ = [
     "CallResponse",
+    "CostMetadata",
     "LocalProvider",
     "Provider",
     "calculate_cost",

mkdocs.yml

@@ -347,6 +347,7 @@ nav:
               - structured_stream: "api/core/base/structured_stream.md"
               - tool: "api/core/base/tool.md"
               - toolkit: "api/core/base/toolkit.md"
+              - types: "api/core/base/types.md"
           - Bedrock:
               - call: "api/core/bedrock/call.md"
               - call_params: "api/core/bedrock/call_params.md"
@@ -363,6 +364,8 @@ nav:
               - dynamic_config: "api/core/cohere/dynamic_config.md"
               - stream: "api/core/cohere/stream.md"
               - tool: "api/core/cohere/tool.md"
+          - Costs:
+              - calculate_cost: "api/core/costs/calculate_cost.md"
           - Gemini:
               - call: "api/core/gemini/call.md"
               - call_params: "api/core/gemini/call_params.md"

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mirascope"
-version = "1.20.0"
+version = "1.20.1"
 description = "LLM abstractions that aren't obstructions"
 readme = "README.md"
 license = { file = "LICENSE" }