You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

embedding_model.py 32KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889
  1. #
  2. # Copyright 2024 The InfiniFlow Authors. All Rights Reserved.
  3. #
  4. # Licensed under the Apache License, Version 2.0 (the "License");
  5. # you may not use this file except in compliance with the License.
  6. # You may obtain a copy of the License at
  7. #
  8. # http://www.apache.org/licenses/LICENSE-2.0
  9. #
  10. # Unless required by applicable law or agreed to in writing, software
  11. # distributed under the License is distributed on an "AS IS" BASIS,
  12. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. # See the License for the specific language governing permissions and
  14. # limitations under the License.
  15. #
  16. import json
  17. import logging
  18. import os
  19. import re
  20. import threading
  21. from abc import ABC
  22. from urllib.parse import urljoin
  23. import dashscope
  24. import google.generativeai as genai
  25. import numpy as np
  26. import requests
  27. from huggingface_hub import snapshot_download
  28. from ollama import Client
  29. from openai import OpenAI
  30. from zhipuai import ZhipuAI
  31. from api import settings
  32. from api.utils.file_utils import get_home_cache_dir
  33. from api.utils.log_utils import log_exception
  34. from rag.utils import num_tokens_from_string, truncate
  35. class Base(ABC):
  36. def __init__(self, key, model_name):
  37. pass
  38. def encode(self, texts: list):
  39. raise NotImplementedError("Please implement encode method!")
  40. def encode_queries(self, text: str):
  41. raise NotImplementedError("Please implement encode method!")
  42. def total_token_count(self, resp):
  43. try:
  44. return resp.usage.total_tokens
  45. except Exception:
  46. pass
  47. try:
  48. return resp["usage"]["total_tokens"]
  49. except Exception:
  50. pass
  51. return 0
  52. class DefaultEmbedding(Base):
  53. _FACTORY_NAME = "BAAI"
  54. os.environ["CUDA_VISIBLE_DEVICES"] = "0"
  55. _model = None
  56. _model_name = ""
  57. _model_lock = threading.Lock()
  58. def __init__(self, key, model_name, **kwargs):
  59. """
  60. If you have trouble downloading HuggingFace models, -_^ this might help!!
  61. For Linux:
  62. export HF_ENDPOINT=https://hf-mirror.com
  63. For Windows:
  64. Good luck
  65. ^_-
  66. """
  67. if not settings.LIGHTEN:
  68. with DefaultEmbedding._model_lock:
  69. import torch
  70. from FlagEmbedding import FlagModel
  71. if not DefaultEmbedding._model or model_name != DefaultEmbedding._model_name:
  72. try:
  73. DefaultEmbedding._model = FlagModel(
  74. os.path.join(get_home_cache_dir(), re.sub(r"^[a-zA-Z0-9]+/", "", model_name)),
  75. query_instruction_for_retrieval="为这个句子生成表示以用于检索相关文章:",
  76. use_fp16=torch.cuda.is_available(),
  77. )
  78. DefaultEmbedding._model_name = model_name
  79. except Exception:
  80. model_dir = snapshot_download(
  81. repo_id="BAAI/bge-large-zh-v1.5", local_dir=os.path.join(get_home_cache_dir(), re.sub(r"^[a-zA-Z0-9]+/", "", model_name)), local_dir_use_symlinks=False
  82. )
  83. DefaultEmbedding._model = FlagModel(model_dir, query_instruction_for_retrieval="为这个句子生成表示以用于检索相关文章:", use_fp16=torch.cuda.is_available())
  84. self._model = DefaultEmbedding._model
  85. self._model_name = DefaultEmbedding._model_name
  86. def encode(self, texts: list):
  87. batch_size = 16
  88. texts = [truncate(t, 2048) for t in texts]
  89. token_count = 0
  90. for t in texts:
  91. token_count += num_tokens_from_string(t)
  92. ress = []
  93. for i in range(0, len(texts), batch_size):
  94. ress.extend(self._model.encode(texts[i : i + batch_size]).tolist())
  95. return np.array(ress), token_count
  96. def encode_queries(self, text: str):
  97. token_count = num_tokens_from_string(text)
  98. return self._model.encode_queries([text]).tolist()[0], token_count
  99. class OpenAIEmbed(Base):
  100. _FACTORY_NAME = "OpenAI"
  101. def __init__(self, key, model_name="text-embedding-ada-002", base_url="https://api.openai.com/v1"):
  102. if not base_url:
  103. base_url = "https://api.openai.com/v1"
  104. self.client = OpenAI(api_key=key, base_url=base_url)
  105. self.model_name = model_name
  106. def encode(self, texts: list):
  107. # OpenAI requires batch size <=16
  108. batch_size = 16
  109. texts = [truncate(t, 8191) for t in texts]
  110. ress = []
  111. total_tokens = 0
  112. for i in range(0, len(texts), batch_size):
  113. res = self.client.embeddings.create(input=texts[i : i + batch_size], model=self.model_name)
  114. try:
  115. ress.extend([d.embedding for d in res.data])
  116. total_tokens += self.total_token_count(res)
  117. except Exception as _e:
  118. log_exception(_e, res)
  119. return np.array(ress), total_tokens
  120. def encode_queries(self, text):
  121. res = self.client.embeddings.create(input=[truncate(text, 8191)], model=self.model_name)
  122. return np.array(res.data[0].embedding), self.total_token_count(res)
  123. class LocalAIEmbed(Base):
  124. _FACTORY_NAME = "LocalAI"
  125. def __init__(self, key, model_name, base_url):
  126. if not base_url:
  127. raise ValueError("Local embedding model url cannot be None")
  128. base_url = urljoin(base_url, "v1")
  129. self.client = OpenAI(api_key="empty", base_url=base_url)
  130. self.model_name = model_name.split("___")[0]
  131. def encode(self, texts: list):
  132. batch_size = 16
  133. ress = []
  134. for i in range(0, len(texts), batch_size):
  135. res = self.client.embeddings.create(input=texts[i : i + batch_size], model=self.model_name)
  136. try:
  137. ress.extend([d.embedding for d in res.data])
  138. except Exception as _e:
  139. log_exception(_e, res)
  140. # local embedding for LmStudio donot count tokens
  141. return np.array(ress), 1024
  142. def encode_queries(self, text):
  143. embds, cnt = self.encode([text])
  144. return np.array(embds[0]), cnt
  145. class AzureEmbed(OpenAIEmbed):
  146. _FACTORY_NAME = "Azure-OpenAI"
  147. def __init__(self, key, model_name, **kwargs):
  148. from openai.lib.azure import AzureOpenAI
  149. api_key = json.loads(key).get("api_key", "")
  150. api_version = json.loads(key).get("api_version", "2024-02-01")
  151. self.client = AzureOpenAI(api_key=api_key, azure_endpoint=kwargs["base_url"], api_version=api_version)
  152. self.model_name = model_name
  153. class BaiChuanEmbed(OpenAIEmbed):
  154. _FACTORY_NAME = "BaiChuan"
  155. def __init__(self, key, model_name="Baichuan-Text-Embedding", base_url="https://api.baichuan-ai.com/v1"):
  156. if not base_url:
  157. base_url = "https://api.baichuan-ai.com/v1"
  158. super().__init__(key, model_name, base_url)
  159. class QWenEmbed(Base):
  160. _FACTORY_NAME = "Tongyi-Qianwen"
  161. def __init__(self, key, model_name="text_embedding_v2", **kwargs):
  162. self.key = key
  163. self.model_name = model_name
  164. def encode(self, texts: list):
  165. import dashscope
  166. import time
  167. batch_size = 4
  168. res = []
  169. token_count = 0
  170. texts = [truncate(t, 2048) for t in texts]
  171. for i in range(0, len(texts), batch_size):
  172. retry_max = 5
  173. resp = dashscope.TextEmbedding.call(model=self.model_name, input=texts[i : i + batch_size], api_key=self.key, text_type="document")
  174. while resp["output"] is None and retry_max > 0:
  175. time.sleep(10)
  176. resp = dashscope.TextEmbedding.call(model=self.model_name, input=texts[i : i + batch_size], api_key=self.key, text_type="document")
  177. retry_max -= 1
  178. if retry_max == 0 and resp["output"] is None:
  179. log_exception(ValueError("Retry_max reached, calling embedding model failed"))
  180. raise
  181. try:
  182. embds = [[] for _ in range(len(resp["output"]["embeddings"]))]
  183. for e in resp["output"]["embeddings"]:
  184. embds[e["text_index"]] = e["embedding"]
  185. res.extend(embds)
  186. token_count += self.total_token_count(resp)
  187. except Exception as _e:
  188. log_exception(_e, resp)
  189. raise
  190. return np.array(res), token_count
  191. def encode_queries(self, text):
  192. resp = dashscope.TextEmbedding.call(model=self.model_name, input=text[:2048], api_key=self.key, text_type="query")
  193. try:
  194. return np.array(resp["output"]["embeddings"][0]["embedding"]), self.total_token_count(resp)
  195. except Exception as _e:
  196. log_exception(_e, resp)
  197. class ZhipuEmbed(Base):
  198. _FACTORY_NAME = "ZHIPU-AI"
  199. def __init__(self, key, model_name="embedding-2", **kwargs):
  200. self.client = ZhipuAI(api_key=key)
  201. self.model_name = model_name
  202. def encode(self, texts: list):
  203. arr = []
  204. tks_num = 0
  205. MAX_LEN = -1
  206. if self.model_name.lower() == "embedding-2":
  207. MAX_LEN = 512
  208. if self.model_name.lower() == "embedding-3":
  209. MAX_LEN = 3072
  210. if MAX_LEN > 0:
  211. texts = [truncate(t, MAX_LEN) for t in texts]
  212. for txt in texts:
  213. res = self.client.embeddings.create(input=txt, model=self.model_name)
  214. try:
  215. arr.append(res.data[0].embedding)
  216. tks_num += self.total_token_count(res)
  217. except Exception as _e:
  218. log_exception(_e, res)
  219. return np.array(arr), tks_num
  220. def encode_queries(self, text):
  221. res = self.client.embeddings.create(input=text, model=self.model_name)
  222. try:
  223. return np.array(res.data[0].embedding), self.total_token_count(res)
  224. except Exception as _e:
  225. log_exception(_e, res)
  226. class OllamaEmbed(Base):
  227. _FACTORY_NAME = "Ollama"
  228. def __init__(self, key, model_name, **kwargs):
  229. self.client = Client(host=kwargs["base_url"]) if not key or key == "x" else Client(host=kwargs["base_url"], headers={"Authorization": f"Bear {key}"})
  230. self.model_name = model_name
  231. def encode(self, texts: list):
  232. arr = []
  233. tks_num = 0
  234. for txt in texts:
  235. res = self.client.embeddings(prompt=txt, model=self.model_name, options={"use_mmap": True})
  236. try:
  237. arr.append(res["embedding"])
  238. except Exception as _e:
  239. log_exception(_e, res)
  240. tks_num += 128
  241. return np.array(arr), tks_num
  242. def encode_queries(self, text):
  243. res = self.client.embeddings(prompt=text, model=self.model_name, options={"use_mmap": True})
  244. try:
  245. return np.array(res["embedding"]), 128
  246. except Exception as _e:
  247. log_exception(_e, res)
  248. class FastEmbed(DefaultEmbedding):
  249. _FACTORY_NAME = "FastEmbed"
  250. def __init__(
  251. self,
  252. key: str | None = None,
  253. model_name: str = "BAAI/bge-small-en-v1.5",
  254. cache_dir: str | None = None,
  255. threads: int | None = None,
  256. **kwargs,
  257. ):
  258. if not settings.LIGHTEN:
  259. with FastEmbed._model_lock:
  260. from fastembed import TextEmbedding
  261. if not DefaultEmbedding._model or model_name != DefaultEmbedding._model_name:
  262. try:
  263. DefaultEmbedding._model = TextEmbedding(model_name, cache_dir, threads, **kwargs)
  264. DefaultEmbedding._model_name = model_name
  265. except Exception:
  266. cache_dir = snapshot_download(
  267. repo_id="BAAI/bge-small-en-v1.5", local_dir=os.path.join(get_home_cache_dir(), re.sub(r"^[a-zA-Z0-9]+/", "", model_name)), local_dir_use_symlinks=False
  268. )
  269. DefaultEmbedding._model = TextEmbedding(model_name, cache_dir, threads, **kwargs)
  270. self._model = DefaultEmbedding._model
  271. self._model_name = model_name
  272. def encode(self, texts: list):
  273. # Using the internal tokenizer to encode the texts and get the total
  274. # number of tokens
  275. encodings = self._model.model.tokenizer.encode_batch(texts)
  276. total_tokens = sum(len(e) for e in encodings)
  277. embeddings = [e.tolist() for e in self._model.embed(texts, batch_size=16)]
  278. return np.array(embeddings), total_tokens
  279. def encode_queries(self, text: str):
  280. # Using the internal tokenizer to encode the texts and get the total
  281. # number of tokens
  282. encoding = self._model.model.tokenizer.encode(text)
  283. embedding = next(self._model.query_embed(text)).tolist()
  284. return np.array(embedding), len(encoding.ids)
  285. class XinferenceEmbed(Base):
  286. _FACTORY_NAME = "Xinference"
  287. def __init__(self, key, model_name="", base_url=""):
  288. base_url = urljoin(base_url, "v1")
  289. self.client = OpenAI(api_key=key, base_url=base_url)
  290. self.model_name = model_name
  291. def encode(self, texts: list):
  292. batch_size = 16
  293. ress = []
  294. total_tokens = 0
  295. for i in range(0, len(texts), batch_size):
  296. res = self.client.embeddings.create(input=texts[i : i + batch_size], model=self.model_name)
  297. try:
  298. ress.extend([d.embedding for d in res.data])
  299. total_tokens += self.total_token_count(res)
  300. except Exception as _e:
  301. log_exception(_e, res)
  302. return np.array(ress), total_tokens
  303. def encode_queries(self, text):
  304. res = self.client.embeddings.create(input=[text], model=self.model_name)
  305. try:
  306. return np.array(res.data[0].embedding), self.total_token_count(res)
  307. except Exception as _e:
  308. log_exception(_e, res)
  309. class YoudaoEmbed(Base):
  310. _FACTORY_NAME = "Youdao"
  311. _client = None
  312. def __init__(self, key=None, model_name="maidalun1020/bce-embedding-base_v1", **kwargs):
  313. if not settings.LIGHTEN and not YoudaoEmbed._client:
  314. from BCEmbedding import EmbeddingModel as qanthing
  315. try:
  316. logging.info("LOADING BCE...")
  317. YoudaoEmbed._client = qanthing(model_name_or_path=os.path.join(get_home_cache_dir(), "bce-embedding-base_v1"))
  318. except Exception:
  319. YoudaoEmbed._client = qanthing(model_name_or_path=model_name.replace("maidalun1020", "InfiniFlow"))
  320. def encode(self, texts: list):
  321. batch_size = 10
  322. res = []
  323. token_count = 0
  324. for t in texts:
  325. token_count += num_tokens_from_string(t)
  326. for i in range(0, len(texts), batch_size):
  327. embds = YoudaoEmbed._client.encode(texts[i : i + batch_size])
  328. res.extend(embds)
  329. return np.array(res), token_count
  330. def encode_queries(self, text):
  331. embds = YoudaoEmbed._client.encode([text])
  332. return np.array(embds[0]), num_tokens_from_string(text)
  333. class JinaEmbed(Base):
  334. _FACTORY_NAME = "Jina"
  335. def __init__(self, key, model_name="jina-embeddings-v3", base_url="https://api.jina.ai/v1/embeddings"):
  336. self.base_url = "https://api.jina.ai/v1/embeddings"
  337. self.headers = {"Content-Type": "application/json", "Authorization": f"Bearer {key}"}
  338. self.model_name = model_name
  339. def encode(self, texts: list):
  340. texts = [truncate(t, 8196) for t in texts]
  341. batch_size = 16
  342. ress = []
  343. token_count = 0
  344. for i in range(0, len(texts), batch_size):
  345. data = {"model": self.model_name, "input": texts[i : i + batch_size], "encoding_type": "float"}
  346. response = requests.post(self.base_url, headers=self.headers, json=data)
  347. try:
  348. res = response.json()
  349. ress.extend([d["embedding"] for d in res["data"]])
  350. token_count += self.total_token_count(res)
  351. except Exception as _e:
  352. log_exception(_e, response)
  353. return np.array(ress), token_count
  354. def encode_queries(self, text):
  355. embds, cnt = self.encode([text])
  356. return np.array(embds[0]), cnt
  357. class MistralEmbed(Base):
  358. _FACTORY_NAME = "Mistral"
  359. def __init__(self, key, model_name="mistral-embed", base_url=None):
  360. from mistralai.client import MistralClient
  361. self.client = MistralClient(api_key=key)
  362. self.model_name = model_name
  363. def encode(self, texts: list):
  364. texts = [truncate(t, 8196) for t in texts]
  365. batch_size = 16
  366. ress = []
  367. token_count = 0
  368. for i in range(0, len(texts), batch_size):
  369. res = self.client.embeddings(input=texts[i : i + batch_size], model=self.model_name)
  370. try:
  371. ress.extend([d.embedding for d in res.data])
  372. token_count += self.total_token_count(res)
  373. except Exception as _e:
  374. log_exception(_e, res)
  375. return np.array(ress), token_count
  376. def encode_queries(self, text):
  377. res = self.client.embeddings(input=[truncate(text, 8196)], model=self.model_name)
  378. try:
  379. return np.array(res.data[0].embedding), self.total_token_count(res)
  380. except Exception as _e:
  381. log_exception(_e, res)
  382. class BedrockEmbed(Base):
  383. _FACTORY_NAME = "Bedrock"
  384. def __init__(self, key, model_name, **kwargs):
  385. import boto3
  386. self.bedrock_ak = json.loads(key).get("bedrock_ak", "")
  387. self.bedrock_sk = json.loads(key).get("bedrock_sk", "")
  388. self.bedrock_region = json.loads(key).get("bedrock_region", "")
  389. self.model_name = model_name
  390. if self.bedrock_ak == "" or self.bedrock_sk == "" or self.bedrock_region == "":
  391. # Try to create a client using the default credentials (AWS_PROFILE, AWS_DEFAULT_REGION, etc.)
  392. self.client = boto3.client("bedrock-runtime")
  393. else:
  394. self.client = boto3.client(service_name="bedrock-runtime", region_name=self.bedrock_region, aws_access_key_id=self.bedrock_ak, aws_secret_access_key=self.bedrock_sk)
  395. def encode(self, texts: list):
  396. texts = [truncate(t, 8196) for t in texts]
  397. embeddings = []
  398. token_count = 0
  399. for text in texts:
  400. if self.model_name.split(".")[0] == "amazon":
  401. body = {"inputText": text}
  402. elif self.model_name.split(".")[0] == "cohere":
  403. body = {"texts": [text], "input_type": "search_document"}
  404. response = self.client.invoke_model(modelId=self.model_name, body=json.dumps(body))
  405. try:
  406. model_response = json.loads(response["body"].read())
  407. embeddings.extend([model_response["embedding"]])
  408. token_count += num_tokens_from_string(text)
  409. except Exception as _e:
  410. log_exception(_e, response)
  411. return np.array(embeddings), token_count
  412. def encode_queries(self, text):
  413. embeddings = []
  414. token_count = num_tokens_from_string(text)
  415. if self.model_name.split(".")[0] == "amazon":
  416. body = {"inputText": truncate(text, 8196)}
  417. elif self.model_name.split(".")[0] == "cohere":
  418. body = {"texts": [truncate(text, 8196)], "input_type": "search_query"}
  419. response = self.client.invoke_model(modelId=self.model_name, body=json.dumps(body))
  420. try:
  421. model_response = json.loads(response["body"].read())
  422. embeddings.extend(model_response["embedding"])
  423. except Exception as _e:
  424. log_exception(_e, response)
  425. return np.array(embeddings), token_count
  426. class GeminiEmbed(Base):
  427. _FACTORY_NAME = "Gemini"
  428. def __init__(self, key, model_name="models/text-embedding-004", **kwargs):
  429. self.key = key
  430. self.model_name = "models/" + model_name
  431. def encode(self, texts: list):
  432. texts = [truncate(t, 2048) for t in texts]
  433. token_count = sum(num_tokens_from_string(text) for text in texts)
  434. genai.configure(api_key=self.key)
  435. batch_size = 16
  436. ress = []
  437. for i in range(0, len(texts), batch_size):
  438. result = genai.embed_content(model=self.model_name, content=texts[i : i + batch_size], task_type="retrieval_document", title="Embedding of single string")
  439. try:
  440. ress.extend(result["embedding"])
  441. except Exception as _e:
  442. log_exception(_e, result)
  443. return np.array(ress), token_count
  444. def encode_queries(self, text):
  445. genai.configure(api_key=self.key)
  446. result = genai.embed_content(model=self.model_name, content=truncate(text, 2048), task_type="retrieval_document", title="Embedding of single string")
  447. token_count = num_tokens_from_string(text)
  448. try:
  449. return np.array(result["embedding"]), token_count
  450. except Exception as _e:
  451. log_exception(_e, result)
  452. class NvidiaEmbed(Base):
  453. _FACTORY_NAME = "NVIDIA"
  454. def __init__(self, key, model_name, base_url="https://integrate.api.nvidia.com/v1/embeddings"):
  455. if not base_url:
  456. base_url = "https://integrate.api.nvidia.com/v1/embeddings"
  457. self.api_key = key
  458. self.base_url = base_url
  459. self.headers = {
  460. "accept": "application/json",
  461. "Content-Type": "application/json",
  462. "authorization": f"Bearer {self.api_key}",
  463. }
  464. self.model_name = model_name
  465. if model_name == "nvidia/embed-qa-4":
  466. self.base_url = "https://ai.api.nvidia.com/v1/retrieval/nvidia/embeddings"
  467. self.model_name = "NV-Embed-QA"
  468. if model_name == "snowflake/arctic-embed-l":
  469. self.base_url = "https://ai.api.nvidia.com/v1/retrieval/snowflake/arctic-embed-l/embeddings"
  470. def encode(self, texts: list):
  471. batch_size = 16
  472. ress = []
  473. token_count = 0
  474. for i in range(0, len(texts), batch_size):
  475. payload = {
  476. "input": texts[i : i + batch_size],
  477. "input_type": "query",
  478. "model": self.model_name,
  479. "encoding_format": "float",
  480. "truncate": "END",
  481. }
  482. response = requests.post(self.base_url, headers=self.headers, json=payload)
  483. try:
  484. res = response.json()
  485. except Exception as _e:
  486. log_exception(_e, response)
  487. ress.extend([d["embedding"] for d in res["data"]])
  488. token_count += self.total_token_count(res)
  489. return np.array(ress), token_count
  490. def encode_queries(self, text):
  491. embds, cnt = self.encode([text])
  492. return np.array(embds[0]), cnt
  493. class LmStudioEmbed(LocalAIEmbed):
  494. _FACTORY_NAME = "LM-Studio"
  495. def __init__(self, key, model_name, base_url):
  496. if not base_url:
  497. raise ValueError("Local llm url cannot be None")
  498. base_url = urljoin(base_url, "v1")
  499. self.client = OpenAI(api_key="lm-studio", base_url=base_url)
  500. self.model_name = model_name
  501. class OpenAI_APIEmbed(OpenAIEmbed):
  502. _FACTORY_NAME = ["VLLM", "OpenAI-API-Compatible"]
  503. def __init__(self, key, model_name, base_url):
  504. if not base_url:
  505. raise ValueError("url cannot be None")
  506. base_url = urljoin(base_url, "v1")
  507. self.client = OpenAI(api_key=key, base_url=base_url)
  508. self.model_name = model_name.split("___")[0]
  509. class CoHereEmbed(Base):
  510. _FACTORY_NAME = "Cohere"
  511. def __init__(self, key, model_name, base_url=None):
  512. from cohere import Client
  513. self.client = Client(api_key=key)
  514. self.model_name = model_name
  515. def encode(self, texts: list):
  516. batch_size = 16
  517. ress = []
  518. token_count = 0
  519. for i in range(0, len(texts), batch_size):
  520. res = self.client.embed(
  521. texts=texts[i : i + batch_size],
  522. model=self.model_name,
  523. input_type="search_document",
  524. embedding_types=["float"],
  525. )
  526. try:
  527. ress.extend([d for d in res.embeddings.float])
  528. token_count += res.meta.billed_units.input_tokens
  529. except Exception as _e:
  530. log_exception(_e, res)
  531. return np.array(ress), token_count
  532. def encode_queries(self, text):
  533. res = self.client.embed(
  534. texts=[text],
  535. model=self.model_name,
  536. input_type="search_query",
  537. embedding_types=["float"],
  538. )
  539. try:
  540. return np.array(res.embeddings.float[0]), int(res.meta.billed_units.input_tokens)
  541. except Exception as _e:
  542. log_exception(_e, res)
  543. class TogetherAIEmbed(OpenAIEmbed):
  544. _FACTORY_NAME = "TogetherAI"
  545. def __init__(self, key, model_name, base_url="https://api.together.xyz/v1"):
  546. if not base_url:
  547. base_url = "https://api.together.xyz/v1"
  548. super().__init__(key, model_name, base_url=base_url)
  549. class PerfXCloudEmbed(OpenAIEmbed):
  550. _FACTORY_NAME = "PerfXCloud"
  551. def __init__(self, key, model_name, base_url="https://cloud.perfxlab.cn/v1"):
  552. if not base_url:
  553. base_url = "https://cloud.perfxlab.cn/v1"
  554. super().__init__(key, model_name, base_url)
  555. class UpstageEmbed(OpenAIEmbed):
  556. _FACTORY_NAME = "Upstage"
  557. def __init__(self, key, model_name, base_url="https://api.upstage.ai/v1/solar"):
  558. if not base_url:
  559. base_url = "https://api.upstage.ai/v1/solar"
  560. super().__init__(key, model_name, base_url)
  561. class SILICONFLOWEmbed(Base):
  562. _FACTORY_NAME = "SILICONFLOW"
  563. def __init__(self, key, model_name, base_url="https://api.siliconflow.cn/v1/embeddings"):
  564. if not base_url:
  565. base_url = "https://api.siliconflow.cn/v1/embeddings"
  566. self.headers = {
  567. "accept": "application/json",
  568. "content-type": "application/json",
  569. "authorization": f"Bearer {key}",
  570. }
  571. self.base_url = base_url
  572. self.model_name = model_name
  573. def encode(self, texts: list):
  574. batch_size = 16
  575. ress = []
  576. token_count = 0
  577. for i in range(0, len(texts), batch_size):
  578. texts_batch = texts[i : i + batch_size]
  579. payload = {
  580. "model": self.model_name,
  581. "input": texts_batch,
  582. "encoding_format": "float",
  583. }
  584. response = requests.post(self.base_url, json=payload, headers=self.headers)
  585. try:
  586. res = response.json()
  587. ress.extend([d["embedding"] for d in res["data"]])
  588. token_count += self.total_token_count(res)
  589. except Exception as _e:
  590. log_exception(_e, response)
  591. return np.array(ress), token_count
  592. def encode_queries(self, text):
  593. payload = {
  594. "model": self.model_name,
  595. "input": text,
  596. "encoding_format": "float",
  597. }
  598. response = requests.post(self.base_url, json=payload, headers=self.headers)
  599. try:
  600. res = response.json()
  601. return np.array(res["data"][0]["embedding"]), self.total_token_count(res)
  602. except Exception as _e:
  603. log_exception(_e, response)
  604. class ReplicateEmbed(Base):
  605. _FACTORY_NAME = "Replicate"
  606. def __init__(self, key, model_name, base_url=None):
  607. from replicate.client import Client
  608. self.model_name = model_name
  609. self.client = Client(api_token=key)
  610. def encode(self, texts: list):
  611. batch_size = 16
  612. token_count = sum([num_tokens_from_string(text) for text in texts])
  613. ress = []
  614. for i in range(0, len(texts), batch_size):
  615. res = self.client.run(self.model_name, input={"texts": texts[i : i + batch_size]})
  616. ress.extend(res)
  617. return np.array(ress), token_count
  618. def encode_queries(self, text):
  619. res = self.client.embed(self.model_name, input={"texts": [text]})
  620. return np.array(res), num_tokens_from_string(text)
  621. class BaiduYiyanEmbed(Base):
  622. _FACTORY_NAME = "BaiduYiyan"
  623. def __init__(self, key, model_name, base_url=None):
  624. import qianfan
  625. key = json.loads(key)
  626. ak = key.get("yiyan_ak", "")
  627. sk = key.get("yiyan_sk", "")
  628. self.client = qianfan.Embedding(ak=ak, sk=sk)
  629. self.model_name = model_name
  630. def encode(self, texts: list, batch_size=16):
  631. res = self.client.do(model=self.model_name, texts=texts).body
  632. try:
  633. return (
  634. np.array([r["embedding"] for r in res["data"]]),
  635. self.total_token_count(res),
  636. )
  637. except Exception as _e:
  638. log_exception(_e, res)
  639. def encode_queries(self, text):
  640. res = self.client.do(model=self.model_name, texts=[text]).body
  641. try:
  642. return (
  643. np.array([r["embedding"] for r in res["data"]]),
  644. self.total_token_count(res),
  645. )
  646. except Exception as _e:
  647. log_exception(_e, res)
  648. class VoyageEmbed(Base):
  649. _FACTORY_NAME = "Voyage AI"
  650. def __init__(self, key, model_name, base_url=None):
  651. import voyageai
  652. self.client = voyageai.Client(api_key=key)
  653. self.model_name = model_name
  654. def encode(self, texts: list):
  655. batch_size = 16
  656. ress = []
  657. token_count = 0
  658. for i in range(0, len(texts), batch_size):
  659. res = self.client.embed(texts=texts[i : i + batch_size], model=self.model_name, input_type="document")
  660. try:
  661. ress.extend(res.embeddings)
  662. token_count += res.total_tokens
  663. except Exception as _e:
  664. log_exception(_e, res)
  665. return np.array(ress), token_count
  666. def encode_queries(self, text):
  667. res = self.client.embed(texts=text, model=self.model_name, input_type="query")
  668. try:
  669. return np.array(res.embeddings)[0], res.total_tokens
  670. except Exception as _e:
  671. log_exception(_e, res)
  672. class HuggingFaceEmbed(Base):
  673. _FACTORY_NAME = "HuggingFace"
  674. def __init__(self, key, model_name, base_url=None):
  675. if not model_name:
  676. raise ValueError("Model name cannot be None")
  677. self.key = key
  678. self.model_name = model_name.split("___")[0]
  679. self.base_url = base_url or "http://127.0.0.1:8080"
  680. def encode(self, texts: list):
  681. embeddings = []
  682. for text in texts:
  683. response = requests.post(f"{self.base_url}/embed", json={"inputs": text}, headers={"Content-Type": "application/json"})
  684. if response.status_code == 200:
  685. embedding = response.json()
  686. embeddings.append(embedding[0])
  687. else:
  688. raise Exception(f"Error: {response.status_code} - {response.text}")
  689. return np.array(embeddings), sum([num_tokens_from_string(text) for text in texts])
  690. def encode_queries(self, text):
  691. response = requests.post(f"{self.base_url}/embed", json={"inputs": text}, headers={"Content-Type": "application/json"})
  692. if response.status_code == 200:
  693. embedding = response.json()
  694. return np.array(embedding[0]), num_tokens_from_string(text)
  695. else:
  696. raise Exception(f"Error: {response.status_code} - {response.text}")
  697. class VolcEngineEmbed(OpenAIEmbed):
  698. _FACTORY_NAME = "VolcEngine"
  699. def __init__(self, key, model_name, base_url="https://ark.cn-beijing.volces.com/api/v3"):
  700. if not base_url:
  701. base_url = "https://ark.cn-beijing.volces.com/api/v3"
  702. ark_api_key = json.loads(key).get("ark_api_key", "")
  703. model_name = json.loads(key).get("ep_id", "") + json.loads(key).get("endpoint_id", "")
  704. super().__init__(ark_api_key, model_name, base_url)
  705. class GPUStackEmbed(OpenAIEmbed):
  706. _FACTORY_NAME = "GPUStack"
  707. def __init__(self, key, model_name, base_url):
  708. if not base_url:
  709. raise ValueError("url cannot be None")
  710. base_url = urljoin(base_url, "v1")
  711. self.client = OpenAI(api_key=key, base_url=base_url)
  712. self.model_name = model_name
  713. class NovitaEmbed(SILICONFLOWEmbed):
  714. _FACTORY_NAME = "NovitaAI"
  715. def __init__(self, key, model_name, base_url="https://api.novita.ai/v3/openai/embeddings"):
  716. if not base_url:
  717. base_url = "https://api.novita.ai/v3/openai/embeddings"
  718. super().__init__(key, model_name, base_url)
  719. class GiteeEmbed(SILICONFLOWEmbed):
  720. _FACTORY_NAME = "GiteeAI"
  721. def __init__(self, key, model_name, base_url="https://ai.gitee.com/v1/embeddings"):
  722. if not base_url:
  723. base_url = "https://ai.gitee.com/v1/embeddings"
  724. super().__init__(key, model_name, base_url)