v1

latestOpenAPI 3.0.12026-08-06292853.3 KB
Samples

List Samples for a Function

get/v1/functions/{functionId}/samples

Path parameters

functionIdstring required

Query parameters

externalIdstring

The externalId of the Sample

startIndexinteger

The zero-based index of the first result to return

countinteger

The number of results to return

cursorstring

The Id of the first Sample in the ascending-order list of Samples

maxItemsinteger

The maximum number of Samples desired over a sequence of API calls

batchSizeinteger

The maximum number of Samples to return in this API call

lastItemIndexinteger

The index for the last item from the previous query, useful for displaying pagination state

annotatedboolean

Whether the sample is annotated

predictedboolean

Whether the sample is predicted

annotationLabelIdstring

The label id for the annotation

predictionLabelIdstring

The label id for the prediction

predictionAndAnnotationAgreeboolean

Whether the annotation and the prediction agrees

captureReason'Random' | 'Uncertain' | 'RareClass' | 'LowAccuracyClass' | 'CaptureAll'

The capture reason of the sample

origin'Unspecified' | 'InvokeCapture'

The origin of the sample (e.g. InvokeCapture)

searchTextstring

Text that should be present in the sample data

sampleIdsstring[]

The list of sample ids to return

sampleSetIdstring

The sample set that the returned samples must belong to

inTrainSetboolean

Whether the returned samples must be in the training set

createdBeforestring date-time

Date on or before which the sample was created

createdAfterstring date-time

Date on or after which the sample was created

sortBy'Default' | 'Annotation' | 'Creation' | 'Confidence' | 'Agreement'

How the Samples are sorted for paging and returning

sortOrder'Ascending' | 'Descending'

The order of sorting samples for paging and returning. Only used when sortBy is specified

includeDataboolean

Whether to include the sample data in the response. Defaults to true

Response

Success

externalIdstring nullable
idstring nullable