add readme

tomasliu-agora · Oct 12, 2024 · efbbd52 · efbbd52
1 parent b39ae22
commit efbbd52
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/agents/ten_packages/extension/openai_v2v_python/README.md b/agents/ten_packages/extension/openai_v2v_python/README.md
@@ -48,3 +48,18 @@ Refer to `api` definition in [manifest.json] and default values in [property.jso
 | **Name**         | **Description**                           |
 |------------------|-------------------------------------------|
 | `pcm_frame`    | Audio frame output after voice processing    |
+
+
+### Azure Support
+
+This extension also support Azure OpenAI Service, the propoerty settings are as follow:
+
+``` json
+{
+    "base_uri": "wss://xxx.openai.azure.com",
+    "path": "/openai/realtime?api-version=xxx&deployment=xxx",
+    "api_key": "xxx",
+    "model": "gpt-4o-realtime-preview",
+    "platform": "azure"
+}
+```
diff --git a/agents/ten_packages/extension/openai_v2v_python/manifest.json b/agents/ten_packages/extension/openai_v2v_python/manifest.json
@@ -26,6 +26,15 @@
       "api_key": {
         "type": "string"
       },
+      "base_uri": {
+        "type": "string"
+      },
+      "path": {
+        "type": "string"
+      },
+      "platform": {
+        "type": "string"
+      },
       "temperature": {
         "type": "float64"
       },