fiftyone.relay¶

Types¶

class fiftyone.relay.AggregationForm()¶

AggregationForm¶

Name	Type	Description
AggregationForm.dataset	`string`
AggregationForm.extendedStages	`Array<` `any` `>`
AggregationForm.filters	`Union<` `object` `,` `null` `>`
AggregationForm.groupId	`Union<` `string` `,` `null` `>`
AggregationForm.hiddenLabels	`ReadonlyArray < SelectedLabel >` `<` `fiftyone.relay.SelectedLabel()` `>`
AggregationForm.index	`Union<` `number` `,` `null` `>`
AggregationForm.mixed	`boolean`
AggregationForm.paths	`ReadonlyArray < string >` `<` `string` `>`
AggregationForm.sampleIds	`ReadonlyArray < string >` `<` `string` `>`
AggregationForm.slice	`Union<` `string` `,` `null` `>`
AggregationForm.view	`Array<` `any` `>`
AggregationForm.viewName	`Union<` `string` `,` `null` `>`

class fiftyone.relay.ColorBy()¶

ColorBy¶

Union of 'field'(), 'instance'(), 'label'(), '%future added value'()

class fiftyone.relay.ExtendedViewForm()¶

ExtendedViewForm¶

Name	Type	Description
ExtendedViewForm.filters	`Union<` `object` `,` `null` `>`
ExtendedViewForm.mixed	`Union<` `boolean` `,` `null` `>`
ExtendedViewForm.sampleIds	`Union<` `ReadonlyArray < string >` `,` `null` `>`
ExtendedViewForm.slice	`Union<` `string` `,` `null` `>`

class fiftyone.relay.GroupElementFilter()¶

GroupElementFilter¶

Name	Type	Description
GroupElementFilter.id	`Union<` `string` `,` `null` `>`
GroupElementFilter.slice	`Union<` `string` `,` `null` `>`

class fiftyone.relay.MediaType()¶

MediaType¶

Union of 'group'(), 'image'(), 'point_cloud'(), 'video'(), '%future added value'()

class fiftyone.relay.SampleFilter()¶

SampleFilter¶

Name	Type	Description
SampleFilter.group	`Union<` `fiftyone.relay.GroupElementFilter()` `,` `null` `>`
SampleFilter.id	`Union<` `string` `,` `null` `>`

class fiftyone.relay.SavedViewInfo()¶

SavedViewInfo¶

Name	Type	Description
SavedViewInfo.color	`Union<` `string` `,` `null` `>`
SavedViewInfo.description	`Union<` `string` `,` `null` `>`
SavedViewInfo.name	`Union<` `string` `,` `null` `>`

class fiftyone.relay.SelectedLabel()¶

SelectedLabel¶

Name	Type	Description
SelectedLabel.field	`string`
SelectedLabel.frameNumber	`Union<` `number` `,` `null` `>`
SelectedLabel.labelId	`string`
SelectedLabel.sampleId	`string`

class fiftyone.relay.SidebarGroupInput()¶

SidebarGroupInput¶

Name	Type	Description
SidebarGroupInput.expanded	`Union<` `boolean` `,` `null` `>`
SidebarGroupInput.name	`string`
SidebarGroupInput.paths	`Union<` `ReadonlyArray < string >` `,` `null` `>`

class fiftyone.relay.SidebarMode()¶

SidebarMode¶

Union of 'all'(), 'best'(), 'fast'(), '%future added value'()

class fiftyone.relay.StateForm()¶

StateForm¶

Name	Type	Description
StateForm.addStages	`Union<` `Array< any >` `,` `null` `>`
StateForm.extended	`Union<` `object` `,` `null` `>`
StateForm.filters	`Union<` `object` `,` `null` `>`
StateForm.labels	`Union<` `ReadonlyArray < SelectedLabel >` `,` `null` `>`
StateForm.sampleIds	`Union<` `ReadonlyArray < string >` `,` `null` `>`
StateForm.slice	`Union<` `string` `,` `null` `>`

class fiftyone.relay.Theme()¶

Theme¶

Union of 'browser'(), 'dark'(), 'light'(), '%future added value'()

class fiftyone.relay.aggregationsQuery()¶

aggregationsQuery¶

Name	Type	Description
aggregationsQuery.response	`fiftyone.relay.aggregationsQuery$data()`
aggregationsQuery.variables	`fiftyone.relay.aggregationsQuery$variables()`

class fiftyone.relay.aggregationsQuery$data()¶

aggregationsQuery$data¶

Name	Type	Description
aggregationsQuery$data.aggregations	`ReadonlyArray < >` `<` `Object` `>`

class fiftyone.relay.aggregationsQuery$variables()¶

aggregationsQuery$variables¶

Name	Type	Description
aggregationsQuery$variables.form	`fiftyone.relay.AggregationForm()`

class fiftyone.relay.configQuery()¶

configQuery¶

Name	Type	Description
configQuery.response	`fiftyone.relay.configQuery$data()`
configQuery.variables	`fiftyone.relay.configQuery$variables()`

class fiftyone.relay.configQuery$data()¶

configQuery$data¶

Name	Type	Description
configQuery$data.colorscale	`Union<` `ReadonlyArray < ReadonlyArray >` `,` `null` `>`
configQuery$data.config	`Object`

class fiftyone.relay.configQuery$variables()¶

configQuery$variables¶

class fiftyone.relay.countValuesQuery()¶

countValuesQuery¶

Name	Type	Description
countValuesQuery.response	`fiftyone.relay.countValuesQuery$data()`
countValuesQuery.variables	`fiftyone.relay.countValuesQuery$variables()`

class fiftyone.relay.countValuesQuery$data()¶

countValuesQuery$data¶

Name	Type	Description
countValuesQuery$data.aggregate	`ReadonlyArray < >` `<` `Union< , , >` `>`

class fiftyone.relay.countValuesQuery$variables()¶

countValuesQuery$variables¶

Name	Type	Description
countValuesQuery$variables.dataset	`string`
countValuesQuery$variables.form	`Union<` `fiftyone.relay.ExtendedViewForm()` `,` `null` `>`
countValuesQuery$variables.path	`string`
countValuesQuery$variables.view	`Array<` `any` `>`

class fiftyone.relay.createSavedViewMutation()¶

createSavedViewMutation¶

Name	Type	Description
createSavedViewMutation.response	`fiftyone.relay.createSavedViewMutation$data()`
createSavedViewMutation.variables	`fiftyone.relay.createSavedViewMutation$variables()`

class fiftyone.relay.createSavedViewMutation$data()¶

createSavedViewMutation$data¶

Name	Type	Description
createSavedViewMutation$data.createSavedView	`Union<` `Object` `,` `null` `>`

class fiftyone.relay.createSavedViewMutation$variables()¶

createSavedViewMutation$variables¶

Name	Type	Description
createSavedViewMutation$variables.color	`Union<` `string` `,` `null` `>`
createSavedViewMutation$variables.datasetName	`Union<` `string` `,` `null` `>`
createSavedViewMutation$variables.description	`Union<` `string` `,` `null` `>`
createSavedViewMutation$variables.form	`Union<` `fiftyone.relay.StateForm()` `,` `null` `>`
createSavedViewMutation$variables.session	`Union<` `string` `,` `null` `>`
createSavedViewMutation$variables.subscription	`string`
createSavedViewMutation$variables.viewName	`string`
createSavedViewMutation$variables.viewStages	`Union<` `Array< any >` `,` `null` `>`

class fiftyone.relay.deleteSavedViewMutation()¶

deleteSavedViewMutation¶

Name	Type	Description
deleteSavedViewMutation.response	`fiftyone.relay.deleteSavedViewMutation$data()`
deleteSavedViewMutation.variables	`fiftyone.relay.deleteSavedViewMutation$variables()`

class fiftyone.relay.deleteSavedViewMutation$data()¶

deleteSavedViewMutation$data¶

Name	Type	Description
deleteSavedViewMutation$data.deleteSavedView	`Union<` `string` `,` `null` `>`

class fiftyone.relay.deleteSavedViewMutation$variables()¶

deleteSavedViewMutation$variables¶

Name	Type	Description
deleteSavedViewMutation$variables.datasetName	`Union<` `string` `,` `null` `>`
deleteSavedViewMutation$variables.session	`Union<` `string` `,` `null` `>`
deleteSavedViewMutation$variables.subscription	`string`
deleteSavedViewMutation$variables.viewName	`string`

class fiftyone.relay.histogramValuesQuery()¶

histogramValuesQuery¶

Name	Type	Description
histogramValuesQuery.response	`fiftyone.relay.histogramValuesQuery$data()`
histogramValuesQuery.variables	`fiftyone.relay.histogramValuesQuery$variables()`

class fiftyone.relay.histogramValuesQuery$data()¶

histogramValuesQuery$data¶

Name	Type	Description
histogramValuesQuery$data.aggregate	`ReadonlyArray < >` `<` `Union< , , , >` `>`

class fiftyone.relay.histogramValuesQuery$variables()¶

histogramValuesQuery$variables¶

Name	Type	Description
histogramValuesQuery$variables.dataset	`string`
histogramValuesQuery$variables.form	`Union<` `fiftyone.relay.ExtendedViewForm()` `,` `null` `>`
histogramValuesQuery$variables.path	`string`
histogramValuesQuery$variables.view	`Array<` `any` `>`

class fiftyone.relay.mainSampleQuery()¶

mainSampleQuery¶

Name	Type	Description
mainSampleQuery.response	`fiftyone.relay.mainSampleQuery$data()`
mainSampleQuery.variables	`fiftyone.relay.mainSampleQuery$variables()`

class fiftyone.relay.mainSampleQuery$data()¶

mainSampleQuery$data¶

Name	Type	Description
mainSampleQuery$data.sample	`Union<` `Object` `,` `null` `>`

class fiftyone.relay.mainSampleQuery$variables()¶

mainSampleQuery$variables¶

Name	Type	Description
mainSampleQuery$variables.dataset	`string`
mainSampleQuery$variables.filter	`fiftyone.relay.SampleFilter()`
mainSampleQuery$variables.view	`Array<` `any` `>`

class fiftyone.relay.paginateGroupPageQuery()¶

paginateGroupPageQuery¶

Name	Type	Description
paginateGroupPageQuery.response	`fiftyone.relay.paginateGroupPageQuery$data()`
paginateGroupPageQuery.variables	`fiftyone.relay.paginateGroupPageQuery$variables()`

class fiftyone.relay.paginateGroupPageQuery$data()¶

paginateGroupPageQuery$data¶

Name	Type	Description
paginateGroupPageQuery$data. $fragmentSpreads	`FragmentRefs < >` `<` `'paginateGroup_query'` `>`

class fiftyone.relay.paginateGroupPageQuery$variables()¶

paginateGroupPageQuery$variables¶

Name	Type	Description
paginateGroupPageQuery$variables.count	`Union<` `number` `,` `null` `>`
paginateGroupPageQuery$variables.cursor	`Union<` `string` `,` `null` `>`
paginateGroupPageQuery$variables.dataset	`string`
paginateGroupPageQuery$variables.filter	`Union<` `fiftyone.relay.SampleFilter()` `,` `null` `>`
paginateGroupPageQuery$variables.view	`Array<` `any` `>`

class fiftyone.relay.paginateGroupQuery()¶

paginateGroupQuery¶

Name	Type	Description
paginateGroupQuery.response	`fiftyone.relay.paginateGroupQuery$data()`
paginateGroupQuery.variables	`fiftyone.relay.paginateGroupQuery$variables()`

class fiftyone.relay.paginateGroupQuery$data()¶

paginateGroupQuery$data¶

Name	Type	Description
paginateGroupQuery$data. $fragmentSpreads	`FragmentRefs < >` `<` `'paginateGroup_query'` `>`

class fiftyone.relay.paginateGroupQuery$variables()¶

paginateGroupQuery$variables¶

Name	Type	Description
paginateGroupQuery$variables.count	`Union<` `number` `,` `null` `>`
paginateGroupQuery$variables.cursor	`Union<` `string` `,` `null` `>`
paginateGroupQuery$variables.dataset	`string`
paginateGroupQuery$variables.filter	`fiftyone.relay.SampleFilter()`
paginateGroupQuery$variables.view	`Array<` `any` `>`

class fiftyone.relay.paginateGroup_query$data()¶

paginateGroup_query$data¶

Name	Type	Description
paginateGroup_query$data. $fragmentType	`'paginateGroup_query'`
paginateGroup_query$data.samples	`Object`

class fiftyone.relay.paginateGroup_query$key()¶

paginateGroup_query$key¶

Name	Type	Description
paginateGroup_query$key. $data	`fiftyone.relay.paginateGroup_query$data()`
paginateGroup_query$key. $fragmentSpreads	`FragmentRefs < >` `<` `'paginateGroup_query'` `>`

class fiftyone.relay.pinnedSampleQuery()¶

pinnedSampleQuery¶

Name	Type	Description
pinnedSampleQuery.response	`fiftyone.relay.pinnedSampleQuery$data()`
pinnedSampleQuery.variables	`fiftyone.relay.pinnedSampleQuery$variables()`

class fiftyone.relay.pinnedSampleQuery$data()¶

pinnedSampleQuery$data¶

Name	Type	Description
pinnedSampleQuery$data.sample	`Union<` `Object` `,` `null` `>`

class fiftyone.relay.pinnedSampleQuery$variables()¶

pinnedSampleQuery$variables¶

Name	Type	Description
pinnedSampleQuery$variables.dataset	`string`
pinnedSampleQuery$variables.filter	`fiftyone.relay.SampleFilter()`
pinnedSampleQuery$variables.view	`Array<` `any` `>`

class fiftyone.relay.setDatasetMutation()¶

setDatasetMutation¶

Name	Type	Description
setDatasetMutation.response	`fiftyone.relay.setDatasetMutation$data()`
setDatasetMutation.variables	`fiftyone.relay.setDatasetMutation$variables()`

class fiftyone.relay.setDatasetMutation$data()¶

setDatasetMutation$data¶

Name	Type	Description
setDatasetMutation$data.setDataset	`boolean`

class fiftyone.relay.setDatasetMutation$variables()¶

setDatasetMutation$variables¶

Name	Type	Description
setDatasetMutation$variables.name	`Union<` `string` `,` `null` `>`
setDatasetMutation$variables.session	`Union<` `string` `,` `null` `>`
setDatasetMutation$variables.subscription	`string`
setDatasetMutation$variables.viewName	`Union<` `string` `,` `null` `>`

class fiftyone.relay.setGroupSliceMutation()¶

setGroupSliceMutation¶

Name	Type	Description
setGroupSliceMutation.response	`fiftyone.relay.setGroupSliceMutation$data()`
setGroupSliceMutation.variables	`fiftyone.relay.setGroupSliceMutation$variables()`

class fiftyone.relay.setGroupSliceMutation$data()¶

setGroupSliceMutation$data¶

Name	Type	Description
setGroupSliceMutation$data.setGroupSlice	`Object`

class fiftyone.relay.setGroupSliceMutation$variables()¶

setGroupSliceMutation$variables¶

Name	Type	Description
setGroupSliceMutation$variables.session	`Union<` `string` `,` `null` `>`
setGroupSliceMutation$variables.slice	`string`
setGroupSliceMutation$variables.subscription	`string`
setGroupSliceMutation$variables.view	`Array<` `any` `>`
setGroupSliceMutation$variables.viewName	`Union<` `string` `,` `null` `>`

class fiftyone.relay.setSelectedLabelsMutation()¶

setSelectedLabelsMutation¶

Name	Type	Description
setSelectedLabelsMutation.response	`fiftyone.relay.setSelectedLabelsMutation$data()`
setSelectedLabelsMutation.variables	`fiftyone.relay.setSelectedLabelsMutation$variables()`

class fiftyone.relay.setSelectedLabelsMutation$data()¶

setSelectedLabelsMutation$data¶

Name	Type	Description
setSelectedLabelsMutation$data.setSelectedLabels	`boolean`

class fiftyone.relay.setSelectedLabelsMutation$variables()¶

setSelectedLabelsMutation$variables¶

Name	Type	Description
setSelectedLabelsMutation$variables.selectedLabels	`ReadonlyArray < SelectedLabel >` `<` `fiftyone.relay.SelectedLabel()` `>`
setSelectedLabelsMutation$variables.session	`Union<` `string` `,` `null` `>`
setSelectedLabelsMutation$variables.subscription	`string`

class fiftyone.relay.setSelectedMutation()¶

setSelectedMutation¶

Name	Type	Description
setSelectedMutation.response	`fiftyone.relay.setSelectedMutation$data()`
setSelectedMutation.variables	`fiftyone.relay.setSelectedMutation$variables()`

class fiftyone.relay.setSelectedMutation$data()¶

setSelectedMutation$data¶

Name	Type	Description
setSelectedMutation$data.setSelected	`boolean`

class fiftyone.relay.setSelectedMutation$variables()¶

setSelectedMutation$variables¶

Name	Type	Description
setSelectedMutation$variables.selected	`ReadonlyArray < string >` `<` `string` `>`
setSelectedMutation$variables.session	`Union<` `string` `,` `null` `>`
setSelectedMutation$variables.subscription	`string`

class fiftyone.relay.setSidebarGroupsMutation()¶

setSidebarGroupsMutation¶

Name	Type	Description
setSidebarGroupsMutation.response	`fiftyone.relay.setSidebarGroupsMutation$data()`
setSidebarGroupsMutation.variables	`fiftyone.relay.setSidebarGroupsMutation$variables()`

class fiftyone.relay.setSidebarGroupsMutation$data()¶

setSidebarGroupsMutation$data¶

Name	Type	Description
setSidebarGroupsMutation$data.setSidebarGroups	`boolean`

class fiftyone.relay.setSidebarGroupsMutation$variables()¶

setSidebarGroupsMutation$variables¶

Name	Type	Description
setSidebarGroupsMutation$variables.dataset	`string`
setSidebarGroupsMutation$variables.session	`Union<` `string` `,` `null` `>`
setSidebarGroupsMutation$variables.sidebarGroups	`ReadonlyArray < SidebarGroupInput >` `<` `fiftyone.relay.SidebarGroupInput()` `>`
setSidebarGroupsMutation$variables.stages	`Array<` `any` `>`
setSidebarGroupsMutation$variables.subscription	`string`

class fiftyone.relay.setSpacesMutation()¶

setSpacesMutation¶

Name	Type	Description
setSpacesMutation.response	`fiftyone.relay.setSpacesMutation$data()`
setSpacesMutation.variables	`fiftyone.relay.setSpacesMutation$variables()`

class fiftyone.relay.setSpacesMutation$data()¶

setSpacesMutation$data¶

Name	Type	Description
setSpacesMutation$data.setSpaces	`boolean`

class fiftyone.relay.setSpacesMutation$variables()¶

setSpacesMutation$variables¶

Name	Type	Description
setSpacesMutation$variables.session	`Union<` `string` `,` `null` `>`
setSpacesMutation$variables.spaces	`object`
setSpacesMutation$variables.subscription	`string`

class fiftyone.relay.setViewMutation()¶

setViewMutation¶

Name	Type	Description
setViewMutation.response	`fiftyone.relay.setViewMutation$data()`
setViewMutation.variables	`fiftyone.relay.setViewMutation$variables()`

class fiftyone.relay.setViewMutation$data()¶

setViewMutation$data¶

Name	Type	Description
setViewMutation$data.setView	`Object`

class fiftyone.relay.setViewMutation$variables()¶

setViewMutation$variables¶

Name	Type	Description
setViewMutation$variables.datasetName	`string`
setViewMutation$variables.form	`fiftyone.relay.StateForm()`
setViewMutation$variables.savedViewSlug	`Union<` `string` `,` `null` `>`
setViewMutation$variables.session	`Union<` `string` `,` `null` `>`
setViewMutation$variables.subscription	`string`
setViewMutation$variables.view	`Array<` `any` `>`

class fiftyone.relay.updateSavedViewMutation()¶

updateSavedViewMutation¶

Name	Type	Description
updateSavedViewMutation.response	`fiftyone.relay.updateSavedViewMutation$data()`
updateSavedViewMutation.variables	`fiftyone.relay.updateSavedViewMutation$variables()`

class fiftyone.relay.updateSavedViewMutation$data()¶

updateSavedViewMutation$data¶

Name	Type	Description
updateSavedViewMutation$data.updateSavedView	`Union<` `Object` `,` `null` `>`

class fiftyone.relay.updateSavedViewMutation$variables()¶

updateSavedViewMutation$variables¶

Name	Type	Description
updateSavedViewMutation$variables.datasetName	`Union<` `string` `,` `null` `>`
updateSavedViewMutation$variables.session	`Union<` `string` `,` `null` `>`
updateSavedViewMutation$variables.subscription	`string`
updateSavedViewMutation$variables.updatedInfo	`fiftyone.relay.SavedViewInfo()`
updateSavedViewMutation$variables.viewName	`string`

Variables¶

aggregation¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`

config¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`

countValues¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`

createSavedView¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`

deleteSavedView¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`

histogramValues¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`

mainSample¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`

paginateGroup¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`

paginateGroupPaginationFragment¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`

pinnedSample¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`

setDataset¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`

setGroupSlice¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`

setSelected¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`

setSelectedLabels¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`

setSidebarGroups¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`

setSpaces¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`

setView¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`

updateSavedView¶

Name	Type	Description
GraphQLTaggedNode	`GraphQLTaggedNode`