Composway Docs
Tool reference

Get evaluation/optimization result

Poll an evaluate_article or optimize_article background job by its jobId.

Tool name: get_evaluation_result

Cost: Free - not billed, and does not draw on a plan quota.

Read-only

This tool only reads. It never creates or changes anything, so an assistant may call it without asking you first.

Poll an evaluate_article or optimize_article background job by its jobId. Returns { jobId, status, kind, cached, result, error }. Status is one of "queued", "running", "completed", "failed". When "completed", result holds the score (and, for optimize, the improved article). When "failed", error explains why. Poll about every 5 seconds while queued/running.

Parameters

ParameterTypeRequiredNotes
jobIdstring (uuid)Yes-
Full input JSON Schema
{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"type": "object",
	"properties": {
		"jobId": {
			"type": "string",
			"format": "uuid",
			"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
		}
	},
	"required": ["jobId"]
}

Response

Full output JSON Schema
{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"type": "object",
	"properties": {
		"jobId": {
			"type": "string",
			"format": "uuid",
			"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
		},
		"status": {
			"type": "string"
		},
		"kind": {
			"type": "string"
		},
		"cached": {
			"type": "boolean"
		},
		"result": {
			"anyOf": [
				{
					"type": "object",
					"propertyNames": {
						"type": "string"
					},
					"additionalProperties": {}
				},
				{
					"type": "null"
				}
			]
		},
		"error": {
			"anyOf": [
				{
					"type": "string"
				},
				{
					"type": "null"
				}
			]
		}
	},
	"required": ["jobId", "status", "kind"],
	"additionalProperties": false
}

On this page