Skip to main content

modules

clarifai-nodejs / Exports

clarifai-nodejs

Table of contents

Classes

Type Aliases

Type Aliases

AppConfig

Ƭ AppConfig: { authConfig: Omit\<AuthConfig, "appId" | "userId"> & { appId?: undefined ; userId?: undefined } ; url: ClarifaiAppUrl } | { authConfig: AuthConfig ; url?: undefined }

Defined in

client/app.ts:52


CreateDatasetParam

Ƭ CreateDatasetParam: Object

Type declaration

NameType
appIdundefined | string
bookmarkOriginundefined | AsObject
createdAtundefined | AsObject
defaultAnnotationFilterundefined | AsObject
defaultProcessingInfoundefined | AsObject
descriptionundefined | string
imageundefined | AsObject
isStarredundefined | boolean
metadataundefined | AsObject
modifiedAtundefined | AsObject
notesundefined | string
starCountundefined | number
userIdundefined | string
versionundefined | AsObject
visibilityundefined | AsObject

Defined in

client/app.ts:75


CreateModelParam

Ƭ CreateModelParam: Object

Type declaration

NameType
appIdundefined | string
bookmarkOriginundefined | AsObject
checkConsentsListundefined | string[]
createdAtundefined | AsObject
defaultEvalInfoundefined | AsObject
descriptionundefined | string
displayNameundefined | string
imageundefined | AsObject
isStarredundefined | boolean
languagesFullListundefined | AsObject[]
languagesListundefined | string[]
metadataundefined | AsObject
modelTypeIdundefined | string
modelVersionundefined | AsObject
modifiedAtundefined | AsObject
nameundefined | string
notesundefined | string
outputInfoundefined | AsObject
presetsundefined | AsObject
starCountundefined | number
taskundefined | string
toolkitsListundefined | string[]
useCasesListundefined | string[]
userIdundefined | string
visibilityundefined | AsObject
workflowRecommendedundefined | AsObject

Defined in

client/app.ts:76


ListAppsRequestParams

Ƭ ListAppsRequestParams: Object

Type declaration

NameType
additionalFieldsListundefined | string[]
featuredOnlyundefined | boolean
idundefined | string
nameundefined | string
pageundefined | number
queryundefined | string
searchundefined | string
sortAscendingundefined | boolean
sortByCreatedAtundefined | boolean
sortByModifiedAtundefined | boolean
sortByNameundefined | boolean
sortByStarCountundefined | boolean
starredOnlyundefined | boolean
templateOnlyundefined | boolean

Defined in

client/user.ts:28


ListDatasetsParam

Ƭ ListDatasetsParam: Object

Type declaration

NameType
additionalFieldsListundefined | string[]
bookmarkundefined | boolean
idundefined | string
pageundefined | number
searchundefined | string
sortAscendingundefined | boolean
sortByCreatedAtundefined | boolean
sortByIdundefined | boolean
sortByModifiedAtundefined | boolean
sortByStarCountundefined | boolean
starredOnlyundefined | boolean

Defined in

client/app.ts:65


ListInstalledModuleVersionsParam

Ƭ ListInstalledModuleVersionsParam: Object

Type declaration

NameType
pageundefined | number

Defined in

client/app.ts:73


ListModelsParam

Ƭ ListModelsParam: Object

Type declaration

NameType
additionalFieldsListundefined | string[]
bookmarkundefined | boolean
dontFetchFromMainundefined | boolean
featuredOnlyundefined | boolean
filterByUserIdundefined | boolean
inputFieldsListundefined | string[]
languagesListundefined | string[]
licenseundefined | string
modelTypeIdundefined | string
nameundefined | string
outputFieldsListundefined | string[]
pageundefined | number
queryundefined | string
searchundefined | string
sortAscendingundefined | boolean
sortByCreatedAtundefined | boolean
sortByModifiedAtundefined | boolean
sortByNameundefined | boolean
sortByNumInputsundefined | boolean
sortByStarCountundefined | boolean
starredOnlyundefined | boolean
toolkitsListundefined | string[]
trainedOnlyundefined | boolean
useCasesListundefined | string[]

Defined in

client/app.ts:67


ListModulesParam

Ƭ ListModulesParam: Object

Type declaration

NameType
additionalFieldsListundefined | string[]
bookmarkundefined | boolean
filterByUserIdundefined | boolean
nameundefined | string
pageundefined | number
searchundefined | string
sortAscendingundefined | boolean
sortByCreatedAtundefined | boolean
sortByIdundefined | boolean
sortByModifiedAtundefined | boolean
sortByStarCountundefined | boolean
starredOnlyundefined | boolean

Defined in

client/app.ts:71


ListRunnersRequestParams

Ƭ ListRunnersRequestParams: Object

Type declaration

NameType
pageundefined | number

Defined in

client/user.ts:30


ListWorkflowsParam

Ƭ ListWorkflowsParam: Object

Type declaration

NameType
additionalFieldsListundefined | string[]
bookmarkundefined | boolean
featuredOnlyundefined | boolean
idundefined | string
pageundefined | number
queryundefined | string
searchundefined | string
searchTermundefined | string
sortAscendingundefined | boolean
sortByCreatedAtundefined | boolean
sortByIdundefined | boolean
sortByModifiedAtundefined | boolean
sortByStarCountundefined | boolean
starredOnlyundefined | boolean

Defined in

client/app.ts:69


UserConfig

Ƭ UserConfig: Object

Type declaration

NameType
appIdstring
baseundefined | string
patstring
tokenundefined | string
uiundefined | string
userIdstring

Defined in

client/user.ts:27