Skip to content

update doc for unreleased change #2

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
willydouhard merged 1 commit into from
Jun 8, 2023
Merged

update doc for unreleased change #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 14 additions & 3 deletions api-reference/ask/ask-for-file.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ If a project ID is configured, the messages will be uploaded to the cloud storag
<ParamField path="content" type="str">
Text displayed above the upload button.
</ParamField>
<ParamField path="accept" type="List[str]">
List of mime type to accept like ["text/csv", "application/pdf"]
<ParamField path="accept" type="Union[List[str], Dict[str, List[str]]]">
List of mime type to accept like ["text/csv", "application/pdf"] or a dict like {"text/plain": [".txt", ".py"]}.
More infos here https://react-dropzone.org/#!/Accepting%20specific%20file%20types.
</ParamField>
<ParamField path="max_size_mb" type="int" optional>
Maximum file size in MB. Defaults to 2.
Maximum file size in MB. Defaults to 2. Max 100.
</ParamField>
<ParamField path="timeout" type="int" optional>
The number of seconds to wait for an answer before raising a TimeoutError.
Expand Down Expand Up @@ -53,3 +54,13 @@ def start():
content=f"`{file.name}` uploaded, it contains {len(text)} characters!"
).send()
```

You can also pass a dict to the `accept` parameter to precise the file extension for each mime type:

```python Code Example
import chainlit as cl

file = cl.AskFileMessage(
content="Please upload a python file to begin!", accept={"text/plain": [".py"]}
).send()
```