You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: _ml-commons-plugin/api/agent-apis/register-agent.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,6 +61,7 @@ Field | Data type | Required/Optional | Agent type | Description
61
61
`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`.
62
62
`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).
63
63
`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.
Copy file name to clipboardExpand all lines: _ml-commons-plugin/api/model-apis/register-model.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,6 +57,7 @@ Field | Data type | Required/Optional | Description
57
57
`model_format` | String | Required | The portable format of the model file. Valid values are `TORCH_SCRIPT` and `ONNX`. |
58
58
`description` | String | Optional| The model description. |
59
59
`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.
60
61
61
62
## Example request: OpenSearch-provided text embedding model
62
63
@@ -89,6 +90,7 @@ Field | Data type | Required/Optional | Description
89
90
`url` | String | Required | The URL that contains the model. |
90
91
`description` | String | Optional| The model description. |
91
92
`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.
92
94
93
95
## Example request: OpenSearch-provided sparse encoding model
94
96
@@ -125,6 +127,7 @@ Field | Data type | Required/Optional | Description
125
127
`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`.
126
128
`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).
127
129
`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.
128
131
129
132
#### The `model_config` object
130
133
@@ -188,6 +191,7 @@ Field | Data type | Required/Optional | Description
188
191
`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).
189
192
`guardrails`| Object | Optional | The guardrails for the model input. For more information, see [Guardrails](#the-guardrails-parameter).|
190
193
`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.
191
195
192
196
## Example request: Externally hosted with a standalone connector
Copy file name to clipboardExpand all lines: _ml-commons-plugin/remote-models/blueprints.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,6 +69,7 @@ As an ML developer, you can build connector blueprints for other platforms. Usin
69
69
|`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`. |
70
70
|`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. |
71
71
|`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. |
72
73
73
74
74
75
The `actions` parameter supports the following options.
0 commit comments