Skip to content

Commit

Permalink
(doc) Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
edwardspec committed Dec 7, 2024
1 parent 5d1ac32 commit ed0074f
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,16 @@ Extension:AskAI
This extension adds [[Special:AI]],
which allows user to make AI queries about content of articles in this wiki.

It also adds "Add to AI chat" link to search results on [[Special:Search]].

## Example configuration

```php
// To use ChatGPT API, add the API key to LocalSettings.php:
$wgAskAIServiceOptionsOpenAI['apiKey'] = 'some-api-key-to-ChatGPT';

// Can choose a model. Default is "gpt-3.5-turbo".
$wgAskAIServiceOptionsOpenAI['model'] = 'chatgpt-4o-latest';
```

## Debug configuration
Expand All @@ -16,3 +22,12 @@ $wgAskAIServiceOptionsOpenAI['apiKey'] = 'some-api-key-to-ChatGPT';
// instead it will respond with "what did we ask from AI" information.
$wgAskAIServiceClass = 'MediaWiki\\AskAI\\Service\\DebugService';
```

## Specifying instructions for AI

Page [[MediaWiki:Askai-default-instructions]] contains instructions for the AI,
which can be modified.

AI will receive the text of these instructions,
then the text of all relevant paragraphs in articles that were selected by user,
and only then the user's question.

0 comments on commit ed0074f

Please sign in to comment.