biolevate-client 1.1.0

Biolevate API

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 project:

• API version: 1.0.0
• Package version: 1.1.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:

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:

import biolevate_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import biolevate_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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	POST /api/core/collections/{id}/files	Add file to collection
CollectionsApi	create_collection	POST /api/core/collections	Create a collection
CollectionsApi	delete_collection	DELETE /api/core/collections/{id}	Delete a collection
CollectionsApi	get_collection	GET /api/core/collections/{id}	Get a collection
CollectionsApi	list_collection_files	GET /api/core/collections/{id}/files	List files in collection
CollectionsApi	list_collections	GET /api/core/collections	List collections
CollectionsApi	remove_file_from_collection	DELETE /api/core/collections/{id}/files/{fileId}	Remove file from collection
CollectionsApi	update_collection	PATCH /api/core/collections/{id}	Update a collection
ExtractionApi	create_extraction_job	POST /api/core/extraction/jobs	Create extraction job
ExtractionApi	get_extraction_job	GET /api/core/extraction/jobs/{jobId}	Get extraction job
ExtractionApi	get_extraction_job_annotations	GET /api/core/extraction/jobs/{jobId}/annotations	Get extraction job annotations
ExtractionApi	get_extraction_job_inputs	GET /api/core/extraction/jobs/{jobId}/inputs	Get extraction job inputs
ExtractionApi	get_extraction_job_outputs	GET /api/core/extraction/jobs/{jobId}/results	Get extraction job outputs
ExtractionApi	list_extraction_jobs	GET /api/core/extraction/jobs	List extraction jobs
FilesApi	create_file	POST /api/core/files	Create a file
FilesApi	delete_file	DELETE /api/core/files/{id}	Delete a file
FilesApi	get_file	GET /api/core/files/{id}	Get a file
FilesApi	get_file_ontologies	GET /api/core/files/{id}/ontologies	Get file ontologies
FilesApi	list_files	GET /api/core/files	List files in a provider
FilesApi	recompute_file_ontologies	POST /api/core/files/{id}/recompute-ontologies	Recompute file ontologies
FilesApi	reindex_file	POST /api/core/files/{id}/reindex	Reindex a file
FindSimilarFilesApi	create_job	POST /api/core/find-similar/jobs	Create find-similar job
FindSimilarFilesApi	get_job	GET /api/core/find-similar/jobs/{jobId}	Get find-similar job
FindSimilarFilesApi	list_jobs	GET /api/core/find-similar/jobs	List find-similar jobs
MultiDimensionalExtractionApi	create_mde_job	POST /api/core/multi-dim-extraction/jobs	Create multi-dimensional extraction job
MultiDimensionalExtractionApi	get_mde_job	GET /api/core/multi-dim-extraction/jobs/{jobId}	Get multi-dimensional extraction job
MultiDimensionalExtractionApi	get_mde_job_annotations	GET /api/core/multi-dim-extraction/jobs/{jobId}/annotations	Get multi-dimensional extraction job annotations
MultiDimensionalExtractionApi	get_mde_job_inputs	GET /api/core/multi-dim-extraction/jobs/{jobId}/inputs	Get multi-dimensional extraction job inputs
MultiDimensionalExtractionApi	get_mde_job_outputs	GET /api/core/multi-dim-extraction/jobs/{jobId}/results	Get multi-dimensional extraction job outputs
MultiDimensionalExtractionApi	list_mde_jobs	GET /api/core/multi-dim-extraction/jobs	List multi-dimensional extraction jobs
ProviderItemsApi	confirm_upload	POST /api/core/providers/{providerId}/items/confirm	Confirm presigned upload
ProviderItemsApi	delete_item	DELETE /api/core/providers/{providerId}/items	Delete item
ProviderItemsApi	get_download_url	GET /api/core/providers/{providerId}/items/download-url	Get download URL
ProviderItemsApi	get_file_content	GET /api/core/providers/{providerId}/items/content	Get file content
ProviderItemsApi	get_upload_url	POST /api/core/providers/{providerId}/items/upload-url	Get presigned upload URL
ProviderItemsApi	list_items	GET /api/core/providers/{providerId}/items	List items
ProviderItemsApi	rename_item	PATCH /api/core/providers/{providerId}/items	Rename item
ProviderItemsApi	upload_file	POST /api/core/providers/{providerId}/items	Create folder
ProvidersApi	get_provider	GET /api/core/providers/{id}	Get a provider
ProvidersApi	list_providers	GET /api/core/providers	List providers
QuestionAnsweringApi	create_qa_job	POST /api/core/qa/jobs	Create QA job
QuestionAnsweringApi	get_qa_job	GET /api/core/qa/jobs/{jobId}	Get QA job
QuestionAnsweringApi	get_qa_job_annotations	GET /api/core/qa/jobs/{jobId}/annotations	Get QA job annotations
QuestionAnsweringApi	get_qa_job_inputs	GET /api/core/qa/jobs/{jobId}/inputs	Get QA job inputs
QuestionAnsweringApi	get_qa_job_outputs	GET /api/core/qa/jobs/{jobId}/results	Get QA job outputs
QuestionAnsweringApi	list_qa_jobs	GET /api/core/qa/jobs	List QA jobs

Documentation For Models

• AddFileToCollectionRequest
• AnnotationId
• BboxDto
• CollectionId
• CollectionViewId
• ConfirmUploadRequest
• CreateCollectionRequest
• CreateExtractRequest
• CreateFileRequest
• CreateItemRequest
• CreateMDERequest
• CreateQARequest
• DataValue
• DownloadUrlResponse
• EliseAnnotation
• EliseAnnotationConfig
• EliseAnnotationData
• EliseCollectionInfo
• EliseDocumentStatement
• EliseDocumentStatementAllOfPositions
• EliseEntityCellResult
• EliseEntityColumnInput
• EliseEntityExtractionResult
• EliseEntityRowResult
• EliseEntitySchemaInput
• EliseExternalDocumentStatement
• EliseFileInfo
• EliseFullDocumentStatement
• EliseKnowledgeStatement
• EliseMetaInput
• EliseMetaResult
• EliseOntology
• EliseOntologyMeta
• EliseQAResult
• EliseQuestionInput
• EliseReviewComment
• EliseWebStatement
• EntityId
• ExpectedAnswerTypeDto
• ExtractJobInputs
• ExtractJobOutputs
• FSProviderAzureConfigExternal
• FSProviderConfigurationExternal
• FSProviderExternal
• FSProviderExternalConfig
• FSProviderGCSConfigExternal
• FSProviderLeanearConfigExternal
• FSProviderLocalConfigExternal
• FSProviderS3ConfigExternal
• FSProviderSFTPConfigExternal
• FSProviderSharepointOnlineConfigExternal
• FileId
• FileMatch
• FilesInput
• FindSimilarApiJobDto
• ItemReference
• Job
• JobStatistics
• KnowledgeSource
• LibItemIndexationInfos
• ListItemsResponse
• MDEJobInputs
• MDEJobOutputs
• MetadataOnlyMatch
• PageDataEliseCollectionInfo
• PageDataEliseFileInfo
• PageDataFSProviderExternal
• PageDataFindSimilarApiJobDto
• PageDataJob
• PolicyId
• PolicyIdExternal
• PositionBboxDto
• PositionCellDto
• PositionDto
• PositionLineDto
• ProviderId
• ProviderIdExternal
• ProviderItem
• QAJobInputs
• QAJobOutputs
• SearchSources
• SourceIdentifiers
• SourceMatches
• UpdateCollectionRequest
• UploadUrlRequest
• UploadUrlResponse
• UserId
• UserIdExternal

Documentation For Authorization

Authentication schemes defined for the API:

TOKEN

• Type: Bearer authentication (JWT)

Author