Skip to content

Commit dd30f09

Browse files
fix docstrings
1 parent 47532c3 commit dd30f09

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

mindee/parsing/v2/inference_active_options.py

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,30 @@ class InferenceActiveOptions:
55
"""Active options for the inference."""
66

77
raw_text: bool
8-
"""Whether raw text extraction is active or not."""
8+
"""
9+
Whether the Raw Text feature was activated.
10+
When this feature is activated, the raw text extracted from the document is returned in the result.
11+
"""
912
polygon: bool
10-
"""Whether polygon extraction is active or not."""
13+
"""
14+
Whether the polygon feature was activated.
15+
When this feature is activated, the bounding-box polygon(s) for each field is returned in the result.
16+
"""
1117
confidence: bool
12-
"""Whether confidence scores are active or not."""
18+
"""
19+
Whether the confidence feature was activated.
20+
When this feature is activated, a confidence score for each field is returned in the result.
21+
"""
1322
rag: bool
14-
"""Whether RAG is active or not."""
23+
"""
24+
Whether the Retrieval-Augmented Generation feature was activated.
25+
When this feature is activated, the RAG pipeline is used to increase result accuracy.
26+
"""
1527
text_context: bool
16-
"""Whether text context is active or not."""
28+
"""
29+
Whether the text context feature was activated.
30+
When this feature is activated, the provided context is used to improve the accuracy of the inference.
31+
"""
1732

1833
def __init__(self, raw_response: StringDict):
1934
self.raw_text = raw_response["raw_text"]

0 commit comments

Comments
 (0)