isaacus 0.10.1__py3-none-any.whl → 0.12.0__py3-none-any.whl

isaacus/types/classifications/universal_classification_response.py

@@ -8,13 +8,6 @@ __all__ = ["UniversalClassificationResponse", "Classification", "ClassificationC
 
 
 class ClassificationChunk(BaseModel):
-    end: int
-    """
-    The index of the character immediately after the last character of the chunk in
-    the original text, beginning from `0` (such that, in Python, the chunk is
-    equivalent to `text[start:end]`).
-    """
-
     index: int
     """
     The original position of the chunk in the outputted list of chunks before
@@ -22,6 +15,19 @@ class ClassificationChunk(BaseModel):
     `1`).
     """
 
+    start: int
+    """
+    The index of the character in the original text where the chunk starts,
+    beginning from `0`.
+    """
+
+    end: int
+    """
+    The index of the character immediately after the last character of the chunk in
+    the original text, beginning from `0` (such that, in Python, the chunk is
+    equivalent to `text[start:end]`).
+    """
+
     score: float
     """
     The model's score of the likelihood that the query expressed about the chunk is
@@ -31,26 +37,11 @@ class ClassificationChunk(BaseModel):
     score less than `0.5` indicates that the chunk does not support the query.
     """
 
-    start: int
-    """
-    The index of the character in the original text where the chunk starts,
-    beginning from `0`.
-    """
-
     text: str
     """The text of the chunk."""
 
 
 class Classification(BaseModel):
-    chunks: Optional[List[ClassificationChunk]] = None
-    """
-    The text as broken into chunks by
-    [semchunk](https://github.com/isaacus-dev/semchunk), each chunk with its own
-    confidence score, ordered from highest to lowest score.
-
-    If no chunking occurred, this will be `null`.
-    """
-
     index: int
     """
     The index of the text in the input array of texts, starting from `0` (and,
@@ -66,6 +57,15 @@ class Classification(BaseModel):
     score less than `0.5` indicates that the text does not support the query.
     """
 
+    chunks: Optional[List[ClassificationChunk]] = None
+    """
+    The text as broken into chunks by
+    [semchunk](https://github.com/isaacus-dev/semchunk), each chunk with its own
+    confidence score, ordered from highest to lowest score.
+
+    If no chunking occurred, this will be `null`.
+    """
+
 
 class Usage(BaseModel):
     """Statistics about the usage of resources in the process of classifying the text."""

isaacus/types/classifications/universal_create_params.py

@@ -34,9 +34,6 @@ class UniversalCreateParams(TypedDict, total=False):
     Each text must contain at least one non-whitespace character.
     """
 
-    chunking_options: Optional[ChunkingOptions]
-    """Options for how to split text into smaller chunks."""
-
     is_iql: bool
     """
     Whether the query should be interpreted as an
@@ -57,15 +54,18 @@ class UniversalCreateParams(TypedDict, total=False):
     `chunk_min` uses the lowest confidence score of all of the texts' chunks.
     """
 
+    chunking_options: Optional[ChunkingOptions]
+    """Options for how to split text into smaller chunks."""
+
 
 class ChunkingOptions(TypedDict, total=False):
     """Options for how to split text into smaller chunks."""
 
+    size: Optional[int]
+    """A whole number greater than or equal to 1."""
+
     overlap_ratio: Optional[float]
     """A number greater than or equal to 0 and less than 1."""
 
     overlap_tokens: Optional[int]
     """A whole number greater than or equal to 0."""
-
-    size: Optional[int]
-    """A whole number greater than or equal to 1."""

isaacus/types/embedding_create_params.py

@@ -25,8 +25,15 @@ class EmbeddingCreateParams(TypedDict, total=False):
     No more than 128 texts can be embedded in a single request.
     """
 
-    dimensions: Optional[int]
-    """A whole number greater than or equal to 1."""
+    task: Optional[Literal["retrieval/query", "retrieval/document"]]
+    """The task the embeddings will be used for.
+
+    `retrieval/query` is meant for queries and statements, and `retrieval/document`
+    is meant for anything to be retrieved using query embeddings.
+
+    If `null`, which is the default setting, embeddings will not be optimized for
+    any particular task.
+    """
 
     overflow_strategy: Optional[Literal["drop_end"]]
     """The strategy to employ when content exceeds the model's maximum input length.
@@ -38,12 +45,5 @@ class EmbeddingCreateParams(TypedDict, total=False):
     input length.
     """
 
-    task: Optional[Literal["retrieval/query", "retrieval/document"]]
-    """The task the embeddings will be used for.
-
-    `retrieval/query` is meant for queries and statements, and `retrieval/document`
-    is meant for anything to be retrieved using query embeddings.
-
-    If `null`, which is the default setting, embeddings will not be optimized for
-    any particular task.
-    """
+    dimensions: Optional[int]
+    """A whole number greater than or equal to 1."""

isaacus/types/embedding_response.py

@@ -8,15 +8,15 @@ __all__ = ["EmbeddingResponse", "Embedding", "Usage"]
 
 
 class Embedding(BaseModel):
-    embedding: List[float]
-    """The embedding of the content represented as an array of floating point numbers."""
-
     index: int
     """
     The position of the content in the input array of contents, starting from `0`
     (and, therefore, ending at the number of contents minus `1`).
     """
 
+    embedding: List[float]
+    """The embedding of the content represented as an array of floating point numbers."""
+
 
 class Usage(BaseModel):
     """Statistics about the usage of resources in the process of embedding the inputs."""

isaacus/types/enrichment_create_params.py

@@ -11,7 +11,7 @@ __all__ = ["EnrichmentCreateParams"]
 
 
 class EnrichmentCreateParams(TypedDict, total=False):
-    model: Required[Literal["kanon-2-enricher-preview"]]
+    model: Required[Literal["kanon-2-enricher"]]
     """
     The ID of the [model](https://docs.isaacus.com/models#enrichment) to use for
     enrichment.