Skip to content

Commit e8d00ad

Browse files
committed
Update docs
1 parent 2537ce8 commit e8d00ad

File tree

3 files changed

+30
-30
lines changed

3 files changed

+30
-30
lines changed

docs/api/vectorizer.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ AzureOpenAITextVectorizer
3838
:members:
3939

4040

41-
VertexAITextVectorizer
41+
VertexAIVectorizer
4242
======================
4343

44-
.. _vertexaitextvectorizer_api:
44+
.. _vertexaivectorizer_api:
4545

46-
.. currentmodule:: redisvl.utils.vectorize.text.vertexai
46+
.. currentmodule:: redisvl.utils.vectorize.vertexai
4747

48-
.. autoclass:: VertexAITextVectorizer
48+
.. autoclass:: VertexAIVectorizer
4949
:show-inheritance:
5050
:members:
5151

@@ -62,37 +62,37 @@ CohereTextVectorizer
6262
:members:
6363

6464

65-
BedrockTextVectorizer
65+
BedrockVectorizer
6666
=====================
6767

68-
.. _bedrocktextvectorizer_api:
68+
.. _bedrockvectorizer_api:
6969

70-
.. currentmodule:: redisvl.utils.vectorize.text.bedrock
70+
.. currentmodule:: redisvl.utils.vectorize.bedrock
7171

72-
.. autoclass:: BedrockTextVectorizer
72+
.. autoclass:: BedrockVectorizer
7373
:show-inheritance:
7474
:members:
7575

7676

77-
CustomTextVectorizer
77+
CustomVectorizer
7878
====================
7979

80-
.. _customtextvectorizer_api:
80+
.. _customvectorizer_api:
8181

82-
.. currentmodule:: redisvl.utils.vectorize.text.custom
82+
.. currentmodule:: redisvl.utils.vectorize.custom
8383

84-
.. autoclass:: CustomTextVectorizer
84+
.. autoclass:: CustomVectorizer
8585
:show-inheritance:
8686
:members:
8787

8888

89-
VoyageAITextVectorizer
89+
VoyageAIVectorizer
9090
======================
9191

92-
.. _voyageaitextvectorizer_api:
92+
.. _voyageaivectorizer_api:
9393

94-
.. currentmodule:: redisvl.utils.vectorize.text.voyageai
94+
.. currentmodule:: redisvl.utils.vectorize.voyageai
9595

96-
.. autoclass:: VoyageAITextVectorizer
96+
.. autoclass:: VoyageAIVectorizer
9797
:show-inheritance:
9898
:members:

docs/user_guide/04_vectorizers.ipynb

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -413,23 +413,23 @@
413413
]
414414
},
415415
{
416-
"cell_type": "markdown",
417416
"metadata": {},
417+
"cell_type": "markdown",
418418
"source": [
419419
"### VoyageAI\n",
420420
"\n",
421-
"[VoyageAI](https://dash.voyageai.com/) allows you to implement language AI into your product. The `VoyageAITextVectorizer` makes it simple to use RedisVL with the embeddings models at VoyageAI. For this you will need to install `voyageai`.\n",
421+
"[VoyageAI](https://dash.voyageai.com/) allows you to implement language AI into your product. The `VoyageAIVectorizer` makes it simple to use RedisVL with the embeddings models at VoyageAI. For this you will need to install `voyageai`.\n",
422422
"\n",
423423
"```bash\n",
424424
"pip install voyageai\n",
425425
"```"
426426
]
427427
},
428428
{
429-
"cell_type": "code",
430-
"execution_count": 11,
431429
"metadata": {},
430+
"cell_type": "code",
432431
"outputs": [],
432+
"execution_count": null,
433433
"source": [
434434
"import getpass\n",
435435
"# setup the API Key\n",
@@ -447,15 +447,15 @@
447447
]
448448
},
449449
{
450-
"cell_type": "code",
451-
"execution_count": null,
452450
"metadata": {},
451+
"cell_type": "code",
453452
"outputs": [],
453+
"execution_count": null,
454454
"source": [
455-
"from redisvl.utils.vectorize import VoyageAITextVectorizer\n",
455+
"from redisvl.utils.vectorize import VoyageAIVectorizer\n",
456456
"\n",
457457
"# create a vectorizer\n",
458-
"vo = VoyageAITextVectorizer(\n",
458+
"vo = VoyageAIVectorizer(\n",
459459
" model=\"voyage-law-2\", # Please check the available models at https://docs.voyageai.com/docs/embeddings\n",
460460
" api_config={\"api_key\": api_key},\n",
461461
")\n",
@@ -472,8 +472,8 @@
472472
]
473473
},
474474
{
475-
"cell_type": "markdown",
476475
"metadata": {},
476+
"cell_type": "markdown",
477477
"source": [
478478
"### Mistral AI\n",
479479
"\n",
@@ -486,10 +486,10 @@
486486
]
487487
},
488488
{
489-
"cell_type": "code",
490-
"execution_count": null,
491489
"metadata": {},
490+
"cell_type": "code",
492491
"outputs": [],
492+
"execution_count": null,
493493
"source": [
494494
"from redisvl.utils.vectorize import MistralAITextVectorizer\n",
495495
"\n",

docs/user_guide/10_embeddings_cache.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -264,19 +264,19 @@
264264
"# Prepare batch items as dictionaries\n",
265265
"batch_items = [\n",
266266
" {\n",
267-
" \"text\": texts[0],\n",
267+
" \"content\": texts[0],\n",
268268
" \"model_name\": model_name,\n",
269269
" \"embedding\": embeddings[0],\n",
270270
" \"metadata\": {\"category\": \"ai\", \"type\": \"question\"}\n",
271271
" },\n",
272272
" {\n",
273-
" \"text\": texts[1],\n",
273+
" \"content\": texts[1],\n",
274274
" \"model_name\": model_name,\n",
275275
" \"embedding\": embeddings[1],\n",
276276
" \"metadata\": {\"category\": \"ai\", \"type\": \"question\"}\n",
277277
" },\n",
278278
" {\n",
279-
" \"text\": texts[2],\n",
279+
" \"content\": texts[2],\n",
280280
" \"model_name\": model_name,\n",
281281
" \"embedding\": embeddings[2],\n",
282282
" \"metadata\": {\"category\": \"ai\", \"type\": \"question\"}\n",

0 commit comments

Comments
 (0)