Repository navigation
Conversation
2b37363 to
8cf9500
Compare
There was a problem hiding this comment.
🟡 Changes recommended
The change silently drops symbol-keyed annotation corrections, leaves new RAG classes unavailable through the public loader, and breaks the existing CommonResponse constant and require path.
3 open issues
What changed in this PR
Adds data models and request parameters for extraction RAG document management in the Ruby SDK. It also separates shared response handling from inference-specific responses.
Changes:
- Adds RAG annotations, nested field models, upload/update parameters, and response parsing.
- Refactors the V2 response hierarchy and updates corresponding RBS signatures.
- Adds parameter and response specs, plus repository typing guidance.
| File | Description |
|---|---|
| spec/v2/product/extraction/rag_document_spec.rb | Tests RAG parameters and response parsing. |
| spec/v2/parsing/base_response_spec.rb | Updates tests to target BaseResponse. |
| sig/mindee/v2/product/split/split_response.rbs | Updates inference-response inheritance. |
| sig/mindee/v2/product/ocr/ocr_response.rbs | Updates inference-response inheritance. |
| sig/mindee/v2/product/extraction/rag_documents/rag_annotation.rbs | Types annotation serialization. |
| sig/mindee/v2/product/extraction/rag_documents/params/rag_document_upload_parameters.rbs | Types extraction upload parameters. |
| sig/mindee/v2/product/extraction/rag_documents/params/rag_document_annotation_parameters.rbs | Types annotation update parameters. |
| sig/mindee/v2/product/extraction/rag_documents/extraction_rag_annotation_response.rbs | Types extraction RAG responses. |
| sig/mindee/v2/product/extraction/rag_documents/annotated_simple_field.rbs | Types scalar annotation fields. |
| sig/mindee/v2/product/extraction/rag_documents/annotated_object_field.rbs | Types nested annotation objects. |
| sig/mindee/v2/product/extraction/rag_documents/annotated_list_field.rbs | Types annotation lists. |
| sig/mindee/v2/product/extraction/rag_documents/annotated_fields.rbs | Types annotation field collections. |
| sig/mindee/v2/product/extraction/rag_documents/annotated_base_field.rbs | Types shared annotation configuration. |
| sig/mindee/v2/product/extraction/extraction_response.rbs | Updates inference-response inheritance. |
| sig/mindee/v2/product/crop/crop_response.rbs | Updates inference-response inheritance. |
| sig/mindee/v2/product/classification/classification_response.rbs | Updates inference-response inheritance. |
| sig/mindee/v2/product/base_product.rbs | Updates the default response type. |
| sig/mindee/v2/parsing/search/base_search_response.rbs | Uses the shared response base. |
| sig/mindee/v2/parsing/job_response.rbs | Uses the shared response base. |
| sig/mindee/v2/parsing/failed_inference_response.rbs | Declares shared response inheritance. |
| sig/mindee/v2/parsing/common_response.rbs | Removes the former shared response signature. |
| sig/mindee/v2/parsing/base_response.rbs | Types shared raw-response handling. |
| sig/mindee/v2/parsing/base_rag_annotation_response.rbs | Types common RAG document metadata. |
| sig/mindee/v2/parsing/base_inference_response.rbs | Introduces the generic inference-response type. |
| sig/mindee/v2/client_options/base_rag_document_upload_parameters.rbs | Types shared upload parameters. |
| sig/mindee/v2/client_options/base_annotation_parameters.rbs | Types shared annotation parameters. |
| sig/mindee/input/local_response.rbs | Updates the deserialization response type. |
| lib/mindee/v2/product/split/split_response.rb | Uses the inference-specific response base. |
| lib/mindee/v2/product/ocr/ocr_response.rb | Uses the inference-specific response base. |
| lib/mindee/v2/product/extraction/rag_documents/rag_annotation.rb | Parses and serializes annotations. |
| lib/mindee/v2/product/extraction/rag_documents/params/rag_document_upload_parameters.rb | Adds extraction RAG upload parameters. |
| lib/mindee/v2/product/extraction/rag_documents/params/rag_document_annotation_parameters.rb | Builds annotation update parameters. |
| lib/mindee/v2/product/extraction/rag_documents/extraction_rag_annotation_response.rb | Parses extraction RAG response metadata. |
| lib/mindee/v2/product/extraction/rag_documents/annotated_simple_field.rb | Adds scalar annotation fields. |
| lib/mindee/v2/product/extraction/rag_documents/annotated_object_field.rb | Adds nested annotation objects. |
| lib/mindee/v2/product/extraction/rag_documents/annotated_list_field.rb | Adds annotation lists and item accessors. |
| lib/mindee/v2/product/extraction/rag_documents/annotated_fields.rb | Adds typed field lookup and serialization. |
| lib/mindee/v2/product/extraction/rag_documents/annotated_base_field.rb | Adds shared configuration and field construction. |
| lib/mindee/v2/product/extraction/params.rb | Adds an extraction-parameter require aggregator. |
| lib/mindee/v2/product/extraction/extraction_response.rb | Uses the inference-specific response base. |
| lib/mindee/v2/product/crop/crop_response.rb | Uses the inference-specific response base. |
| lib/mindee/v2/product/classification/classification_response.rb | Uses the inference-specific response base. |
| lib/mindee/v2/product/base_product.rb | Sets the inference-specific default response. |
| lib/mindee/v2/parsing/search/base_search_response.rb | Uses the shared response base. |
| lib/mindee/v2/parsing/job_response.rb | Loads and inherits the shared response base. |
| lib/mindee/v2/parsing/inference_job.rb | Removes the obsolete response require. |
| lib/mindee/v2/parsing/failed_inference_response.rb | Uses the shared response base. |
| lib/mindee/v2/parsing/common_response.rb | Removes the former shared response class. |
| lib/mindee/v2/parsing/base_response.rb | Centralizes raw-response serialization. |
| lib/mindee/v2/parsing/base_rag_annotation_response.rb | Parses common RAG document metadata. |
| lib/mindee/v2/parsing/base_inference_response.rb | Introduces the inference-specific response base. |
| lib/mindee/v2/parsing.rb | Loads the new response hierarchy. |
| lib/mindee/v2/http/mindee_api_v2.rb | Updates return-type documentation only. |
| lib/mindee/v2/client.rb | Updates return-type documentation only. |
| lib/mindee/v2/client_options/base_rag_document_upload_parameters.rb | Validates and serializes model identifiers. |
| lib/mindee/v2/client_options/base_annotation_parameters.rb | Validates annotation document identifiers. |
| lib/mindee/input/local_response.rb | Updates deserialization documentation only. |
| bin/v2/parser.rb | Updates response-type documentation only. |
| AGENTS.md | Documents the matching RBS requirement. |
Review effort: Balanced
There was a problem hiding this comment.
🟡 Changes recommended
Unresolved issues cause incorrect RAG field rendering, silently discard symbol-keyed annotations, and break existing callers by removing public response and product APIs.
4 open issues
3 resolved since last review
Review effort: Balanced
There was a problem hiding this comment.
🔵 Needs a closer look
RagAnnotation accepts symbol-keyed hashes but reads only string keys, silently discarding annotation fields and propagating the empty data into serialized document parameters.
No open issues 🎉
3 resolved since last review
Review effort: Balanced
There was a problem hiding this comment.
🟡 Changes recommended
Symbol-keyed annotations silently lose their fields when wrapped in RagAnnotation, and the new RAG types lack public client methods and HTTP operations for uploading, retrieving, or annotating documents.
1 open issue
Review effort: Balanced
c80faf1 to
424ec8a
Compare
There was a problem hiding this comment.
🟡 Changes recommended
Initial failed RAG responses bypass error handling, deletion redirects are incorrectly reported as success, and incomplete RBS declarations prevent typed callers from using the new APIs.
4 open issues
1 resolved since last review
Review effort: Balanced
There was a problem hiding this comment.
🟡 Changes recommended
Unresolved issues allow failed RAG operations and redirected deletions to appear successful, silently discard symbol-keyed annotation data, and leave uploaded test documents behind after failures.
2 open issues
4 resolved since last review
Review effort: Balanced



Description
Renaming of common and base responses are not breaking change, no one uses these directly.
Types of changes