@oracle/oci-ai-speech-realtime-web
v2.0.0
Published
OCI Web client for AI Speech Realtime Service
Downloads
130
Maintainers
Keywords
Readme
Oracle Cloud Infrastructure Realtime Speech Web SDK
About
This repository contains the source code for the Web SDK to connect to the realtime speech service. There's also an example client for reference. This is meant for clients in a browser environment. For NodeJS clients, please refer to the Realtime Speech TypeScript SDK.
Installation instructions
Do the following to install the SDK:
npm install @oracle/oci-ai-speech-realtime-web
You can also choose to clone this git repo and install from source.
Documentation
The home page for the OCI Speech Service can be found here. The API reference for OCI Speech Service can be found here.
Note that realtime speech URLs are distinct from the speech URLs mentioned in the above link. To obtain a realtime speech url, take a speech url, and replace 'speech' with realtime. Also replace https with wss.
For example, for the following speech url:
https://speech.aiservice.af-johannesburg-1.oci.oraclecloud.com
This is the corresponding realtime speech URL:
wss://realtime.aiservice.af-johannesburg-1.oci.oraclecloud.com
Examples
We have an example here itself, it can be found in the example-client directory.
Development
Follow the instructions in the Development Readme to get started with local development/testing of the SDK code.
Contributing
This project welcomes contributions from the community. Before submitting a pull request, please review our contribution guide
Security
Please consult the security guide for our responsible security vulnerability disclosure process
License
Copyright (c) 2024 Oracle and/or its affiliates.
Released under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl/.