IOrganizationLlmProvidersService
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
This service provides access to organization llm providers configuration.
export interface IOrganizationLlmProvidersService
Methods
Method | Description |
|---|---|
(ALPHA) Create a new llm provider | |
(ALPHA) Delete a provider | |
(ALPHA) Get count of all llm providers | |
(ALPHA) Get llm provider by id | |
(ALPHA) Get providers query | |
(ALPHA) List models for a provider | |
(ALPHA) List models for a provider definition | |
(ALPHA) Patch existing llm provider | |
(ALPHA) Test existing llm provider | |
(ALPHA) Update existing llm provider |
Method details
IOrganizationLlmProvidersService.createLlmProvider()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Create a new llm provider
createLlmProvider(provider: ILlmProvider): Promise<ILlmProvider>;
Parameters
Parameter | Type | Description |
|---|---|---|
provider | definition of the llm provider |
Returns
Promise<ILlmProvider>
Promise resolved with created llm provider.
IOrganizationLlmProvidersService.deleteLlmProvider()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Delete a provider
deleteLlmProvider(id: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
id | string | id of the provider |
Returns
Promise<void>
Promise resolved when the provider is deleted.
IOrganizationLlmProvidersService.getCount()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Get count of all llm providers
getCount(): Promise<number>;
Returns
Promise<number>
Promise resolved with number of llm providers.
IOrganizationLlmProvidersService.getLlmProvider()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Get llm provider by id
getLlmProvider(id: string): Promise<ILlmProvider | undefined>;
Parameters
Parameter | Type | Description |
|---|---|---|
id | string | id of the provider |
Returns
Promise<ILlmProvider | undefined>
Promise resolved with provider.
IOrganizationLlmProvidersService.getProvidersQuery()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Get providers query
getProvidersQuery(): ILlmProvidersQuery;
Returns
providers query
IOrganizationLlmProvidersService.listLlmProviderModels()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
List models for a provider
listLlmProviderModels(id: string): Promise<LlmProviderListModelsResults>;
Parameters
Parameter | Type | Description |
|---|---|---|
id | string | id of the provider |
Returns
Promise<LlmProviderListModelsResults>
Promise resolved with list of models.
IOrganizationLlmProvidersService.listLlmProviderModels()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
List models for a provider definition
listLlmProviderModels(provider: Partial<LlmProviderPatch>): Promise<LlmProviderListModelsResults>;
Parameters
Parameter | Type | Description |
|---|---|---|
provider | Partial<LlmProviderPatch> | definition of the llm provider |
Returns
Promise<LlmProviderListModelsResults>
Promise resolved with list of models.
IOrganizationLlmProvidersService.patchLlmProvider()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Patch existing llm provider
patchLlmProvider(provider: LlmProviderPatch): Promise<ILlmProvider>;
Parameters
Parameter | Type | Description |
|---|---|---|
provider | definition of the llm provider |
Returns
Promise<ILlmProvider>
Promise resolved when the llm provider is patched.
IOrganizationLlmProvidersService.testLlmProvider()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Test existing llm provider
testLlmProvider(provider: Partial<LlmProviderPatch>): Promise<LlmProviderTestResults>;
Parameters
Parameter | Type | Description |
|---|---|---|
provider | Partial<LlmProviderPatch> | definition of the llm provider |
Returns
Promise<LlmProviderTestResults>
Promise resolved with test results.
IOrganizationLlmProvidersService.updateLlmProvider()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Update existing llm provider
updateLlmProvider(provider: ILlmProvider): Promise<ILlmProvider>;
Parameters
Parameter | Type | Description |
|---|---|---|
provider | definition of the llm provider |
Returns
Promise<ILlmProvider>
Promise resolved when the llm provider is updated.