# pyhcx
The HCX REST API. Please see https://api.ncloud-docs.com/docs/ai-naver-clovastudio-summary for more details.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 24.1.5
- Package version: 1.0.0
- Generator version: 7.5.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://www.ncloud.com/support/overview](https://www.ncloud.com/support/overview)
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import pyhcx
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import pyhcx
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import pyhcx
from pyhcx.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = pyhcx.Configuration(
host = "http://localhost"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApigwApiKey
configuration.api_key['ApigwApiKey'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApigwApiKey'] = 'Bearer'
# Configure API key authorization: ClovastudioApiKey
configuration.api_key['ClovastudioApiKey'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ClovastudioApiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with pyhcx.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pyhcx.ChatApi(api_client)
app_name = 'app_name_example' # str | app Name
model_name = 'model_name_example' # str | model Name
x_ncp_clovastudio_request_id = 'x_ncp_clovastudio_request_id_example' # str | request id
create_chat_completion_request = pyhcx.CreateChatCompletionRequest() # CreateChatCompletionRequest |
try:
api_response = api_instance.create_chat_completion(app_name, model_name, x_ncp_clovastudio_request_id, create_chat_completion_request)
print("The response of ChatApi->create_chat_completion:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ChatApi->create_chat_completion: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ChatApi* | [**create_chat_completion**](docs/ChatApi.md#create_chat_completion) | **POST** /{appName}/v1/chat-completions/{modelName} |
*ChatApi* | [**create_training_chat_completion**](docs/ChatApi.md#create_training_chat_completion) | **POST** /{appName}/v1/tasks/{taskId}/chat-completions |
*CompletionsApi* | [**create_completion**](docs/CompletionsApi.md#create_completion) | **POST** /{appName}/v1/completions/{model} |
*EmbeddingsApi* | [**create_embedding**](docs/EmbeddingsApi.md#create_embedding) | **POST** /{appName}/v1/api-tools/embedding/{modelName}/{appId} |
*FineTuningApi* | [**create_training_task**](docs/FineTuningApi.md#create_training_task) | **POST** /tuning/v2/tasks |
*FineTuningApi* | [**delete_training_task**](docs/FineTuningApi.md#delete_training_task) | **DELETE** /tuning/v2/tasks/{taskId} |
*FineTuningApi* | [**get_training_task_list**](docs/FineTuningApi.md#get_training_task_list) | **GET** /tuning/v2/tasks |
*FineTuningApi* | [**get_training_task_status**](docs/FineTuningApi.md#get_training_task_status) | **GET** /tuning/v2/tasks/{taskId} |
*SegmentationApi* | [**create_segmentation**](docs/SegmentationApi.md#create_segmentation) | **POST** /{appName}/v1/api-tools/segmentation/{appId} |
## Documentation For Models
- [ChatCompletionMessage](docs/ChatCompletionMessage.md)
- [ChatCompletionResult](docs/ChatCompletionResult.md)
- [CompletionAIFilter](docs/CompletionAIFilter.md)
- [CompletionResult](docs/CompletionResult.md)
- [CreateChatCompletionRequest](docs/CreateChatCompletionRequest.md)
- [CreateChatCompletionResponse](docs/CreateChatCompletionResponse.md)
- [CreateCompletionRequest](docs/CreateCompletionRequest.md)
- [CreateCompletionResponse](docs/CreateCompletionResponse.md)
- [CreateEmbeddingRequest](docs/CreateEmbeddingRequest.md)
- [CreateEmbeddingResponse](docs/CreateEmbeddingResponse.md)
- [CreateEmbeddingResult](docs/CreateEmbeddingResult.md)
- [CreateSegmentationRequest](docs/CreateSegmentationRequest.md)
- [CreateSegmentationResponse](docs/CreateSegmentationResponse.md)
- [CreateSegmentationResult](docs/CreateSegmentationResult.md)
- [DeleteTrainingTask200Response](docs/DeleteTrainingTask200Response.md)
- [GetTrainingTaskListResponse](docs/GetTrainingTaskListResponse.md)
- [GetTrainingTaskListResult](docs/GetTrainingTaskListResult.md)
- [GetTrainingTaskListResultContentInner](docs/GetTrainingTaskListResultContentInner.md)
- [Status](docs/Status.md)
- [TrainingTaskResponse](docs/TrainingTaskResponse.md)
- [TrainingTaskResult](docs/TrainingTaskResult.md)
- [TrainingTaskResultStatusInfo](docs/TrainingTaskResultStatusInfo.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="ClovastudioApiKey"></a>
### ClovastudioApiKey
- **Type**: API key
- **API key parameter name**: X-NCP-CLOVASTUDIO-API-KEY
- **Location**: HTTP header
<a id="ApigwApiKey"></a>
### ApigwApiKey
- **Type**: API key
- **API key parameter name**: X-NCP-APIGW-API-KEY
- **Location**: HTTP header
<a id="IamAccessKey"></a>
### IamAccessKey
- **Type**: API key
- **API key parameter name**: X-NCP-IAM-ACCESS-KEY
- **Location**: HTTP header
<a id="ApigwSignatureKey"></a>
### ApigwSignatureKey
- **Type**: API key
- **API key parameter name**: X-NCP-APIGW-SIGNATURE-V2
- **Location**: HTTP header
## Author
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/didim365-ai/naver-ai",
"name": "pyhcx",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, HCX API",
"author": "HCX Support",
"author_email": "ai@didim365.co.kr",
"download_url": "https://files.pythonhosted.org/packages/23/f9/da991da919a6bc5b4299340a6bbd2fe3a009116cc97c6dc22265669b3a38/pyhcx-0.9.8.tar.gz",
"platform": null,
"description": "# pyhcx\nThe HCX REST API. Please see https://api.ncloud-docs.com/docs/ai-naver-clovastudio-summary for more details.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 24.1.5\n- Package version: 1.0.0\n- Generator version: 7.5.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\nFor more information, please visit [https://www.ncloud.com/support/overview](https://www.ncloud.com/support/overview)\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport pyhcx\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport pyhcx\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport pyhcx\nfrom pyhcx.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pyhcx.Configuration(\n host = \"http://localhost\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure API key authorization: ApigwApiKey\nconfiguration.api_key['ApigwApiKey'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['ApigwApiKey'] = 'Bearer'\n\n# Configure API key authorization: ClovastudioApiKey\nconfiguration.api_key['ClovastudioApiKey'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['ClovastudioApiKey'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nwith pyhcx.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pyhcx.ChatApi(api_client)\n app_name = 'app_name_example' # str | app Name\n model_name = 'model_name_example' # str | model Name\n x_ncp_clovastudio_request_id = 'x_ncp_clovastudio_request_id_example' # str | request id\n create_chat_completion_request = pyhcx.CreateChatCompletionRequest() # CreateChatCompletionRequest | \n\n try:\n api_response = api_instance.create_chat_completion(app_name, model_name, x_ncp_clovastudio_request_id, create_chat_completion_request)\n print(\"The response of ChatApi->create_chat_completion:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling ChatApi->create_chat_completion: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ChatApi* | [**create_chat_completion**](docs/ChatApi.md#create_chat_completion) | **POST** /{appName}/v1/chat-completions/{modelName} | \n*ChatApi* | [**create_training_chat_completion**](docs/ChatApi.md#create_training_chat_completion) | **POST** /{appName}/v1/tasks/{taskId}/chat-completions | \n*CompletionsApi* | [**create_completion**](docs/CompletionsApi.md#create_completion) | **POST** /{appName}/v1/completions/{model} | \n*EmbeddingsApi* | [**create_embedding**](docs/EmbeddingsApi.md#create_embedding) | **POST** /{appName}/v1/api-tools/embedding/{modelName}/{appId} | \n*FineTuningApi* | [**create_training_task**](docs/FineTuningApi.md#create_training_task) | **POST** /tuning/v2/tasks | \n*FineTuningApi* | [**delete_training_task**](docs/FineTuningApi.md#delete_training_task) | **DELETE** /tuning/v2/tasks/{taskId} | \n*FineTuningApi* | [**get_training_task_list**](docs/FineTuningApi.md#get_training_task_list) | **GET** /tuning/v2/tasks | \n*FineTuningApi* | [**get_training_task_status**](docs/FineTuningApi.md#get_training_task_status) | **GET** /tuning/v2/tasks/{taskId} | \n*SegmentationApi* | [**create_segmentation**](docs/SegmentationApi.md#create_segmentation) | **POST** /{appName}/v1/api-tools/segmentation/{appId} | \n\n\n## Documentation For Models\n\n - [ChatCompletionMessage](docs/ChatCompletionMessage.md)\n - [ChatCompletionResult](docs/ChatCompletionResult.md)\n - [CompletionAIFilter](docs/CompletionAIFilter.md)\n - [CompletionResult](docs/CompletionResult.md)\n - [CreateChatCompletionRequest](docs/CreateChatCompletionRequest.md)\n - [CreateChatCompletionResponse](docs/CreateChatCompletionResponse.md)\n - [CreateCompletionRequest](docs/CreateCompletionRequest.md)\n - [CreateCompletionResponse](docs/CreateCompletionResponse.md)\n - [CreateEmbeddingRequest](docs/CreateEmbeddingRequest.md)\n - [CreateEmbeddingResponse](docs/CreateEmbeddingResponse.md)\n - [CreateEmbeddingResult](docs/CreateEmbeddingResult.md)\n - [CreateSegmentationRequest](docs/CreateSegmentationRequest.md)\n - [CreateSegmentationResponse](docs/CreateSegmentationResponse.md)\n - [CreateSegmentationResult](docs/CreateSegmentationResult.md)\n - [DeleteTrainingTask200Response](docs/DeleteTrainingTask200Response.md)\n - [GetTrainingTaskListResponse](docs/GetTrainingTaskListResponse.md)\n - [GetTrainingTaskListResult](docs/GetTrainingTaskListResult.md)\n - [GetTrainingTaskListResultContentInner](docs/GetTrainingTaskListResultContentInner.md)\n - [Status](docs/Status.md)\n - [TrainingTaskResponse](docs/TrainingTaskResponse.md)\n - [TrainingTaskResult](docs/TrainingTaskResult.md)\n - [TrainingTaskResultStatusInfo](docs/TrainingTaskResultStatusInfo.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"ClovastudioApiKey\"></a>\n### ClovastudioApiKey\n\n- **Type**: API key\n- **API key parameter name**: X-NCP-CLOVASTUDIO-API-KEY\n- **Location**: HTTP header\n\n<a id=\"ApigwApiKey\"></a>\n### ApigwApiKey\n\n- **Type**: API key\n- **API key parameter name**: X-NCP-APIGW-API-KEY\n- **Location**: HTTP header\n\n<a id=\"IamAccessKey\"></a>\n### IamAccessKey\n\n- **Type**: API key\n- **API key parameter name**: X-NCP-IAM-ACCESS-KEY\n- **Location**: HTTP header\n\n<a id=\"ApigwSignatureKey\"></a>\n### ApigwSignatureKey\n\n- **Type**: API key\n- **API key parameter name**: X-NCP-APIGW-SIGNATURE-V2\n- **Location**: HTTP header\n\n\n## Author\n\n\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "HCX API",
"version": "0.9.8",
"project_urls": {
"Homepage": "https://gitlab.com/didim365-ai/naver-ai",
"Repository": "https://gitlab.com/didim365-ai/naver-ai"
},
"split_keywords": [
"openapi",
" openapi-generator",
" hcx api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f5e3998735344557fb73089ca94a4e7c67599269cbcd2a3d77ec7dd906766c84",
"md5": "484ead749d57b99c24542395d8549fa4",
"sha256": "10c94379181aac22038c3f1fea0841fb82b3918ed4cd9b89f21096965a2b42d4"
},
"downloads": -1,
"filename": "pyhcx-0.9.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "484ead749d57b99c24542395d8549fa4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 67309,
"upload_time": "2024-09-04T04:41:26",
"upload_time_iso_8601": "2024-09-04T04:41:26.614378Z",
"url": "https://files.pythonhosted.org/packages/f5/e3/998735344557fb73089ca94a4e7c67599269cbcd2a3d77ec7dd906766c84/pyhcx-0.9.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "23f9da991da919a6bc5b4299340a6bbd2fe3a009116cc97c6dc22265669b3a38",
"md5": "53f36921c5d116543c86f127f8315bd9",
"sha256": "7d82d3917831415d87f67a54ddeb83ff10a941a306c3a0bdd4f50b58de5f51c8"
},
"downloads": -1,
"filename": "pyhcx-0.9.8.tar.gz",
"has_sig": false,
"md5_digest": "53f36921c5d116543c86f127f8315bd9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 31487,
"upload_time": "2024-09-04T04:41:28",
"upload_time_iso_8601": "2024-09-04T04:41:28.534103Z",
"url": "https://files.pythonhosted.org/packages/23/f9/da991da919a6bc5b4299340a6bbd2fe3a009116cc97c6dc22265669b3a38/pyhcx-0.9.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-04 04:41:28",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "didim365-ai",
"gitlab_project": "naver-ai",
"lcname": "pyhcx"
}
JSON