# amgix-client
Amalgam Index (Amgix). Open-Source Hybrid Search System

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

- API version: 1.1.0
- Package version: 1.1.0
- Generator version: 7.21.0-SNAPSHOT
- 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/amgix/amgix-client-python.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/amgix/amgix-client-python.git`)

Then import the package:
```python
import amgix_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 amgix_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import amgix_client
from amgix_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8234
# See configuration.py for a list of all supported configuration parameters.
configuration = amgix_client.Configuration(
    host = "http://localhost:8234"
)



# Enter a context with an instance of the API client
async with amgix_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = amgix_client.AmgixApi(api_client)
    collection_name = 'collection_name_example' # str | Collection name (alphanumeric, underscores, hyphens only)

    try:
        # Collection Exists
        api_response = await api_instance.collection_exists(collection_name)
        print("The response of AmgixApi->collection_exists:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AmgixApi->collection_exists: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AmgixApi* | [**collection_exists**](docs/AmgixApi.md#collection_exists) | **GET** /v1/collections/{collection_name}/exists | Collection Exists
*AmgixApi* | [**create_collection**](docs/AmgixApi.md#create_collection) | **POST** /v1/collections/{collection_name} | Create Collection
*AmgixApi* | [**delete_collection**](docs/AmgixApi.md#delete_collection) | **DELETE** /v1/collections/{collection_name} | Delete Collection
*AmgixApi* | [**delete_collection_queue**](docs/AmgixApi.md#delete_collection_queue) | **DELETE** /v1/collections/{collection_name}/queue | Delete Collection Queue
*AmgixApi* | [**delete_document**](docs/AmgixApi.md#delete_document) | **DELETE** /v1/collections/{collection_name}/documents/{document_id} | Delete Document
*AmgixApi* | [**empty_collection**](docs/AmgixApi.md#empty_collection) | **POST** /v1/collections/{collection_name}/empty | Empty Collection
*AmgixApi* | [**get_collection_config**](docs/AmgixApi.md#get_collection_config) | **GET** /v1/collections/{collection_name} | Get Collection Config
*AmgixApi* | [**get_collection_queue_info**](docs/AmgixApi.md#get_collection_queue_info) | **GET** /v1/collections/{collection_name}/queue/info | Get Collection Queue Info
*AmgixApi* | [**get_document**](docs/AmgixApi.md#get_document) | **GET** /v1/collections/{collection_name}/documents/{document_id} | Get Document
*AmgixApi* | [**get_document_status**](docs/AmgixApi.md#get_document_status) | **GET** /v1/collections/{collection_name}/documents/{document_id}/status | Get Document Status
*AmgixApi* | [**health_check**](docs/AmgixApi.md#health_check) | **GET** /v1/health/check | Health
*AmgixApi* | [**health_ready**](docs/AmgixApi.md#health_ready) | **GET** /v1/health/ready | Readiness Check
*AmgixApi* | [**list_collections**](docs/AmgixApi.md#list_collections) | **GET** /v1/collections | List Collections
*AmgixApi* | [**search**](docs/AmgixApi.md#search) | **POST** /v1/collections/{collection_name}/search | Search
*AmgixApi* | [**upsert_document**](docs/AmgixApi.md#upsert_document) | **POST** /v1/collections/{collection_name}/documents | Upsert Document
*AmgixApi* | [**upsert_document_sync**](docs/AmgixApi.md#upsert_document_sync) | **POST** /v1/collections/{collection_name}/documents/sync | Upsert Document Sync
*AmgixApi* | [**upsert_documents_bulk**](docs/AmgixApi.md#upsert_documents_bulk) | **POST** /v1/collections/{collection_name}/documents/bulk | Upsert Documents Bulk
*AmgixApi* | [**version**](docs/AmgixApi.md#version) | **GET** /v1/version | Version


## Documentation For Models

 - [BulkUploadRequest](docs/BulkUploadRequest.md)
 - [CollectionConfig](docs/CollectionConfig.md)
 - [CollectionExistsResponse](docs/CollectionExistsResponse.md)
 - [CustomDocumentVector](docs/CustomDocumentVector.md)
 - [CustomVector](docs/CustomVector.md)
 - [Document](docs/Document.md)
 - [DocumentStatus](docs/DocumentStatus.md)
 - [DocumentStatusResponse](docs/DocumentStatusResponse.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [MetadataFilter](docs/MetadataFilter.md)
 - [MetadataIndex](docs/MetadataIndex.md)
 - [OkResponse](docs/OkResponse.md)
 - [QueueInfo](docs/QueueInfo.md)
 - [ReadyResponse](docs/ReadyResponse.md)
 - [SearchQuery](docs/SearchQuery.md)
 - [SearchResult](docs/SearchResult.md)
 - [ValidationError](docs/ValidationError.md)
 - [ValidationErrorLocItem](docs/ValidationErrorLocItem.md)
 - [Vector](docs/Vector.md)
 - [VectorConfig](docs/VectorConfig.md)
 - [VectorScore](docs/VectorScore.md)
 - [VectorSearchWeight](docs/VectorSearchWeight.md)
 - [VersionResponse](docs/VersionResponse.md)


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

Endpoints do not require authorization.


## Author




