API Reference

clarifai-nodejs / Exports

clarifai-nodejs

Table of contents

Classes

• App
• Input
• Model
• Search
• User
• Workflow

Type Aliases

• AppConfig
• CreateDatasetParam
• CreateModelParam
• ListAppsRequestParams
• ListDatasetsParam
• ListInstalledModuleVersionsParam
• ListModelsParam
• ListModulesParam
• ListRunnersRequestParams
• ListWorkflowsParam
• UserConfig

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

Name	Type
appId	undefined | string
bookmarkOrigin	undefined | AsObject
createdAt	undefined | AsObject
defaultAnnotationFilter	undefined | AsObject
defaultProcessingInfo	undefined | AsObject
description	undefined | string
image	undefined | AsObject
isStarred	undefined | boolean
metadata	undefined | AsObject
modifiedAt	undefined | AsObject
notes	undefined | string
starCount	undefined | number
userId	undefined | string
version	undefined | AsObject
visibility	undefined | AsObject

Defined in

client/app.ts:75

---

CreateModelParam

Ƭ CreateModelParam: Object

Type declaration

Name	Type
appId	undefined | string
bookmarkOrigin	undefined | AsObject
checkConsentsList	undefined | string[]
createdAt	undefined | AsObject
defaultEvalInfo	undefined | AsObject
description	undefined | string
displayName	undefined | string
image	undefined | AsObject
isStarred	undefined | boolean
languagesFullList	undefined | AsObject[]
languagesList	undefined | string[]
metadata	undefined | AsObject
modelTypeId	undefined | string
modelVersion	undefined | AsObject
modifiedAt	undefined | AsObject
name	undefined | string
notes	undefined | string
outputInfo	undefined | AsObject
presets	undefined | AsObject
starCount	undefined | number
task	undefined | string
toolkitsList	undefined | string[]
useCasesList	undefined | string[]
userId	undefined | string
visibility	undefined | AsObject
workflowRecommended	undefined | AsObject

Defined in

client/app.ts:76

---

ListAppsRequestParams

Ƭ ListAppsRequestParams: Object

Type declaration

Name	Type
additionalFieldsList	undefined | string[]
featuredOnly	undefined | boolean
id	undefined | string
name	undefined | string
page	undefined | number
query	undefined | string
search	undefined | string
sortAscending	undefined | boolean
sortByCreatedAt	undefined | boolean
sortByModifiedAt	undefined | boolean
sortByName	undefined | boolean
sortByStarCount	undefined | boolean
starredOnly	undefined | boolean
templateOnly	undefined | boolean

Defined in

client/user.ts:28

---

ListDatasetsParam

Ƭ ListDatasetsParam: Object

Type declaration

Name	Type
additionalFieldsList	undefined | string[]
bookmark	undefined | boolean
id	undefined | string
page	undefined | number
search	undefined | string
sortAscending	undefined | boolean
sortByCreatedAt	undefined | boolean
sortById	undefined | boolean
sortByModifiedAt	undefined | boolean
sortByStarCount	undefined | boolean
starredOnly	undefined | boolean

Defined in

client/app.ts:65

---

ListInstalledModuleVersionsParam

Ƭ ListInstalledModuleVersionsParam: Object

Type declaration

Name	Type
page	undefined | number

Defined in

client/app.ts:73

---

ListModelsParam

Ƭ ListModelsParam: Object

Type declaration

Name	Type
additionalFieldsList	undefined | string[]
bookmark	undefined | boolean
dontFetchFromMain	undefined | boolean
featuredOnly	undefined | boolean
filterByUserId	undefined | boolean
inputFieldsList	undefined | string[]
languagesList	undefined | string[]
license	undefined | string
modelTypeId	undefined | string
name	undefined | string
outputFieldsList	undefined | string[]
page	undefined | number
query	undefined | string
search	undefined | string
sortAscending	undefined | boolean
sortByCreatedAt	undefined | boolean
sortByModifiedAt	undefined | boolean
sortByName	undefined | boolean
sortByNumInputs	undefined | boolean
sortByStarCount	undefined | boolean
starredOnly	undefined | boolean
toolkitsList	undefined | string[]
trainedOnly	undefined | boolean
useCasesList	undefined | string[]

Defined in

client/app.ts:67

---

ListModulesParam

Ƭ ListModulesParam: Object

Type declaration

Name	Type
additionalFieldsList	undefined | string[]
bookmark	undefined | boolean
filterByUserId	undefined | boolean
name	undefined | string
page	undefined | number
search	undefined | string
sortAscending	undefined | boolean
sortByCreatedAt	undefined | boolean
sortById	undefined | boolean
sortByModifiedAt	undefined | boolean
sortByStarCount	undefined | boolean
starredOnly	undefined | boolean

Defined in

client/app.ts:71

---

ListRunnersRequestParams

Ƭ ListRunnersRequestParams: Object

Type declaration

Name	Type
page	undefined | number

Defined in

client/user.ts:30

---

ListWorkflowsParam

Ƭ ListWorkflowsParam: Object

Type declaration

Name	Type
additionalFieldsList	undefined | string[]
bookmark	undefined | boolean
featuredOnly	undefined | boolean
id	undefined | string
page	undefined | number
query	undefined | string
search	undefined | string
searchTerm	undefined | string
sortAscending	undefined | boolean
sortByCreatedAt	undefined | boolean
sortById	undefined | boolean
sortByModifiedAt	undefined | boolean
sortByStarCount	undefined | boolean
starredOnly	undefined | boolean

Defined in

client/app.ts:69

---

UserConfig

Ƭ UserConfig: Object

Type declaration

Name	Type
appId	string
base	undefined | string
pat	string
token	undefined | string
ui	undefined | string
userId	string

Defined in

client/user.ts:27