Standard-Labs / real-intent

Python SDK and abstracted interface for Real Intent operations.
https://realintent.co
0 stars 0 forks source link

Flexible SDK model instantiation options #135

Closed preritdas closed 1 week ago

preritdas commented 1 week ago

Allow models (namely, PII) to be instantiated with the variable-defined names instead of just the alias.

Crucial for Webhawk PII cache.

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

Walkthrough

The changes in this pull request involve updates to the PII class within the real_intent/schemas.py file. A new import from the pydantic library enhances model configuration capabilities. The mobile_phones field is now initialized to an empty list, and a validator for the investment_type field has been added to handle empty strings. Additionally, the from_api_dict method has been modified to ensure the Email_Array key defaults to an empty list if missing and converts gender values to their respective string representations.

Changes

File Change Summary
real_intent/schemas.py - Added ConfigDict import for model configuration.
- Initialized mobile_phones field to an empty list.
- Added validator for investment_type to convert empty strings to None.
- Updated from_api_dict to initialize Email_Array to an empty list if missing.
- Modified gender value conversion logic in from_api_dict to map "M" and "F" to "Male" and "Female", defaulting to "Unknown".

Sequence Diagram(s)

sequenceDiagram
    participant API
    participant PII
    participant Validator

    API->>PII: Send data with Email_Array
    PII->>Validator: Validate investment_type
    Validator-->>PII: Convert empty string to None
    PII->>PII: Initialize mobile_phones to []
    PII->>PII: Check Email_Array
    alt Email_Array is missing
        PII-->>PII: Set Email_Array to []
    end
    PII->>PII: Convert gender values
    Note right of PII: "M" -> "Male", "F" -> "Female", else "Unknown"

🐇 In the code where rabbits hop,
New fields and logic, we can't stop!
With lists and checks, our data's neat,
A model so fine, it can't be beat!
Hooray for the changes, let's give a cheer,
For PII's magic, we hold so dear!
🥕


🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.