-
Notifications
You must be signed in to change notification settings - Fork 237
Expand file tree
/
Copy pathdocarray_response.py
More file actions
50 lines (39 loc) · 1.61 KB
/
docarray_response.py
File metadata and controls
50 lines (39 loc) · 1.61 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# Licensed to the LF AI & Data foundation under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from typing import TYPE_CHECKING, Any
from docarray.base_doc.io.json import orjson_dumps
from docarray.utils._internal.misc import import_library
if TYPE_CHECKING:
from fastapi.responses import JSONResponse
else:
fastapi = import_library('fastapi', raise_error=True)
JSONResponse = fastapi.responses.JSONResponse
class DocArrayResponse(JSONResponse):
"""
This is a custom Response class for FastAPI and starlette. This is needed
to handle serialization of the Document types when using FastAPI
---
```python
from docarray.documets import Text
from docarray.base_doc import DocResponse
@app.post("/doc/", response_model=Text, response_class=DocResponse)
async def create_item(doc: Text) -> Text:
return doc
```
---
"""
def render(self, content: Any) -> bytes:
return orjson_dumps(content)