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.5.tar.gz (15.2 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.5-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fance_types-0.1.5.tar.gz
  • Upload date:
  • Size: 15.2 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.5.tar.gz
Algorithm Hash digest
SHA256 02fbdbba7f407a5872f00025e47f6adc018aa879530239b84afbd7629a1fb74c
MD5 1302b5c9bd3cfccfe6c7387b01475ec0
BLAKE2b-256 306cffc8a6f18881e40bc4fe1c5da5c4249dcef21be95266e88ba59e9f791320

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fance_types-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 15.9 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ce1d76496330197d87636bd7f4927867612790c10d56dbf2907578f2efec18f7
MD5 9ecd00017ceebadac8e98b0741f21fde
BLAKE2b-256 511ea2ea97feca242d52ece45e47d0c5bba19e34e5cb7bc3d9174ba66da71d47

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