amgix-client 1.6.1

Amalgam Index (Amgix) API

amgix-client

Amgix (Amalgam Index) - Open-Source Hybrid Search System

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.6.1
• Package version: 1.6.1
• 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:

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:

import amgix_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 amgix_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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"
)

# 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'

# Configure Bearer authorization: BearerAuth
configuration = amgix_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# 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	GET /v1/collections/{collection_name}/exists	Collection Exists
AmgixApi	create_collection	POST /v1/collections/{collection_name}	Create Collection
AmgixApi	delete_collection	DELETE /v1/collections/{collection_name}	Delete Collection
AmgixApi	delete_collection_queue	DELETE /v1/collections/{collection_name}/queue	Delete Collection Queue
AmgixApi	delete_document	DELETE /v1/collections/{collection_name}/documents/{document_id}	Delete Document
AmgixApi	delete_document_sync	DELETE /v1/collections/{collection_name}/documents/{document_id}/sync	Delete Document Sync
AmgixApi	empty_collection	POST /v1/collections/{collection_name}/empty	Empty Collection
AmgixApi	export_documents	GET /v1/collections/{collection_name}/documents/export	Export Documents
AmgixApi	fetch_documents	POST /v1/collections/{collection_name}/documents/fetch	Fetch Documents
AmgixApi	get_collection_config	GET /v1/collections/{collection_name}	Get Collection Config
AmgixApi	get_collection_queue_info	GET /v1/collections/{collection_name}/queue/info	Get Collection Queue Info
AmgixApi	get_collection_stats	GET /v1/collections/{collection_name}/stats	Get Collection Stats
AmgixApi	get_document	GET /v1/collections/{collection_name}/documents/{document_id}	Get Document
AmgixApi	get_document_status	GET /v1/collections/{collection_name}/documents/{document_id}/status	Get Document Status
AmgixApi	health_check	GET /v1/health/check	Health
AmgixApi	health_ready	GET /v1/health/ready	Readiness Check
AmgixApi	list_collections	GET /v1/collections	List Collections
AmgixApi	metrics_current	GET /v1/metrics/current	Metrics Current
AmgixApi	metrics_definitions	GET /v1/metrics/definitions	Metrics Definitions
AmgixApi	metrics_prometheus	GET /v1/metrics/prometheus	Metrics Prometheus
AmgixApi	metrics_trends	GET /v1/metrics/trends	Metrics Trends
AmgixApi	search	POST /v1/collections/{collection_name}/search	Search
AmgixApi	system_info	GET /v1/system/info	System Info
AmgixApi	upsert_document	POST /v1/collections/{collection_name}/documents	Upsert Document
AmgixApi	upsert_document_sync	POST /v1/collections/{collection_name}/documents/sync	Upsert Document Sync
AmgixApi	upsert_documents_bulk	POST /v1/collections/{collection_name}/documents/bulk	Upsert Documents Bulk
AmgixApi	version	GET /v1/version	Version

Documentation For Models

• BulkUploadRequest
• CollectionConfig
• CollectionExistsResponse
• CollectionStatsResponse
• CustomDocumentVector
• CustomVector
• Document
• DocumentFetchRequest
• DocumentFetchResponse
• DocumentStatus
• DocumentStatusResponse
• FacetOptions
• HTTPValidationError
• Join
• Join1
• MetadataFilter
• MetadataFilter1
• MetadataIndex
• MetricDefinitionItem
• MetricTrend
• Metrics
• MetricsBucket
• NodeMetricSeries
• NodeView
• OkResponse
• QueueInfo
• ReadyResponse
• SearchQuery
• SearchResponse
• SearchResult
• SystemInfoResponse
• ValidationError
• ValidationErrorLocItem
• Vector
• VectorConfig
• VectorData
• VectorScore
• VectorSearchOption
• VersionResponse
• WindowSample

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyHeader

• Type: API key
• API key parameter name: api-key
• Location: HTTP header

BearerAuth

• Type: Bearer authentication

Author