Skip to content

Modifying readme and agent startup to point to docs on deploying AzOAI account #326

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.

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
Jan 21, 2025
Merged
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -77,6 +77,10 @@ README in the each agent folder.

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

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

### Chat commands

By default, `aish` provides a base set of chat `/` commands used to interact with the responses from
2 changes: 2 additions & 0 deletions shell/agents/AIShell.OpenAI.Agent/Agent.cs
Original file line number Diff line number Diff line change
@@ -151,6 +151,8 @@ 1. Run '/agent config' to open the setting file.
2. {1}. See details at
https://aka.ms/aish/openai
3. Run '/refresh' to apply the new settings.

If you would like to learn more about deploying your own Azure OpenAI Service please see https://aka.ms/AIShell/DeployAOAI.
""";

if (_settings is null || _settings.GPTs.Count is 0)
2 changes: 1 addition & 1 deletion shell/agents/AIShell.OpenAI.Agent/README.md
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@

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

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