isaacus 0.11.0__py3-none-any.whl → 0.13.0__py3-none-any.whl

isaacus/types/segment.py

@@ -0,0 +1,205 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .span import Span
+from .._models import BaseModel
+
+__all__ = ["Segment"]
+
+
+class Segment(BaseModel):
+    """
+    A segment within the document representing a structurally distinct portion of the document's content.
+    """
+
+    id: str
+    """
+    The unique identifier of the segment in the format `seg:{index}` where `{index}`
+    is a non-negative incrementing integer starting from zero.
+    """
+
+    kind: Literal["container", "unit", "item", "figure"]
+    """
+    The structural 'kind' of the segment, being one of `container`, `unit`, `item`,
+    or `figure`.
+
+    A `container` is a structural or semantic grouping of content such as a chapter.
+    It can contain segments of any kind or none at all.
+
+    A `unit` is a single syntactically independent unit of text such as a paragraph.
+    It can only contain `item`s and `figure`s.
+
+    An `item` is a syntactically subordinate unit of text such as an item in a
+    run-in list. It can only contain other `item`s. Note that an `item` is
+    conceptually distinct from a list item—it is perfectly possible to encounter
+    list items that are syntactically independent of their surrounding items just as
+    it is possible to encounter dependent clauses that do not appear as part of a
+    list.
+
+    A `figure` is a visually structured or tabular unit of content such as a
+    diagram, equation, or table. It cannot contain segments.
+    """
+
+    type: Optional[
+        Literal[
+            "title",
+            "book",
+            "part",
+            "chapter",
+            "subchapter",
+            "division",
+            "subdivision",
+            "subpart",
+            "subtitle",
+            "table_of_contents",
+            "article",
+            "section",
+            "regulation",
+            "rule",
+            "clause",
+            "paragraph",
+            "subarticle",
+            "subsection",
+            "subregulation",
+            "subrule",
+            "subclause",
+            "subparagraph",
+            "item",
+            "subitem",
+            "point",
+            "indent",
+            "schedule",
+            "annex",
+            "appendix",
+            "exhibit",
+            "recital",
+            "signature",
+            "note",
+            "figure",
+            "table",
+            "formula",
+        ]
+    ] = None
+    """
+    The addressable 'type' of the segment within the document's referential scheme
+    and hierarchy, whether defined explicitly (e.g., by headings, such as
+    'Section 2. Definitions'), implicitly (e.g., by way of reference, such as 'as
+    defined in Section 2'), or by convention (e.g., [42] in a judgment often denotes
+    a `paragraph`, independent provisions in statute are often `section`s, etc.). If
+    the type is not known or not applicable, it will be set to `null`.
+
+    Note that, although many segment types may coincide with syntactic constructs,
+    they should be thought of purely as distinct formal citable units. Most
+    paragraphs (in the syntactic sense) will not have the `paragraph` type, for
+    example. That type is reserved for segments that would formally be cited as a
+    'Paragraph' within the document's referential scheme.
+
+    The following types are currently supported: `title`, `book`, `part`, `chapter`,
+    `subchapter`, `division`, `subdivision`, `subpart`, `subtitle`,
+    `table_of_contents`, `article`, `section`, `regulation`, `rule`, `clause`,
+    `paragraph`, `subarticle`, `subsection`, `subregulation`, `subrule`,
+    `subclause`, `subparagraph`, `item`, `subitem`, `point`, `indent`, `schedule`,
+    `annex`, `appendix`, `exhibit`, `recital`, `signature`, `note`, `figure`,
+    `table`, and `formula`.
+
+    The `title`, `book`, `part`, `chapter`, `subchapter`, `division`, `subdivision`,
+    `subpart`, `subtitle`, and `table_of_contents` types are exclusive to the
+    `container` kind.
+
+    The `figure` kind only supports the `figure`, `table`, and `formula` types, all
+    of which are exclusive to it.
+    """
+
+    category: Literal["front_matter", "scope", "main", "annotation", "back_matter", "other"]
+    """
+    The functional 'category' of the segment within the document, being one of
+    `front_matter`, `scope`, `main`, `annotation`, `back_matter`, or `other`.
+
+    `front_matter` denotes non-operative contextualizing content occurring at the
+    start of a document such as a preamble or recitals.
+
+    `scope` denotes operative content defining the application or interpretation of
+    a document such as definition sections and governing law clauses.
+
+    `main` denotes operative, non-scopal content.
+
+    `annotation` denotes non-operative annotative content providing explanatory or
+    referential information such as commentary, footnotes, and endnotes.
+
+    `back_matter` denotes non-operative contextualizing content occurring at the end
+    of a document such as authority statements.
+
+    `other` denotes content that does not fit into any of the other categories.
+    """
+
+    type_name: Optional[Span] = 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
+    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).
+    """
+
+    code: Optional[Span] = 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
+    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).
+    """
+
+    title: Optional[Span] = 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
+    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).
+    """
+
+    parent: Optional[str] = None
+    """
+    A unique identifier for a segment in the format `seg:{index}` where `{index}` is
+    a non-negative incrementing integer starting from zero.
+    """
+
+    span: Span
+    """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).
+    """

isaacus/types/span.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["Span"]
+
+
+class Span(BaseModel):
+    """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).
+    """
+
+    start: int
+    """
+    The zero-based start index of the half-open span of Unicode code points in the
+    input text.
+    """
+
+    end: int
+    """
+    The zero-based end index of the half-open span (i.e., the end is exclusive) of
+    Unicode code points in the input text.
+    """

isaacus/types/term.py

@@ -0,0 +1,59 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from .span import Span
+from .._models import BaseModel
+
+__all__ = ["Term"]
+
+
+class Term(BaseModel):
+    """A term assigned a definite meaning within a document."""
+
+    id: str
+    """
+    The unique identifier of the term in the format `term:{index}` where `{index}`
+    is a non-negative incrementing integer starting from zero.
+    """
+
+    name: Span
+    """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).
+    """
+
+    meaning: Span
+    """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).
+    """
+
+    mentions: List[Span]
+    """
+    An array of spans within the document's text where the term is mentioned outside
+    of its definition.
+
+    It is possible for the term to have no mentions if, outside of its definition,
+    it is never referred to in the document.
+    """

isaacus/types/website.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from .span import Span
+from .._models import BaseModel
+
+__all__ = ["Website"]
+
+
+class Website(BaseModel):
+    """A website identified in a document belonging to a legal person.
+
+    If a website was mentioned in the document but is not attributable to a legal person, it will not be extracted.
+    """
+
+    url: str
+    """The normalized URL of the website in the form `https://{host}/`."""
+
+    person: str
+    """The unique identifier of the person that this website belongs to."""
+
+    mentions: List[Span]
+    """
+    An array of one or more spans within the document's text where the website is
+    mentioned (including paths and slugs which are not part of the website's
+    normalized URL).
+    """

{isaacus-0.11.0.dist-info → isaacus-0.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: isaacus
-Version: 0.11.0
+Version: 0.13.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.11.0.dist-info → isaacus-0.13.0.dist-info}/RECORD

@@ -11,7 +11,7 @@ isaacus/_resource.py,sha256=iP_oYhz5enCI58mK7hlwLoPMPh4Q5s8-KBv-jGfv2aM,1106
 isaacus/_response.py,sha256=aXLF5ia58bjjQXTxY574lh7JfKXiGL2tDTX09klm8lw,28794
 isaacus/_streaming.py,sha256=jcoIlOzPElsxFLKe54I-TavCZEuYIx_MYkZN3uSQFqk,10225
 isaacus/_types.py,sha256=hm4MJQF5-9CmsPcIufE6_KvsWtxKrRMnJAgZ7MBydsk,7595
-isaacus/_version.py,sha256=TEDKgfCrk8p0h43HIu1ym-K8iuQSCC_eHT6babGJMDY,160
+isaacus/_version.py,sha256=oqAgTU8q_lQ9Fi2VY0n65Yy4cP5MfOYiSz4tRdhkZ-A,160
 isaacus/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 isaacus/_utils/__init__.py,sha256=7fch0GT9zpNnErbciSpUNa-SjTxxjY6kxHxKMOM4AGs,2305
 isaacus/_utils/_compat.py,sha256=D8gtAvjJQrDWt9upS0XaG9Rr5l1QhiAx_I_1utT_tt0,1195
@@ -28,29 +28,43 @@ isaacus/_utils/_typing.py,sha256=N_5PPuFNsaygbtA_npZd98SVN1LQQvFTKL6bkWPBZGU,478
 isaacus/_utils/_utils.py,sha256=ugfUaneOK7I8h9b3656flwf5u_kthY0gvNuqvgOLoSU,12252
 isaacus/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
 isaacus/resources/__init__.py,sha256=lBkxBgx6-Cz4isNcKC15aHKJxXJN0xw3Dzj8iZlEz8o,2703
-isaacus/resources/embeddings.py,sha256=Ol-K756e376CnzdoEBuuRRIIdbNpYUOLD0bUN7o6ffA,9470
+isaacus/resources/embeddings.py,sha256=82o8Q7pi4ve-Q-V3KA1I-WygV9iYEfwEAbId5ZnUhCU,9470
 isaacus/resources/enrichments.py,sha256=CAl2NVmh15PDCT729rlGzi1Ww4d_TRaZVk_NHSmaD04,8743
-isaacus/resources/rerankings.py,sha256=Zz3TofFzaexgxqmOsxFWIhb2MFJdEr2o1JzsSxeiIKE,11189
+isaacus/resources/rerankings.py,sha256=X5oisCxHeELNtDLEdPIu9P5DYydLBceBZ5vMPzMOIkU,11189
 isaacus/resources/classifications/__init__.py,sha256=tYSnDm-o0CVuTC95VoNJzOqHsb8jTzYmW8hdwW14K60,1158
 isaacus/resources/classifications/classifications.py,sha256=Td5Gscg1PNJJeobxow_hJq_RicpFe3ibEYN0Gh3Kpsg,4018
-isaacus/resources/classifications/universal.py,sha256=TuTkM2d0bC5A3Eo_1km06IISu2nctEGpWzKHKHnW2IE,10714
-isaacus/resources/extractions/__init__.py,sha256=24ccXv3kRlfXwnZJ4572kWNjJKiJ0Cd5vWeRkKCuMyY,1015
-isaacus/resources/extractions/extractions.py,sha256=RaUnv1OG4i5J3JhpBNfpnxELpSHvmkqZmS2_DVL9Wvw,3671
-isaacus/resources/extractions/qa.py,sha256=5KgPXamGlkR4qTglw0LBsIiytxGwdALQ-RBV7hS5kGo,10029
-isaacus/types/__init__.py,sha256=oEeUoff816LbolcipS92iRJDw6Zdgd4GqsDY67G_Bx0,594
-isaacus/types/embedding_create_params.py,sha256=Vcqa_CSnj_rXl8CWyGzBtjJKin18dRmy-q8N0eNFYQ8,1575
-isaacus/types/embedding_response.py,sha256=hDrsSna4GW8-ukNKtN7Svv-zskulPdymkgfv0RJGFoU,937
+isaacus/resources/classifications/universal.py,sha256=qOVHy4GFrvC3jH3BxkhcKWzEnxda1QC-KOhDf5ammKM,10714
+isaacus/resources/extractions/__init__.py,sha256=vH5RxCZmOg19r7ttxYcSQsxwL9MlomyewT-ZPYxC8HA,1015
+isaacus/resources/extractions/extractions.py,sha256=TG2WSbGS1ufWuQz6bKU6SdswCex93gzyT5hQgn0FEC4,3671
+isaacus/resources/extractions/qa.py,sha256=mCT63LN-luU1JhiRBDnRZuaNEA1V8TgiqDgkuo9rpuQ,10029
+isaacus/types/__init__.py,sha256=Qdwm105MbCKcFM4seFEt8oD1m5AeVkQiPKk6DsSCzv4,1184
+isaacus/types/crossreference.py,sha256=5Mc0yXRNn78mgBrVqC1mahPbW1byWzi6KOBKKSZfFOU,1622
+isaacus/types/date.py,sha256=n6fa7H3FkVNc7CwyeeOEG_KaHSbaKQH8agE06ZUWu-k,2733
+isaacus/types/document.py,sha256=-OeyvVw8OVbmuHaMGNqx9TumTU-hbuZDWMRrTRJktgg,5919
+isaacus/types/email.py,sha256=Nc19c3b4N-VCORxhXuFX72KF9IP41mQbezXWZmtrJXE,726
+isaacus/types/embedding_create_params.py,sha256=OCIuc_GeBQijFhjPMRdz5my05r3K1BG1IKy-nHmwUxg,1575
+isaacus/types/embedding_response.py,sha256=kAE2EyR7MpY1fhk867iVErCl7pM0dYjypcZgbFAD_Vw,937
 isaacus/types/enrichment_create_params.py,sha256=1wJUAs1hp_S6ej3aK8YqudEI8XIGaH29qfymcuRuHPg,1339
-isaacus/types/enrichment_response.py,sha256=8ykz2OssM6YEHe-rjn-SNBLAmM-7IwyRRBM2CqM4xY4,57688
-isaacus/types/reranking_create_params.py,sha256=8JzCxxIqhsLyINUgzVjG8HadMSrAlqMYMZX-c84vsjk,2595
+isaacus/types/enrichment_response.py,sha256=Vy0ZA_D9_ioRP71H10kYj4pFS5BYPIEN_KL3sovlVQ4,2038
+isaacus/types/external_document.py,sha256=hGoc-bLxUnNwRy8rnAjS4CTUsLoKsqr2E8EtJcloylI,3825
+isaacus/types/id_number.py,sha256=MXD1bs_JuSYfEmiLlM5G812QvqHMiXUXyiL08cJHw-Y,759
+isaacus/types/location.py,sha256=iQ6s7M6MkojrQO15-Bcx-RLfVYsHoz1K3zT76lYFllM,1751
+isaacus/types/person.py,sha256=PdXyf3w7K7qCeCGOqI8PotZClYVPftI4ffPugjOPA4g,9800
+isaacus/types/phone_number.py,sha256=WqAF9-4kzJMlUoyjXQzcFUX5lR2DJ3jS1FMGWNtt430,883
+isaacus/types/quote.py,sha256=c_Nd74B_2dVzilollwoZQyloEc0h7C4yT0bDFaAhFiY,1755
+isaacus/types/reranking_create_params.py,sha256=XiUTkTtkf4k0o-p-hqfQsXrdVcyO-HW0dYY-sTQhkDw,2595
 isaacus/types/reranking_response.py,sha256=qyCeK30TC6YXO_zmzRzAskwQxnHuyehjqLM8QO5B8z0,1017
+isaacus/types/segment.py,sha256=myczhGMxgC32ZsrAAldoohy_sXhDkSgLQZ860x8DjWM,8333
+isaacus/types/span.py,sha256=Y2W9B8K9Lde1_EwvOYyhXZ_U6oAycgXQkWN7HFU3rY8,1148
+isaacus/types/term.py,sha256=opd4ZHXdA9GsAbAuzt23wztupa1CsCksUKUd4GLUOgU,2207
+isaacus/types/website.py,sha256=zOCckhmLaQupCYPce4bKSwkxWL0uenNZ7hwPbNfyC68,818
 isaacus/types/classifications/__init__.py,sha256=5wz2ChA8Ld8Yfx-7z7PShbfeyvE3wXRfpkctjS27t10,321
-isaacus/types/classifications/universal_classification_response.py,sha256=DkqL-2oCDZStVTC0ErABe9PC7mo7r8QUj-yrpMNXzP4,2545
-isaacus/types/classifications/universal_create_params.py,sha256=o33anF7A87yvW7pBPffTY0Wbhdos5dSdqNGG3qDe20s,2392
-isaacus/types/extractions/__init__.py,sha256=em0yfSoMG1XqO_LfmqveKlKh03y5x6g7hbaUn7ck21c,279
-isaacus/types/extractions/answer_extraction_response.py,sha256=B-TKDFyte681wE-DttSGF85E5eLbmeVONNxxavSXjcY,2383
-isaacus/types/extractions/qa_create_params.py,sha256=qa6J5OrYA-nLCCuUG8PSb5N4VZAbKeco7lNCmTXQggA,2200
-isaacus-0.11.0.dist-info/METADATA,sha256=Ab1cjK4kCsOjvjicivV6ccX-Jjbv21CDHSa9ud35V-0,17499
-isaacus-0.11.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-isaacus-0.11.0.dist-info/licenses/LICENSE,sha256=a39aM3IX2G2L5Xs88KP8lWSk-UJ3Eaqo8HwnQs9c08U,11337
-isaacus-0.11.0.dist-info/RECORD,,
+isaacus/types/classifications/universal_classification_response.py,sha256=2QfUqVFxvgkhvni9ooI9sRCb3xsbTNVs8PzuHLAE7oM,2545
+isaacus/types/classifications/universal_create_params.py,sha256=IOAdb3sqg8ahSILJQ8jjtcgw693vGLTzCc8bQVfyND8,2392
+isaacus/types/extractions/__init__.py,sha256=VXrUSuL-YBSy66o8Qwo3V4PrXLclfLHMoPIsElTV0tM,279
+isaacus/types/extractions/answer_extraction_response.py,sha256=JGriq8l7OZeTK30AyDkDepbs839x9SZDCjDn8NJc7jQ,2383
+isaacus/types/extractions/qa_create_params.py,sha256=vCoEwQGgfYF_eG0DGsfQnV4nC2_PhEc4D-f1aq-72sU,2200
+isaacus-0.13.0.dist-info/METADATA,sha256=TBG7dVdJ5Tq04SBOj06TEESB0bSAl2gRS8Xgzf8FbYo,17499
+isaacus-0.13.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+isaacus-0.13.0.dist-info/licenses/LICENSE,sha256=a39aM3IX2G2L5Xs88KP8lWSk-UJ3Eaqo8HwnQs9c08U,11337
+isaacus-0.13.0.dist-info/RECORD,,