Skip to content

Commit d16ac5a

Browse files
authoredJan 21, 2025··
Modify readme and agent to point to docs (#326)
1 parent 33009f1 commit d16ac5a

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed
 

‎README.md

+4
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ README in the each agent folder.
7777

7878
To learn more about how to create an agent for yourself please see, [Creating an Agent][03].
7979

80+
In order to use the `openai-gpt` agent you will need a valid Azure OpenAI service or a public OpenAI
81+
key. For more information on how to get an Azure OpenAI service, see
82+
[Deploying Azure OpenAI Service](./docs/development/AzureOAIDeployment/DeployingAzureOAI.md).
83+
8084
### Chat commands
8185

8286
By default, `aish` provides a base set of chat `/` commands used to interact with the responses from

‎shell/agents/AIShell.OpenAI.Agent/Agent.cs

+2
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,8 @@ 1. Run '/agent config' to open the setting file.
159159
2. {1}. See details at
160160
https://aka.ms/aish/openai
161161
3. Run '/refresh' to apply the new settings.
162+
163+
If you would like to learn more about deploying your own Azure OpenAI Service please see https://aka.ms/AIShell/DeployAOAI.
162164
""";
163165

164166
if (_settings is null || _settings.GPTs.Count is 0)

‎shell/agents/AIShell.OpenAI.Agent/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This agent is designed to provide a flexible and user-friendly platform for interacting with OpenAI
44
services, either the public OpenAI service or a private deployment of the Azure OpenAI service,
5-
through one or more customly defined GPT instances.
5+
through one or more custom defined GPT instances.
66

77
For more information about this agent, see the [OpenAI Agent][01] documentation.
88

0 commit comments

Comments
 (0)
Please sign in to comment.