Skip to content
Merged
Show file tree
Hide file tree
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
45 changes: 44 additions & 1 deletion reference/docs-conceptual/AIShell/how-to/agent-openai.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: OpenAI agent README
description: Learn how to use the OpenAI agent in AI Shell.
ms.date: 05/16/2025
ms.date: 05/21/2025
ms.topic: how-to
---
# OpenAI agent
Expand Down Expand Up @@ -77,6 +77,48 @@ Update the file based on the following example:
> deployment, for example you can just use the following endpoint format,
> `https://<YourServiceName>.openai.azure.com`.

### Support for Microsoft Entra ID authentication

To keep password and keys secure, we’ve added support for Entra ID authentication to to Azure OpenAI
instances. Now you can access your Azure OpenAI resource without storing keys in the configuration
file. The following example shows how to configure Entra ID authentication:

```json
{
// Declare GPT instances.
"GPTs": [
// Declaration of an Azure OpenAI instance with EntraID authentication
{
"Name": "ps-az-entraId",
"Description": "A GPT instance with expertise in PowerShell scripting using Entra ID authentication.",
"Endpoint": "<Your Endpoint>",
"Deployment": "<Your Deployment Name>",
"ModelName": "<Your Model Name>",
"AuthType": "EntraID",
"SystemPrompt": "You are a helpful and friendly assistant with expertise in PowerShell scripting and command line."
}
],

// Specify the default GPT instance to use for user query.
"Active": "ps-az-entraId"
}
```

Azure OpenAI uses the following hierarchy of credentials for authentication:

- `EnvironmentCredential`
- `WorkloadIdentityCredential`
- `ManagedIdentityCredential`
- `SharedTokenCacheCredential`
- `VisualStudioCredential`
- `AzureCliCredential`
- `AzurePowerShellCredential`
- `AzureDeveloperCliCredential`
- `InteractiveBrowserCredential`

For more information about these credentials, see .NET documentation for
[`DefaultAzureCredential`][11].

## GPT

GPTs are tailored versions of base OpenAI models. You use a GPT to provide focused responses based
Expand Down Expand Up @@ -154,3 +196,4 @@ models names:
[08]: https://ollama.com/blog/openai-compatibility
[09]: https://platform.openai.com/api-keys
[10]: https://platform.openai.com/docs/models
[11]: xref:Azure.Identity.DefaultAzureCredential
23 changes: 16 additions & 7 deletions reference/docs-conceptual/AIShell/overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: What is AI Shell?
description: Learn about AI Shell, an interactive shell that provides a chat interface with language models.
ms.date: 05/16/2025
ms.date: 05/21/2025
ms.topic: overview
---

Expand Down Expand Up @@ -37,16 +37,22 @@ shell. These features include:

## Project Status

The current version of AI Shell is 1.0.0-preview.4. AI Shell is provided for testing, but it's not
feature-complete. Some elements of the tool are still under development and are subject to change.
Your feedback is important to us during this development phase. We encourage you to share your
experiences to help us improve AI Shell.
The current version of AI Shell is v1.0.0-preview.4. AI Some elements of the tool are still under
development and are subject to change.

AI Shell v1.0.0-preview.4 includes the following enhancements:

- Improved macOS support including the side-car experience with iTerm2
- Support for Microsoft Entra ID authentication in Azure OpenAI
- New parameters for `Invoke-AIShell`
- Experimental Phi Silica agent that uses the built-in AI model included with the latest Copilot+
PCs

## Known Issues

This current release of AI Shell has some known issues that we're actively working on addressing:

- The split-screen experience works with Windows Terminal and iTerm2 for macOS.
- The split-screen experience only works with Windows Terminal and iTerm2 for macOS.
- The **AI Shell** module isn't supported on Linux. You can run the `aish` executable on Linux,
but it isn't tested on any Linux distribution.
- If you have multiple versions of Windows Terminal installed, the `Start-AIShell` command opens a
Expand All @@ -60,7 +66,10 @@ You can report other issues in the [GitHub repository][03].

## Providing feedback

We welcome your feedback to help improve AI Shell! Here are ways you can get involved:
Your feedback is important to us during this development phase. We encourage you to share your
experiences to help us improve AI Shell.

Here are ways you can get involved:

- **File Issues:** If you encounter bugs, have suggestions for new features, or would like to report
inconsistencies, open an issue on the [AI Shell GitHub repository][03].
Expand Down