From 26de8d974fcd27fec857b93cc309e76860777dea Mon Sep 17 00:00:00 2001 From: David Miguel Date: Wed, 9 Oct 2024 11:16:11 +0200 Subject: [PATCH] docs: Add note about the openai_dart client --- packages/openai_realtime_dart/README.md | 4 +++- packages/openai_realtime_dart/lib/openai_realtime_dart.dart | 2 +- packages/openai_realtime_dart/pubspec.yaml | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/packages/openai_realtime_dart/README.md b/packages/openai_realtime_dart/README.md index 1150d8cd..0c2c2f05 100644 --- 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 index 898d6515..5334e883 100644 --- 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 index 8fdaebf0..09857dd0 100644 --- 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