Add az aks ai command #6629

sulixu · 2023-08-10T20:21:55Z

The az aks ai command initiates a chat with an Azure Kubernetes Service AI Expert, providing scripts for az commands along with instructions ('re-prompt', 'run', 'quit') for interactive use.

Summary of changes in each file:

_help.py: Added help text for the new aks ai command.
_openai_wrapper.py: Added a new file that contains the implementation of the OpenAI chat assistant.
commands.py: Added the aks ai command to the command table.
custom.py: Added the start_chat function that launches the OpenAI interactive shell.
tests/latest/test_aks_commands.py: Added tests for the aks ai command.
setup.py: Updated the version number and dependencies

This checklist is used to make sure that common guidelines for a pull request are followed.

Related command

az extension update --name aks-preview
az aks copilot

General Guidelines

Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
Have you run python scripts/ci/test_index.py -q locally?

For new extensions:

[] My extension description/summary conforms to the Extension Summary Guidelines.

About Extension Publish

There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update src/index.json automatically.
You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify src/index.json.

azure-client-tools-bot-prd · 2023-08-10T20:21:57Z

⚠️Azure CLI Extensions Breaking Change Test

⚠️aks-preview

rule cmd_name rule_message suggest_message

⚠️ 1001 - CmdAdd aks copilot cmd aks copilot added

azure-client-tools-bot-prd · 2023-08-10T20:22:00Z

Hi @sulixu,
Please write the description of changes which can be perceived by customers into HISTORY.rst.
If you want to release a new extension version, please update the version in setup.py as well.

yonzhan · 2023-08-10T20:22:09Z

Thank you for your contribution! We will review the pull request and get back to you soon.

FumingZhang · 2023-08-11T08:06:17Z

src/aks-preview/azext_aks_preview/_help.py

As far as I know, cli command does not accept positional arguments. May be set an option for this?

FumingZhang · 2023-08-11T08:10:52Z

src/aks-preview/setup.py

Better pin the dependency to a fixed version

FumingZhang

LGTM

FumingZhang · 2023-08-17T02:00:14Z

src/aks-preview/azext_aks_preview/tests/latest/test_aks_commands.py

Can you leave a note (or a link) about where/how to acquire these keys in the command help message?

jsntcy · 2023-08-23T03:45:51Z

src/aks-preview/azext_aks_preview/commands.py

Maybe "copilot" is better than "ai"?

ReaNAiveD · 2023-08-23T04:37:59Z

src/aks-preview/azext_aks_preview/_help.py

Suggested change

long-summary: This command initiates a chat assistant with expertise in Azure Kubernetes Service, offering guidance on troubleshooting issues using az commands.

long-summary: |-

This command initiates a chat assistant with expertise in Azure Kubernetes Service, offering guidance on troubleshooting issues using az commands.

Maybe we could use |- to preserves the newlines in long-summary?

zhoxing-ms · 2023-08-23T09:21:54Z

src/aks-preview/azext_aks_preview/_help.py

How about naming it as aks assistant or aks copilot?

zhoxing-ms · 2023-08-23T09:30:57Z

src/aks-preview/azext_aks_preview/_params.py

Using general name instead of professional terminology may be more user-friendly, especially for some customers who may not be familiar with ChatGPT related fields

Suggested change

c.argument('prompt', options_list=['--prompt', '-p'], validator=validate_prompt_input,

help='The question you want to ask, e.g: How to create a AKS cluster')

c.argument('question', options_list=['--question', '-q'], validator=validate_prompt_input,

help='The question you want to ask, e.g: How to create a AKS cluster')

zhoxing-ms · 2023-08-23T09:33:53Z

src/aks-preview/setup.py

Please note that the colorama is already defined in core CLI code link , so there is no need for duplicate definitions to avoid dependency conflicts in the future

…vice expert Summary of changes in each file: - `_help.py`: Added help text for the new `aks ai` command. - `_openai_wrapper.py`: Added a new file that contains the implementation of the OpenAI chat assistant. - `commands.py`: Added the `aks ai` command to the command table. - `custom.py`: Added the `start_chat` function that launches the OpenAI interactive shell. - `tests/latest/test_aks_commands.py`: Added tests for the `aks ai` command. - `setup.py`: Updated the version number and dependencies

Summary of changes in each file: - `_help.py`: Renamed the command 'aks ai' to 'aks copilot' in the help text. - `_params.py`: Renamed the command 'aks ai' to 'aks copilot' in the argument context. - `commands.py`: Renamed the command 'aks ai' to 'aks copilot' in the command group. - `test_aks_commands.py`: Updated the test case to use the new command 'aks copilot' instead of 'aks ai'.

zhoxing-ms · 2023-09-01T02:29:16Z

Please take a look at this comment #6629 (comment) You need to add the description of PR change into the HISTORY.rst

jsntcy · 2023-09-04T05:47:28Z

src/aks-preview/azext_aks_preview/custom.py

+        # Handle user input
+        user_input = getch()
+        if user_input in ('p', 'P'):
+            scripts, messages = prompt_chat_gpt(messages, params, insist=False, scripts=scripts)


Could you please help explain the purpose of passing insist=False for prompt_char_gpt?

at the very beginning of the session, we need to start with a user mission/task
"Prompt: I need to create a aks cluster"

If user just press enter without entering anything, we have so objective, so insist is default to True to prompt the user until they supply to task to work with

for example, user might hit enter by mistake multiple times until typed "Create a AKS cluster", so I only show "Prompt:"

Once that is started, user can always re-prompt the LLM to refine their objectives or add more requirements by re-prompting. But they would trigger that by mistake or they change their mind, so insist=False allow the user to not enter anything (= cancel out of the prompt)

from 0.5.155 to 0.5.156

azclibot · 2023-09-06T04:10:03Z

[Release] Update index.json for extension [ aks-preview ] : https://dev.azure.com/azclitools/internal/_build/results?buildId=88397&view=results

sulixu requested review from FumingZhang and andyliuliming as code owners August 10, 2023 20:21

azure-client-tools-bot-prd bot added this to the August 2023 (2023-09-05) milestone Aug 10, 2023

microsoft-github-policy-service bot requested review from yanzhudd, yonzhan and zhoxing-ms August 10, 2023 20:22

microsoft-github-policy-service bot assigned zhoxing-ms Aug 10, 2023

microsoft-github-policy-service bot added Auto-Assign Auto assign by bot AKS labels Aug 10, 2023

FumingZhang reviewed Aug 11, 2023

View reviewed changes

sulixu force-pushed the dev-aks-preview-ai branch from 749599e to 619aa54 Compare August 14, 2023 23:36

FumingZhang approved these changes Aug 17, 2023

View reviewed changes

FumingZhang reviewed Aug 17, 2023

View reviewed changes

jsntcy reviewed Aug 23, 2023

View reviewed changes

src/aks-preview/azext_aks_preview/commands.py Outdated

Copy link

Member

jsntcy Aug 23, 2023 •

edited

Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe "copilot" is better than "ai"?

ReaNAiveD reviewed Aug 23, 2023

View reviewed changes

zhoxing-ms reviewed Aug 23, 2023

View reviewed changes

src/aks-preview/azext_aks_preview/_help.py Outdated

Copy link

Contributor

zhoxing-ms Aug 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about naming it as aks assistant or aks copilot?

zhoxing-ms reviewed Aug 23, 2023

View reviewed changes

sulixu force-pushed the dev-aks-preview-ai branch from f9f5591 to 754331d Compare August 28, 2023 18:42

suli-ms added 8 commits August 30, 2023 10:26

update help file

1faaf8d

fix lint issues

1e28849

fix lint issues

e313a21

add optional parameter: --prompt

672fed0

fix lint error

4819f32

add validator

6a8ee75

provide links and help messages about where/how to acquire keys

3c55f54

suli-ms added 2 commits August 30, 2023 10:26

address comments

e18bc98

sulixu force-pushed the dev-aks-preview-ai branch from e56bb8d to 71b95d6 Compare August 30, 2023 17:28

update history.rst to include new command change

4186986

zhoxing-ms approved these changes Sep 4, 2023

View reviewed changes

ReaNAiveD approved these changes Sep 4, 2023

View reviewed changes

jsntcy reviewed Sep 4, 2023

View reviewed changes

sulixu added 2 commits September 5, 2023 09:55

Merge branch 'main' into dev-aks-preview-ai

9a65283

Update setup.py

65b6a77

from 0.5.155 to 0.5.156

jsntcy approved these changes Sep 6, 2023

View reviewed changes

zhoxing-ms approved these changes Sep 6, 2023

View reviewed changes

zhoxing-ms merged commit e1e186d into Azure:main Sep 6, 2023

sulixu mentioned this pull request Sep 19, 2023

revert az aks copilot #6773

Merged

3 tasks

	long-summary: This command initiates a chat assistant with expertise in Azure Kubernetes Service, offering guidance on troubleshooting issues using az commands.
	long-summary: \|-
	This command initiates a chat assistant with expertise in Azure Kubernetes Service, offering guidance on troubleshooting issues using az commands.

-        c.argument('prompt', options_list=['--prompt', '-p'], validator=validate_prompt_input,
-                   help='The question you want to ask, e.g: How to create a AKS cluster')
+        c.argument('question', options_list=['--question', '-q'], validator=validate_prompt_input,
+                   help='The question you want to ask, e.g: How to create a AKS cluster')

Add az aks ai command #6629

Add az aks ai command #6629

Uh oh!

Conversation

sulixu commented Aug 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related command

General Guidelines

About Extension Publish

Uh oh!

azure-client-tools-bot-prd bot commented Aug 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azure-client-tools-bot-prd bot commented Aug 10, 2023

Uh oh!

yonzhan commented Aug 10, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FumingZhang left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jsntcy Aug 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zhoxing-ms Aug 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zhoxing-ms commented Sep 1, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

azclibot commented Sep 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

sulixu commented Aug 10, 2023 •

edited

Loading

azure-client-tools-bot-prd bot commented Aug 10, 2023 •

edited

Loading

jsntcy Aug 23, 2023 •

edited

Loading

zhoxing-ms Aug 23, 2023 •

edited

Loading