Metadata-Version: 2.4
Name: biolevate-client
Version: 1.0.0
Summary: Biolevate API
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,Biolevate API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: httpx>=0.28.1
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# biolevate-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: 1.0.0
- Package version: 1.0.0
- Generator version: 7.20.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 biolevate_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 biolevate_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

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

# Configure Bearer authorization (JWT): TOKEN
configuration = biolevate_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
async with biolevate_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = biolevate_client.CollectionsApi(api_client)
    id = 'id_example' # str | Collection ID
    add_file_to_collection_request = biolevate_client.AddFileToCollectionRequest() # AddFileToCollectionRequest | 

    try:
        # Add file to collection
        api_response = await api_instance.add_file_to_collection(id, add_file_to_collection_request)
        print("The response of CollectionsApi->add_file_to_collection:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CollectionsApi->add_file_to_collection: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CollectionsApi* | [**add_file_to_collection**](docs/CollectionsApi.md#add_file_to_collection) | **POST** /api/core/collections/{id}/files | Add file to collection
*CollectionsApi* | [**create_collection**](docs/CollectionsApi.md#create_collection) | **POST** /api/core/collections | Create a collection
*CollectionsApi* | [**delete_collection**](docs/CollectionsApi.md#delete_collection) | **DELETE** /api/core/collections/{id} | Delete a collection
*CollectionsApi* | [**get_collection**](docs/CollectionsApi.md#get_collection) | **GET** /api/core/collections/{id} | Get a collection
*CollectionsApi* | [**list_collection_files**](docs/CollectionsApi.md#list_collection_files) | **GET** /api/core/collections/{id}/files | List files in collection
*CollectionsApi* | [**list_collections**](docs/CollectionsApi.md#list_collections) | **GET** /api/core/collections | List collections
*CollectionsApi* | [**remove_file_from_collection**](docs/CollectionsApi.md#remove_file_from_collection) | **DELETE** /api/core/collections/{id}/files/{fileId} | Remove file from collection
*CollectionsApi* | [**update_collection**](docs/CollectionsApi.md#update_collection) | **PATCH** /api/core/collections/{id} | Update a collection
*ExtractionApi* | [**create_extraction_job**](docs/ExtractionApi.md#create_extraction_job) | **POST** /api/core/extraction/jobs | Create extraction job
*ExtractionApi* | [**get_extraction_job**](docs/ExtractionApi.md#get_extraction_job) | **GET** /api/core/extraction/jobs/{jobId} | Get extraction job
*ExtractionApi* | [**get_extraction_job_annotations**](docs/ExtractionApi.md#get_extraction_job_annotations) | **GET** /api/core/extraction/jobs/{jobId}/annotations | Get extraction job annotations
*ExtractionApi* | [**get_extraction_job_inputs**](docs/ExtractionApi.md#get_extraction_job_inputs) | **GET** /api/core/extraction/jobs/{jobId}/inputs | Get extraction job inputs
*ExtractionApi* | [**get_extraction_job_outputs**](docs/ExtractionApi.md#get_extraction_job_outputs) | **GET** /api/core/extraction/jobs/{jobId}/results | Get extraction job outputs
*ExtractionApi* | [**list_extraction_jobs**](docs/ExtractionApi.md#list_extraction_jobs) | **GET** /api/core/extraction/jobs | List extraction jobs
*FilesApi* | [**create_file**](docs/FilesApi.md#create_file) | **POST** /api/core/files | Create a file
*FilesApi* | [**delete_file**](docs/FilesApi.md#delete_file) | **DELETE** /api/core/files/{id} | Delete a file
*FilesApi* | [**get_file**](docs/FilesApi.md#get_file) | **GET** /api/core/files/{id} | Get a file
*FilesApi* | [**get_file_ontologies**](docs/FilesApi.md#get_file_ontologies) | **GET** /api/core/files/{id}/ontologies | Get file ontologies
*FilesApi* | [**list_files**](docs/FilesApi.md#list_files) | **GET** /api/core/files | List files in a provider
*FilesApi* | [**recompute_file_ontologies**](docs/FilesApi.md#recompute_file_ontologies) | **POST** /api/core/files/{id}/recompute-ontologies | Recompute file ontologies
*FilesApi* | [**reindex_file**](docs/FilesApi.md#reindex_file) | **POST** /api/core/files/{id}/reindex | Reindex a file
*ProviderItemsApi* | [**confirm_upload**](docs/ProviderItemsApi.md#confirm_upload) | **POST** /api/core/providers/{providerId}/items/confirm | Confirm presigned upload
*ProviderItemsApi* | [**delete_item**](docs/ProviderItemsApi.md#delete_item) | **DELETE** /api/core/providers/{providerId}/items | Delete item
*ProviderItemsApi* | [**get_download_url**](docs/ProviderItemsApi.md#get_download_url) | **GET** /api/core/providers/{providerId}/items/download-url | Get download URL
*ProviderItemsApi* | [**get_file_content**](docs/ProviderItemsApi.md#get_file_content) | **GET** /api/core/providers/{providerId}/items/content | Get file content
*ProviderItemsApi* | [**get_upload_url**](docs/ProviderItemsApi.md#get_upload_url) | **POST** /api/core/providers/{providerId}/items/upload-url | Get presigned upload URL
*ProviderItemsApi* | [**list_items**](docs/ProviderItemsApi.md#list_items) | **GET** /api/core/providers/{providerId}/items | List items
*ProviderItemsApi* | [**rename_item**](docs/ProviderItemsApi.md#rename_item) | **PATCH** /api/core/providers/{providerId}/items | Rename item
*ProviderItemsApi* | [**upload_file**](docs/ProviderItemsApi.md#upload_file) | **POST** /api/core/providers/{providerId}/items | Create folder
*ProvidersApi* | [**get_provider**](docs/ProvidersApi.md#get_provider) | **GET** /api/core/providers/{id} | Get a provider
*ProvidersApi* | [**list_providers**](docs/ProvidersApi.md#list_providers) | **GET** /api/core/providers | List providers
*QuestionAnsweringApi* | [**create_qa_job**](docs/QuestionAnsweringApi.md#create_qa_job) | **POST** /api/core/qa/jobs | Create QA job
*QuestionAnsweringApi* | [**get_qa_job**](docs/QuestionAnsweringApi.md#get_qa_job) | **GET** /api/core/qa/jobs/{jobId} | Get QA job
*QuestionAnsweringApi* | [**get_qa_job_annotations**](docs/QuestionAnsweringApi.md#get_qa_job_annotations) | **GET** /api/core/qa/jobs/{jobId}/annotations | Get QA job annotations
*QuestionAnsweringApi* | [**get_qa_job_inputs**](docs/QuestionAnsweringApi.md#get_qa_job_inputs) | **GET** /api/core/qa/jobs/{jobId}/inputs | Get QA job inputs
*QuestionAnsweringApi* | [**get_qa_job_outputs**](docs/QuestionAnsweringApi.md#get_qa_job_outputs) | **GET** /api/core/qa/jobs/{jobId}/results | Get QA job outputs
*QuestionAnsweringApi* | [**list_qa_jobs**](docs/QuestionAnsweringApi.md#list_qa_jobs) | **GET** /api/core/qa/jobs | List QA jobs


## Documentation For Models

 - [AddFileToCollectionRequest](docs/AddFileToCollectionRequest.md)
 - [AnnotationId](docs/AnnotationId.md)
 - [BboxDto](docs/BboxDto.md)
 - [CollectionId](docs/CollectionId.md)
 - [CollectionViewId](docs/CollectionViewId.md)
 - [ConfirmUploadRequest](docs/ConfirmUploadRequest.md)
 - [CreateCollectionRequest](docs/CreateCollectionRequest.md)
 - [CreateExtractRequest](docs/CreateExtractRequest.md)
 - [CreateFileRequest](docs/CreateFileRequest.md)
 - [CreateItemRequest](docs/CreateItemRequest.md)
 - [CreateQARequest](docs/CreateQARequest.md)
 - [DataValue](docs/DataValue.md)
 - [DownloadUrlResponse](docs/DownloadUrlResponse.md)
 - [EliseAnnotation](docs/EliseAnnotation.md)
 - [EliseAnnotationConfig](docs/EliseAnnotationConfig.md)
 - [EliseAnnotationData](docs/EliseAnnotationData.md)
 - [EliseCollectionInfo](docs/EliseCollectionInfo.md)
 - [EliseDocumentStatement](docs/EliseDocumentStatement.md)
 - [EliseDocumentStatementAllOfPositions](docs/EliseDocumentStatementAllOfPositions.md)
 - [EliseExternalDocumentStatement](docs/EliseExternalDocumentStatement.md)
 - [EliseFileInfo](docs/EliseFileInfo.md)
 - [EliseFullDocumentStatement](docs/EliseFullDocumentStatement.md)
 - [EliseKnowledgeStatement](docs/EliseKnowledgeStatement.md)
 - [EliseMetaInput](docs/EliseMetaInput.md)
 - [EliseMetaResult](docs/EliseMetaResult.md)
 - [EliseOntology](docs/EliseOntology.md)
 - [EliseOntologyMeta](docs/EliseOntologyMeta.md)
 - [EliseQAResult](docs/EliseQAResult.md)
 - [EliseQuestionInput](docs/EliseQuestionInput.md)
 - [EliseReviewComment](docs/EliseReviewComment.md)
 - [EliseWebStatement](docs/EliseWebStatement.md)
 - [EntityId](docs/EntityId.md)
 - [ExpectedAnswerTypeDto](docs/ExpectedAnswerTypeDto.md)
 - [ExtractJobInputs](docs/ExtractJobInputs.md)
 - [ExtractJobOutputs](docs/ExtractJobOutputs.md)
 - [FSProviderAzureConfigExternal](docs/FSProviderAzureConfigExternal.md)
 - [FSProviderConfigurationExternal](docs/FSProviderConfigurationExternal.md)
 - [FSProviderExternal](docs/FSProviderExternal.md)
 - [FSProviderExternalConfig](docs/FSProviderExternalConfig.md)
 - [FSProviderGCSConfigExternal](docs/FSProviderGCSConfigExternal.md)
 - [FSProviderLeanearConfigExternal](docs/FSProviderLeanearConfigExternal.md)
 - [FSProviderLocalConfigExternal](docs/FSProviderLocalConfigExternal.md)
 - [FSProviderS3ConfigExternal](docs/FSProviderS3ConfigExternal.md)
 - [FSProviderSFTPConfigExternal](docs/FSProviderSFTPConfigExternal.md)
 - [FSProviderSharepointOnlineConfigExternal](docs/FSProviderSharepointOnlineConfigExternal.md)
 - [FileId](docs/FileId.md)
 - [FilesInput](docs/FilesInput.md)
 - [ItemReference](docs/ItemReference.md)
 - [Job](docs/Job.md)
 - [LibItemIndexationInfos](docs/LibItemIndexationInfos.md)
 - [ListItemsResponse](docs/ListItemsResponse.md)
 - [PageDataEliseCollectionInfo](docs/PageDataEliseCollectionInfo.md)
 - [PageDataEliseFileInfo](docs/PageDataEliseFileInfo.md)
 - [PageDataFSProviderExternal](docs/PageDataFSProviderExternal.md)
 - [PageDataJob](docs/PageDataJob.md)
 - [PolicyId](docs/PolicyId.md)
 - [PolicyIdExternal](docs/PolicyIdExternal.md)
 - [PositionBboxDto](docs/PositionBboxDto.md)
 - [PositionCellDto](docs/PositionCellDto.md)
 - [PositionDto](docs/PositionDto.md)
 - [PositionLineDto](docs/PositionLineDto.md)
 - [ProviderId](docs/ProviderId.md)
 - [ProviderIdExternal](docs/ProviderIdExternal.md)
 - [ProviderItem](docs/ProviderItem.md)
 - [QAJobInputs](docs/QAJobInputs.md)
 - [QAJobOutputs](docs/QAJobOutputs.md)
 - [UpdateCollectionRequest](docs/UpdateCollectionRequest.md)
 - [UploadUrlRequest](docs/UploadUrlRequest.md)
 - [UploadUrlResponse](docs/UploadUrlResponse.md)
 - [UserId](docs/UserId.md)
 - [UserIdExternal](docs/UserIdExternal.md)


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


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

- **Type**: Bearer authentication (JWT)


## Author




