Skip to content

Commit d072236

Browse files
authored
DOC-1314 Add dimensions field to cohere_embeddings processor (#244)
1 parent 1479551 commit d072236

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

modules/components/pages/processors/cohere_embeddings.adoc

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,15 @@ Introduced in version 4.37.0.
1717
endif::[]
1818

1919
```yml
20-
# Config fields, showing default values
20+
# Configuration fields, showing default values
2121
label: ""
2222
cohere_embeddings:
2323
base_url: https://api.cohere.com
2424
auth_token: "" # No default (required)
2525
model: embed-english-v3.0 # No default (required)
2626
text_mapping: "" # No default (optional)
27-
dimensions: search_document
27+
input_type: search_document
28+
dimensions: "" # No default (optional)
2829
```
2930

3031
This processor sends text strings to your chosen large language model (LLM), which generates vector embeddings for them using the Cohere API. By default, the processor submits the entire payload of each message as a string, unless you use the `text_mapping` field to customize it.
@@ -101,7 +102,7 @@ The text you want to generate a vector embedding for. By default, the processor
101102

102103
*Type*: `string`
103104

104-
=== `dimensions`
105+
=== `input_type`
105106

106107
The type of text input passed to the model.
107108

@@ -110,15 +111,29 @@ The type of text input passed to the model.
110111
*Default*: `search_document`
111112

112113
|===
113-
| Option | Summary
114+
| Option | Description
115+
114116
| `classification`
115117
| For embeddings passed through a text classifier.
118+
116119
| `clustering`
117120
| For embeddings run through a clustering algorithm.
121+
118122
| `search_document`
119-
| For embeddings stored in a vector database for search use cases.
123+
| For embeddings stored in a vector database and used for search use cases.
124+
120125
| `search_query`
121126
| For embeddings of search queries run against a vector database to find relevant documents.
122127
|===
123128

129+
=== `dimensions`
130+
131+
The number of dimensions (numerical values) in each vector embedding generated by this processor. This parameter only supports https://docs.cohere.com/v2/docs/embeddings[`embed-v4.0`^] and newer models.
132+
133+
*Type*: `int`
134+
135+
*Default*: `""`
136+
137+
Options: `256`, `512`, `1024`, `1536`
138+
124139
// end::single-source[]

0 commit comments

Comments
 (0)