Class ListPromptsPager

ListPromptsPager can be used to simplify the use of listPrompts().

Index

Constructors

Properties

client hasNextPage params

Methods

getAll getNext hasNext

Constructors

constructor

new ListPromptsPager(client, params?): WatsonXAI.ListPromptsPager
Construct a ListPromptsPager object.
Parameters
- client: WatsonXAI
  The service client instance used to invoke listPrompts()
- Optional params: WatsonXAI.PromptListParams
  The parameters to be passed to listPrompts()
Returns WatsonXAI.ListPromptsPager
- Defined in vml_v1.ts:7615

Properties

`Protected` client

client: WatsonXAI

`Protected` hasNextPage

hasNextPage: boolean

`Protected` params

params: WatsonXAI.PromptListParams

Methods

getAll

getAll(): Promise<WatsonXAI.CatalogSearchResponseAsset[]>
Returns all results by invoking listPrompts() repeatedly until all pages of results have been retrieved.

Returns Promise<WatsonXAI.CatalogSearchResponseAsset[]>
A Promise that resolves to an array of catalog search response assets
- Defined in vml_v1.ts:7660

getNext

getNext(): Promise<WatsonXAI.CatalogSearchResponseAsset[]>
Returns the next page of results by invoking listPrompts().

Returns Promise<WatsonXAI.CatalogSearchResponseAsset[]>
A Promise that resolves to an array of catalog search response assets
- Defined in vml_v1.ts:7636

hasNext

hasNext(): boolean
Returns true if there are potentially more results to be retrieved by invoking getNext().

Returns boolean
True if there are more results available, false otherwise
- Defined in vml_v1.ts:7626