Skip to content

docs: explain the state of doclist in fastapi #1546

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samsja merged 5 commits into from
May 16, 2023
+13 −5
Merged

docs: explain the state of doclist in fastapi #1546

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
32bc6de
feat: show torch shape in openapi schema
JohannesMessner May 8, 2023
d2c4918
feat: openapi tensor shapes for all backends
JohannesMessner May 8, 2023
ce99dc6
Merge remote-tracking branch 'origin/main' into main
JohannesMessner May 9, 2023
cc4febd
Merge remote-tracking branch 'origin/main' into main
JohannesMessner May 16, 2023
b282f54
docs: add explanation about doclist in fastapi
JohannesMessner May 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions docs/user_guide/sending/api/fastAPI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,13 +95,21 @@ Image(
) # fails validation because it does not have enough dimensions
```

## Use DocList with FastAPI

Further, you can send and receive lists of documents represented as a `DocList` object:
Further, you can send and receive lists of documents represented as a `DocList` object.

!!! note
Currently, `FastAPI` receives `DocList` objects as lists, so you have to construct a DocList inside the function.
Also, if you want to return a `DocList` object, first you have to convert it to a list.
(Shown in the example below)
To do that, you need to receive a list of documents (`List[TextDoc]`) in your FastAPI function, and then convert it to a `DocList` object.
To return a `DocList` object, similarly, you need to convert it to a list first.

!!! note "Why is there no native support for `DocList`?"
We would love to natively support `DocList` in FastAPI, but it's not possible at the moment due to some behaviour
stemming from Pydantic. This should be resolved once [Pydantic v2](https://docs.pydantic.dev/latest/blog/pydantic-v2/) is released.

If you are curious about the root cause of this, you can check out the following issues:
- [Pydantic issue #1457](https://github.com/pydantic/pydantic/issues/1457)
- [Should be resolved in Pydantic v2 (#4161)](https://github.com/pydantic/pydantic/issues/4161)
- [DocArray needs the above (#1521)](https://github.com/docarray/docarray/issues/1521)

```python
from typing import List
Expand Down