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
71 changes: 0 additions & 71 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,77 +181,6 @@ To remove the library, run the following.
pip uninstall jupyter_nbmodel_client
```

## Data Models

The following json schema describes the data model used in cells and notebook metadata to communicate between user clients and an Jupyter AI Agent.

For that, you will need the [Jupyter AI Agents](https://github.com/datalayer/jupyter-ai-agents) extension installed.

```json
{
"datalayer": {
"type": "object",
"properties": {
"ai": {
"type": "object",
"properties": {
"prompts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"title": "Prompt unique identifier",
"type": "string"
},
"prompt": {
"title": "User prompt",
"type": "string"
},
"username": {
"title": "Unique identifier of the user making the prompt.",
"type": "string"
},
"timestamp": {
"title": "Number of milliseconds elapsed since the epoch; i.e. January 1st, 1970 at midnight UTC.",
"type": "integer"
}
},
"required": ["id", "prompt"]
}
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"parent_id": {
"title": "Prompt unique identifier",
"type": "string"
},
"message": {
"title": "AI reply",
"type": "string"
},
"type": {
"title": "Type message",
"enum": [0, 1, 2]
},
"timestamp": {
"title": "Number of milliseconds elapsed since the epoch; i.e. January 1st, 1970 at midnight UTC.",
"type": "integer"
}
},
"required": ["id", "prompt"]
}
}
}
}
}
}
}
```

## Contributing

### Development install
Expand Down
2 changes: 0 additions & 2 deletions jupyter_nbmodel_client/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
from nbformat import NotebookNode

from jupyter_nbmodel_client._version import VERSION as __version__ # noqa: N811
from jupyter_nbmodel_client.agent import AIMessageType, BaseNbAgent
from jupyter_nbmodel_client.client import NbModelClient
from jupyter_nbmodel_client.helpers import (
get_notebook_websocket_url,
Expand All @@ -19,7 +18,6 @@

__all__ = [
"AIMessageType",
"BaseNbAgent",
"KernelClient",
"NbModelClient",
"NotebookModel",
Expand Down
2 changes: 1 addition & 1 deletion jupyter_nbmodel_client/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
#
# BSD 3-Clause License

VERSION = "0.14.2"
VERSION = "0.14.3"
Loading
Loading