{"id":19350485,"url":"https://github.com/zincsearch/sdk-python-zincsearch","last_synced_at":"2025-04-23T07:30:48.421Z","repository":{"id":39342410,"uuid":"506638425","full_name":"zincsearch/sdk-python-zincsearch","owner":"zincsearch","description":"Python SDK Client for ZincSearch","archived":false,"fork":false,"pushed_at":"2022-09-21T10:18:33.000Z","size":230,"stargazers_count":10,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-09T14:50:37.503Z","etag":null,"topics":["zinc","zincsearch"],"latest_commit_sha":null,"homepage":"https://docs.zincsearch.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zincsearch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-06-23T12:50:23.000Z","updated_at":"2024-11-04T07:49:15.000Z","dependencies_parsed_at":"2022-08-09T14:48:18.782Z","dependency_job_id":null,"html_url":"https://github.com/zincsearch/sdk-python-zincsearch","commit_stats":null,"previous_names":["zinclabs/sdk-python-zincsearch"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zincsearch%2Fsdk-python-zincsearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zincsearch%2Fsdk-python-zincsearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zincsearch%2Fsdk-python-zincsearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zincsearch%2Fsdk-python-zincsearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zincsearch","download_url":"https://codeload.github.com/zincsearch/sdk-python-zincsearch/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223913312,"owners_count":17224192,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["zinc","zincsearch"],"created_at":"2024-11-10T04:32:37.338Z","updated_at":"2024-11-10T04:32:47.780Z","avatar_url":"https://github.com/zincsearch.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# zincsearch-sdk\nZinc Search engine API documents https://docs.zincsearch.com\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.3.3\n- Package version: 0.3.3\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\nFor more information, please visit [https://www.zincsearch.com](https://www.zincsearch.com)\n\n## Requirements.\n\nPython \u003e=3.6\n\n## Installation \u0026 Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/zinclabs/sdk-python-zincsearch.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/zinclabs/sdk-python-zincsearch.git`)\n\nThen import the package:\n```python\nimport zincsearch_sdk\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport zincsearch_sdk\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport zincsearch_sdk\nfrom pprint import pprint\nfrom zincsearch_sdk.api import document\nfrom zincsearch_sdk.model.meta_http_response_document import MetaHTTPResponseDocument\nfrom zincsearch_sdk.model.meta_http_response_error import MetaHTTPResponseError\nfrom zincsearch_sdk.model.meta_http_response_id import MetaHTTPResponseID\nfrom zincsearch_sdk.model.meta_http_response_record_count import MetaHTTPResponseRecordCount\nfrom zincsearch_sdk.model.meta_json_ingest import MetaJSONIngest\n# Defining the host is optional and defaults to http://localhost:4080\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = zincsearch_sdk.Configuration(\n    host = \"http://localhost:4080\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = zincsearch_sdk.Configuration(\n    username = 'YOUR_USERNAME',\n    password = 'YOUR_PASSWORD'\n)\n\n\n# Enter a context with an instance of the API client\nwith zincsearch_sdk.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = document.Document(api_client)\n    query = \"query_example\" # str | Query\n\n    try:\n        # Bulk documents\n        api_response = api_instance.bulk(query)\n        pprint(api_response)\n    except zincsearch_sdk.ApiException as e:\n        print(\"Exception when calling Document-\u003ebulk: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost:4080*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*Document* | [**bulk**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Document.md#bulk) | **POST** /api/_bulk | Bulk documents\n*Document* | [**bulkv2**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Document.md#bulkv2) | **POST** /api/_bulkv2 | Bulkv2 documents\n*Document* | [**delete**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Document.md#delete) | **DELETE** /api/{index}/_doc/{id} | Delete document\n*Document* | [**es_bulk**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Document.md#es_bulk) | **POST** /es/_bulk | ES bulk documents\n*Document* | [**index**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Document.md#index) | **POST** /api/{index}/_doc | Create or update document\n*Document* | [**index_with_id**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Document.md#index_with_id) | **PUT** /api/{index}/_doc/{id} | Create or update document with id\n*Document* | [**multi**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Document.md#multi) | **POST** /api/{index}/_multi | Multi documents\n*Document* | [**update**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Document.md#update) | **POST** /api/{index}/_update/{id} | Update document with id\n*Index* | [**add_or_remove_es_alias**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#add_or_remove_es_alias) | **POST** /es/_aliases | Add or remove index alias for compatible ES\n*Index* | [**analyze**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#analyze) | **POST** /api/_analyze | Analyze\n*Index* | [**analyze_index**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#analyze_index) | **POST** /api/{index}/_analyze | Analyze\n*Index* | [**create**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#create) | **POST** /api/index | Create index\n*Index* | [**create_template**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#create_template) | **POST** /es/_index_template | Create update index template\n*Index* | [**delete**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#delete) | **DELETE** /api/index/{index} | Delete index\n*Index* | [**delete_template**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#delete_template) | **DELETE** /es/_index_template/{name} | Delete template\n*Index* | [**e_s_create_index**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#e_s_create_index) | **PUT** /es/{index} | Create index for compatible ES\n*Index* | [**e_s_get_mapping**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#e_s_get_mapping) | **GET** /es/{index}/_mapping | Get index mappings for compatible ES\n*Index* | [**es_exists**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#es_exists) | **HEAD** /es/{index} | Checks if the index exists for compatible ES\n*Index* | [**exists**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#exists) | **HEAD** /api/index/{index} | Checks if the index exists\n*Index* | [**get_es_aliases**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#get_es_aliases) | **GET** /es/{target}/_alias/{target_alias} | Get index alias for compatible ES\n*Index* | [**get_index**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#get_index) | **GET** /api/index/{index} | Get index metadata\n*Index* | [**get_mapping**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#get_mapping) | **GET** /api/{index}/_mapping | Get index mappings\n*Index* | [**get_settings**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#get_settings) | **GET** /api/{index}/_settings | Get index settings\n*Index* | [**get_template**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#get_template) | **GET** /es/_index_template/{name} | Get index template\n*Index* | [**index_name_list**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#index_name_list) | **GET** /api/index_name | List index Name\n*Index* | [**list**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#list) | **GET** /api/index | List indexes\n*Index* | [**list_templates**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#list_templates) | **GET** /es/_index_template | List index teplates\n*Index* | [**refresh**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#refresh) | **POST** /api/index/{index}/refresh | Resfresh index\n*Index* | [**set_mapping**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#set_mapping) | **PUT** /api/{index}/_mapping | Set index mappings\n*Index* | [**set_settings**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#set_settings) | **PUT** /api/{index}/_settings | Set index Settings\n*Index* | [**update_template**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Index.md#update_template) | **PUT** /es/_index_template/{name} | Create update index template\n*Search* | [**delete_by_query**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Search.md#delete_by_query) | **POST** /es/{index}/_delete_by_query | Searches the index and deletes all matched documents\n*Search* | [**msearch**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Search.md#msearch) | **POST** /es/_msearch | Search V2 MultipleSearch for compatible ES\n*Search* | [**search**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Search.md#search) | **POST** /es/{index}/_search | Search V2 DSL for compatible ES\n*Search* | [**search_v1**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Search.md#search_v1) | **POST** /api/{index}/_search | Search V1\n*User* | [**create**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/User.md#create) | **POST** /api/user | Create user\n*User* | [**delete**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/User.md#delete) | **DELETE** /api/user/{id} | Delete user\n*User* | [**list**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/User.md#list) | **GET** /api/user | List user\n*User* | [**login**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/User.md#login) | **POST** /api/login | Login\n*User* | [**update**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/User.md#update) | **PUT** /api/user | Update user\n*Default* | [**healthz**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Default.md#healthz) | **GET** /healthz | Get healthz\n*Default* | [**version**](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/Default.md#version) | **GET** /version | Get version\n\n\n## Documentation For Models\n\n - [AggregationHistogramBound](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/AggregationHistogramBound.md)\n - [AuthLoginRequest](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/AuthLoginRequest.md)\n - [AuthLoginResponse](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/AuthLoginResponse.md)\n - [AuthLoginUser](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/AuthLoginUser.md)\n - [IndexAnalyzeResponse](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/IndexAnalyzeResponse.md)\n - [IndexAnalyzeResponseToken](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/IndexAnalyzeResponseToken.md)\n - [IndexIndexListResponse](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/IndexIndexListResponse.md)\n - [MetaAggregationAutoDateHistogram](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaAggregationAutoDateHistogram.md)\n - [MetaAggregationDateHistogram](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaAggregationDateHistogram.md)\n - [MetaAggregationDateRange](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaAggregationDateRange.md)\n - [MetaAggregationHistogram](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaAggregationHistogram.md)\n - [MetaAggregationIPRange](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaAggregationIPRange.md)\n - [MetaAggregationMetric](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaAggregationMetric.md)\n - [MetaAggregationRange](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaAggregationRange.md)\n - [MetaAggregationResponse](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaAggregationResponse.md)\n - [MetaAggregations](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaAggregations.md)\n - [MetaAggregationsTerms](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaAggregationsTerms.md)\n - [MetaAnalyzer](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaAnalyzer.md)\n - [MetaBoolQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaBoolQuery.md)\n - [MetaDateRange](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaDateRange.md)\n - [MetaExistsQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaExistsQuery.md)\n - [MetaFuzzyQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaFuzzyQuery.md)\n - [MetaHTTPResponse](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaHTTPResponse.md)\n - [MetaHTTPResponseDeleteByQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaHTTPResponseDeleteByQuery.md)\n - [MetaHTTPResponseDocument](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaHTTPResponseDocument.md)\n - [MetaHTTPResponseError](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaHTTPResponseError.md)\n - [MetaHTTPResponseID](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaHTTPResponseID.md)\n - [MetaHTTPResponseIndex](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaHTTPResponseIndex.md)\n - [MetaHTTPResponseRecordCount](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaHTTPResponseRecordCount.md)\n - [MetaHTTPResponseTemplate](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaHTTPResponseTemplate.md)\n - [MetaHealthzResponse](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaHealthzResponse.md)\n - [MetaHighlight](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaHighlight.md)\n - [MetaHit](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaHit.md)\n - [MetaHits](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaHits.md)\n - [MetaHttpRetriesResponse](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaHttpRetriesResponse.md)\n - [MetaIPRange](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaIPRange.md)\n - [MetaIdsQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaIdsQuery.md)\n - [MetaIndexAnalysis](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaIndexAnalysis.md)\n - [MetaIndexSettings](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaIndexSettings.md)\n - [MetaIndexSimple](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaIndexSimple.md)\n - [MetaIndexTemplate](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaIndexTemplate.md)\n - [MetaJSONIngest](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaJSONIngest.md)\n - [MetaMappings](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaMappings.md)\n - [MetaMatchBoolPrefixQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaMatchBoolPrefixQuery.md)\n - [MetaMatchPhrasePrefixQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaMatchPhrasePrefixQuery.md)\n - [MetaMatchPhraseQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaMatchPhraseQuery.md)\n - [MetaMatchQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaMatchQuery.md)\n - [MetaMultiMatchQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaMultiMatchQuery.md)\n - [MetaPage](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaPage.md)\n - [MetaPrefixQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaPrefixQuery.md)\n - [MetaProperty](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaProperty.md)\n - [MetaQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaQuery.md)\n - [MetaQueryStringQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaQueryStringQuery.md)\n - [MetaRange](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaRange.md)\n - [MetaRangeQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaRangeQuery.md)\n - [MetaRegexpQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaRegexpQuery.md)\n - [MetaSearchResponse](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaSearchResponse.md)\n - [MetaShards](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaShards.md)\n - [MetaSimpleQueryStringQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaSimpleQueryStringQuery.md)\n - [MetaTemplate](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaTemplate.md)\n - [MetaTemplateTemplate](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaTemplateTemplate.md)\n - [MetaTermQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaTermQuery.md)\n - [MetaTotal](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaTotal.md)\n - [MetaUser](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaUser.md)\n - [MetaVersionResponse](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaVersionResponse.md)\n - [MetaWildcardQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaWildcardQuery.md)\n - [MetaZincQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/MetaZincQuery.md)\n - [V1AggregationDateRange](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/V1AggregationDateRange.md)\n - [V1AggregationNumberRange](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/V1AggregationNumberRange.md)\n - [V1AggregationParams](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/V1AggregationParams.md)\n - [V1QueryParams](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/V1QueryParams.md)\n - [V1ZincQuery](https://github.com/zinclabs/sdk-python-zincsearch/tree/main/docs/V1ZincQuery.md)\n\n\n## Documentation For Authorization\n\n\n## basicAuth\n\n- **Type**: HTTP basic authentication\n\n\n## Author\n\n\n\n\n## Notes for Large OpenAPI documents\nIf the OpenAPI document is large, imports in zincsearch_sdk.apis and zincsearch_sdk.models may fail with a\nRecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:\n\nSolution 1:\nUse specific imports for apis and models like:\n- `from zincsearch_sdk.api.default_api import DefaultApi`\n- `from zincsearch_sdk.model.pet import Pet`\n\nSolution 2:\nBefore importing the package, adjust the maximum recursion limit as shown below:\n```\nimport sys\nsys.setrecursionlimit(1500)\nimport zincsearch_sdk\nfrom zincsearch_sdk.apis import *\nfrom zincsearch_sdk.models import *\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzincsearch%2Fsdk-python-zincsearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzincsearch%2Fsdk-python-zincsearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzincsearch%2Fsdk-python-zincsearch/lists"}