From a140e93a68a2ec7204e46711d9caf4955ae831fd Mon Sep 17 00:00:00 2001 From: DaniAkash Date: Mon, 1 Apr 2024 12:37:01 +0530 Subject: [PATCH 1/5] docs: added no inherit docs --- src/client/model.ts | 1 + src/client/search.ts | 3 +++ src/client/workflow.ts | 3 +++ 3 files changed, 7 insertions(+) diff --git a/src/client/model.ts b/src/client/model.ts index ededb79..adcfa85 100644 --- a/src/client/model.ts +++ b/src/client/model.ts @@ -41,6 +41,7 @@ import { /** * Model is a class that provides access to Clarifai API endpoints related to Model information. + * @noInheritDoc */ export class Model extends Lister { private appId: string; diff --git a/src/client/search.ts b/src/client/search.ts index e569a82..c7efa76 100644 --- a/src/client/search.ts +++ b/src/client/search.ts @@ -39,6 +39,9 @@ import { StatusCode } from "clarifai-nodejs-grpc/proto/clarifai/api/status/statu type FilterType = z.infer>; +/** + * @noInheritDoc + */ export class Search extends Lister { private topK: number; private metricDistance: "COSINE_DISTANCE" | "EUCLIDEAN_DISTANCE"; diff --git a/src/client/workflow.ts b/src/client/workflow.ts index e1527bd..7e05ccc 100644 --- a/src/client/workflow.ts +++ b/src/client/workflow.ts @@ -42,6 +42,9 @@ type WorkflowConfig = authConfig?: AuthConfig; }; +/** + * @noInheritDoc + */ export class Workflow extends Lister { private versionId: string; private id: string; From c1c8e44dabdf005b2a979c7a3b4f756547aa8335 Mon Sep 17 00:00:00 2001 From: DaniAkash Date: Mon, 1 Apr 2024 12:37:47 +0530 Subject: [PATCH 2/5] chore: regenerate docs --- docs/classes/App.md | 40 +++--- docs/classes/Input.md | 38 +++--- docs/classes/Model.md | 282 +++------------------------------------ docs/classes/Search.md | 264 ++---------------------------------- docs/classes/User.md | 18 +-- docs/classes/Workflow.md | 262 ++---------------------------------- docs/modules.md | 22 +-- 7 files changed, 97 insertions(+), 829 deletions(-) diff --git a/docs/classes/App.md b/docs/classes/App.md index 13265b1..05909f0 100644 --- a/docs/classes/App.md +++ b/docs/classes/App.md @@ -78,7 +78,7 @@ Lister.constructor #### Defined in -[client/app.ts:98](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L98) +[client/app.ts:98](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L98) ## Properties @@ -88,7 +88,7 @@ Lister.constructor #### Defined in -[client/app.ts:83](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L83) +[client/app.ts:83](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L83) ## Methods @@ -160,7 +160,7 @@ A Dataset object for the specified dataset ID. #### Defined in -[client/app.ts:420](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L420) +[client/app.ts:420](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L420) ___ @@ -237,7 +237,7 @@ A Model object for the specified model ID. #### Defined in -[client/app.ts:462](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L462) +[client/app.ts:462](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L462) ___ @@ -283,7 +283,7 @@ A Module object for the specified module ID. #### Defined in -[client/app.ts:501](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L501) +[client/app.ts:501](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L501) ___ @@ -356,7 +356,7 @@ A Workflow object for the specified workflow config. #### Defined in -[client/app.ts:537](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L537) +[client/app.ts:537](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L537) ___ @@ -398,7 +398,7 @@ A Dataset object for the existing dataset ID. #### Defined in -[client/app.ts:727](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L727) +[client/app.ts:727](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L727) ___ @@ -436,7 +436,7 @@ await app.deleteDataset({ datasetId: "dataset-id" }); #### Defined in -[client/app.ts:754](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L754) +[client/app.ts:754](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L754) ___ @@ -474,7 +474,7 @@ await app.deleteModel({ modelId: "modelId" }); #### Defined in -[client/app.ts:777](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L777) +[client/app.ts:777](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L777) ___ @@ -512,7 +512,7 @@ await app.deleteModule({ moduleId: "moduleId" }); #### Defined in -[client/app.ts:823](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L823) +[client/app.ts:823](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L823) ___ @@ -550,7 +550,7 @@ await app.deleteWorkflow({ workflowId: "workflowId" }); #### Defined in -[client/app.ts:800](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L800) +[client/app.ts:800](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L800) ___ @@ -594,7 +594,7 @@ Concepts in the app. #### Defined in -[client/app.ts:382](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L382) +[client/app.ts:382](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L382) ___ @@ -643,7 +643,7 @@ Defaults to 16 per page #### Defined in -[client/app.ts:131](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L131) +[client/app.ts:131](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L131) ___ @@ -692,7 +692,7 @@ Defaults to 16 per page #### Defined in -[client/app.ts:337](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L337) +[client/app.ts:337](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L337) ___ @@ -738,7 +738,7 @@ Defaults to 16 per page #### Defined in -[client/app.ts:175](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L175) +[client/app.ts:175](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L175) ___ @@ -788,7 +788,7 @@ Defaults to 16 per page #### Defined in -[client/app.ts:286](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L286) +[client/app.ts:286](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L286) ___ @@ -802,7 +802,7 @@ ___ #### Defined in -[client/app.ts:406](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L406) +[client/app.ts:406](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L406) ___ @@ -852,7 +852,7 @@ Defaults to 16 per page #### Defined in -[client/app.ts:233](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L233) +[client/app.ts:233](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L233) ___ @@ -896,7 +896,7 @@ A model object for the specified model ID. #### Defined in -[client/app.ts:666](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L666) +[client/app.ts:666](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L666) ___ @@ -937,4 +937,4 @@ A workflow object for the specified workflow ID. #### Defined in -[client/app.ts:699](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L699) +[client/app.ts:699](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L699) diff --git a/docs/classes/Input.md b/docs/classes/Input.md index 774268e..95b10c7 100644 --- a/docs/classes/Input.md +++ b/docs/classes/Input.md @@ -75,7 +75,7 @@ Lister.constructor #### Defined in -[client/input.ts:64](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L64) +[client/input.ts:64](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L64) ## Methods @@ -97,7 +97,7 @@ Lister.constructor #### Defined in -[client/input.ts:923](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L923) +[client/input.ts:923](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L923) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -[client/input.ts:959](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L959) +[client/input.ts:959](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L959) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[client/input.ts:871](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L871) +[client/input.ts:871](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L871) ___ @@ -177,7 +177,7 @@ ___ #### Defined in -[client/input.ts:836](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L836) +[client/input.ts:836](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L836) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -[client/input.ts:801](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L801) +[client/input.ts:801](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L801) ___ @@ -228,7 +228,7 @@ ___ #### Defined in -[client/input.ts:760](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L760) +[client/input.ts:760](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L760) ___ @@ -251,7 +251,7 @@ ___ #### Defined in -[client/input.ts:906](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L906) +[client/input.ts:906](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L906) ___ @@ -274,7 +274,7 @@ ___ #### Defined in -[client/input.ts:679](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L679) +[client/input.ts:679](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L679) ___ @@ -325,7 +325,7 @@ console.log(prediction); #### Defined in -[client/input.ts:396](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L396) +[client/input.ts:396](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L396) ___ @@ -386,7 +386,7 @@ An `Input` object for the specified input ID. #### Defined in -[client/input.ts:194](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L194) +[client/input.ts:194](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L194) ___ @@ -445,7 +445,7 @@ console.log(prediction); #### Defined in -[client/input.ts:258](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L258) +[client/input.ts:258](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L258) ___ @@ -503,7 +503,7 @@ console.log(prediction); #### Defined in -[client/input.ts:322](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L322) +[client/input.ts:322](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L322) ___ @@ -533,7 +533,7 @@ Create Input proto from CSV File. Supported columns are: #### Defined in -[client/input.ts:533](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L533) +[client/input.ts:533](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L533) ___ @@ -555,7 +555,7 @@ ___ #### Defined in -[client/input.ts:720](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L720) +[client/input.ts:720](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L720) ___ @@ -585,7 +585,7 @@ Create input proto for text and image from bytes or url #### Defined in -[client/input.ts:476](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L476) +[client/input.ts:476](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L476) ___ @@ -618,7 +618,7 @@ Create input proto for image data type. #### Defined in -[client/input.ts:82](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L82) +[client/input.ts:82](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L82) ___ @@ -673,7 +673,7 @@ console.log(prediction); #### Defined in -[client/input.ts:439](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L439) +[client/input.ts:439](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L439) ___ @@ -696,4 +696,4 @@ ___ #### Defined in -[client/input.ts:648](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/input.ts#L648) +[client/input.ts:648](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/input.ts#L648) diff --git a/docs/classes/Model.md b/docs/classes/Model.md index 7a33c41..e0daeac 100644 --- a/docs/classes/Model.md +++ b/docs/classes/Model.md @@ -18,29 +18,18 @@ Model is a class that provides access to Clarifai API endpoints related to Model ### Properties -- [STUB](Model.md#stub) - [appId](Model.md#appid) -- [authHelper](Model.md#authhelper) -- [base](Model.md#base) -- [defaultPageSize](Model.md#defaultpagesize) - [id](Model.md#id) -- [metadata](Model.md#metadata) - [modelInfo](Model.md#modelinfo) - [modelVersion](Model.md#modelversion) -- [pat](Model.md#pat) - [trainingParams](Model.md#trainingparams) -- [userAppId](Model.md#userappid) ### Methods -- [convertStringToTimestamp](Model.md#convertstringtotimestamp) - [createVersion](Model.md#createversion) - [deleteVersion](Model.md#deleteversion) - [getParamInfo](Model.md#getparaminfo) - [getParams](Model.md#getparams) -- [grpcRequest](Model.md#grpcrequest) -- [listPagesData](Model.md#listpagesdata) -- [listPagesGenerator](Model.md#listpagesgenerator) - [listTrainingTemplates](Model.md#listtrainingtemplates) - [listVersions](Model.md#listversions) - [loadInfo](Model.md#loadinfo) @@ -89,73 +78,17 @@ Lister.constructor #### Defined in -[client/model.ts:65](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L65) +[client/model.ts:66](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L66) ## Properties -### STUB - -• `Protected` **STUB**: `V2Stub` - -#### Inherited from - -Lister.STUB - -#### Defined in - -[client/base.ts:26](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L26) - -___ - ### appId • `Private` **appId**: `string` #### Defined in -[client/model.ts:46](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L46) - -___ - -### authHelper - -• `Protected` **authHelper**: `ClarifaiAuthHelper` - -#### Inherited from - -Lister.authHelper - -#### Defined in - -[client/base.ts:25](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L25) - -___ - -### base - -• `Protected` **base**: `string` - -#### Inherited from - -Lister.base - -#### Defined in - -[client/base.ts:30](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L30) - -___ - -### defaultPageSize - -• **defaultPageSize**: `number` - -#### Inherited from - -Lister.defaultPageSize - -#### Defined in - -[client/lister.ts:9](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/lister.ts#L9) +[client/model.ts:47](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L47) ___ @@ -165,21 +98,7 @@ ___ #### Defined in -[client/model.ts:47](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L47) - -___ - -### metadata - -• `Protected` **metadata**: [`string`, `string`][] - -#### Inherited from - -Lister.metadata - -#### Defined in - -[client/base.ts:27](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L27) +[client/model.ts:48](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L48) ___ @@ -189,7 +108,7 @@ ___ #### Defined in -[client/model.ts:49](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L49) +[client/model.ts:50](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L50) ___ @@ -199,21 +118,7 @@ ___ #### Defined in -[client/model.ts:48](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L48) - -___ - -### pat - -• `Protected` **pat**: `string` - -#### Inherited from - -Lister.pat - -#### Defined in - -[client/base.ts:28](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L28) +[client/model.ts:49](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L49) ___ @@ -223,52 +128,10 @@ ___ #### Defined in -[client/model.ts:50](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L50) - -___ - -### userAppId - -• `Protected` **userAppId**: `UserAppIDSet` - -#### Inherited from - -Lister.userAppId - -#### Defined in - -[client/base.ts:29](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L29) +[client/model.ts:51](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L51) ## 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 - -[client/base.ts:95](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L95) - -___ - ### createVersion ▸ **createVersion**(`modelVersion`): `Promise`\<`undefined` \| `AsObject`\> @@ -320,7 +183,7 @@ console.log(modelObjectWithVersion); #### Defined in -[client/model.ts:394](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L394) +[client/model.ts:395](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L395) ___ @@ -358,7 +221,7 @@ model.deleteVersion("version_id"); #### Defined in -[client/model.ts:369](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L369) +[client/model.ts:370](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L370) ___ @@ -396,7 +259,7 @@ model.getParamInfo("template"); #### Defined in -[client/model.ts:307](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L307) +[client/model.ts:308](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L308) ___ @@ -438,114 +301,7 @@ console.log(modelParams); #### Defined in -[client/model.ts:203](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L203) - -___ - -### 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 - -[client/base.ts:72](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L72) - -___ - -### 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 - -[client/lister.ts:86](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/lister.ts#L86) - -___ - -### 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 - -[client/lister.ts:22](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/lister.ts#L22) +[client/model.ts:204](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L204) ___ @@ -580,7 +336,7 @@ console.log(trainingTemplates); #### Defined in -[client/model.ts:162](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L162) +[client/model.ts:163](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L163) ___ @@ -625,7 +381,7 @@ Defaults to 16 per page if pageNo is not specified #### Defined in -[client/model.ts:432](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L432) +[client/model.ts:433](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L433) ___ @@ -642,7 +398,7 @@ Usually called internally by other methods, to ensure the model info is loaded w #### Defined in -[client/model.ts:123](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L123) +[client/model.ts:124](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L124) ___ @@ -666,7 +422,7 @@ Overrides the model version. #### Defined in -[client/model.ts:696](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L696) +[client/model.ts:697](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L697) ___ @@ -731,7 +487,7 @@ console.log(imagePrediction); #### Defined in -[client/model.ts:479](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L479) +[client/model.ts:480](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L480) ___ @@ -760,7 +516,7 @@ Inputs can be provided as a Buffer. #### Defined in -[client/model.ts:637](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L637) +[client/model.ts:638](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L638) ___ @@ -789,7 +545,7 @@ Inputs can be provided as a filepath which can be read. #### Defined in -[client/model.ts:603](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L603) +[client/model.ts:604](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L604) ___ @@ -818,7 +574,7 @@ Inputs can be provided as a URL. #### Defined in -[client/model.ts:561](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L561) +[client/model.ts:562](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L562) ___ @@ -859,4 +615,4 @@ model.updateParams({ #### Defined in -[client/model.ts:276](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/model.ts#L276) +[client/model.ts:277](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/model.ts#L277) diff --git a/docs/classes/Search.md b/docs/classes/Search.md index 70688df..4970740 100644 --- a/docs/classes/Search.md +++ b/docs/classes/Search.md @@ -16,28 +16,17 @@ ### Properties -- [STUB](Search.md#stub) -- [authHelper](Search.md#authhelper) -- [base](Search.md#base) - [dataProto](Search.md#dataproto) -- [defaultPageSize](Search.md#defaultpagesize) - [inputProto](Search.md#inputproto) -- [metadata](Search.md#metadata) - [metricDistance](Search.md#metricdistance) -- [pat](Search.md#pat) - [topK](Search.md#topk) -- [userAppId](Search.md#userappid) ### Methods -- [convertStringToTimestamp](Search.md#convertstringtotimestamp) - [getAnnotProto](Search.md#getannotproto) - [getGeoPointProto](Search.md#getgeopointproto) - [getInputProto](Search.md#getinputproto) -- [grpcRequest](Search.md#grpcrequest) - [listAllPagesGenerator](Search.md#listallpagesgenerator) -- [listPagesData](Search.md#listpagesdata) -- [listPagesGenerator](Search.md#listpagesgenerator) - [query](Search.md#query) ## Constructors @@ -65,73 +54,17 @@ Lister.constructor #### Defined in -[client/search.ts:48](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/search.ts#L48) +[client/search.ts:51](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/search.ts#L51) ## Properties -### STUB - -• `Protected` **STUB**: `V2Stub` - -#### Inherited from - -Lister.STUB - -#### Defined in - -[client/base.ts:26](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L26) - -___ - -### authHelper - -• `Protected` **authHelper**: `ClarifaiAuthHelper` - -#### Inherited from - -Lister.authHelper - -#### Defined in - -[client/base.ts:25](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L25) - -___ - -### base - -• `Protected` **base**: `string` - -#### Inherited from - -Lister.base - -#### Defined in - -[client/base.ts:30](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L30) - -___ - ### dataProto • `Private` **dataProto**: `Data` #### Defined in -[client/search.ts:45](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/search.ts#L45) - -___ - -### defaultPageSize - -• **defaultPageSize**: `number` - -#### Inherited from - -Lister.defaultPageSize - -#### Defined in - -[client/lister.ts:9](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/lister.ts#L9) +[client/search.ts:48](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/search.ts#L48) ___ @@ -141,21 +74,7 @@ ___ #### Defined in -[client/search.ts:46](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/search.ts#L46) - -___ - -### metadata - -• `Protected` **metadata**: [`string`, `string`][] - -#### Inherited from - -Lister.metadata - -#### Defined in - -[client/base.ts:27](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L27) +[client/search.ts:49](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/search.ts#L49) ___ @@ -165,21 +84,7 @@ ___ #### Defined in -[client/search.ts:44](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/search.ts#L44) - -___ - -### pat - -• `Protected` **pat**: `string` - -#### Inherited from - -Lister.pat - -#### Defined in - -[client/base.ts:28](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L28) +[client/search.ts:47](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/search.ts#L47) ___ @@ -189,52 +94,10 @@ ___ #### Defined in -[client/search.ts:43](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/search.ts#L43) - -___ - -### userAppId - -• `Protected` **userAppId**: `UserAppIDSet` - -#### Inherited from - -Lister.userAppId - -#### Defined in - -[client/base.ts:29](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L29) +[client/search.ts:46](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/search.ts#L46) ## 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 - -[client/base.ts:95](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L95) - -___ - ### getAnnotProto ▸ **getAnnotProto**(`args`): `Annotation` @@ -263,7 +126,7 @@ ___ #### Defined in -[client/search.ts:74](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/search.ts#L74) +[client/search.ts:77](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/search.ts#L77) ___ @@ -285,7 +148,7 @@ ___ #### Defined in -[client/search.ts:182](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/search.ts#L182) +[client/search.ts:185](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/search.ts#L185) ___ @@ -317,44 +180,7 @@ ___ #### Defined in -[client/search.ts:146](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/search.ts#L146) - -___ - -### 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 - -[client/base.ts:72](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L72) +[client/search.ts:149](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/search.ts#L149) ___ @@ -381,77 +207,7 @@ ___ #### Defined in -[client/search.ts:199](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/search.ts#L199) - -___ - -### 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 - -[client/lister.ts:86](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/lister.ts#L86) - -___ - -### 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 - -[client/lister.ts:22](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/lister.ts#L22) +[client/search.ts:202](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/search.ts#L202) ___ @@ -473,4 +229,4 @@ ___ #### Defined in -[client/search.ts:256](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/search.ts#L256) +[client/search.ts:259](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/search.ts#L259) diff --git a/docs/classes/User.md b/docs/classes/User.md index 8d6971d..e7260c4 100644 --- a/docs/classes/User.md +++ b/docs/classes/User.md @@ -62,7 +62,7 @@ Lister.constructor #### Defined in -[client/user.ts:51](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/user.ts#L51) +[client/user.ts:51](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/user.ts#L51) ## Methods @@ -102,7 +102,7 @@ An App object for the specified app ID. #### Defined in -[client/user.ts:236](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/user.ts#L236) +[client/user.ts:236](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/user.ts#L236) ___ @@ -144,7 +144,7 @@ An App object for the specified app ID. #### Defined in -[client/user.ts:143](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/user.ts#L143) +[client/user.ts:143](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/user.ts#L143) ___ @@ -188,7 +188,7 @@ A runner object for the specified Runner ID. #### Defined in -[client/user.ts:191](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/user.ts#L191) +[client/user.ts:191](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/user.ts#L191) ___ @@ -217,7 +217,7 @@ examples/user/deleteApp.ts #### Defined in -[client/user.ts:294](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/user.ts#L294) +[client/user.ts:294](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/user.ts#L294) ___ @@ -252,7 +252,7 @@ await user.deleteRunner({ runnerId: "runner_id" }); #### Defined in -[client/user.ts:319](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/user.ts#L319) +[client/user.ts:319](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/user.ts#L319) ___ @@ -308,7 +308,7 @@ If both pageNo and perPage are None, then lists all the resources. #### Defined in -[client/user.ts:68](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/user.ts#L68) +[client/user.ts:68](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/user.ts#L68) ___ @@ -355,7 +355,7 @@ Defaults to 16 per page if perPage is not specified. #### Defined in -[client/user.ts:109](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/user.ts#L109) +[client/user.ts:109](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/user.ts#L109) ___ @@ -393,4 +393,4 @@ A Runner object for the existing runner ID. #### Defined in -[client/user.ts:265](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/user.ts#L265) +[client/user.ts:265](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/user.ts#L265) diff --git a/docs/classes/Workflow.md b/docs/classes/Workflow.md index 6b99664..118c75f 100644 --- a/docs/classes/Workflow.md +++ b/docs/classes/Workflow.md @@ -16,24 +16,13 @@ ### Properties -- [STUB](Workflow.md#stub) -- [authHelper](Workflow.md#authhelper) -- [base](Workflow.md#base) -- [defaultPageSize](Workflow.md#defaultpagesize) - [id](Workflow.md#id) -- [metadata](Workflow.md#metadata) - [outputConfig](Workflow.md#outputconfig) -- [pat](Workflow.md#pat) -- [userAppId](Workflow.md#userappid) - [versionId](Workflow.md#versionid) ### Methods -- [convertStringToTimestamp](Workflow.md#convertstringtotimestamp) - [exportWorkflow](Workflow.md#exportworkflow) -- [grpcRequest](Workflow.md#grpcrequest) -- [listPagesData](Workflow.md#listpagesdata) -- [listPagesGenerator](Workflow.md#listpagesgenerator) - [listVersions](Workflow.md#listversions) - [predict](Workflow.md#predict) - [predictByBytes](Workflow.md#predictbybytes) @@ -61,87 +50,17 @@ Lister.constructor #### Defined in -[client/workflow.ts:50](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/workflow.ts#L50) +[client/workflow.ts:53](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/workflow.ts#L53) ## Properties -### STUB - -• `Protected` **STUB**: `V2Stub` - -#### Inherited from - -Lister.STUB - -#### Defined in - -[client/base.ts:26](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L26) - -___ - -### authHelper - -• `Protected` **authHelper**: `ClarifaiAuthHelper` - -#### Inherited from - -Lister.authHelper - -#### Defined in - -[client/base.ts:25](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L25) - -___ - -### base - -• `Protected` **base**: `string` - -#### Inherited from - -Lister.base - -#### Defined in - -[client/base.ts:30](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L30) - -___ - -### defaultPageSize - -• **defaultPageSize**: `number` - -#### Inherited from - -Lister.defaultPageSize - -#### Defined in - -[client/lister.ts:9](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/lister.ts#L9) - -___ - ### id • `Private` **id**: `string` #### Defined in -[client/workflow.ts:47](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/workflow.ts#L47) - -___ - -### metadata - -• `Protected` **metadata**: [`string`, `string`][] - -#### Inherited from - -Lister.metadata - -#### Defined in - -[client/base.ts:27](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L27) +[client/workflow.ts:50](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/workflow.ts#L50) ___ @@ -151,35 +70,7 @@ ___ #### Defined in -[client/workflow.ts:48](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/workflow.ts#L48) - -___ - -### pat - -• `Protected` **pat**: `string` - -#### Inherited from - -Lister.pat - -#### Defined in - -[client/base.ts:28](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L28) - -___ - -### userAppId - -• `Protected` **userAppId**: `UserAppIDSet` - -#### Inherited from - -Lister.userAppId - -#### Defined in - -[client/base.ts:29](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L29) +[client/workflow.ts:51](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/workflow.ts#L51) ___ @@ -189,38 +80,10 @@ ___ #### Defined in -[client/workflow.ts:46](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/workflow.ts#L46) +[client/workflow.ts:49](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/workflow.ts#L49) ## 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 - -[client/base.ts:95](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L95) - -___ - ### exportWorkflow ▸ **exportWorkflow**(`outPath`): `Promise`\<`void`\> @@ -248,114 +111,7 @@ await workflow.export("out_path.yml"); #### Defined in -[client/workflow.ts:253](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/workflow.ts#L253) - -___ - -### 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 - -[client/base.ts:72](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/base.ts#L72) - -___ - -### 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 - -[client/lister.ts:86](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/lister.ts#L86) - -___ - -### 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 - -[client/lister.ts:22](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/lister.ts#L22) +[client/workflow.ts:256](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/workflow.ts#L256) ___ @@ -377,7 +133,7 @@ ___ #### Defined in -[client/workflow.ts:211](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/workflow.ts#L211) +[client/workflow.ts:214](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/workflow.ts#L214) ___ @@ -399,7 +155,7 @@ ___ #### Defined in -[client/workflow.ts:79](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/workflow.ts#L79) +[client/workflow.ts:82](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/workflow.ts#L82) ___ @@ -420,7 +176,7 @@ ___ #### Defined in -[client/workflow.ts:150](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/workflow.ts#L150) +[client/workflow.ts:153](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/workflow.ts#L153) ___ @@ -441,4 +197,4 @@ ___ #### Defined in -[client/workflow.ts:189](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/workflow.ts#L189) +[client/workflow.ts:192](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/workflow.ts#L192) diff --git a/docs/modules.md b/docs/modules.md index 34e6c62..de161ca 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -35,7 +35,7 @@ #### Defined in -[client/app.ts:52](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L52) +[client/app.ts:52](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L52) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[client/app.ts:75](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L75) +[client/app.ts:75](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L75) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[client/app.ts:76](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L76) +[client/app.ts:76](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L76) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -[client/user.ts:28](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/user.ts#L28) +[client/user.ts:28](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/user.ts#L28) ___ @@ -161,7 +161,7 @@ ___ #### Defined in -[client/app.ts:65](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L65) +[client/app.ts:65](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L65) ___ @@ -177,7 +177,7 @@ ___ #### Defined in -[client/app.ts:73](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L73) +[client/app.ts:73](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L73) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[client/app.ts:67](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L67) +[client/app.ts:67](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L67) ___ @@ -243,7 +243,7 @@ ___ #### Defined in -[client/app.ts:71](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L71) +[client/app.ts:71](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L71) ___ @@ -259,7 +259,7 @@ ___ #### Defined in -[client/user.ts:30](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/user.ts#L30) +[client/user.ts:30](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/user.ts#L30) ___ @@ -288,7 +288,7 @@ ___ #### Defined in -[client/app.ts:69](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/app.ts#L69) +[client/app.ts:69](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/app.ts#L69) ___ @@ -309,4 +309,4 @@ ___ #### Defined in -[client/user.ts:27](https://github.com/Clarifai/clarifai-nodejs/blob/f6de468/src/client/user.ts#L27) +[client/user.ts:27](https://github.com/Clarifai/clarifai-nodejs/blob/a140e93/src/client/user.ts#L27) From 58ca745891b4cc0f6ec9ab3571f6532d495e45b5 Mon Sep 17 00:00:00 2001 From: DaniAkash Date: Mon, 1 Apr 2024 14:42:48 +0530 Subject: [PATCH 3/5] chore: fix badges --- .github/workflows/build.yml | 25 +++++++++++++++++++++++++ CONTRIBUTING.md | 8 ++------ docs/README.md | 3 ++- 3 files changed, 29 insertions(+), 7 deletions(-) create mode 100644 .github/workflows/build.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..d303ae5 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,25 @@ +name: Build +on: + push: + branches: + - main +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Use Node.js 14.x + uses: actions/setup-node@v4 + with: + node-version: "20.11.0" + - name: Install dependencies + run: npm install + - name: Lint + run: npm run lint + - name: Run tests + run: npm run test + env: + VITE_CLARIFAI_USER_ID: ${{ secrets.VITE_CLARIFAI_USER_ID }} + VITE_CLARIFAI_PAT: ${{ secrets.VITE_CLARIFAI_PAT }} + - name: Build + run: npm run build diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b5a8163..40a0dfe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,9 +29,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents This project and everyone participating in it is governed by the [CONTRIBUTING.md Code of Conduct](https://github.com/Clarifai/clarifai-nodejs/blob/main/CODE_OF_CONDUCT.md). -By participating, you are expected to uphold this code. - - +By participating, you are expected to uphold this code. Please report unacceptable behavior to support@clarifai.com. ## I Have a Question @@ -75,9 +73,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform #### How Do I Submit a Good Bug Report? -> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. - - +> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to support@clarifai.com We use GitHub issues to track bugs and errors. If you run into an issue with the project: diff --git a/docs/README.md b/docs/README.md index f35055c..0da7657 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,7 +3,8 @@ clarifai-nodejs / [Exports](modules.md) ![Clarifai logo](https://www.clarifai.com/hubfs/Clarifai-logo-dark.svg) [![npm](https://img.shields.io/npm/v/clarifai-nodejs)](https://www.npmjs.com/package/clarifai-nodejs) -[![Build](https://github.com/Clarifai/clarifai-nodejs/workflows/Run%20tests/badge.svg)](https://github.com/Clarifai/clarifai-nodejs/actions) +[![Build](https://github.com/Clarifai/clarifai-nodejs/actions/workflows/build.yml/badge.svg)](https://github.com/Clarifai/clarifai-nodejs/actions/workflows/build.yml) +[![Discord](https://img.shields.io/discord/1145701543228735582)](https://discord.com/invite/26upV8Y4Nd) > This library is currently in beta, any improvements & feedback welcome! From d146ca7914ae39567208dea5f6dd3b212b0bf52e Mon Sep 17 00:00:00 2001 From: DaniAkash Date: Mon, 1 Apr 2024 14:44:18 +0530 Subject: [PATCH 4/5] ci: added check pr title action --- .github/workflows/pr-title.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .github/workflows/pr-title.yml diff --git a/.github/workflows/pr-title.yml b/.github/workflows/pr-title.yml new file mode 100644 index 0000000..bedaa8e --- /dev/null +++ b/.github/workflows/pr-title.yml @@ -0,0 +1,19 @@ +name: Check PR title + +on: + pull_request_target: + types: + - opened + - reopened + - edited + - synchronize + +jobs: + lint: + runs-on: ubuntu-latest + permissions: + statuses: write + steps: + - uses: aslafy-z/conventional-pr-title-action@v3 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From b34cc5811bdddb3d4596ae085b80a2d74773627a Mon Sep 17 00:00:00 2001 From: DaniAkash Date: Mon, 1 Apr 2024 14:47:53 +0530 Subject: [PATCH 5/5] ci: fix pr event --- .github/workflows/build.yml | 2 +- .github/workflows/pr-title.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index d303ae5..6ec5212 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -13,7 +13,7 @@ jobs: with: node-version: "20.11.0" - name: Install dependencies - run: npm install + run: npm ci - name: Lint run: npm run lint - name: Run tests diff --git a/.github/workflows/pr-title.yml b/.github/workflows/pr-title.yml index bedaa8e..747bae4 100644 --- a/.github/workflows/pr-title.yml +++ b/.github/workflows/pr-title.yml @@ -1,7 +1,7 @@ name: Check PR title on: - pull_request_target: + pull_request: types: - opened - reopened