# 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](https://github.com/python-websockets/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:
```bash
pip install oci-ai-speech-realtime
```
## Development
Follow the instructions in the [Development Readme](ai-speech-realtime-sdk-python/README.md) to get started with local development/testing of the SDK code.
## Documentation
The home page for the OCI Speech Service can be found [here](https://www.oracle.com/artificial-intelligence/speech/).
The API reference for OCI Speech Service can be found [here](https://docs.oracle.com/en-us/iaas/api/#/en/speech/latest/).
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](example-client/) directory.
## Contributing
This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
## Security
Please consult the [security guide](./SECURITY.md) 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/>.
Raw data
{
"_id": null,
"home_page": "https://docs.oracle.com/en-us/iaas/tools/python/latest/index.html",
"name": "oci-ai-speech-realtime",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Oracle",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/f2/79/c3e91bbb5471c570f359b9f01259217df59cef97cae09e714b4a9461574f/oci_ai_speech_realtime-2.0.0.tar.gz",
"platform": null,
"description": "# Oracle Cloud Infrastructure Realtime Speech Python SDK\n\n## About\n\nThis 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. \\\nThis SDK is based on the popular [websockets](https://github.com/python-websockets/websockets) python library.\n\n## Installation\n\nIt is highly recommended that a Python virtual environment be used when installing the OCI Realtime Speech Python SDK. \nOnce your virtual environment is active, the SDK can be installed using pip. Do the following for installation:\n\n```bash\npip install oci-ai-speech-realtime\n```\n\n## Development\nFollow the instructions in the [Development Readme](ai-speech-realtime-sdk-python/README.md) to get started with local development/testing of the SDK code. \n\n## Documentation\n\nThe home page for the OCI Speech Service can be found [here](https://www.oracle.com/artificial-intelligence/speech/).\nThe API reference for OCI Speech Service can be found [here](https://docs.oracle.com/en-us/iaas/api/#/en/speech/latest/).\n\nNote 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. \n\nFor example, for the following speech url:\n\n```https://speech.aiservice.af-johannesburg-1.oci.oraclecloud.com```\n\nThis is the corresponding realtime speech URL:\n\n```wss://realtime.aiservice.af-johannesburg-1.oci.oraclecloud.com```\n\n\n## Examples\n\nWe have an example here itself, it can be found in the [example-client](example-client/) directory.\n\n## Contributing\n\nThis project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)\n\n## Security\n\nPlease consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process\n\n## License\n\nCopyright (c) 2024 Oracle and/or its affiliates.\n\nReleased under the Universal Permissive License v1.0 as shown at\n<https://oss.oracle.com/licenses/upl/>.\n",
"bugtrack_url": null,
"license": "Universal Permissive License 1.0",
"summary": "Oracle Cloud Infrastructure Python SDK for Realtime Speech Service",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://docs.oracle.com/en-us/iaas/tools/python/latest/index.html"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "17e4e08050d5cc0f978c7669ed34e21efa28a06c7a3fc5837933add04fb622b9",
"md5": "95a6b3449e6d55a7da947c2265e8da24",
"sha256": "4568c9c0573a2eb79cd621d5938b75f4f3b95bde9573a9029dc98a83d49e7831"
},
"downloads": -1,
"filename": "oci_ai_speech_realtime-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "95a6b3449e6d55a7da947c2265e8da24",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 33070,
"upload_time": "2024-12-10T03:43:59",
"upload_time_iso_8601": "2024-12-10T03:43:59.012551Z",
"url": "https://files.pythonhosted.org/packages/17/e4/e08050d5cc0f978c7669ed34e21efa28a06c7a3fc5837933add04fb622b9/oci_ai_speech_realtime-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f279c3e91bbb5471c570f359b9f01259217df59cef97cae09e714b4a9461574f",
"md5": "a800ee0c46e5222e9f0f5c64fbb2b360",
"sha256": "80820ed8393049de7d8b310d9f3cc7324b41a4d752b3b8a0984caef50c8533a9"
},
"downloads": -1,
"filename": "oci_ai_speech_realtime-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "a800ee0c46e5222e9f0f5c64fbb2b360",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 32573,
"upload_time": "2024-12-10T03:44:01",
"upload_time_iso_8601": "2024-12-10T03:44:01.093525Z",
"url": "https://files.pythonhosted.org/packages/f2/79/c3e91bbb5471c570f359b9f01259217df59cef97cae09e714b4a9461574f/oci_ai_speech_realtime-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-10 03:44:01",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "oci-ai-speech-realtime"
}
JSON