isaacus 0.10.1__tar.gz → 0.12.0__tar.gz

isaacus-0.12.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.12.0"
+}

{isaacus-0.10.1 → isaacus-0.12.0}/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 0.12.0 (2026-02-03)
+
+Full Changelog: [v0.11.0...v0.12.0](https://github.com/isaacus-dev/isaacus-python/compare/v0.11.0...v0.12.0)
+
+### Features
+
+* **sdk:** add `qa` as an initialism ([27162f3](https://github.com/isaacus-dev/isaacus-python/commit/27162f3e98efa095e41f67801c6a3497709be9d6))
+* **sdk:** force ilgs v1 prefix on models ([62bc9ff](https://github.com/isaacus-dev/isaacus-python/commit/62bc9ffc03feb68e3638cfee3d9df9a8547bb9e8))
+* **sdk:** modify how ILGSv1 models are cased ([f295222](https://github.com/isaacus-dev/isaacus-python/commit/f2952227e58618b33c4d0da9515a1c73942a771a))
+* **sdk:** order properties as in spec ([3dc865c](https://github.com/isaacus-dev/isaacus-python/commit/3dc865c2ee865b334b7f0ca8810226f3ac251be8))
+
+
+### Bug Fixes
+
+* **api:** merge duplicate components, reorder required fields ([55b68ce](https://github.com/isaacus-dev/isaacus-python/commit/55b68ce2bc294f094ccaf3750ea1b932ed4f95f5))
+
+## 0.11.0 (2026-02-03)
+
+Full Changelog: [v0.10.1...v0.11.0](https://github.com/isaacus-dev/isaacus-python/compare/v0.10.1...v0.11.0)
+
+### Features
+
+* **api:** remove -preview from model name ([e86f57d](https://github.com/isaacus-dev/isaacus-python/commit/e86f57dc2ac6c1f5a11973aaf1c4e5c19b6b2ec6))
+
 ## 0.10.1 (2026-02-03)
 
 Full Changelog: [v0.10.0...v0.10.1](https://github.com/isaacus-dev/isaacus-python/compare/v0.10.0...v0.10.1)

{isaacus-0.10.1 → isaacus-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: isaacus
-Version: 0.10.1
+Version: 0.12.0
 Summary: The official Python library for the isaacus API
 Project-URL: Homepage, https://github.com/isaacus-dev/isaacus-python
 Project-URL: Repository, https://github.com/isaacus-dev/isaacus-python

{isaacus-0.10.1 → isaacus-0.12.0}/api.md

@@ -38,7 +38,7 @@ Methods:
 
 # Extractions
 
-## Qa
+## QA
 
 Types:
 
@@ -55,7 +55,23 @@ Methods:
 Types:
 
 ```python
-from isaacus.types import EnrichmentResponse
+from isaacus.types import (
+    EnrichmentResponse,
+    ILGSv1Crossreference,
+    ILGSv1Date,
+    ILGSv1Document,
+    ILGSv1Email,
+    ILGSv1ExternalDocument,
+    ILGSv1IDNumber,
+    ILGSv1Location,
+    ILGSv1Person,
+    ILGSv1PhoneNumber,
+    ILGSv1Quote,
+    ILGSv1Segment,
+    ILGSv1Span,
+    ILGSv1Term,
+    ILGSv1Website,
+)
 ```
 
 Methods:

{isaacus-0.10.1 → isaacus-0.12.0}/pyproject.toml

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

{isaacus-0.10.1 → isaacus-0.12.0}/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.10.1"  # x-release-please-version
+__version__ = "0.12.0"  # x-release-please-version

{isaacus-0.10.1 → isaacus-0.12.0}/src/isaacus/resources/enrichments.py

@@ -47,7 +47,7 @@ class EnrichmentsResource(SyncAPIResource):
     def create(
         self,
         *,
-        model: Literal["kanon-2-enricher-preview"],
+        model: Literal["kanon-2-enricher"],
         texts: Union[SequenceNotStr[str], str],
         overflow_strategy: Optional[Literal["auto", "drop_end"]] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -129,7 +129,7 @@ class AsyncEnrichmentsResource(AsyncAPIResource):
     async def create(
         self,
         *,
-        model: Literal["kanon-2-enricher-preview"],
+        model: Literal["kanon-2-enricher"],
         texts: Union[SequenceNotStr[str], str],
         overflow_strategy: Optional[Literal["auto", "drop_end"]] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.

{isaacus-0.10.1 → isaacus-0.12.0}/src/isaacus/resources/extractions/__init__.py

@@ -1,12 +1,12 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 from .qa import (
-    QaResource,
-    AsyncQaResource,
-    QaResourceWithRawResponse,
-    AsyncQaResourceWithRawResponse,
-    QaResourceWithStreamingResponse,
-    AsyncQaResourceWithStreamingResponse,
+    QAResource,
+    AsyncQAResource,
+    QAResourceWithRawResponse,
+    AsyncQAResourceWithRawResponse,
+    QAResourceWithStreamingResponse,
+    AsyncQAResourceWithStreamingResponse,
 )
 from .extractions import (
     ExtractionsResource,
@@ -18,12 +18,12 @@ from .extractions import (
 )
 
 __all__ = [
-    "QaResource",
-    "AsyncQaResource",
-    "QaResourceWithRawResponse",
-    "AsyncQaResourceWithRawResponse",
-    "QaResourceWithStreamingResponse",
-    "AsyncQaResourceWithStreamingResponse",
+    "QAResource",
+    "AsyncQAResource",
+    "QAResourceWithRawResponse",
+    "AsyncQAResourceWithRawResponse",
+    "QAResourceWithStreamingResponse",
+    "AsyncQAResourceWithStreamingResponse",
     "ExtractionsResource",
     "AsyncExtractionsResource",
     "ExtractionsResourceWithRawResponse",

{isaacus-0.10.1 → isaacus-0.12.0}/src/isaacus/resources/extractions/extractions.py

@@ -3,12 +3,12 @@
 from __future__ import annotations
 
 from .qa import (
-    QaResource,
-    AsyncQaResource,
-    QaResourceWithRawResponse,
-    AsyncQaResourceWithRawResponse,
-    QaResourceWithStreamingResponse,
-    AsyncQaResourceWithStreamingResponse,
+    QAResource,
+    AsyncQAResource,
+    QAResourceWithRawResponse,
+    AsyncQAResourceWithRawResponse,
+    QAResourceWithStreamingResponse,
+    AsyncQAResourceWithStreamingResponse,
 )
 from ..._compat import cached_property
 from ..._resource import SyncAPIResource, AsyncAPIResource
@@ -18,8 +18,8 @@ __all__ = ["ExtractionsResource", "AsyncExtractionsResource"]
 
 class ExtractionsResource(SyncAPIResource):
     @cached_property
-    def qa(self) -> QaResource:
-        return QaResource(self._client)
+    def qa(self) -> QAResource:
+        return QAResource(self._client)
 
     @cached_property
     def with_raw_response(self) -> ExtractionsResourceWithRawResponse:
@@ -43,8 +43,8 @@ class ExtractionsResource(SyncAPIResource):
 
 class AsyncExtractionsResource(AsyncAPIResource):
     @cached_property
-    def qa(self) -> AsyncQaResource:
-        return AsyncQaResource(self._client)
+    def qa(self) -> AsyncQAResource:
+        return AsyncQAResource(self._client)
 
     @cached_property
     def with_raw_response(self) -> AsyncExtractionsResourceWithRawResponse:
@@ -71,8 +71,8 @@ class ExtractionsResourceWithRawResponse:
         self._extractions = extractions
 
     @cached_property
-    def qa(self) -> QaResourceWithRawResponse:
-        return QaResourceWithRawResponse(self._extractions.qa)
+    def qa(self) -> QAResourceWithRawResponse:
+        return QAResourceWithRawResponse(self._extractions.qa)
 
 
 class AsyncExtractionsResourceWithRawResponse:
@@ -80,8 +80,8 @@ class AsyncExtractionsResourceWithRawResponse:
         self._extractions = extractions
 
     @cached_property
-    def qa(self) -> AsyncQaResourceWithRawResponse:
-        return AsyncQaResourceWithRawResponse(self._extractions.qa)
+    def qa(self) -> AsyncQAResourceWithRawResponse:
+        return AsyncQAResourceWithRawResponse(self._extractions.qa)
 
 
 class ExtractionsResourceWithStreamingResponse:
@@ -89,8 +89,8 @@ class ExtractionsResourceWithStreamingResponse:
         self._extractions = extractions
 
     @cached_property
-    def qa(self) -> QaResourceWithStreamingResponse:
-        return QaResourceWithStreamingResponse(self._extractions.qa)
+    def qa(self) -> QAResourceWithStreamingResponse:
+        return QAResourceWithStreamingResponse(self._extractions.qa)
 
 
 class AsyncExtractionsResourceWithStreamingResponse:
@@ -98,5 +98,5 @@ class AsyncExtractionsResourceWithStreamingResponse:
         self._extractions = extractions
 
     @cached_property
-    def qa(self) -> AsyncQaResourceWithStreamingResponse:
-        return AsyncQaResourceWithStreamingResponse(self._extractions.qa)
+    def qa(self) -> AsyncQAResourceWithStreamingResponse:
+        return AsyncQAResourceWithStreamingResponse(self._extractions.qa)

{isaacus-0.10.1 → isaacus-0.12.0}/src/isaacus/resources/extractions/qa.py

@@ -21,28 +21,28 @@ from ..._base_client import make_request_options
 from ...types.extractions import qa_create_params
 from ...types.extractions.answer_extraction_response import AnswerExtractionResponse
 
-__all__ = ["QaResource", "AsyncQaResource"]
+__all__ = ["QAResource", "AsyncQAResource"]
 
 
-class QaResource(SyncAPIResource):
+class QAResource(SyncAPIResource):
     @cached_property
-    def with_raw_response(self) -> QaResourceWithRawResponse:
+    def with_raw_response(self) -> QAResourceWithRawResponse:
         """
         This property can be used as a prefix for any HTTP method call to return
         the raw response object instead of the parsed content.
 
         For more information, see https://www.github.com/isaacus-dev/isaacus-python#accessing-raw-response-data-eg-headers
         """
-        return QaResourceWithRawResponse(self)
+        return QAResourceWithRawResponse(self)
 
     @cached_property
-    def with_streaming_response(self) -> QaResourceWithStreamingResponse:
+    def with_streaming_response(self) -> QAResourceWithStreamingResponse:
         """
         An alternative to `.with_raw_response` that doesn't eagerly read the response body.
 
         For more information, see https://www.github.com/isaacus-dev/isaacus-python#with_streaming_response
         """
-        return QaResourceWithStreamingResponse(self)
+        return QAResourceWithStreamingResponse(self)
 
     def create(
         self,
@@ -50,9 +50,9 @@ class QaResource(SyncAPIResource):
         model: Literal["kanon-answer-extractor", "kanon-answer-extractor-mini"],
         query: str,
         texts: SequenceNotStr[str],
-        chunking_options: Optional[qa_create_params.ChunkingOptions] | Omit = omit,
         ignore_inextractability: bool | Omit = omit,
         top_k: int | Omit = omit,
+        chunking_options: Optional[qa_create_params.ChunkingOptions] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -82,8 +82,6 @@ class QaResource(SyncAPIResource):
 
               Each text must contain at least one non-whitespace character.
 
-          chunking_options: Options for how to split text into smaller chunks.
-
           ignore_inextractability: Whether to, if the model's score of the likelihood that an answer can not be
               extracted from a text is greater than the highest score of all possible answers,
               still return the highest scoring answers for that text.
@@ -96,6 +94,8 @@ class QaResource(SyncAPIResource):
 
               If `null`, which is the default, all answers will be returned.
 
+          chunking_options: Options for how to split text into smaller chunks.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -111,11 +111,11 @@ class QaResource(SyncAPIResource):
                     "model": model,
                     "query": query,
                     "texts": texts,
-                    "chunking_options": chunking_options,
                     "ignore_inextractability": ignore_inextractability,
                     "top_k": top_k,
+                    "chunking_options": chunking_options,
                 },
-                qa_create_params.QaCreateParams,
+                qa_create_params.QACreateParams,
             ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
@@ -124,25 +124,25 @@ class QaResource(SyncAPIResource):
         )
 
 
-class AsyncQaResource(AsyncAPIResource):
+class AsyncQAResource(AsyncAPIResource):
     @cached_property
-    def with_raw_response(self) -> AsyncQaResourceWithRawResponse:
+    def with_raw_response(self) -> AsyncQAResourceWithRawResponse:
         """
         This property can be used as a prefix for any HTTP method call to return
         the raw response object instead of the parsed content.
 
         For more information, see https://www.github.com/isaacus-dev/isaacus-python#accessing-raw-response-data-eg-headers
         """
-        return AsyncQaResourceWithRawResponse(self)
+        return AsyncQAResourceWithRawResponse(self)
 
     @cached_property
-    def with_streaming_response(self) -> AsyncQaResourceWithStreamingResponse:
+    def with_streaming_response(self) -> AsyncQAResourceWithStreamingResponse:
         """
         An alternative to `.with_raw_response` that doesn't eagerly read the response body.
 
         For more information, see https://www.github.com/isaacus-dev/isaacus-python#with_streaming_response
         """
-        return AsyncQaResourceWithStreamingResponse(self)
+        return AsyncQAResourceWithStreamingResponse(self)
 
     async def create(
         self,
@@ -150,9 +150,9 @@ class AsyncQaResource(AsyncAPIResource):
         model: Literal["kanon-answer-extractor", "kanon-answer-extractor-mini"],
         query: str,
         texts: SequenceNotStr[str],
-        chunking_options: Optional[qa_create_params.ChunkingOptions] | Omit = omit,
         ignore_inextractability: bool | Omit = omit,
         top_k: int | Omit = omit,
+        chunking_options: Optional[qa_create_params.ChunkingOptions] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -182,8 +182,6 @@ class AsyncQaResource(AsyncAPIResource):
 
               Each text must contain at least one non-whitespace character.
 
-          chunking_options: Options for how to split text into smaller chunks.
-
           ignore_inextractability: Whether to, if the model's score of the likelihood that an answer can not be
               extracted from a text is greater than the highest score of all possible answers,
               still return the highest scoring answers for that text.
@@ -196,6 +194,8 @@ class AsyncQaResource(AsyncAPIResource):
 
               If `null`, which is the default, all answers will be returned.
 
+          chunking_options: Options for how to split text into smaller chunks.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -211,11 +211,11 @@ class AsyncQaResource(AsyncAPIResource):
                     "model": model,
                     "query": query,
                     "texts": texts,
-                    "chunking_options": chunking_options,
                     "ignore_inextractability": ignore_inextractability,
                     "top_k": top_k,
+                    "chunking_options": chunking_options,
                 },
-                qa_create_params.QaCreateParams,
+                qa_create_params.QACreateParams,
             ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
@@ -224,8 +224,8 @@ class AsyncQaResource(AsyncAPIResource):
         )
 
 
-class QaResourceWithRawResponse:
-    def __init__(self, qa: QaResource) -> None:
+class QAResourceWithRawResponse:
+    def __init__(self, qa: QAResource) -> None:
         self._qa = qa
 
         self.create = to_raw_response_wrapper(
@@ -233,8 +233,8 @@ class QaResourceWithRawResponse:
         )
 
 
-class AsyncQaResourceWithRawResponse:
-    def __init__(self, qa: AsyncQaResource) -> None:
+class AsyncQAResourceWithRawResponse:
+    def __init__(self, qa: AsyncQAResource) -> None:
         self._qa = qa
 
         self.create = async_to_raw_response_wrapper(
@@ -242,8 +242,8 @@ class AsyncQaResourceWithRawResponse:
         )
 
 
-class QaResourceWithStreamingResponse:
-    def __init__(self, qa: QaResource) -> None:
+class QAResourceWithStreamingResponse:
+    def __init__(self, qa: QAResource) -> None:
         self._qa = qa
 
         self.create = to_streamed_response_wrapper(
@@ -251,8 +251,8 @@ class QaResourceWithStreamingResponse:
         )
 
 
-class AsyncQaResourceWithStreamingResponse:
-    def __init__(self, qa: AsyncQaResource) -> None:
+class AsyncQAResourceWithStreamingResponse:
+    def __init__(self, qa: AsyncQAResource) -> None:
         self._qa = qa
 
         self.create = async_to_streamed_response_wrapper(

isaacus-0.12.0/src/isaacus/types/__init__.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .ilgs_v1_date import ILGSv1Date as ILGSv1Date
+from .ilgs_v1_span import ILGSv1Span as ILGSv1Span
+from .ilgs_v1_term import ILGSv1Term as ILGSv1Term
+from .ilgs_v1_email import ILGSv1Email as ILGSv1Email
+from .ilgs_v1_quote import ILGSv1Quote as ILGSv1Quote
+from .ilgs_v1_person import ILGSv1Person as ILGSv1Person
+from .ilgs_v1_segment import ILGSv1Segment as ILGSv1Segment
+from .ilgs_v1_website import ILGSv1Website as ILGSv1Website
+from .ilgs_v1_document import ILGSv1Document as ILGSv1Document
+from .ilgs_v1_location import ILGSv1Location as ILGSv1Location
+from .ilgs_v1_id_number import ILGSv1IDNumber as ILGSv1IDNumber
+from .embedding_response import EmbeddingResponse as EmbeddingResponse
+from .reranking_response import RerankingResponse as RerankingResponse
+from .enrichment_response import EnrichmentResponse as EnrichmentResponse
+from .ilgs_v1_phone_number import ILGSv1PhoneNumber as ILGSv1PhoneNumber
+from .ilgs_v1_crossreference import ILGSv1Crossreference as ILGSv1Crossreference
+from .embedding_create_params import EmbeddingCreateParams as EmbeddingCreateParams
+from .reranking_create_params import RerankingCreateParams as RerankingCreateParams
+from .enrichment_create_params import EnrichmentCreateParams as EnrichmentCreateParams
+from .ilgs_v1_external_document import ILGSv1ExternalDocument as ILGSv1ExternalDocument

{isaacus-0.10.1 → isaacus-0.12.0}/src/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.

isaacus-0.12.0/src/isaacus/types/enrichment_response.py

@@ -0,0 +1,60 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from .._models import BaseModel
+from .ilgs_v1_document import ILGSv1Document
+
+__all__ = ["EnrichmentResponse", "Result", "Usage"]
+
+
+class Result(BaseModel):
+    """An enriched document alongside its index in the input array of texts."""
+
+    index: int
+    """
+    The index of this document in the input array of texts, starting at `0` (and,
+    therefore, ending at the number of inputs minus `1`).
+    """
+
+    document: ILGSv1Document
+    """The enriched document."""
+
+
+class Usage(BaseModel):
+    """Statistics about the usage of resources in the process of enriching the input."""
+
+    input_tokens: int
+    """The total number of tokens inputted to the model."""
+
+
+class EnrichmentResponse(BaseModel):
+    results: List[Result]
+    """
+    The input documents enriched into version 1.0.0 of the Isaacus Legal Graph
+    Schema (IGLS).
+
+    All spans in an enriched document graph are indexed into the Unicode code point
+    space of a source document. Access to source documents is thus required to
+    resolve spans into text.
+
+    The start and end indices of spans are zero-based (i.e., the first Unicode code
+    point in the document is at index 0) and half-open (i.e., the end index is
+    exclusive).
+
+    All spans are globally laminar and well-nested similar to XML—it is impossible
+    for any two spans to partially overlap; they can only be disjoint, adjacent, or
+    wholly nested.
+
+    Spans of the exact same type (e.g., segments) will never be duplicated.
+
+    Spans cannot be empty and will never start or end at whitespace.
+
+    When using programming languages other than Python (which uses zero-based,
+    half-open, Unicode code point-spaced string indexing), indices may need to be
+    translated accordingly (for example, JavaScript slices into UTF-16 code units
+    instead of Unicode code points).
+    """
+
+    usage: Usage
+    """Statistics about the usage of resources in the process of enriching the input."""

{isaacus-0.10.1 → isaacus-0.12.0}/src/isaacus/types/extractions/__init__.py

@@ -2,5 +2,5 @@
 
 from __future__ import annotations
 
-from .qa_create_params import QaCreateParams as QaCreateParams
+from .qa_create_params import QACreateParams as QACreateParams
 from .answer_extraction_response import AnswerExtractionResponse as AnswerExtractionResponse

{isaacus-0.10.1 → isaacus-0.12.0}/src/isaacus/types/extractions/qa_create_params.py

@@ -7,10 +7,10 @@ from typing_extensions import Literal, Required, TypedDict
 
 from ..._types import SequenceNotStr
 
-__all__ = ["QaCreateParams", "ChunkingOptions"]
+__all__ = ["QACreateParams", "ChunkingOptions"]
 
 
-class QaCreateParams(TypedDict, total=False):
+class QACreateParams(TypedDict, total=False):
     model: Required[Literal["kanon-answer-extractor", "kanon-answer-extractor-mini"]]
     """
     The ID of the
@@ -35,9 +35,6 @@ class QaCreateParams(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."""
-
     ignore_inextractability: bool
     """
     Whether to, if the model's score of the likelihood that an answer can not be
@@ -55,15 +52,18 @@ class QaCreateParams(TypedDict, total=False):
     If `null`, which is the default, all answers will be returned.
     """
 
+    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-0.12.0/src/isaacus/types/ilgs_v1_crossreference.py

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+from .ilgs_v1_span import ILGSv1Span
+
+__all__ = ["ILGSv1Crossreference"]
+
+
+class ILGSv1Crossreference(BaseModel):
+    """A cross-reference within the document pointing to one or more segments."""
+
+    start: str
+    """
+    The unique identifier of the earliest segment in the span of segments being
+    cross-referenced with ties broken in favor of the least-nested (i.e., largest)
+    segment. If the cross-reference points to a single segment, `start` and `end`
+    will be identical.
+    """
+
+    end: str
+    """
+    The unique identifier of the latest segment in the span of segments being
+    cross-referenced with ties broken in favor of the least-nested (i.e., largest)
+    segment. If the cross-reference points to a single segment, `start` and `end`
+    will be identical.
+    """
+
+    span: ILGSv1Span
+    """A zero-based, half-open span into the Unicode code point space of input text.
+
+    All spans are globally laminar and well-nested similar to XML—it is impossible
+    for any two spans to partially overlap; they can only be disjoint, adjacent, or
+    wholly nested. Spans of the exact same type (e.g., segments) will never be
+    duplicated.
+
+    A span cannot be empty and will never start or end at whitespace.
+
+    Note that, when using programming languages other than Python (which uses
+    zero-based, half-open, Unicode code point-spaced string indexing), indices may
+    need to be translated accordingly (for example, JavaScript slices into UTF-16
+    code units instead of Unicode code points).
+    """