clarifai-nodejs / Exports / Dataset

Class: Dataset

Hierarchy

• Lister

  ↳ Dataset

Table of contents

Constructors

• constructor

Properties

• STUB
• authHelper
• base
• batchSize
• defaultPageSize
• info
• input
• metadata
• pat
• rootCertificatesPath
• userAppId

Methods

• convertStringToTimestamp
• createVersion
• deleteVersion
• grpcRequest
• listPagesData
• listPagesGenerator
• listVersions
• uploadFromCSV
• uploadFromFolder

Constructors

constructor

• new Dataset(«destructured»): Dataset

Parameters

Name	Type
«destructured»	DatasetConfig

Returns

Dataset

Overrides

Lister.constructor

Defined in

src/client/dataset.ts:39

Properties

STUB

• Protected STUB: V2Stub

Inherited from

Lister.STUB

Defined in

src/client/base.ts:27

---

authHelper

• Protected authHelper: ClarifaiAuthHelper

Inherited from

Lister.authHelper

Defined in

src/client/base.ts:26

---

base

• Protected base: string

Inherited from

Lister.base

Defined in

src/client/base.ts:31

---

batchSize

• Private batchSize: number = 128

Defined in

src/client/dataset.ts:36

---

defaultPageSize

• defaultPageSize: number

Inherited from

Lister.defaultPageSize

Defined in

src/client/lister.ts:10

---

info

• Private info: Dataset

Defined in

src/client/dataset.ts:35

---

input

• Private input: Input

Defined in

src/client/dataset.ts:37

---

metadata

• Protected metadata: [string, string][]

Inherited from

Lister.metadata

Defined in

src/client/base.ts:28

---

pat

• Protected pat: string

Inherited from

Lister.pat

Defined in

src/client/base.ts:29

---

rootCertificatesPath

• Protected rootCertificatesPath: string

Inherited from

Lister.rootCertificatesPath

Defined in

src/client/base.ts:32

---

userAppId

• Protected userAppId: UserAppIDSet

Inherited from

Lister.userAppId

Defined in

src/client/base.ts:30

Methods

convertStringToTimestamp

▸ convertStringToTimestamp(dateStr): Timestamp

Converts a string to a Timestamp object.

Parameters

Name	Type	Description
dateStr	string	The string to convert.

Returns

Timestamp

A Timestamp object representing the given date string.

Inherited from

Lister.convertStringToTimestamp

Defined in

src/client/base.ts:100

---

createVersion

▸ createVersion(«destructured»): Promise<AsObject>

Parameters

Name	Type
«destructured»	Object
› description	string
› id	string
› metadata?	Record<string, JavaScriptValue>

Returns

Promise<AsObject>

Defined in

src/client/dataset.ts:58

---

deleteVersion

▸ deleteVersion(versionId): Promise<void>

Parameters

Name	Type
versionId	string

Returns

Promise<void>

Defined in

src/client/dataset.ts:93

---

grpcRequest

▸ grpcRequest<TRequest, TResponseObject, TResponse>(endpoint, requestData): Promise<TResponse>

Makes a gRPC request to the API.

Type parameters

Name	Type
TRequest	extends Message
TResponseObject	extends Object
TResponse	extends Object

Parameters

Name	Type
endpoint	(request: TRequest, metadata: Metadata, options: Partial<CallOptions>) => Promise<TResponse>
requestData	TRequest

Returns

Promise<TResponse>

A Promise resolving to the result of the gRPC method call.

Inherited from

Lister.grpcRequest

Defined in

src/client/base.ts:77

---

listPagesData

▸ listPagesData<TRequest, TResponseObject, TResponse>(endpoint, requestData, pageNo?, perPage?): Promise<TResponse>

Type parameters

Name	Type
TRequest	extends Message
TResponseObject	extends Object
TResponse	extends Object

Parameters

Name	Type	Default value
endpoint	(request: TRequest, metadata: Metadata, options: Partial<CallOptions>) => Promise<TResponse>	undefined
requestData	TRequest	undefined
pageNo	number	1
perPage	number	undefined

Returns

Promise<TResponse>

Inherited from

Lister.listPagesData

Defined in

src/client/lister.ts:92

---

listPagesGenerator

▸ listPagesGenerator<TRequest, TResponseObject, TResponse>(endpoint, requestData, pageNo?, perPage?): AsyncGenerator<TResponse, void, unknown>

Type parameters

Name	Type
TRequest	extends Message
TResponseObject	extends Object
TResponse	extends Object

Parameters

Name	Type	Default value
endpoint	(request: TRequest, metadata: Metadata, options: Partial<CallOptions>) => Promise<TResponse>	undefined
requestData	TRequest	undefined
pageNo	number	1
perPage	number	undefined

Returns

AsyncGenerator<TResponse, void, unknown>

Inherited from

Lister.listPagesGenerator

Defined in

src/client/lister.ts:23

---

listVersions

▸ listVersions(pageNo?, perPage?): AsyncGenerator<AsObject[], void, unknown>

Parameters

Name	Type
pageNo?	number
perPage?	number

Returns

AsyncGenerator<AsObject[], void, unknown>

Defined in

src/client/dataset.ts:113

---

uploadFromCSV

▸ uploadFromCSV(«destructured»): Promise<void>

Parameters

Name	Type	Default value
«destructured»	Object	undefined
› batchSize?	number	128
› csvPath	string	undefined
› csvType	"url" | "raw" | "file"	undefined
› inputType?	"image" | "text" | "video" | "audio"	"text"
› labels?	boolean	true
› uploadProgressEmitter?	InputBulkUpload	undefined

Returns

Promise<void>

Defined in

src/client/dataset.ts:176

---

uploadFromFolder

▸ uploadFromFolder(«destructured»): Promise<void>

Parameters

Name	Type	Default value
«destructured»	Object	undefined
› batchSize?	number	undefined
› folderPath	string	undefined
› inputType	"image" | "text"	undefined
› labels?	boolean	false
› uploadProgressEmitter?	InputBulkUpload	undefined

Returns

Promise<void>

Defined in

src/client/dataset.ts:138