semvec/pypi-packages huggingface dataset:
LittleKnow 1.0.2
this is a little know base
License: MIT
Requires Python: <4.0,>=3.10


# LittleKnow 轻量知识库模块

## 概述
LittleKnow 是一个基于 BM2.5 算法的文本检索系统，它能够对知识库中的内容进行高效检索。系统支持添加文本知识、进行网络搜索以及查询特定文本。

## 功能特点
- **文本知识添加**：用户可以向知识库中添加文本，以供检索使用。
- **网络搜索**：系统能够根据用户输入的关键词进行网络搜索，获取相关信息。
- **文本查询**：用户可以查询知识库中与特定文本相关的信息，系统支持返回前K个最相关结果。

## 使用方法

### 1. 初始化知识库
首先，需要创建一个 `LittleKnow` 实例，并指定知识库的名称。

```python
lk = LittleKnow(know_name="大语言模型测试知识库2")
```

### 2. 添加文本知识
将文本添加到知识库中，以便后续检索。

```python
lk.add_know(text)
```

### 3. 进行网络搜索
使用 `know_net_work_search` 方法，根据用户输入的关键词进行网络搜索。

```python
res = lk.know_net_work_search("大语言模型")
print(res)
```

### 4. 查询知识库
使用 `query` 方法查询知识库中与特定文本相关的信息，可以通过 `top_k` 参数指定返回结果的数量。

```python
results = lk.query("模型主体为4层FSMN结构", top_k=5)
```

## 技术细节
- **BM2.5 算法**：BM2.5（Best Matching 2.5）是一种基于概率的文本检索算法，它能够根据文本的相关性对搜索结果进行排序。

## 应用场景
LittleKnow 适用于需要大量文本检索和知识管理的场景，例如企业知识库、在线帮助系统等。

## 注意事项
- 确保输入的文本格式正确，以避免检索错误。
- 网络搜索功能依赖于网络环境，可能受到网络速度和稳定性的影响。

## 版本信息
- 当前文档描述的是 LittleKnow 系统的使用和功能，适用于版本 2.5。

## 联系我们
如有任何问题或需要技术支持，请联系我们的客服团队。
knopka 0.0.1
another api client for online accounting knopka.com
License: MIT
Requires Python: <4.0,>=3.11
Keywords: finance, accounting

## another unofficial api for [knopka.com](https://knopka.com)

[![python-latest](https://img.shields.io/pypi/pyversions/knopka?logo=python&logoColor=FFE873)](https://www.python.org/downloads/)
[![pypi](https://img.shields.io/badge/pypi-0.0.1-blue?logo=pypi&logoColor=FFE873)](https://pypi.org/project/knopka/)
[![status](https://img.shields.io/pypi/status/knopka)](https://pypi.org/project/knopka/)
[![pypi_downloads](https://img.shields.io/pypi/dm/knopka)](https://pypi.org/project/knopka/)
[![license](https://img.shields.io/pypi/l/knopka)](https://github.com/rdnve/knopka/blob/master/LICENSE)


### installation

```bash
# via pypi (recommended)
$ python -m pip install -U knopka

# or using github w/ pip
$ python -m pip install git+https://github.com/rdnve/knopka.git

# or using github w/ poetry
$ poetry add git+https://github.com/rdnve/knopka.git
```

### retrieve documents by task identifier
```python
import typing as ty

from knopka import KnopkaAdapter
from knopka.library import Document

adapter: KnopkaAdapter = KnopkaAdapter(access_token="your-secret-token")
documents: ty.List[Document] = adapter.get_documents_from_ones(uid=1234567)

for x in documents:
    print(f"Document: {x.guid} ({x.type=!s}) {x.number=!s} {x.date=!s}")
```

### retrieve file metadata
```python
import typing as ty

from knopka import KnopkaAdapter
from knopka.library import Document, File

adapter: KnopkaAdapter = KnopkaAdapter(access_token="your-secret-token")
documents: ty.List[Document] = adapter.get_documents_from_ones(uid=1234567)

for document in documents:
    myfile: File = adapter.get_meta_from_file(uid=document.file_uid)
    print(f"Meta file: {myfile.name} type={myfile.type}")
```

### retrieve full file
```python
import typing as ty

from knopka import KnopkaAdapter
from knopka.library import Document, File

adapter: KnopkaAdapter = KnopkaAdapter(access_token="your-secret-token")
documents: ty.List[Document] = adapter.get_documents_from_ones(uid=1234567)

path: str = "/home/user/some_files"
for document in documents:
    myfile: File = adapter.get_file(uid=document.file_uid)

    print(f"File: {myfile.name} type={myfile.type} w/ size={myfile.size} bytes")
    path: str = myfile.save(path)
```