OpenAIBackend
¶
Bases: BaseEmbedder
OpenAI Embedding Model
Parameters:
Name | Type | Description | Default |
---|---|---|---|
client |
OpenAI
|
A |
required |
embedding_model |
str
|
An OpenAI model. Default is For an overview of models see: https://platform.openai.com/docs/models/embeddings |
'text-embedding-ada-002'
|
delay_in_seconds |
float
|
If a |
None
|
batch_size |
int
|
The size of each batch. |
None
|
generator_kwargs |
Mapping[str, Any]
|
Kwargs passed to |
{}
|
Examples:
import openai
from bertopic.backend import OpenAIBackend
client = openai.OpenAI(api_key="sk-...")
openai_embedder = OpenAIBackend(client, "text-embedding-ada-002")
Source code in bertopic\backend\_openai.py
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 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
|
embed(documents, verbose=False)
¶
Embed a list of n documents/words into an n-dimensional matrix of embeddings
Parameters:
Name | Type | Description | Default |
---|---|---|---|
documents |
List[str]
|
A list of documents or words to be embedded |
required |
verbose |
bool
|
Controls the verbosity of the process |
False
|
Returns:
Type | Description |
---|---|
ndarray
|
Document/words embeddings with shape (n, m) with |
ndarray
|
that each have an embeddings size of |
Source code in bertopic\backend\_openai.py
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
|