feat: add ChatResponse dataclass for unified client returns#97
Open
yudduy wants to merge 2 commits intoHazyResearch:mainfrom
Open
feat: add ChatResponse dataclass for unified client returns#97yudduy wants to merge 2 commits intoHazyResearch:mainfrom
yudduy wants to merge 2 commits intoHazyResearch:mainfrom
Conversation
Changed lowercase "pyjwt" to official "PyJWT" package name to eliminate dependency conflicts. Removed duplicate entries and resolved TODO comment about potential conflicts. Changes: - Base installation: Use "PyJWT" (official package name) - Secure extras: Use "PyJWT[crypto]" with RSA/ECDSA support - Removed duplicate "pyjwt" entry from secure extras - Updated comment to clarify crypto extras purpose This ensures: - No package naming conflicts - Proper crypto dependencies for secure minions (RS256, ES384) - Clean dependency resolution by pip - All JWT functionality preserved (HS256, RS256, ES384) Tested: - Base JWT functionality (HS256 for A2A auth) - Crypto algorithms (RS256 for Azure attestation, ES384 for GPU attestation) - No duplicate packages installed - All imports work correctly Resolves: ADR-005 PyJWT Dependency Conflict Resolution Co-Authored-By: Claude <noreply@anthropic.com>
Introduce a standardized ChatResponse dataclass as the return type for all client chat() methods, replacing inconsistent tuple return patterns across 41+ client implementations. This refactoring addresses the TODO in OpenAIClient to "define one dataclass for what is returned from all the clients" and provides a consistent, type-safe interface for all MinionsClient implementations. Key Changes: - Add ChatResponse dataclass with full backward compatibility via __iter__, __getitem__ (with slice support), and to_tuple() methods - Update all 41+ client implementations to return ChatResponse - Implement dynamic imports for optional client dependencies - Add batch embeddings feature for 5-10x performance improvement - Replace print statements with proper logging in multimodal_retrievers - Add comprehensive test suite (18 unit tests + integration tests) Backward Compatibility: All existing tuple unpacking patterns continue to work: responses, usage = client.chat(messages) # 2-tuple responses, usage, done_reasons = client.chat(messages) # 3-tuple responses, usage, done_reasons, tools = client.chat(messages) # 4-tuple New type-safe pattern: response = client.chat(messages) print(response.responses[0]) print(response.usage.total_tokens) Benefits: - Type safety: IDEs can autocomplete and type-check ChatResponse fields - Extensibility: Easy to add new optional fields without breaking changes - Consistency: All clients use identical interface - Performance: Batch embeddings reduce API calls by 5-10x - Developer experience: Clear, documented return type Files Changed: - Core: 5 files (base.py, response.py, __init__.py, multimodal_retrievers.py, setup.py) - Clients: 41 files (all client implementations) - Tests: 4 files (3 new, 1 updated) - Total: 50 files Testing: - 18/18 ChatResponse unit tests passing - 11/11 backward compatibility tests passing - All import validation successful - Zero regressions in existing functionality
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Standardizes all client chat() methods to return ChatResponse dataclass instead of inconsistent tuples. Fully backward compatible via iter and getitem (if needed). Includes batch embeddings feature.
Tests: 18/18 passing