This repository was archived by the owner on Sep 9, 2026. It is now read-only.
Repository navigation
This repository was archived by the owner on Sep 9, 2026. It is now read-only.
Add Field Description and example to Predefined Documents #1736
Description
Initial Checks
- I have searched Google & GitHub for similar requests and couldn't find anything
- I have read and followed the docs and still think this feature is missing
Description
One nice thing about DocArray is the predefined Document types that we offer that allow people to use for multimodal applications.
Having rich field definitions, with description and examples would help when building services based on FastAPI with them.
Affected Components
Metadata
Metadata
Assignees
Type
Projects
- Status
Activity
punndcoder28 commentedon Aug 31, 2023
Hi, @JoanFM I can take this up and work on the changes. Could you provide more information on what is required for the change? Happy to work on it
JoanFM commentedon Aug 31, 2023
Hello @punndcoder28,
Sure, what u need is to slowly add meaningful descriptions, use
Field(description=...)to the fields of the predefined documents. You can split it in multiple PRpunndcoder28 commentedon Aug 31, 2023
Thanks for the quick reply. The predefined document types are those of
TextDoc, andImageDocand the list of other docs as talked about here and field descriptions, for example onTextDoc, would be concise information for attributestext,url,embeddingsandbytes?JoanFM commentedon Aug 31, 2023
yes, you can add description and example field
punndcoder28 commentedon Aug 31, 2023
The
descriptionfield would be for the document type and the example would be a separate section in the docs page?JoanFM commentedon Aug 31, 2023
It is not about docs page sections, is about completing the fields of the predefined documents as it has been done for
IDfor the abstractBaseDocdocarray/docarray/base_doc/doc.py
Line 75 in cc2339d
punndcoder28 commentedon Aug 31, 2023
Thank you for the clarification
punndcoder28 commentedon Sep 20, 2023
@JoanFM I seem to have added field descriptions for all the predefined documents (which were present on docs). Are there any more I've missed?
JoanFM commentedon Sep 20, 2023
I do not think so, then let's close this ticket thanks