-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add embedding reference (#1584)
- Loading branch information
Showing
2 changed files
with
26 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
title: embed | ||
description: Embed a single value using the AI SDK Core | ||
--- | ||
|
||
# `embed` | ||
|
||
Generate an embedding for a single value using an embedding model. | ||
|
||
This is ideal for use cases where you need to embed a single value to e.g. retrieve similar items or to use the embedding in a downstream task. | ||
|
||
## Import | ||
|
||
<Snippet text={`import { embed } from "ai"`} prompt={false} /> | ||
|
||
<ReferenceTable packageName="core" functionName="embed" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters