cms-client 0.0.1
CogStack Model Serve APIs
Requires Python: >=3.9
Keywords: OpenAPI, OpenAPI-Generator, CogStack Model Serve APIs

# cms_client
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.1.0
- Package version: 0.0.1
- Generator version: 7.14.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## 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 cms_client
```

### 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 cms_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import cms_client
from cms_client.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 = cms_client.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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure API key authorization: APIKeyCookie
configuration.api_key['APIKeyCookie'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKeyCookie'] = 'Bearer'


# Enter a context with an instance of the API client
with cms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cms_client.AnnotationsApi(api_client)
    multi_text_file = None # bytearray | A file containing a list of plain texts, in the format of [\\\"text_1\\\", \\\"text_2\\\", ..., \\\"text_n\\\"]
    tracking_id = 'tracking_id_example' # str | The tracking ID of the requested task (optional)

    try:
        # Extract Entities From Multi Text File
        api_instance.extract_entities_from_multi_text_file(multi_text_file, tracking_id=tracking_id)
    except ApiException as e:
        print("Exception when calling AnnotationsApi->extract_entities_from_multi_text_file: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AnnotationsApi* | [**extract_entities_from_multi_text_file**](docs/AnnotationsApi.md#extract_entities_from_multi_text_file) | **POST** /process_bulk_file | Extract Entities From Multi Text File
*AnnotationsApi* | [**get_entities_from_jsonlines_text**](docs/AnnotationsApi.md#get_entities_from_jsonlines_text) | **POST** /process_jsonl | Get Entities From Jsonlines Text
*AnnotationsApi* | [**get_entities_from_multiple_texts**](docs/AnnotationsApi.md#get_entities_from_multiple_texts) | **POST** /process_bulk | Get Entities From Multiple Texts
*AnnotationsApi* | [**get_entities_from_text**](docs/AnnotationsApi.md#get_entities_from_text) | **POST** /process | Get Entities From Text
*AnnotationsApi* | [**get_entities_stream_from_jsonlines_stream**](docs/AnnotationsApi.md#get_entities_stream_from_jsonlines_stream) | **POST** /stream/process | Get Entities Stream From Jsonlines Stream
*AuthenticationApi* | [**auth_cookie_login**](docs/AuthenticationApi.md#auth_cookie_login) | **POST** /auth/cookie/login | Auth:Cookie.Login
*AuthenticationApi* | [**auth_cookie_logout**](docs/AuthenticationApi.md#auth_cookie_logout) | **POST** /auth/cookie/logout | Auth:Cookie.Logout
*AuthenticationApi* | [**auth_jwt_login**](docs/AuthenticationApi.md#auth_jwt_login) | **POST** /auth/jwt/login | Auth:Jwt.Login
*AuthenticationApi* | [**auth_jwt_logout**](docs/AuthenticationApi.md#auth_jwt_logout) | **POST** /auth/jwt/logout | Auth:Jwt.Logout
*EvaluatingApi* | [**get_annotation_stats**](docs/EvaluatingApi.md#get_annotation_stats) | **POST** /annotation-stats | Get Annotation Stats
*EvaluatingApi* | [**get_concatenated_trainer_exports**](docs/EvaluatingApi.md#get_concatenated_trainer_exports) | **POST** /concat_trainer_exports | Get Concatenated Trainer Exports
*EvaluatingApi* | [**get_inter_annotator_agreement_scores**](docs/EvaluatingApi.md#get_inter_annotator_agreement_scores) | **POST** /iaa-scores | Get Inter Annotator Agreement Scores
*EvaluatingApi* | [**get_sanity_check_with_trainer_export**](docs/EvaluatingApi.md#get_sanity_check_with_trainer_export) | **POST** /sanity-check | Get Sanity Check With Trainer Export
*GenerateTextBasedOnTheInputPromptApi* | [**generate_text**](docs/GenerateTextBasedOnTheInputPromptApi.md#generate_text) | **POST** /generate | Generate Text
*GenerateTextBasedOnTheInputPromptApi* | [**generate_text_stream**](docs/GenerateTextBasedOnTheInputPromptApi.md#generate_text_stream) | **POST** /stream/generate | Generate Text Stream
*MetadataApi* | [**get_model_card**](docs/MetadataApi.md#get_model_card) | **GET** /info | Get Model Card
*OpenAICompatibleApi* | [**embed_texts**](docs/OpenAICompatibleApi.md#embed_texts) | **POST** /v1/embeddings | Embed Texts
*OpenAICompatibleApi* | [**generate_chat_completions**](docs/OpenAICompatibleApi.md#generate_chat_completions) | **POST** /v1/chat/completions | Generate Chat Completions
*RedactionApi* | [**get_redacted_text**](docs/RedactionApi.md#get_redacted_text) | **POST** /redact | Get Redacted Text
*RedactionApi* | [**get_redacted_text_with_encryption**](docs/RedactionApi.md#get_redacted_text_with_encryption) | **POST** /redact_with_encryption | Get Redacted Text With Encryption
*RenderingApi* | [**get_rendered_entities_from_text**](docs/RenderingApi.md#get_rendered_entities_from_text) | **POST** /preview | Get Rendered Entities From Text
*RenderingApi* | [**get_rendered_entities_from_trainer_export**](docs/RenderingApi.md#get_rendered_entities_from_trainer_export) | **POST** /preview_trainer_export | Get Rendered Entities From Trainer Export
*TrainingApi* | [**cancel_training**](docs/TrainingApi.md#cancel_training) | **POST** /cancel_training | Cancel Training
*TrainingApi* | [**get_evaluation_with_trainer_export**](docs/TrainingApi.md#get_evaluation_with_trainer_export) | **POST** /evaluate | Get Evaluation With Trainer Export
*TrainingApi* | [**train_eval_info**](docs/TrainingApi.md#train_eval_info) | **GET** /train_eval_info | Train Eval Info
*TrainingApi* | [**train_eval_metrics**](docs/TrainingApi.md#train_eval_metrics) | **GET** /train_eval_metrics | Train Eval Metrics
*TrainingApi* | [**train_metacat**](docs/TrainingApi.md#train_metacat) | **POST** /train_metacat | Train Metacat
*TrainingApi* | [**train_supervised**](docs/TrainingApi.md#train_supervised) | **POST** /train_supervised | Train Supervised
*TrainingApi* | [**train_unsupervised**](docs/TrainingApi.md#train_unsupervised) | **POST** /train_unsupervised | Train Unsupervised
*TrainingApi* | [**train_unsupervised_with_hf_dataset**](docs/TrainingApi.md#train_unsupervised_with_hf_dataset) | **POST** /train_unsupervised_with_hf_hub_dataset | Train Unsupervised With Hf Dataset


## Documentation For Models

 - [Annotation](docs/Annotation.md)
 - [BearerResponse](docs/BearerResponse.md)
 - [Detail](docs/Detail.md)
 - [ErrorModel](docs/ErrorModel.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [Input](docs/Input.md)
 - [ModelCard](docs/ModelCard.md)
 - [ModelType](docs/ModelType.md)
 - [OpenAIChatRequest](docs/OpenAIChatRequest.md)
 - [OpenAIEmbeddingsRequest](docs/OpenAIEmbeddingsRequest.md)
 - [PromptMessage](docs/PromptMessage.md)
 - [PromptRole](docs/PromptRole.md)
 - [TextWithAnnotations](docs/TextWithAnnotations.md)
 - [TextWithPublicKey](docs/TextWithPublicKey.md)
 - [ValidationError](docs/ValidationError.md)
 - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="OAuth2PasswordBearer"></a>
### OAuth2PasswordBearer

- **Type**: OAuth
- **Flow**: password
- **Authorization URL**: 
- **Scopes**: N/A

<a id="APIKeyCookie"></a>
### APIKeyCookie

- **Type**: API key
- **API key parameter name**: fastapiusersauth
- **Location**: 


## Author