Skip to content

docs: add documentation for eval_async() #520

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
merged 2 commits into from
May 20, 2025
Merged

docs: add documentation for eval_async() #520

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be4be34
docs: add documentation for `eval_async()`
badmonster0 May 20, 2025
862b9c6
style: minor words
badmonster0 May 20, 2025
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
8 changes: 7 additions & 1 deletion docs/docs/query.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ In this case, you can:

3. At query time, you usually want to directly run the function with specific input data, instead of letting it called as part of a long-lived indexing flow.
To do this, declare the function as a *transform flow*, by decorating it with `@cocoindex.transform_flow()`.
This will add a `eval()` method to the function, so that you can directly call with specific input data.
This will add `eval()` and `eval_async()` methods to the function, so that you can directly call with specific input data.


<Tabs>
Expand Down Expand Up @@ -67,6 +67,12 @@ Any time, you can call the `eval()` method with specific string, which will retu
print(text_to_embedding.eval("Hello, world!"))
```

If you're in an async context, please call the `eval_async()` method instead:

```python
print(await text_to_embedding.eval_async("Hello, world!"))
```

</TabItem>
</Tabs>

Expand Down