Fix update connector documentation error (#9122)

* Fix update connector documentation error Signed-off-by: Sicheng Song <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Sicheng Song <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]>
opensearch-project · Jan 28, 2025 · 9e51185 · 9e51185
1 parent d621412
commit 9e51185
Showing 1 changed file with 20 additions and 1 deletion.
diff --git a/_ml-commons-plugin/remote-models/connectors.md b/_ml-commons-plugin/remote-models/connectors.md
@@ -289,7 +289,11 @@ POST /_plugins/_ml/connectors/_create
 
 ## Updating connector credentials
 
-In some cases, you may need to update credentials, like `access_key`, that you use to connect to externally hosted models. You can update credentials without undeploying the model by providing the new credentials in the following request:
+In some cases, you may need to update credentials, such as `access_key`, used to connect to externally hosted models. To do this without undeploying the model, provide the new credentials in an update request.
+
+### Connector for a specific model
+
+To update credentials for a connector linked to a specific model, provide the new credentials in the following request:
 
 ```json
 PUT /_plugins/_ml/models/<model_id>
@@ -301,6 +305,21 @@ PUT /_plugins/_ml/models/<model_id>
   }
 }
 ```
+{% include copy-curl.html %}
+
+### Standalone connector
+
+To update credentials for a standalone connector, provide the new credentials in the following request:
+
+```json
+PUT /_plugins/_ml/connectors/<connector_id>
+{
+  "credential": {
+    "openAI_key": "YOUR NEW OPENAI KEY"
+  }
+}
+```
+{% include copy-curl.html %}
 
 ## Next steps