docs: Add note about the openai_dart client

davidmigloz · Oct 9, 2024 · 26de8d9 · 26de8d9
1 parent 1e93a59
commit 26de8d9
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/packages/openai_realtime_dart/README.md b/packages/openai_realtime_dart/README.md
@@ -5,7 +5,9 @@
 [![](https://dcbadge.vercel.app/api/server/x4qbhqecVR?style=flat)](https://discord.gg/x4qbhqecVR)
 [![MIT](https://img.shields.io/badge/license-MIT-purple.svg)](https://github.com/davidmigloz/langchain_dart/blob/main/LICENSE)
 
-Unofficial Dart client for the [OpenAI Realtime API](https://platform.openai.com/docs/guides/realtime).
+Unofficial Dart client for the [OpenAI Realtime API](https://platform.openai.com/docs/guides/realtime), a stateful, event-based API that communicates over a WebSocket.
+
+> Note: If you are looking for a client for the [REST OpenAI API](https://platform.openai.com/docs/api-reference), please check the [openai_dart](https://pub.dev/packages/openai_dart) package.
 
 ## Table of contents
 

diff --git a/packages/openai_realtime_dart/lib/openai_realtime_dart.dart b/packages/openai_realtime_dart/lib/openai_realtime_dart.dart
@@ -1,4 +1,4 @@
-/// Dart client for the OpenAI Realtime API.
+/// Dart client for the OpenAI Realtime API (beta), a stateful, event-based API that communicates over a WebSocket.
 library;
 
 export 'src/api.dart';

diff --git a/packages/openai_realtime_dart/pubspec.yaml b/packages/openai_realtime_dart/pubspec.yaml
@@ -1,5 +1,5 @@
 name: openai_realtime_dart
-description: Dart client for the OpenAI Realtime API (beta).
+description: Dart client for the OpenAI Realtime API (beta), a stateful, event-based API that communicates over a WebSocket.
 version: 0.0.1
 repository: https://github.com/davidmigloz/langchain_dart/tree/main/packages/openai_realtime_dart
 issue_tracker: https://github.com/davidmigloz/langchain_dart/issues?q=label:p:openai_realtime_dart