Skip to content

Commit d7b3acc

Browse files
[DOCS] Adjusts PUT inference API docs examples (#106604) (#106606)
Co-authored-by: David Kyle <[email protected]>
1 parent 8b50e93 commit d7b3acc

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

docs/reference/inference/put-inference.asciidoc

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,12 @@ creating the {infer} model, you cannot change the associated API key. If you
162162
want to use a different API key, delete the {infer} model and recreate it with
163163
the same name and the updated API key.
164164
165+
`model_id`:::
166+
(Optional, string)
167+
The name of the model to use for the {infer} task. Refer to the
168+
https://platform.openai.com/docs/guides/embeddings/what-are-embeddings[OpenAI documentation]
169+
for the list of available text embedding models.
170+
165171
`organization_id`:::
166172
(Optional, string)
167173
The unique identifier of your organization. You can find the Organization ID in
@@ -215,13 +221,6 @@ Valid values are:
215221
* `search`: use it for storing embeddings of search queries run against a
216222
vector data base to find relevant documents.
217223
218-
`model`:::
219-
(Optional, string)
220-
For `openai` sevice only. The name of the model to use for the {infer} task. Refer
221-
to the
222-
https://platform.openai.com/docs/guides/embeddings/what-are-embeddings[OpenAI documentation]
223-
for the list of available text embedding models.
224-
225224
`truncate`:::
226225
(Optional, string)
227226
For `cohere` service only. Specifies how the API handles inputs longer than the
@@ -256,7 +255,7 @@ PUT _inference/text_embedding/cohere-embeddings
256255
"service": "cohere",
257256
"service_settings": {
258257
"api_key": "<api_key>",
259-
"model": "embed-english-light-v3.0",
258+
"model_id": "embed-english-light-v3.0",
260259
"embedding_type": "byte"
261260
}
262261
}
@@ -304,8 +303,7 @@ PUT _inference/sparse_embedding/my-elser-model
304303
"service_settings": {
305304
"num_allocations": 1,
306305
"num_threads": 1
307-
},
308-
"task_settings": {}
306+
}
309307
}
310308
------------------------------------------------------------
311309
// TEST[skip:TBD]
@@ -397,10 +395,8 @@ PUT _inference/text_embedding/openai_embeddings
397395
{
398396
"service": "openai",
399397
"service_settings": {
400-
"api_key": "<api_key>"
401-
},
402-
"task_settings": {
403-
"model": "text-embedding-ada-002"
398+
"api_key": "<api_key>",
399+
"model_id": "text-embedding-ada-002"
404400
}
405401
}
406402
------------------------------------------------------------

0 commit comments

Comments
 (0)