Initial Implementation #1

NeonDaniel · 2024-10-30T23:20:52Z

Description

Define high-level structure of grouping models into (api, base, client, user, messagebus)
Consolidate existing models and add unit test coverage
Defines User Database schema and method for adapting to existing NeonCore schema
Defines base Message schema, including context
Defines __all__ in modules so import * can be used to import all Pydantic models from a module without also pulling extraneous imports (i.e. datetime which can cause confusion if both datetime and datetime.datetime are imported as datetime)

Issues

Other Notes

The intention is to also define all known Message schemas here, but this will require planning for how to organize - Messages as well as how much to enforce structure on what is currently a very unstructured system.
This module will in the future include the schemas used in HANA
Consider in the future defining schemas for MQ module communications (base schema included for now)
Ideally, the function sketched out in the util module will be extended to generate some browsable registry that may be included in documentation

Move existing unit tests to this repository

Refactor README.md into expected path

Add "test" extras

Add JSON schema for all models

…obally Document envvar to allow extra params

Remove bundled `schema` directory Update `build_json_schema` util to be more flexible

…t sepc) Update `node_v1` to extend base module and define `__all__` Normalize newer `lat`/`lon` refs to `latitude`/`longitude` for consistency with database Remove `verified` config options as those should not be self-reported Remove unused `brands` config spec Fix `UserProfile.from_user_object` bugs Remove top-level import helpers Add unit tests

…de other MQ message specs Define Data schemas for all node messages Move enum classes related to data schema to this module Outline repo organization in README.md

Refactor node_v1 to improve `msg_type` validation, specify `data` models for all objects, and remove models that are used only in one other model

neon_data_models/enum.py

mikejgray · 2024-11-02T01:21:04Z

neon_data_models/enum.py

+class Weekdays(IntEnum):
+    """
+    Defines weekdays.
+    """
+    MON = 0
+    TUE = 1
+    WED = 2
+    THU = 3
+    FRI = 4
+    SAT = 5
+    SUN = 6


This may be replicating functionality available in the datetime library, but I'd have to check to be sure...

I can't find it in searching.. I only find results for DayOfWeek in C and Java

Ah, I was thinking of datetime.isoweekday()...that's not really going to help in this scenario

Might be worth moving to that eventually instead of this special enum, but that's more of an issue for the Alerts skill

mikejgray · 2024-11-02T01:21:59Z

neon_data_models/models/api/mq.py

+
+
+class UserDbRequest(MQContext):
+    operation: Literal["create", "read", "update", "delete"]


Not sure if you want to consider list to be another form of read or an entirely separate entity - I lean towards a separate entity myself but don't have strong opinions about it one way or another

Possibly.. right now there isn't any functionality for bulk actions, but that would be helpful in the future

mikejgray · 2024-11-02T01:24:25Z

neon_data_models/models/api/node_v1/__init__.py

+    parser_data: dict
+    transcripts: List[str]
+    skills_recv: bool


I like the description fields in KlatResponse - is there an intention to include those everywhere eventually?

Ideally, yes. It's just time consuming so I started with things that are ambiguous without them (describing dict keys, bcp-47 vs iso lang codes, etc)

mikejgray · 2024-11-02T01:27:12Z

neon_data_models/models/api/node_v1/__init__.py

+        username: str
+        data_to_remove: List[UserData]
+
+    msg_type: Literal["neon.clear_data"] = "neon.clear_data"


Is there a way to annotate the entire class with a description? I've never run into this message type before and am now curious what it actually does

I believe docstrings are rendered in swagger, but I'm not sure if that's technically part of the json schema

neon_data_models/models/user/database.py

mikejgray · 2024-11-02T01:35:06Z

neon_data_models/models/user/database.py

+    """
+    Defines configuration used in BrainForge LLM applications.
+    """
+    inference_access: Dict[str, Dict[str, List[str]]] = {}


Not sure this default meets the type, technically? But I assume over time this will be more strictly defined

I think an empty dict technically satisfies the schema, but you are correct that this is still yet to be implemented/fully-defined

neon_data_models/models/user/database.py

neon_data_models/models/user/neon_profile.py

…r networking parameters

Add api.mq module import for consistency

# Changelog ## [0.0.0a11](https://github.com/NeonGeckoCom/neon-data-models/tree/0.0.0a11) (2025-02-07) [Full Changelog](0.0.0a10...0.0.0a11) **Implemented enhancements:** - \[FEAT\] Skip system prompt if `persona=None` [\#9](#9) **Merged pull requests:** - Add support for "vanilla" persona with unit tests [\#15](#15) ([NeonDaniel](https://github.com/NeonDaniel)) ## [0.0.0a10](https://github.com/NeonGeckoCom/neon-data-models/tree/0.0.0a10) (2025-02-06) [Full Changelog](0.0.0a9...0.0.0a10) **Merged pull requests:** - Update `llm` submodule and model docstrings [\#13](#13) ([NeonDaniel](https://github.com/NeonDaniel)) ## [0.0.0a9](https://github.com/NeonGeckoCom/neon-data-models/tree/0.0.0a9) (2025-02-06) [Full Changelog](0.0.0a8...0.0.0a9) ## [0.0.0a8](https://github.com/NeonGeckoCom/neon-data-models/tree/0.0.0a8) (2025-02-02) [Full Changelog](0.0.0a7...0.0.0a8) ## [0.0.0a7](https://github.com/NeonGeckoCom/neon-data-models/tree/0.0.0a7) (2025-01-26) [Full Changelog](0.0.0a6...0.0.0a7) ## [0.0.0a6](https://github.com/NeonGeckoCom/neon-data-models/tree/0.0.0a6) (2025-01-06) [Full Changelog](0.0.0a5...0.0.0a6) **Merged pull requests:** - Resolve issue with serializing default permissions [\#10](#10) ([NeonDaniel](https://github.com/NeonDaniel)) ## [0.0.0a5](https://github.com/NeonGeckoCom/neon-data-models/tree/0.0.0a5) (2024-12-18) [Full Changelog](0.0.0a4...0.0.0a5) **Merged pull requests:** - Define data models for LLM interactions [\#4](#4) ([NeonDaniel](https://github.com/NeonDaniel)) ## [0.0.0a4](https://github.com/NeonGeckoCom/neon-data-models/tree/0.0.0a4) (2024-11-21) [Full Changelog](0.0.0a3...0.0.0a4) **Merged pull requests:** - Update UserDbRequest models [\#3](#3) ([NeonDaniel](https://github.com/NeonDaniel)) ## [0.0.0a3](https://github.com/NeonGeckoCom/neon-data-models/tree/0.0.0a3) (2024-11-19) [Full Changelog](0.0.0a2...0.0.0a3) **Implemented enhancements:** - \[FEAT\] Define range for user permissions [\#5](#5) **Merged pull requests:** - Formally define and document Access Roles values [\#6](#6) ([NeonDaniel](https://github.com/NeonDaniel)) ## [0.0.0a2](https://github.com/NeonGeckoCom/neon-data-models/tree/0.0.0a2) (2024-11-19) [Full Changelog](0.0.0a1...0.0.0a2) **Merged pull requests:** - Update TokenConfig and add JWT models [\#2](#2) ([NeonDaniel](https://github.com/NeonDaniel)) ## [0.0.0a1](https://github.com/NeonGeckoCom/neon-data-models/tree/0.0.0a1) (2024-11-04) [Full Changelog](ccd1aff...0.0.0a1) **Merged pull requests:** - Initial Implementation [\#1](#1) ([NeonDaniel](https://github.com/NeonDaniel)) \* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

NeonDaniel added 13 commits October 30, 2024 16:18

Organize existing user and node-related models into modules.

9fccdba

Move existing unit tests to this repository

Add missing requirements.txt

952dd00

Refactor README.md into expected path

Add pytest test dependency

8b338d1

Fix copy/paste errors in unit test automation

617a73a

Add "test" extras

Fix missed import refactor in node_v1 module

3c51ca2

Add util module with function to build JSON schema

0fbdc8f

Add JSON schema for all models

Add pytz dependency for tz parsing

e1dd335

Add new BaseModel with envvar to configure allowing extra params gl…

01c88d6

…obally Document envvar to allow extra params

Fix syntax error in BaseModel definition

fb3e0b8

Ensure license notices in all files

c4a9e06

Remove bundled `schema` directory Update `build_json_schema` util to be more flexible

Refactor MQRequest into mq.UserDbRequest for extensibility to inclu…

11e17f7

…de other MQ message specs Define Data schemas for all node messages Move enum classes related to data schema to this module Outline repo organization in README.md

Add test coverage for node_v1 module

f9f08c6

Refactor node_v1 to improve `msg_type` validation, specify `data` models for all objects, and remove models that are used only in one other model

NeonDaniel marked this pull request as ready for review November 1, 2024 00:24

NeonDaniel requested a review from mikejgray November 1, 2024 00:24

NeonDaniel mentioned this pull request Nov 1, 2024

Initial Service Implementation NeonGeckoCom/neon-users-service#1

Merged

mikejgray approved these changes Nov 2, 2024

View reviewed changes

NeonDaniel added 6 commits November 4, 2024 09:10

Refactor UserData enum to be more descriptive

f94bff3

Add example value to avatar_url

cfe052d

Update neon_profile annotations per review comments

53ec262

Annotate timestamp fields per review

b652982

Reorganize AlertData fields per review

5a771f9

Default local IP address to an empty string for consistency with othe…

9db1679

…r networking parameters

NeonDaniel requested a review from mikejgray November 4, 2024 17:50

mikejgray approved these changes Nov 4, 2024

View reviewed changes

NeonDaniel added 3 commits November 4, 2024 10:39

Add note to weekdays enum that it is used for alerts

0c49ccd

Fix copy/paste error in publish release action

ee8200f

Remove commented out unused model

9d35eac

Add api.mq module import for consistency

NeonDaniel merged commit 638ddf2 into dev Nov 4, 2024

NeonDaniel deleted the FEAT_InitialImplementation branch November 4, 2024 19:01

NeonDaniel mentioned this pull request Nov 6, 2024

Update TokenConfig and add JWT models #2

Merged

This was referenced Feb 7, 2025

0.0.0 #16

Closed

0.0.1 #17

Merged



		class UserDbRequest(MQContext):
		operation: Literal["create", "read", "update", "delete"]

Initial Implementation #1

Initial Implementation #1

Uh oh!

Conversation

NeonDaniel commented Oct 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues

Other Notes

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

NeonDaniel commented Oct 30, 2024 •

edited

Loading