Skip to content

Commit 22b6993

Browse files
authored
Merge pull request #381 from drpebcak/docs-update
2 parents 5f5d8af + c1eafc6 commit 22b6993

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

docs/docs/04-alternative-model-providers.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Alternative Model Providers
22

3-
43
## Usage
54

65
GPTScript can be used against alternative models that expose an OpenAI compatible API or have a provider shim available.
@@ -16,24 +15,29 @@ Say hello world
1615
To use a model that requires a provider shim:
1716

1817
```gptscript
19-
model: claude-3-haiku-20240307 from github.com/gptscript-ai/anthropic-provider
18+
model: claude-3-haiku-20240307 from github.com/gptscript-ai/claude3-anthropic-provider
2019
2120
Say hello world
2221
```
2322

2423
### Authentication
2524

26-
For OpenAI compatible providers, GPTScript will look for an API key to be configured with the prefix `GPTSCRIPT_PROVIDER_`, the base domain converted to environment variable format, and a suffix of `_API_KEY`.
27-
As an example if you are using `mistral-large-latest from https://api.mistral.ai/v1`, the environment variable would be `GPTSCRIPT_PROVIDER_API_MISTRAL_AI_API_KEY`
25+
For OpenAI compatible providers, GPTScript will look for an API key to be configured with the
26+
prefix `GPTSCRIPT_PROVIDER_`, the base domain converted to environment variable format, and a suffix of `_API_KEY`.
27+
As an example if you are using `mistral-large-latest from https://api.mistral.ai/v1`, the environment variable would
28+
be `GPTSCRIPT_PROVIDER_API_MISTRAL_AI_API_KEY`
2829

29-
Each provider shim has different requirements for authentication. Please check the readme for the provider you are trying to use.
30+
Each provider shim has different requirements for authentication. Please check the readme for the provider you are
31+
trying to use.
3032

3133
## Available Model Providers
3234

3335
The following shims are currently available:
36+
3437
* [github.com/gptscript-ai/azure-openai-provider](https://github.com/gptscript-ai/azure-openai-provider)
3538
* [github.com/gptscript-ai/azure-other-provider](https://github.com/gptscript-ai/azure-other-provider)
36-
* [github.com/gptscript-ai/anthropic-provider](https://github.com/gptscript-ai/anthropic-provider)
39+
* [github.com/gptscript-ai/claude3-anthropic-provider](https://github.com/gptscript-ai/claude3-anthropic-provider)
40+
* [github.com/gptscript-ai/claude3-bedrock-provider](https://github.com/gptscript-ai/claude3-bedrock-provider)
3741
* [github.com/gptscript-ai/gemini-aistudio-provider](https://github.com/gptscript-ai/gemini-aistudio-provider)
3842
* [github.com/gptscript-ai/gemini-vertexai-provider](https://github.com/gptscript-ai/gemini-vertexai-provider)
3943

@@ -43,13 +47,12 @@ For any provider that supports listing models, you can use this command:
4347

4448
```bash
4549
# With a shim
46-
gptscript --list-models github.com/gptscript-ai/anthropic-provider
50+
gptscript --list-models github.com/gptscript-ai/claude3-anthropic-provider
4751

4852
# To OpenAI compatible endpoint
4953
gptscript --list-models https://api.mistral.ai/v1
5054
```
5155

52-
5356
## Compatibility
5457

5558
While the shims provide support for using GPTScript with other models, the effectiveness of using a

0 commit comments

Comments
 (0)