Skip to content

Commit ff7e35a

Browse files
committed
Add provisioned_by field to connector, model, and agent API documentation
Documents the new provisioned_by field added in ml-commons for OpenSearch 3.7. This field is an optional attribution tag identifying the plugin or client that provisioned the resource (e.g., flow-framework). Included in ML stats metrics. Added to: - register-agent.md request body table - register-model.md request body tables (pretrained, custom, externally hosted) - blueprints.md connector configuration parameters table Signed-off-by: Daniel Widdis <widdis@gmail.com> Signed-off-by: Dan Widdis <widdisd@amazon.com>
1 parent 5bda230 commit ff7e35a

3 files changed

Lines changed: 6 additions & 0 deletions

File tree

_ml-commons-plugin/api/agent-apis/register-agent.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ Field | Data type | Required/Optional | Agent type | Description
6161
`model.model_provider` | String | Required (if using `model`) | `conversational`, `plan_execute_and_reflect` | The model provider. Supported values: `bedrock/converse`, `gemini/v1beta/generatecontent`, `openai/v1/chat/completions`.
6262
`model.credential` | Object | Required (if using `model`) | `conversational`, `plan_execute_and_reflect` | Credentials for accessing the model. Accepts any credential format supported by connectors. For details, see [Connector blueprints]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/blueprints#configuration-parameters).
6363
`model.model_parameters` | Object | Optional (if using `model`) | `conversational`, `plan_execute_and_reflect` | Model-specific parameters such as system prompts and other configuration options.
64+
`provisioned_by` | String | Optional | All | An optional attribution tag identifying the plugin or client that registered the agent (for example, `"flow-framework"`). Included in ML stats metrics.
6465

6566
### Using agentic memory
6667

_ml-commons-plugin/api/model-apis/register-model.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Field | Data type | Required/Optional | Description
5757
`model_format` | String | Required | The portable format of the model file. Valid values are `TORCH_SCRIPT` and `ONNX`. |
5858
`description` | String | Optional| The model description. |
5959
`model_group_id` | String | Optional | The ID of the model group to which to register the model.
60+
`provisioned_by` | String | Optional | An optional attribution tag identifying the plugin or client that registered the model (for example, `"flow-framework"`). Included in ML stats metrics.
6061

6162
## Example request: OpenSearch-provided text embedding model
6263

@@ -89,6 +90,7 @@ Field | Data type | Required/Optional | Description
8990
`url` | String | Required | The URL that contains the model. |
9091
`description` | String | Optional| The model description. |
9192
`model_group_id` | String | Optional | The ID of the model group to which to register this model.
93+
`provisioned_by` | String | Optional | An optional attribution tag identifying the plugin or client that registered the model (for example, `"flow-framework"`). Included in ML stats metrics.
9294

9395
## Example request: OpenSearch-provided sparse encoding model
9496

@@ -125,6 +127,7 @@ Field | Data type | Required/Optional | Description
125127
`is_enabled`| Boolean | Optional | Specifies whether the model is enabled. Disabling the model makes it unavailable for Predict API requests, regardless of the model's deployment status. Default is `true`.
126128
`rate_limiter` | Object | Optional | Limits the number of times that any user can call the Predict API on the model. For more information, see [Rate limiting inference calls]({{site.url}}{{site.baseurl}}/ml-commons-plugin/integrating-ml-models/#rate-limiting-inference-calls).
127129
`interface`| Object | Optional | The interface for the model. For more information, see [Interface](#the-interface-parameter).|
130+
`provisioned_by` | String | Optional | An optional attribution tag identifying the plugin or client that registered the model (for example, `"flow-framework"`). Included in ML stats metrics.
128131

129132
#### The `model_config` object
130133

@@ -188,6 +191,7 @@ Field | Data type | Required/Optional | Description
188191
`rate_limiter` | Object | Optional | Limits the number of times that any user can call the Predict API on the model. For more information, see [Rate limiting inference calls]({{site.url}}{{site.baseurl}}/ml-commons-plugin/integrating-ml-models/#rate-limiting-inference-calls).
189192
`guardrails`| Object | Optional | The guardrails for the model input. For more information, see [Guardrails](#the-guardrails-parameter).|
190193
`interface`| Object | Optional | The interface for the model. For more information, see [Interface](#the-interface-parameter).|
194+
`provisioned_by` | String | Optional | An optional attribution tag identifying the plugin or client that registered the model (for example, `"flow-framework"`). Included in ML stats metrics.
191195

192196
## Example request: Externally hosted with a standalone connector
193197

_ml-commons-plugin/remote-models/blueprints.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ As an ML developer, you can build connector blueprints for other platforms. Usin
6969
| `add_all_backend_roles` | Boolean | Yes | When set to `true`, adds all `backend_roles` to the access list, which only a user with admin permissions can adjust. When set to `false`, non-admins can add `backend_roles`. |
7070
| `client_config` | JSON object | No | The client configuration object, which provides settings that control the behavior of the client connections used by the connector. These settings allow you to manage connection limits and timeouts, ensuring efficient and reliable communication. |
7171
| `parameters.skip_validating_missing_parameters` | Boolean | No | When set to `true`, this option allows you to send a request using a connector without validating any missing parameters. Default is `false`. |
72+
| `provisioned_by` | String | No | An optional attribution tag identifying the plugin or client that provisioned the connector (for example, `"flow-framework"`). Included in ML stats metrics. Set at creation time only; ignored by the Update Connector API. |
7273

7374

7475
The `actions` parameter supports the following options.

0 commit comments

Comments
 (0)