pangukitsappdev.api.embeddings package

Submodules

pangukitsappdev.api.embeddings.base module

class pangukitsappdev.api.embeddings.base.AbstractEmbeddingApi(embedding_config: EmbeddingConfig)

基类：EmbeddingApi, ABC

abstract create_embeddings(embedding_config: EmbeddingConfig) → Embeddings

创建embeddings的实现类 :param embedding_config: 配置 :return: embeddings的实现类

embed_documents(texts: List[str]) → List[List[float]]

Embed search docs.

embed_qa_documents(doc_texts: List[Dict[str, str]], weight: Dict[str, int]) → List[List[float]]

支持对一份数据的不同文本分权重进行Embedding :param doc_texts: 批量索引的文本 :param weight: 权重，key值和doc_text的元素中的key值一致 :return: embedding结果

embed_query(text: str) → List[float]

Embed query text.

class pangukitsappdev.api.embeddings.base.EmbeddingApi

基类：Embeddings, ABC

abstract embed_qa_documents(doc_texts: List[Dict[str, str]], weight: Dict[str, int]) → List[List[float]]

支持对一份数据的不同文本分权重进行Embedding :param doc_texts: 批量索引的文本 :param weight: 权重，key值和doc_text的元素中的key值一致 :return: embedding结果

pangukitsappdev.api.embeddings.embedding_config module

class pangukitsappdev.api.embeddings.embedding_config.EmbeddingConfig(env_prefix='sdk.embedding.css', *, embedding_name: Optional[str] = 'default_embedding_name', css_url: Optional[str] = None, iam_config: IAMConfig = None, openai_config: OpenAIConfig = None, http_config: HttpConfig = None)

基类：SdkBaseSettings

css_url: Optional[str]

embedding_name: Optional[str]

http_config: HttpConfig

iam_config: IAMConfig

openai_config: OpenAIConfig

pangukitsappdev.api.embeddings.factory module

class pangukitsappdev.api.embeddings.factory.Embeddings

基类：object

embeddings_map: Dict[str, Type[EmbeddingApi]] = {'css': <class 'pangukitsappdev.embeddings.pangu.CSSEmbeddingApi'>, 'openAI': <class 'pangukitsappdev.embeddings.openai.OpenAIEmbeddingApi'>, 'tool': <class 'pangukitsappdev.embeddings.tool.ToolEmbeddingApi'>}

classmethod of(embedding_name: str, embedding_config: Optional[EmbeddingConfig] = None) → EmbeddingApi

根据名字创建一个EmbeddingApi的实现类 :param embedding_name: embedding的名字，唯一标识一种Embedding :param embedding_config: （Optional）Embedding的相关配置，如果不传递则从默认配置文件中或者环境变量中获取 :return: EmbeddingApi

classmethod register(embedding_type: Type[EmbeddingApi], embedding_name: str)

注册一种embedding的类型 :param embedding_type: embedding的类型，要求是EmbeddingApi的子类 :param embedding_name: embedding的名字，唯一代表这个embedding的名字 :return: none

Module contents