ObjectiveService
Objectives

Submit feedback for an objective

Submits feedback for an objective's execution. Feedback scores are used by the agent variation scoring system to evaluate and rank variation performance.

post/v1/workspaces/{workspaceId}/objectives/{objectiveId}/feedback

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q
objectiveIdstring required
Example:obj_01HXKD2E5NQM3T9AYWCFQAZGFV

The ID of the objective. Supports "external_id:" prefix for external IDs.

Request body

workspaceIdstring
objectiveIdstring

The ID of the objective. Supports "external_id:" prefix for external IDs.

Example request

{
  "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
  "objectiveId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV"
}

Response

OK

Example response

{
  "metadata": {
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  },
  "info": {
    "submittedBy": {
      "metadata": {
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
      }
    }
  }
}

Changes

Changed in 2 of the 57 revisions of this API.11

    • added the optional property info/submittedBy/allOf[Profile]/metadata/createdAt to the response with the 200 status

      response-optional-property-added

    This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new PROFILE_TYPE_UNSPECIFIED enum value to the info/submittedBy/allOf[Profile]/spec/type response property for the response status 200

      response-property-enum-value-added