feat(sdk): move ilgs structs around

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 5
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/isaacus%2Fisaacus-fa910a5a3d1321234423bd8c042d202a64d4d956ef45847b4de358cb18e447eb.yml
 openapi_spec_hash: 926b9b619c15e8570e496e11d4fb753e
-config_hash: ed02aaf8b97a6f9e13463c741be2a12f
+config_hash: 8608b9490f9a482b18bd8f733d2c82f6

api.md

@@ -62,25 +62,27 @@ Methods:
 
 - <code title="post /enrichments">client.enrichments.<a href="./src/isaacus/resources/enrichments.py">create</a>(\*\*<a href="src/isaacus/types/enrichment_create_params.py">params</a>) -> <a href="./src/isaacus/types/enrichment_response.py">EnrichmentResponse</a></code>
 
-# ILGSv1
+# ILGS
+
+## v1
 
 Types:
 
 ```python
-from isaacus.types import (
-    Crossreference,
-    Date,
-    Document,
-    Email,
-    ExternalDocument,
-    IDNumber,
-    Location,
-    Person,
-    PhoneNumber,
-    Quote,
-    Segment,
-    Span,
-    Term,
-    Website,
+from isaacus.types.ilgs import (
+    ILGSv1Crossreference,
+    ILGSv1Date,
+    ILGSv1Document,
+    ILGSv1Email,
+    ILGSv1ExternalDocument,
+    ILGSv1IDNumber,
+    ILGSv1Location,
+    ILGSv1Person,
+    ILGSv1PhoneNumber,
+    ILGSv1Quote,
+    ILGSv1Segment,
+    ILGSv1Span,
+    ILGSv1Term,
+    ILGSv1Website,
 )
 ```

src/isaacus/types/__init__.py

@@ -2,20 +2,6 @@
 
 from __future__ import annotations
 
-from .date import Date as Date
-from .span import Span as Span
-from .term import Term as Term
-from .email import Email as Email
-from .quote import Quote as Quote
-from .person import Person as Person
-from .segment import Segment as Segment
-from .website import Website as Website
-from .document import Document as Document
-from .location import Location as Location
-from .id_number import IDNumber as IDNumber
-from .phone_number import PhoneNumber as PhoneNumber
-from .crossreference import Crossreference as Crossreference
-from .external_document import ExternalDocument as ExternalDocument
 from .embedding_response import EmbeddingResponse as EmbeddingResponse
 from .reranking_response import RerankingResponse as RerankingResponse
 from .enrichment_response import EnrichmentResponse as EnrichmentResponse

src/isaacus/types/enrichment_response.py

@@ -3,7 +3,7 @@
 from typing import List
 
 from .._models import BaseModel
-from .document import Document
+from .ilgs.ilgs_v1_document import ILGSv1Document
 
 __all__ = ["EnrichmentResponse", "Result", "Usage"]
 
@@ -17,7 +17,7 @@ class Result(BaseModel):
     therefore, ending at the number of inputs minus `1`).
     """
 
-    document: Document
+    document: ILGSv1Document
     """The enriched document."""
 
 

src/isaacus/types/ilgs/__init__.py

@@ -0,0 +1,18 @@
+# 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 .ilgs_v1_phone_number import ILGSv1PhoneNumber as ILGSv1PhoneNumber
+from .ilgs_v1_crossreference import ILGSv1Crossreference as ILGSv1Crossreference
+from .ilgs_v1_external_document import ILGSv1ExternalDocument as ILGSv1ExternalDocument

src/isaacus/types/crossreference.py …cus/types/ilgs/ilgs_v1_crossreference.pysrc/isaacus/types/crossreference.py renamed to src/isaacus/types/ilgs/ilgs_v1_crossreference.py src/isaacus/types/crossreference.py renamed to src/isaacus/types/ilgs/ilgs_v1_crossreference.py

@@ -1,12 +1,12 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from .span import Span
-from .._models import BaseModel
+from ..._models import BaseModel
+from .ilgs_v1_span import ILGSv1Span
 
-__all__ = ["Crossreference"]
+__all__ = ["ILGSv1Crossreference"]
 
 
-class Crossreference(BaseModel):
+class ILGSv1Crossreference(BaseModel):
     """A cross-reference within the document pointing to one or more segments."""
 
     start: str
@@ -25,7 +25,7 @@ class Crossreference(BaseModel):
     will be identical.
     """
 
-    span: Span
+    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

src/isaacus/types/date.py src/isaacus/types/ilgs/ilgs_v1_date.pysrc/isaacus/types/date.py renamed to src/isaacus/types/ilgs/ilgs_v1_date.py

@@ -3,13 +3,13 @@
 from typing import List, Optional
 from typing_extensions import Literal
 
-from .span import Span
-from .._models import BaseModel
+from ..._models import BaseModel
+from .ilgs_v1_span import ILGSv1Span
 
-__all__ = ["Date"]
+__all__ = ["ILGSv1Date"]
 
 
-class Date(BaseModel):
+class ILGSv1Date(BaseModel):
     """
     A date identified in a document belonging to one of the following types: `creation`, `signature`, `effective`, `expiry`, `delivery`, `renewal`, `payment`, `birth`, or `death`.
 
@@ -63,7 +63,7 @@ class Date(BaseModel):
     `{index}` is a non-negative incrementing integer starting from zero.
     """
 
-    mentions: List[Span]
+    mentions: List[ILGSv1Span]
     """
     An array of one or more spans within the document's text where the date is
     mentioned.

src/isaacus/types/document.py …c/isaacus/types/ilgs/ilgs_v1_document.pysrc/isaacus/types/document.py renamed to src/isaacus/types/ilgs/ilgs_v1_document.py src/isaacus/types/document.py renamed to src/isaacus/types/ilgs/ilgs_v1_document.py

@@ -3,28 +3,28 @@
 from typing import List, Optional
 from typing_extensions import Literal
 
-from .date import Date
-from .span import Span
-from .term import Term
-from .email import Email
-from .quote import Quote
-from .person import Person
-from .segment import Segment
-from .website import Website
-from .._models import BaseModel
-from .location import Location
-from .id_number import IDNumber
-from .phone_number import PhoneNumber
-from .crossreference import Crossreference
-from .external_document import ExternalDocument
-
-__all__ = ["Document"]
-
-
-class Document(BaseModel):
+from ..._models import BaseModel
+from .ilgs_v1_date import ILGSv1Date
+from .ilgs_v1_span import ILGSv1Span
+from .ilgs_v1_term import ILGSv1Term
+from .ilgs_v1_email import ILGSv1Email
+from .ilgs_v1_quote import ILGSv1Quote
+from .ilgs_v1_person import ILGSv1Person
+from .ilgs_v1_segment import ILGSv1Segment
+from .ilgs_v1_website import ILGSv1Website
+from .ilgs_v1_location import ILGSv1Location
+from .ilgs_v1_id_number import ILGSv1IDNumber
+from .ilgs_v1_phone_number import ILGSv1PhoneNumber
+from .ilgs_v1_crossreference import ILGSv1Crossreference
+from .ilgs_v1_external_document import ILGSv1ExternalDocument
+
+__all__ = ["ILGSv1Document"]
+
+
+class ILGSv1Document(BaseModel):
     """The enriched document."""
 
-    title: Optional[Span] = None
+    title: Optional[ILGSv1Span] = None
     """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
@@ -40,7 +40,7 @@ class Document(BaseModel):
     code units instead of Unicode code points).
     """
 
-    subtitle: Optional[Span] = None
+    subtitle: Optional[ILGSv1Span] = None
     """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
@@ -88,25 +88,25 @@ class Document(BaseModel):
     code for federal law.
     """
 
-    segments: List[Segment]
+    segments: List[ILGSv1Segment]
     """
     An array of segments within the document representing structurally distinct
     portions of its content.
     """
 
-    crossreferences: List[Crossreference]
+    crossreferences: List[ILGSv1Crossreference]
     """
     An array of cross-references within the document pointing to a single segment or
     a span of segments.
     """
 
-    locations: List[Location]
+    locations: List[ILGSv1Location]
     """An array of locations identified in the document."""
 
-    persons: List[Person]
+    persons: List[ILGSv1Person]
     """An array of legal persons identified in the document."""
 
-    emails: List[Email]
+    emails: List[ILGSv1Email]
     """
     An array of email addresses identified in the document belonging to legal
     persons.
@@ -115,14 +115,14 @@ class Document(BaseModel):
     persons will not be extracted.
     """
 
-    websites: List[Website]
+    websites: List[ILGSv1Website]
     """An array of websites identified in the document belonging to legal persons.
 
     Websites mentioned in the document that are not attributable to legal persons
     will not be extracted.
     """
 
-    phone_numbers: List[PhoneNumber]
+    phone_numbers: List[ILGSv1PhoneNumber]
     """
     An array of valid phone numbers identified in the document belonging to legal
     persons.
@@ -131,7 +131,7 @@ class Document(BaseModel):
     attributable to legal persons will not be extracted.
     """
 
-    id_numbers: List[IDNumber]
+    id_numbers: List[ILGSv1IDNumber]
     """
     An array of identification numbers identified in the document belonging to legal
     persons.
@@ -140,16 +140,16 @@ class Document(BaseModel):
     legal persons will not be extracted.
     """
 
-    terms: List[Term]
+    terms: List[ILGSv1Term]
     """An array of terms assigned definite meanings within the document."""
 
-    external_documents: List[ExternalDocument]
+    external_documents: List[ILGSv1ExternalDocument]
     """An array of documents identified within the document."""
 
-    quotes: List[Quote]
+    quotes: List[ILGSv1Quote]
     """An array of quotations within the document."""
 
-    dates: List[Date]
+    dates: List[ILGSv1Date]
     """
     An array of dates identified in the document belonging to one of the following
     types: `creation`, `signature`, `effective`, `expiry`, `delivery`, `renewal`,
@@ -159,10 +159,10 @@ class Document(BaseModel):
     one of the supported date types are extractable.
     """
 
-    headings: List[Span]
+    headings: List[ILGSv1Span]
     """An array of spans within the document's text constituting headings."""
 
-    junk: List[Span]
+    junk: List[ILGSv1Span]
     """
     An array of spans within the document's text constituting non-operative,
     non-substantive 'junk' content such as headers, footers, page numbers, and OCR

src/isaacus/types/email.py src/isaacus/types/ilgs/ilgs_v1_email.pysrc/isaacus/types/email.py renamed to src/isaacus/types/ilgs/ilgs_v1_email.py

@@ -2,13 +2,13 @@
 
 from typing import List
 
-from .span import Span
-from .._models import BaseModel
+from ..._models import BaseModel
+from .ilgs_v1_span import ILGSv1Span
 
-__all__ = ["Email"]
+__all__ = ["ILGSv1Email"]
 
 
-class Email(BaseModel):
+class ILGSv1Email(BaseModel):
     """An email address identified in a document belonging to a legal person.
 
     If an email address was mentioned in the document but is not attributable to a legal person, it will not be extracted.
@@ -20,7 +20,7 @@ class Email(BaseModel):
     person: str
     """The unique identifier of the person that this email address belongs to."""
 
-    mentions: List[Span]
+    mentions: List[ILGSv1Span]
     """
     An array of one or more spans within the document's text where the email address
     is mentioned.

src/isaacus/types/external_document.py …/types/ilgs/ilgs_v1_external_document.pysrc/isaacus/types/external_document.py renamed to src/isaacus/types/ilgs/ilgs_v1_external_document.py src/isaacus/types/external_document.py renamed to src/isaacus/types/ilgs/ilgs_v1_external_document.py

@@ -3,13 +3,13 @@
 from typing import List, Optional
 from typing_extensions import Literal
 
-from .span import Span
-from .._models import BaseModel
+from ..._models import BaseModel
+from .ilgs_v1_span import ILGSv1Span
 
-__all__ = ["ExternalDocument"]
+__all__ = ["ILGSv1ExternalDocument"]
 
 
-class ExternalDocument(BaseModel):
+class ILGSv1ExternalDocument(BaseModel):
     """A document identified within another document."""
 
     id: str
@@ -18,7 +18,7 @@ class ExternalDocument(BaseModel):
     `{index}` is a non-negative incrementing integer starting from zero.
     """
 
-    name: Span
+    name: 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
@@ -86,14 +86,14 @@ class ExternalDocument(BaseModel):
     expressing any particular sentiment towards it.
     """
 
-    mentions: List[Span]
+    mentions: List[ILGSv1Span]
     """
     An array of one or more spans within the document's text where the external
     document is mentioned by name, for example, 'the US Constitution' in 'the Second
     Amendment to the US Constitution protects freedom of speech'.
     """
 
-    pinpoints: List[Span]
+    pinpoints: List[ILGSv1Span]
     """
     An array of spans within the document's text where specific parts of the
     external document are referenced, for example, 'Section 2' in 'as defined in