Skip to content

[DOC] Add created_by field to connector, model, and agent API documentation #12179

@dbwiddis

Description

@dbwiddis

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request.

The created_by field is being added to connectors, models, and agents in ml-commons (targeting OpenSearch 3.7). This field identifies the calling plugin or client (for example, "flow-framework") for metrics attribution via ML Commons tag feature. It is set at creation time only and is not updatable.

The following documentation pages need a new optional created_by String field added to their request body field tables:

  • _ml-commons-plugin/remote-models/blueprints.md: the canonical connector configuration parameters table (linked from both Create Connector and Update Connector API pages). Description: The name of the plugin or client creating the resource, used for metrics (for example, "flow-framework"). Optional. Set at creation time only; ignored by the Update Connector API.
  • _ml-commons-plugin/api/model-apis/register-model.md: needs the field added to all three request body tables (pretrained, custom, and externally hosted model sections).
  • _ml-commons-plugin/api/agent-apis/register-agent.md: needs the field added to the request body fields table.

Version: List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all.

3.7.0

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

Metadata

Metadata

Assignees

Labels

In progressIssue/PR: The issue or PR is in progress.v3.7.0

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions