> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IOrganizationLlmProvidersService

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/organization/llmProviders/index.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

This service provides access to organization llm providers configuration.

**Signature:**

```typescript
export interface IOrganizationLlmProvidersService 
```

## Methods

| Method | Description |
| --- | --- |
| [createLlmProvider(provider)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationllmprovidersservice/index.md#iorganizationllmprovidersservicecreatellmprovider) | **_(ALPHA)_** Create a new llm provider |
| [deleteLlmProvider(id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationllmprovidersservice/index.md#iorganizationllmprovidersservicedeletellmprovider) | **_(ALPHA)_** Delete a provider |
| [getCount()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationllmprovidersservice/index.md#iorganizationllmprovidersservicegetcount) | **_(ALPHA)_** Get count of all llm providers |
| [getLlmProvider(id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationllmprovidersservice/index.md#iorganizationllmprovidersservicegetllmprovider) | **_(ALPHA)_** Get llm provider by id |
| [getProvidersQuery()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationllmprovidersservice/index.md#iorganizationllmprovidersservicegetprovidersquery) | **_(ALPHA)_** Get providers query |
| [listLlmProviderModels(id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationllmprovidersservice/index.md#iorganizationllmprovidersservicelistllmprovidermodels) | **_(ALPHA)_** List models for a provider |
| [listLlmProviderModels(provider)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationllmprovidersservice/index.md#iorganizationllmprovidersservicelistllmprovidermodels) | **_(ALPHA)_** List models for a provider definition |
| [patchLlmProvider(provider)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationllmprovidersservice/index.md#iorganizationllmprovidersservicepatchllmprovider) | **_(ALPHA)_** Patch existing llm provider |
| [testLlmProvider(provider)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationllmprovidersservice/index.md#iorganizationllmprovidersservicetestllmprovider) | **_(ALPHA)_** Test existing llm provider |
| [updateLlmProvider(provider)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationllmprovidersservice/index.md#iorganizationllmprovidersserviceupdatellmprovider) | **_(ALPHA)_** Update existing llm provider |

## Method details

### IOrganizationLlmProvidersService.createLlmProvider()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Create a new llm provider

**Signature:**

```typescript
createLlmProvider(provider: ILlmProvider): Promise<ILlmProvider>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| provider | [ILlmProvider](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.illmprovider/index.md) | definition of the llm provider |

**Returns:**

Promise&lt;[ILlmProvider](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.illmprovider/index.md)&gt;

Promise resolved with created llm provider.

### IOrganizationLlmProvidersService.deleteLlmProvider()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Delete a provider

**Signature:**

```typescript
deleteLlmProvider(id: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | id of the provider |

**Returns:**

Promise&lt;void&gt;

Promise resolved when the provider is deleted.

### IOrganizationLlmProvidersService.getCount()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get count of all llm providers

**Signature:**

```typescript
getCount(): Promise<number>;
```
**Returns:**

Promise&lt;number&gt;

Promise resolved with number of llm providers.

### IOrganizationLlmProvidersService.getLlmProvider()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get llm provider by id

**Signature:**

```typescript
getLlmProvider(id: string): Promise<ILlmProvider | undefined>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | id of the provider |

**Returns:**

Promise&lt;[ILlmProvider](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.illmprovider/index.md) &#124; undefined&gt;

Promise resolved with provider.

### IOrganizationLlmProvidersService.getProvidersQuery()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get providers query

**Signature:**

```typescript
getProvidersQuery(): ILlmProvidersQuery;
```
**Returns:**

[ILlmProvidersQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.illmprovidersquery/index.md)

providers query

### IOrganizationLlmProvidersService.listLlmProviderModels()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

List models for a provider

**Signature:**

```typescript
listLlmProviderModels(id: string): Promise<LlmProviderListModelsResults>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | id of the provider |

**Returns:**

Promise&lt;[LlmProviderListModelsResults](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.llmproviderlistmodelsresults/index.md)&gt;

Promise resolved with list of models.

### IOrganizationLlmProvidersService.listLlmProviderModels()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

List models for a provider definition

**Signature:**

```typescript
listLlmProviderModels(provider: Partial<LlmProviderPatch>): Promise<LlmProviderListModelsResults>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| provider | Partial&lt;[LlmProviderPatch](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.llmproviderpatch/index.md)&gt; | definition of the llm provider |

**Returns:**

Promise&lt;[LlmProviderListModelsResults](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.llmproviderlistmodelsresults/index.md)&gt;

Promise resolved with list of models.

### IOrganizationLlmProvidersService.patchLlmProvider()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Patch existing llm provider

**Signature:**

```typescript
patchLlmProvider(provider: LlmProviderPatch): Promise<ILlmProvider>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| provider | [LlmProviderPatch](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.llmproviderpatch/index.md) | definition of the llm provider |

**Returns:**

Promise&lt;[ILlmProvider](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.illmprovider/index.md)&gt;

Promise resolved when the llm provider is patched.

### IOrganizationLlmProvidersService.testLlmProvider()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Test existing llm provider

**Signature:**

```typescript
testLlmProvider(provider: Partial<LlmProviderPatch>): Promise<LlmProviderTestResults>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| provider | Partial&lt;[LlmProviderPatch](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.llmproviderpatch/index.md)&gt; | definition of the llm provider |

**Returns:**

Promise&lt;[LlmProviderTestResults](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.llmprovidertestresults/index.md)&gt;

Promise resolved with test results.

### IOrganizationLlmProvidersService.updateLlmProvider()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Update existing llm provider

**Signature:**

```typescript
updateLlmProvider(provider: ILlmProvider): Promise<ILlmProvider>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| provider | [ILlmProvider](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.illmprovider/index.md) | definition of the llm provider |

**Returns:**

Promise&lt;[ILlmProvider](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.illmprovider/index.md)&gt;

Promise resolved when the llm provider is updated.