Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import json
from dataclasses import asdict, dataclass
from typing import Any, ClassVar

Expand All @@ -7,7 +6,10 @@
from mindee.v2.product.extraction.rag_documents.extraction_rag_annotation_response import (
ExtractionRagAnnotationResponse,
)
from mindee.v2.product.extraction.rag_documents.rag_annotation import RagAnnotation
from mindee.v2.product.extraction.rag_documents.rag_annotation import (
RagAnnotation,
TypeRagAnnotationInput,
)


@dataclass(kw_only=True)
Expand All @@ -19,7 +21,7 @@ class RagDocumentAnnotationParameters(
status: str | None = None
"""New public status to apply to the document (for example, to deactivate it)."""

annotation: RagAnnotation | StringDict | str | None = None
annotation: RagAnnotation | TypeRagAnnotationInput | None = None
"""Field-level RAG annotation and guidelines configuration for the document."""

_slug: ClassVar[str] = "extraction"
Expand All @@ -28,9 +30,9 @@ class RagDocumentAnnotationParameters(
)

def __post_init__(self) -> None:
if isinstance(self.annotation, str):
self.annotation = RagAnnotation(json.loads(self.annotation))
elif isinstance(self.annotation, dict):
if self.annotation is not None and not isinstance(
self.annotation, RagAnnotation
):
self.annotation = RagAnnotation(self.annotation)

def get_request_parameters(self) -> dict[str, str | StringDict]:
Expand Down
15 changes: 12 additions & 3 deletions mindee/v2/product/extraction/rag_documents/rag_annotation.py
Original file line number Diff line number Diff line change
@@ -1,18 +1,27 @@
import json
from dataclasses import InitVar, dataclass, field
from typing import IO

from mindee.parsing.common.string_dict import StringDict
from mindee.v2.parsing.string_data_class import StringDataClass
from mindee.v2.product.extraction.rag_documents.annotated_fields import AnnotatedFields

TypeRagAnnotationInput = StringDict | str | bytes | IO[str] | IO[bytes]
Comment thread
ianardee marked this conversation as resolved.
Resolved


@dataclass
class RagAnnotation(StringDataClass):
"""A RAG annotation enriched with field-level configuration."""

raw_response: InitVar[StringDict]
raw_response: InitVar[TypeRagAnnotationInput]

fields: AnnotatedFields = field(init=False)
"""Annotated fields."""

def __post_init__(self, raw_response: StringDict):
self.fields = AnnotatedFields(raw_response["fields"])
def __post_init__(self, raw_response: TypeRagAnnotationInput) -> None:
if isinstance(raw_response, dict):
self.fields = AnnotatedFields(raw_response["fields"])
elif isinstance(raw_response, (str, bytes)):
self.fields = AnnotatedFields(json.loads(raw_response)["fields"])
else:
self.fields = AnnotatedFields(json.load(raw_response)["fields"])
88 changes: 53 additions & 35 deletions tests/v2/product/extraction/test_rag_documents.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,21 @@
)
from tests.utils import V2_PRODUCT_PATH

expected_annotation = {
"fields": {
"simple": {"selected": False, "guidelines": None, "value": True},
"list": {"selected": False, "guidelines": None, "items": []},
"object": {"selected": False, "guidelines": None, "fields": {}},
}
}
with open(
V2_PRODUCT_PATH / "extraction/rag_documents/test_annotation.json",
encoding="utf-8",
) as fh:
expected_annotation = json.load(fh)


def _assert_patch_parameters(annotation):
parameters = RagDocumentAnnotationParameters(
document_id="invalid-document-id", status="Active", annotation=annotation
)
req_params = parameters.get_request_parameters()
assert parameters.document_id == "invalid-document-id"
assert req_params["status"] == "Active"
assert req_params["annotation"] == expected_annotation


@pytest.mark.v2
Expand All @@ -36,6 +44,42 @@ def test_post_parameters_must_init():
assert req_params["model_id"] == "invalid-model-id"


@pytest.mark.v2
def test_patch_parameters_must_init_from_file():
"""Should init PATCH parameters from an annotation file handle."""
with open(
V2_PRODUCT_PATH / "extraction/rag_documents/test_annotation.json",
encoding="utf-8",
) as fh:
_assert_patch_parameters(fh)


@pytest.mark.v2
def test_patch_parameters_must_init_from_binary_file():
"""Should init PATCH parameters from an annotation binary file handle."""
with open(
V2_PRODUCT_PATH / "extraction/rag_documents/test_annotation.json",
"rb",
) as fh:
_assert_patch_parameters(fh)


@pytest.mark.v2
def test_patch_parameters_must_init_from_string():
"""Should init PATCH parameters from an annotation string."""
_assert_patch_parameters(
'{"fields": {"simple":{"value": true}, "list":{"items": []}, "object":{"fields": {}}}}'
)


@pytest.mark.v2
def test_patch_parameters_must_init_from_bytes():
"""Should init PATCH parameters from annotation bytes."""
_assert_patch_parameters(
b'{"fields": {"simple":{"value": true}, "list":{"items": []}, "object":{"fields": {}}}}'
)


@pytest.mark.v2
def test_patch_parameters_must_init_from_dict():
"""Should init PATCH parameters from an annotation dict."""
Expand All @@ -46,13 +90,7 @@ def test_patch_parameters_must_init_from_dict():
"object": {"fields": {}},
}
}
parameters = RagDocumentAnnotationParameters(
document_id="invalid-document-id", status="Active", annotation=annotation
)
req_params = parameters.get_request_parameters()
assert parameters.document_id == "invalid-document-id"
assert req_params["status"] == "Active"
assert req_params["annotation"] == expected_annotation
_assert_patch_parameters(annotation)


@pytest.mark.v2
Expand All @@ -67,27 +105,7 @@ def test_patch_parameters_must_init_from_object():
}
}
)
parameters = RagDocumentAnnotationParameters(
document_id="invalid-document-id", status="Active", annotation=annotation
)
req_params = parameters.get_request_parameters()
assert parameters.document_id == "invalid-document-id"
assert req_params["status"] == "Active"
assert req_params["annotation"] == expected_annotation


@pytest.mark.v2
def test_patch_parameters_must_init_from_string():
"""Should init PATCH parameters from an annotation string."""
parameters = RagDocumentAnnotationParameters(
document_id="invalid-document-id",
status="Active",
annotation='{"fields": {"simple":{"value": true}, "list":{"items": []}, "object":{"fields": {}}}}',
)
req_params = parameters.get_request_parameters()
assert parameters.document_id == "invalid-document-id"
assert req_params["status"] == "Active"
assert req_params["annotation"] == expected_annotation
_assert_patch_parameters(annotation)


@pytest.mark.v2
Expand Down
12 changes: 9 additions & 3 deletions tests/v2/product/extraction/test_rag_documents_integration.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
from mindee.v2.error import MindeeHTTPErrorV2
from mindee.v2.product.extraction.rag_documents import (
ExtractionRagAnnotationResponse,
RagAnnotation,
RagDocumentAnnotationParameters,
RagDocumentUploadParameters,
)
Expand All @@ -30,7 +31,7 @@ def test_rag_document_lifecycle_must_succeed(v2_client: Client):
post_response = v2_client.upload_and_get_rag_document(input_source, post_parameters)
assert post_response is not None

post_annotation = post_response.annotation
post_annotation: RagAnnotation = post_response.annotation
assert post_annotation is not None

document_id = post_response.id
Expand All @@ -40,6 +41,7 @@ def test_rag_document_lifecycle_must_succeed(v2_client: Client):

post_annotation.fields["supplier_name"].selected = True
post_annotation.fields["supplier_name"].guidelines = "I am the walrus!"
post_annotation.fields["supplier_name"].value = "Odobenus rosmarus"
post_annotation.fields.get_simple_field("invoice_number").selected = True
post_annotation.fields.get_simple_field(
"invoice_number"
Expand All @@ -55,16 +57,20 @@ def test_rag_document_lifecycle_must_succeed(v2_client: Client):
patch_annotation = patch_annotation_response.annotation
assert patch_annotation is not None

assert patch_annotation.fields.get_simple_field("supplier_name").selected is True
assert (
patch_annotation.fields.get_simple_field("supplier_name").guidelines
== "I am the walrus!"
)
assert patch_annotation.fields.get_simple_field("supplier_name").selected is True
assert (
patch_annotation.fields.get_simple_field("supplier_name").value
== "Odobenus rosmarus"
)
assert patch_annotation.fields.get_simple_field("invoice_number").selected is True
assert (
patch_annotation.fields.get_simple_field("invoice_number").guidelines
== "koo koo katchoo!"
)
assert patch_annotation.fields.get_simple_field("invoice_number").selected is True

get_response = v2_client.get_ready_rag_document(
ExtractionRagAnnotationResponse, document_id
Expand Down
Loading