# yfkm3-services-search-client
API for search functionality.

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

- API version: 
- Package version: 1.0.3
- Generator version: 7.21.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:

```sh
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:
```python
import yfkm3_services_search_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 yfkm3_services_search_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import yfkm3_services_search_client
from yfkm3_services_search_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 = yfkm3_services_search_client.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
async with yfkm3_services_search_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = yfkm3_services_search_client.DocumentsApi(api_client)
    chunk_id = 'chunk_id_example' # str | 

    try:
        # 通过 chunk_id 获取单个 chunk
        api_response = await api_instance.get_docs_chunks(chunk_id)
        print("The response of DocumentsApi->get_docs_chunks:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DocumentsApi->get_docs_chunks: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DocumentsApi* | [**get_docs_chunks**](docs/DocumentsApi.md#get_docs_chunks) | **GET** /api/docs/chunks/{chunk_id} | 通过 chunk_id 获取单个 chunk
*DocumentsApi* | [**post_docs_add**](docs/DocumentsApi.md#post_docs_add) | **POST** /api/docs/add | 批量添加文档
*DocumentsApi* | [**post_docs_bulk**](docs/DocumentsApi.md#post_docs_bulk) | **POST** /api/docs/bulk | 批量操作文档（create/update/delete）
*DocumentsApi* | [**post_docs_chunks**](docs/DocumentsApi.md#post_docs_chunks) | **POST** /api/docs/chunks | 通过 document_id 获取所有 chunk
*DocumentsApi* | [**post_docs_delete**](docs/DocumentsApi.md#post_docs_delete) | **POST** /api/docs/delete | 批量删除文档
*DocumentsApi* | [**post_docs_update**](docs/DocumentsApi.md#post_docs_update) | **POST** /api/docs/update | 批量更新文档元数据
*EvaluationApi* | [**post_evaluate**](docs/EvaluationApi.md#post_evaluate) | **POST** /api/evaluate | 检索与响应评测接口
*IndexesApi* | [**get_index_exists**](docs/IndexesApi.md#get_index_exists) | **GET** /api/index/exists | 检查统一索引是否存在
*IndexesApi* | [**post_index_create**](docs/IndexesApi.md#post_index_create) | **POST** /api/index/create | 创建统一搜索索引
*LangfuseApi* | [**get_langfuse_datasets**](docs/LangfuseApi.md#get_langfuse_datasets) | **GET** /api/langfuse/datasets/{dataset_name} | 获取 Langfuse 数据集与样本
*LangfuseApi* | [**post_langfuse_datasets_auto_annotate**](docs/LangfuseApi.md#post_langfuse_datasets_auto_annotate) | **POST** /api/langfuse/datasets/{dataset_name}/auto-annotate | LLM 自动标注 Langfuse 数据集
*LangfuseApi* | [**post_langfuse_datasets_evaluate_only**](docs/LangfuseApi.md#post_langfuse_datasets_evaluate_only) | **POST** /api/langfuse/datasets/{dataset_name}/evaluate/only | 仅评测 Langfuse 数据集（跳过搜索步骤）
*LangfuseApi* | [**post_langfuse_datasets_evaluate_sync**](docs/LangfuseApi.md#post_langfuse_datasets_evaluate_sync) | **POST** /api/langfuse/datasets/{dataset_name}/evaluate/sync | 同步执行 Langfuse 数据集评测
*LangfuseApi* | [**post_langfuse_datasets_items**](docs/LangfuseApi.md#post_langfuse_datasets_items) | **POST** /api/langfuse/datasets/{dataset_name}/items | 新增 Langfuse 数据集样本
*SearchApi* | [**get_health**](docs/SearchApi.md#get_health) | **GET** /api/health | 健康检查
*SearchApi* | [**post_embeddings**](docs/SearchApi.md#post_embeddings) | **POST** /api/embeddings | 文本向量化接口
*SearchApi* | [**post_rerank**](docs/SearchApi.md#post_rerank) | **POST** /api/rerank | 独立重排序接口
*SearchApi* | [**post_search**](docs/SearchApi.md#post_search) | **POST** /api/search | 通用搜索接口


## Documentation For Models

 - [ActionResponse](docs/ActionResponse.md)
 - [AutoAnnotateRequest](docs/AutoAnnotateRequest.md)
 - [AutoAnnotateResponse](docs/AutoAnnotateResponse.md)
 - [BulkOperation](docs/BulkOperation.md)
 - [BulkOperationResult](docs/BulkOperationResult.md)
 - [BulkResponse](docs/BulkResponse.md)
 - [ChunkResponse](docs/ChunkResponse.md)
 - [ChunksByDocumentIdRequest](docs/ChunksByDocumentIdRequest.md)
 - [ChunksListResponse](docs/ChunksListResponse.md)
 - [CountResponse](docs/CountResponse.md)
 - [DatasetSyncEvalRequest](docs/DatasetSyncEvalRequest.md)
 - [DatasetSyncEvalResponse](docs/DatasetSyncEvalResponse.md)
 - [DocsAddRequest](docs/DocsAddRequest.md)
 - [DocsBulkRequest](docs/DocsBulkRequest.md)
 - [DocsDeleteRequest](docs/DocsDeleteRequest.md)
 - [DocsUpdateRequest](docs/DocsUpdateRequest.md)
 - [DocumentIn](docs/DocumentIn.md)
 - [EmbeddingsRequest](docs/EmbeddingsRequest.md)
 - [EmbeddingsResponse](docs/EmbeddingsResponse.md)
 - [EvaluateRequest](docs/EvaluateRequest.md)
 - [EvaluateResponse](docs/EvaluateResponse.md)
 - [FusionMode](docs/FusionMode.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [HealthResponse](docs/HealthResponse.md)
 - [IndexCreateRequest](docs/IndexCreateRequest.md)
 - [IndexStatusResponse](docs/IndexStatusResponse.md)
 - [LangfuseActionResponse](docs/LangfuseActionResponse.md)
 - [LangfuseDatasetItemRequest](docs/LangfuseDatasetItemRequest.md)
 - [LangfuseDatasetResponse](docs/LangfuseDatasetResponse.md)
 - [LangfuseEvalOnlyRequest](docs/LangfuseEvalOnlyRequest.md)
 - [LocationInner](docs/LocationInner.md)
 - [RerankRequest](docs/RerankRequest.md)
 - [RerankResponse](docs/RerankResponse.md)
 - [SearchMode](docs/SearchMode.md)
 - [SearchRequest](docs/SearchRequest.md)
 - [SearchResponse](docs/SearchResponse.md)
 - [SearchResultItem](docs/SearchResultItem.md)
 - [ValidationError](docs/ValidationError.md)


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

Endpoints do not require authorization.


## Author




