/oci-ai-speech-realtime-python-sdk

This repository contains the source code for the Python SDK to connect to the Realtime Speech Service. There is also an example client to help with connecting to the service. This SDK is based on the popular websockets python library.

Primary LanguagePythonUniversal Permissive License v1.0UPL-1.0

Oracle Cloud Infrastructure Realtime Speech Python SDK

About

This repository contains the source code for the Python SDK to connect to the Realtime Speech Service. There is also an example client to help with connecting to the service.
This SDK is based on the popular websockets python library.

Installation

It is highly recommended that a Python virtual environment be used when installing the OCI Realtime Speech Python SDK. Once your virtual environment is active, the SDK can be installed using pip. Do the following for installation:

pip install oci-ai-speech-realtime

Development

Follow the instructions in the Development Readme to get started with local development/testing of the SDK code.

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.

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, 2025, Oracle and/or its affiliates.

Released under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl/.