Skip to content

Commit

Permalink
[docs] AI providers: Add minimal configuration (MDL-83381)
Browse files Browse the repository at this point in the history
  • Loading branch information
davewoloszyn committed Oct 14, 2024
1 parent 4872821 commit 86c8533
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/apis/plugintypes/ai/provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,3 +226,19 @@ For example, the `aiprovider_openai` plugin provides settings for the user and g
));
$settings->hide_if('aiprovider_openai/userratelimit', 'aiprovider_openai/enableuserratelimit', 'eq', 0);
```

## Minimal configuration

Each provider will need to specify what it takes to achieve minimal configuration. The parent method `is_provider_configured()` will
return `false` by default and will need to be overwritten by the child class.

The `is_provider_configured()` must return `true` for UI component visibility and functionality.

For example, the `aiprovider_azureai` provider checks values are set for `$this->apikey` and `$this->apiendpoint` and returns
the result.

```php
public function is_provider_configured(): bool {
return !empty($this->apikey) && !empty($this->apiendpoint);
}
```

0 comments on commit 86c8533

Please sign in to comment.