| Name | neuri JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | https://github.com/Neuri-ai/python-client |
| Summary | Python client library for the Neuri API |
| upload_time | 2023-05-18 23:00:33 |
| maintainer | |
| docs_url | None |
| author | Neuri |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2023 Neuri (https://github.com/Neuri-ai) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
api client
neuri
neuri.ai
neuri api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
==============
Python Client Library for Neuri
==============
This is the official Python client library for Neuri. It allows you to easily integrate Neuri into your Python applications.
++++++++++++
Installation
++++++++++++
To get started with the Neuri Python Client Library, you need to first install the library using pip:
.. code-block:: python
pip install neuri
+++++
Import and initialize the library
+++++
First you have to import the module and set up the client with your API key and service details, as shown below.
.. code-block:: python
import neuri
config = {
"service": "translate",
"lang": "en",
"temperature": 0.5,
"api_key": "YOUR_API_KEY_HERE",
"translate_to": "es" # optional
}
client = neuri.initialize_client(config)
+++++
Import and initialize the library
+++++
The Neuri Client Library currently supports three services: **audio_file**, **audio_url**, and **text**. Each service has its own set of parameters and returns a JSON containing the results of the processing.
* **neuri.audio_file()**: Audio File.
* **neuri.audio_url()**: Audio URL.
* **neuri.text()**: Text
+++++
Audio File
+++++
Process audio files stored locally on your system using the audio_file service.
.. code-block:: python
result = client.audio_file(file_path=[
os.path.join(os.path.dirname(__file__), "examples/girl_phone_call.wav"),
os.path.join(os.path.dirname(__file__), "examples/noise_man_question.wav")
])
Replace the file paths in the file_path list with the actual paths to your audio files. The audio_file service will process the audio files and return the results in a JSON format.
+++++
Audio URL
+++++
Process audio files from a remote URL using the **audio_url** service.
.. code-block:: python
result = client.audio_url(url="https://neuri-storage.s3.amazonaws.com/public_data/girl_phone_call.wav?AWSAccessKeyId=AKIAQFECGXRQOTIJ2FUV&Signature=GjrMz1NkMtQgFd0etJUCiQg4WNI%3D&Expires=1995267608")
Replace the file paths in the url list with the actual paths to your audio files. The audio_url service will process the audio files and return the results in a JSON format.
+++++
Text
+++++
Process text using the text service.
.. code-block:: python
result = client.text(text="Hello, how are you?")
Replace the text in the text parameter with the actual text you want to process. The text service will process the text and return the results in a JSON format.
Raw data
{
"_id": null,
"home_page": "https://github.com/Neuri-ai/python-client",
"name": "neuri",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "api client,neuri,neuri.ai,neuri api",
"author": "Neuri",
"author_email": "support@neuri.ai",
"download_url": "https://files.pythonhosted.org/packages/fc/d2/bdd1a998972b9b3adcaebde881968b2cc4257f692290be371b9adb461f03/neuri-1.0.1.tar.gz",
"platform": null,
"description": "==============\nPython Client Library for Neuri\n==============\n\nThis is the official Python client library for Neuri. It allows you to easily integrate Neuri into your Python applications.\n\n++++++++++++\nInstallation\n++++++++++++\n\nTo get started with the Neuri Python Client Library, you need to first install the library using pip:\n\n.. code-block:: python\n\n pip install neuri\n\n\n\n+++++\nImport and initialize the library\n+++++\n\nFirst you have to import the module and set up the client with your API key and service details, as shown below.\n\n.. code-block:: python\n\n import neuri\n\n config = {\n \"service\": \"translate\",\n \"lang\": \"en\",\n \"temperature\": 0.5,\n \"api_key\": \"YOUR_API_KEY_HERE\",\n \"translate_to\": \"es\" # optional\n }\n\n client = neuri.initialize_client(config)\n\n\n+++++\nImport and initialize the library\n+++++\n\nThe Neuri Client Library currently supports three services: **audio_file**, **audio_url**, and **text**. Each service has its own set of parameters and returns a JSON containing the results of the processing.\n\n* **neuri.audio_file()**: Audio File.\n* **neuri.audio_url()**: Audio URL.\n* **neuri.text()**: Text\n\n+++++\nAudio File\n+++++\n\nProcess audio files stored locally on your system using the audio_file service.\n\n.. code-block:: python\n\n result = client.audio_file(file_path=[\n os.path.join(os.path.dirname(__file__), \"examples/girl_phone_call.wav\"),\n os.path.join(os.path.dirname(__file__), \"examples/noise_man_question.wav\")\n ])\n\nReplace the file paths in the file_path list with the actual paths to your audio files. The audio_file service will process the audio files and return the results in a JSON format.\n\n+++++\nAudio URL\n+++++\n\nProcess audio files from a remote URL using the **audio_url** service.\n\n.. code-block:: python\n\n result = client.audio_url(url=\"https://neuri-storage.s3.amazonaws.com/public_data/girl_phone_call.wav?AWSAccessKeyId=AKIAQFECGXRQOTIJ2FUV&Signature=GjrMz1NkMtQgFd0etJUCiQg4WNI%3D&Expires=1995267608\")\n\nReplace the file paths in the url list with the actual paths to your audio files. The audio_url service will process the audio files and return the results in a JSON format.\n\n+++++\nText\n+++++\n\nProcess text using the text service.\n\n.. code-block:: python\n\n result = client.text(text=\"Hello, how are you?\")\n\nReplace the text in the text parameter with the actual text you want to process. The text service will process the text and return the results in a JSON format.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Neuri (https://github.com/Neuri-ai) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Python client library for the Neuri API",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/Neuri-ai/python-client"
},
"split_keywords": [
"api client",
"neuri",
"neuri.ai",
"neuri api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0d6dcf48223f5a035cf1ba6f1d8760ba71cccbf46c9afbd9948b705ef5050f04",
"md5": "57760f5660718d6561dcafb48bf33030",
"sha256": "1c7839bca69729f9a03e4ed8063641ff49237c5230f2fce3d967ff1b7f9535de"
},
"downloads": -1,
"filename": "neuri-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "57760f5660718d6561dcafb48bf33030",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6136,
"upload_time": "2023-05-18T23:00:28",
"upload_time_iso_8601": "2023-05-18T23:00:28.219156Z",
"url": "https://files.pythonhosted.org/packages/0d/6d/cf48223f5a035cf1ba6f1d8760ba71cccbf46c9afbd9948b705ef5050f04/neuri-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fcd2bdd1a998972b9b3adcaebde881968b2cc4257f692290be371b9adb461f03",
"md5": "b9f555a4284b3d9f3faf6a4fcc788a8c",
"sha256": "05d0e0807c3629c137c94889bc5e5a57471792a7cd20c4a300c61e4cf8182ae8"
},
"downloads": -1,
"filename": "neuri-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "b9f555a4284b3d9f3faf6a4fcc788a8c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5326,
"upload_time": "2023-05-18T23:00:33",
"upload_time_iso_8601": "2023-05-18T23:00:33.977708Z",
"url": "https://files.pythonhosted.org/packages/fc/d2/bdd1a998972b9b3adcaebde881968b2cc4257f692290be371b9adb461f03/neuri-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-18 23:00:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Neuri-ai",
"github_project": "python-client",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "neuri"
}
