Merge pull request #44 from isaacus-dev/release-please--branches--main--changes--next

release: 0.2.0

Author: umarbutler

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.6"
+  ".": "0.2.0"
 }

.stats.yml

@@ -1,2 +1,4 @@
 configured_endpoints: 1
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/isaacus%2Fisaacus-ec269bff43481aeb5c72d3074aa31815ef915d435e78bc62b0290437a7b2992a.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/isaacus%2Fisaacus-19689acec6acc1fe55f5b1f80b6029b2115db76aceb76da98a36e22115990af2.yml
+openapi_spec_hash: d647b0df96ea892932515aa18f690e2a
+config_hash: 8a781867f31df68b9c6fba04c165c647

CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 0.2.0 (2025-03-30)
+
+Full Changelog: [v0.1.6...v0.2.0](https://github.com/isaacus-dev/isaacus-python/compare/v0.1.6...v0.2.0)
+
+### ⚠ BREAKING CHANGES
+
+* **api:** started sorting chunks by score and added `index` field ([#45](https://github.com/isaacus-dev/isaacus-python/issues/45))
+
+### Features
+
+* **api:** started sorting chunks by score and added `index` field ([#45](https://github.com/isaacus-dev/isaacus-python/issues/45)) ([c9999cd](https://github.com/isaacus-dev/isaacus-python/commit/c9999cd77abfe0101a3d30536261a43404cfef6d))
+
+
+### Chores
+
+* fix typos ([#43](https://github.com/isaacus-dev/isaacus-python/issues/43)) ([0667577](https://github.com/isaacus-dev/isaacus-python/commit/066757702f47e403a06cf057f20faa5fa955b135))
+
 ## 0.1.6 (2025-03-18)
 
 Full Changelog: [v0.1.5...v0.1.6](https://github.com/isaacus-dev/isaacus-python/compare/v0.1.5...v0.1.6)

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "isaacus"
-version = "0.1.6"
+version = "0.2.0"
 description = "The official Python library for the isaacus API"
 dynamic = ["readme"]
 license = "Apache-2.0"

src/isaacus/_models.py

@@ -681,7 +681,7 @@ def set_pydantic_config(typ: Any, config: pydantic.ConfigDict) -> None:
     setattr(typ, "__pydantic_config__", config)  # noqa: B010
 
 
-# our use of subclasssing here causes weirdness for type checkers,
+# our use of subclassing here causes weirdness for type checkers,
 # so we just pretend that we don't subclass
 if TYPE_CHECKING:
     GenericModel = BaseModel

src/isaacus/_utils/_transform.py

@@ -126,7 +126,7 @@ def _get_annotated_type(type_: type) -> type | None:
 def _maybe_transform_key(key: str, type_: type) -> str:
     """Transform the given `data` based on the annotations provided in `type_`.
 
-    Note: this function only looks at `Annotated` types that contain `PropertInfo` metadata.
+    Note: this function only looks at `Annotated` types that contain `PropertyInfo` metadata.
     """
     annotated_type = _get_annotated_type(type_)
     if annotated_type is None:

src/isaacus/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "isaacus"
-__version__ = "0.1.6"  # x-release-please-version
+__version__ = "0.2.0"  # x-release-please-version

src/isaacus/types/classifications/universal_classification.py

@@ -11,6 +11,9 @@ class Chunk(BaseModel):
     end: int
     """The end index of the chunk in the original text."""
 
+    index: int
+    """The index of the chunk in the list of chunks."""
+
     score: float
     """
     The model's score of the likelihood that the query expressed about the chunk is
@@ -37,7 +40,7 @@ class UniversalClassification(BaseModel):
     """
     The text as broken into chunks by
     [semchunk](https://github.com/isaacus-dev/semchunk), each chunk with its own
-    confidence score.
+    confidence score, ordered from highest to lowest score.
 
     If no chunking occurred, this will be `null`.
     """