Metadata-Version: 2.3
Name: vectorindexerapi_client
Version: 1.0.0
Summary: VectorIndexer API
Keywords: OpenAPI,OpenAPI-Generator,VectorIndexer API
Author: Educorvi
Author-email: Educorvi <developers@educorvi.de>
Requires-Dist: urllib3>=2.1.0,<3.0.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Requires-Python: >=3.9
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Description-Content-Type: text/markdown

# openapi-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: 1.0.0
- Generator version: 7.20.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Getting Started

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

```python

import vectorindexerapi_client
from vectorindexerapi_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 = vectorindexerapi_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 API key authorization: APIKeyHeader
configuration.api_key['APIKeyHeader'] = os.environ["API_KEY"]

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


# Enter a context with an instance of the API client
with vectorindexerapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vectorindexerapi_client.CollectionApi(api_client)
    collection_name = 'collection_name_example' # str | 
    services = ["qdrant","typesense"] # List[ServiceType] | List of services to delete the collection from (e.g. qdrant, typesense) (optional) (default to ["qdrant","typesense"])

    try:
        # Delete Collection
        api_response = api_instance.delete_collection_collection_collection_name_delete(collection_name, services=services)
        print("The response of CollectionApi->delete_collection_collection_collection_name_delete:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CollectionApi->delete_collection_collection_collection_name_delete: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CollectionApi* | [**delete_collection_collection_collection_name_delete**](docs/CollectionApi.md#delete_collection_collection_collection_name_delete) | **DELETE** /collection/{collection_name} | Delete Collection
*CollectionApi* | [**get_collection_status_collection_collection_name_status_get**](docs/CollectionApi.md#get_collection_status_collection_collection_name_status_get) | **GET** /collection/{collection_name}/status | Get Collection Status
*CollectionApi* | [**list_collections_collection_get**](docs/CollectionApi.md#list_collections_collection_get) | **GET** /collection/ | List Collections
*CollectionApi* | [**post_collection_collection_collection_name_post**](docs/CollectionApi.md#post_collection_collection_collection_name_post) | **POST** /collection/{collection_name} | Post Collection
*CollectionDocumentApi* | [**delete_doc_collection_collection_name_document_document_uuid_delete**](docs/CollectionDocumentApi.md#delete_doc_collection_collection_name_document_document_uuid_delete) | **DELETE** /collection/{collection_name}/document/{document_uuid} | Delete Doc
*CollectionDocumentApi* | [**post_doc_collection_collection_name_document_post**](docs/CollectionDocumentApi.md#post_doc_collection_collection_name_document_post) | **POST** /collection/{collection_name}/document/ | Post Doc
*CollectionDocumentApi* | [**put_doc_collection_collection_name_document_document_uuid_put**](docs/CollectionDocumentApi.md#put_doc_collection_collection_name_document_document_uuid_put) | **PUT** /collection/{collection_name}/document/{document_uuid} | Put Doc
*CollectionDocumentsBatchApi* | [**delete_docs_collection_collection_name_documents_delete**](docs/CollectionDocumentsBatchApi.md#delete_docs_collection_collection_name_documents_delete) | **DELETE** /collection/{collection_name}/documents/ | Delete Docs
*CollectionDocumentsBatchApi* | [**post_documents_collection_collection_name_documents_post**](docs/CollectionDocumentsBatchApi.md#post_documents_collection_collection_name_documents_post) | **POST** /collection/{collection_name}/documents/ | Post Documents
*CollectionDocumentsBatchApi* | [**put_documents_collection_collection_name_documents_put**](docs/CollectionDocumentsBatchApi.md#put_documents_collection_collection_name_documents_put) | **PUT** /collection/{collection_name}/documents/ | Put Documents
*SearchApi* | [**search_search_post**](docs/SearchApi.md#search_search_post) | **POST** /search/ | Search
*SearchApi* | [**search_simple_search_get**](docs/SearchApi.md#search_simple_search_get) | **GET** /search/ | Search Simple
*StatusApi* | [**root_get**](docs/StatusApi.md#root_get) | **GET** / | Root


## Documentation For Models

 - [ApiInfo](docs/ApiInfo.md)
 - [BatchDeleteRequest](docs/BatchDeleteRequest.md)
 - [BatchDocumentOperationResponse](docs/BatchDocumentOperationResponse.md)
 - [CollectionInfo](docs/CollectionInfo.md)
 - [CollectionListResponse](docs/CollectionListResponse.md)
 - [CollectionOperationResponse](docs/CollectionOperationResponse.md)
 - [CollectionStatus](docs/CollectionStatus.md)
 - [CollectionStatusResponseDetailed](docs/CollectionStatusResponseDetailed.md)
 - [CreateDocument](docs/CreateDocument.md)
 - [CreateDocuments](docs/CreateDocuments.md)
 - [Details](docs/Details.md)
 - [DocumentOperationResponse](docs/DocumentOperationResponse.md)
 - [DocumentServiceResult](docs/DocumentServiceResult.md)
 - [FileTypes](docs/FileTypes.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [LocationInner](docs/LocationInner.md)
 - [QdrantCollectionDetails](docs/QdrantCollectionDetails.md)
 - [QdrantSettings](docs/QdrantSettings.md)
 - [ResourceStatus](docs/ResourceStatus.md)
 - [Search](docs/Search.md)
 - [SearchResultItem](docs/SearchResultItem.md)
 - [SearchResults](docs/SearchResults.md)
 - [ServiceType](docs/ServiceType.md)
 - [TypesenseCollectionDetails](docs/TypesenseCollectionDetails.md)
 - [TypesenseSettings](docs/TypesenseSettings.md)
 - [ValidationError](docs/ValidationError.md)


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


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

- **Type**: API key
- **API key parameter name**: API-KEY
- **Location**: HTTP header


## Author




