Skip to content

[docs] AI providers: Add minimal configuration (MDL-83381) #1152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 16, 2024
Merged

[docs] AI providers: Add minimal configuration (MDL-83381) #1152

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/apis/plugintypes/ai/provider.md
View file
Open in desktop
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);
}
```
Loading