Skip to content

Commit 7c959e9

Browse files
docs(api): move around attribute comments
1 parent 27a7ced commit 7c959e9

File tree

3 files changed

+32
-21
lines changed

3 files changed

+32
-21
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 5
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/isaacus%2Fisaacus-3d30398ce36763aa90f81282ad98137f5c8165e5421b7ac3475557134557de86.yml
3-
openapi_spec_hash: 7fda17ba5bd5e3d2b3d539e6d8660a3d
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/isaacus%2Fisaacus-1ac4ab9a8019f580de9a0cdf695fc1d6e933e28d3421eaed6fbb108ef0f66d9e.yml
3+
openapi_spec_hash: c5a97cf51cd410674412c8c509f3fcc5
44
config_hash: 9040e7359f066240ad536041fb2c5185

src/isaacus/types/enrichment_response.py

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -20,26 +20,10 @@ class Result(BaseModel):
2020
document: Document
2121
"""
2222
The document enriched into version 1.0.0 of the Isaacus Legal Graph Schema
23-
(ILGS).
24-
"""
25-
26-
27-
class Usage(BaseModel):
28-
"""Statistics about the usage of resources in the process of enriching the input."""
29-
30-
input_tokens: int
31-
"""The total number of tokens inputted to the model."""
32-
33-
34-
class EnrichmentResponse(BaseModel):
35-
results: List[Result]
36-
"""
37-
The input documents enriched into version 1.0.0 of the Isaacus Legal Graph
38-
Schema (IGLS).
23+
(IGLS).
3924
4025
All spans in an enriched document graph are indexed into the Unicode code point
41-
space of a source document. Access to source documents is thus required to
42-
resolve spans into text.
26+
space of a source document.
4327
4428
The start and end indices of spans are zero-based (i.e., the first Unicode code
4529
point in the document is at index 0) and half-open (i.e., the end index is
@@ -59,5 +43,20 @@ class EnrichmentResponse(BaseModel):
5943
instead of Unicode code points).
6044
"""
6145

46+
47+
class Usage(BaseModel):
48+
"""Statistics about the usage of resources in the process of enriching the input."""
49+
50+
input_tokens: int
51+
"""The total number of tokens inputted to the model."""
52+
53+
54+
class EnrichmentResponse(BaseModel):
55+
results: List[Result]
56+
"""
57+
The enriched documents alongside, and in order of, their indices in the input
58+
array of texts.
59+
"""
60+
6261
usage: Usage
6362
"""Statistics about the usage of resources in the process of enriching the input."""

src/isaacus/types/ilgs/v1/document.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,19 @@
2323

2424
class Document(BaseModel):
2525
"""
26-
The document enriched into version 1.0.0 of the Isaacus Legal Graph Schema (ILGS).
26+
The document enriched into version 1.0.0 of the Isaacus Legal Graph Schema (IGLS).
27+
28+
All spans in an enriched document graph are indexed into the Unicode code point space of a source document.
29+
30+
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).
31+
32+
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.
33+
34+
Spans of the exact same type (e.g., segments) will never be duplicated.
35+
36+
Spans cannot be empty and will never start or end at whitespace.
37+
38+
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).
2739
"""
2840

2941
text: str

0 commit comments

Comments
 (0)