Skip to main content

定义通用数据结构和接口的 Python 包,适用于数据处理、算法、后端等模块间共享

Project description

fance_types模块

数据结构定义

fance_types/common.py

主要定义系统中的通用数据结构,包括数据处理、算法、后端等需要在模块间共享的数据结构。

定义为pydantic.BaseModel的子类。

接口定义

接口定义按照其业务逻辑写在对应名字的文件中,例如推荐逻辑的接口,可以写在fance_types/recommend.py中。

接口主要包含3部分:接口名称、输入和输出。可以通过两个数据结构来定义,分别为:请求对象(Request)和响应对象(Response)。其中接口名称可以包含在请求对象中。例如:

GetInfoRequest(Request):
    """相关注释说明"""
    
    # 如果继承自agent_types.common.Request基类,那么可以设置一个请求名称,相当于该接口的名称
    # 具体用法请参考agentcortex仓库中的examples
    __request_name__ = "get_info"
    
    field1: Optional[str] = Field(
        title="该字段的标题",
        description="该字段的描述(给人看的,也可以给LLM看)",
        default=None  # "默认值(如有)"
    )
    field2: List[int] = Field(
        title="该字段的标题",
        description="该字段的描述(给人看的,也可以给LLM看)",
        default_factory=list  # 默认值也可以是工厂函数
    )
    ......

Response类的定义类似。

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fance_types-0.1.2.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fance_types-0.1.2-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file fance_types-0.1.2.tar.gz.

File metadata

  • Download URL: fance_types-0.1.2.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for fance_types-0.1.2.tar.gz
Algorithm Hash digest
SHA256 829e2725576258711c734ee76d5c7a68890342c1d4b2a60bc63a38ddaf5c89f3
MD5 dd8c0eaa9f16f0466d5361d6ec40db4e
BLAKE2b-256 3e1c703ed70a55516c1fb72bc260086e6a457c90f0753e4ca96d4dd4f58178d7

See more details on using hashes here.

File details

Details for the file fance_types-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: fance_types-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for fance_types-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 49cc6fde6a9056c2b998de861a4e47f556e78aaaee23fa77e3db2abfcac09322
MD5 92556e74b2768d074b57ffcb6597e9a6
BLAKE2b-256 399f1b58e580e5f50de5b9905b9f1ba952c78215e19585270507def790edd05b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page