ILlmProvidersQuery
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Service to query LLM providers.
export interface ILlmProvidersQuery
Methods
Method | Description |
|---|---|
(ALPHA) Starts the LLM providers query. | |
(ALPHA) Starts the LLM providers query. | |
(ALPHA) Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0 | |
(ALPHA) Sets number of LLM providers to return per page. Default size: 100 | |
(ALPHA) Sets sorting for the query. |
Method details
ILlmProvidersQuery.query()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Starts the LLM providers query.
query(): Promise<ILlmProvidersQueryResult>;
Returns
Promise<ILlmProvidersQueryResult>
promise of first page of the results
ILlmProvidersQuery.queryAll()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Starts the LLM providers query.
queryAll(): Promise<ILlmProvider[]>;
Returns
Promise<ILlmProvider[]>
promise with a list of all LLM providers matching the specified options
ILlmProvidersQuery.withPage()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0
withPage(page: number): ILlmProvidersQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
page | number | zero indexed, must be non-negative |
Returns
LLM providers query
ILlmProvidersQuery.withSize()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets number of LLM providers to return per page. Default size: 100
withSize(size: number): ILlmProvidersQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
size | number | desired max number of LLM providers per page must be a positive number |
Returns
LLM providers query
ILlmProvidersQuery.withSorting()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets sorting for the query.
withSorting(sort: string[]): ILlmProvidersQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
sort | string[] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Returns
LLM providers query