Ground Truth

Provide ground truth data to validate the results of a previously successful inference call. This data should list what objects were included in the final transaction, and may not be a perfect match to what was detected in the original inference call.

Request

This endpoint expects an object.

organizationIdstringRequiredformat: "uuid"

Your organization's unique identifier.

transactionTimedatetimeRequired

The date and time of the request.

inferenceIdstringRequiredformat: "uuid"

A unique identifier for the results of a successful inference call.

inferencePointIdstringOptionalformat: "uuid"

The unique identifier for the inference point within your organization used for the original inference call.

transactionPayloadobjectOptional

An array of objects included in the final transaction record related to the previously successful inference call.

Response

201 - Ground Truth Payload Successful

idstring or nullformat: "uuid"

A unique identifier for a successfully posted ground truth payload.

transactionPayloadlist of objects or null

An array of objects included in the final transaction record related to the previously successful inference call.

1	import requests
2
3	url = "https://api.amniscient.com/inference/ground-truth"
4
5	payload = {
6	"organizationId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
7	"transactionTime": "2024-01-15T09:30:00Z",
8	"inferenceId": "d9f8e7c6-b5a4-3210-9f8e-d7c6b5a43210"
9	}
10	headers = {
11	"x-api-key": "x-api-key",
12	"Content-Type": "application/json"
13	}
14
15	response = requests.post(url, json=payload, headers=headers)
16
17	print(response.json())

1	{
2	"id": "60b7c352-12af-43a6-9e1a-dc5bed42470e",
3	"transactionPayload": [
4	{
5	"detectionItemId": "ef404ff0-eaa7-49b5-b7ed-eddc3c45defc",
6	"quantity": 3
7	},
8	{
9	"detectionItemId": "a3b2c1d4-e5f6-7890-ab12-cd34ef567891",
10	"quantity": 1
11	}
12	]
13	}

Headers

Request

Response

Errors