Skip to content
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.

Sign up for GitHub

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

Update using.md #139

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update using.md #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ad4611
Update using.md
Danielabom Dec 4, 2024
8e2eb2d
Update install.md
Danielabom Dec 4, 2024
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
7 changes: 5 additions & 2 deletions OpenAPI/kiota/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,12 +128,15 @@ dotnet tool install --global Microsoft.OpenApi.Kiota

## Install the Visual Studio Code extension

1. Open the [Marketplace page of the extension](https://aka.ms/kiota/extension)
1. Select on the **Install** button.
1. Open VS Code and go to the [Marketplace page of the extension](https://aka.ms/kiota/extension)
2. Click **Install**.
3. Once Kiota is installed, enable the integration with Teams Toolkit (TTK) to leverage Kiota for creating AI plugins.
Copy link
Member

Choose a reason for hiding this comment

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

We still have a large customer base who only generate API clients, I'd suggest we move this last point to a separate section below. And add another bullet point to tell them to install TTK extension in case they don't have it.

Copy link
Author

Choose a reason for hiding this comment

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

Hi @baywet, this PR isn't ready for review. I am adding the info and then giving it a more coherent flow. Thanks for the feedback, though. I'll give you a heads-up once I'm done. :)

Copy link
Member

Choose a reason for hiding this comment

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

Ah thanks for letting me know. Don't hesitate to switch the PR to draft, and back to ready when... Ready


> [!NOTE]
> The Kiota Visual Studio Code extension is currently in public preview and is subject to change.



## Run in GitHub actions

You can use the [setup Kiota GitHub Action](https://github.com/microsoft/setup-kiota/) in your workflow to automate client refresh and more by adding a reference to it in your workflow definition and using the CLI just like you would locally.
Expand Down
12 changes: 12 additions & 0 deletions OpenAPI/kiota/using.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,18 @@ ms.date: 03/10/2023

# Using the Kiota tool

Kiota now supports the generation of AI plugins, including Type-B Plugin manifests, tailored for Microsoft Copilots. These AI plugins can be used to ground Large Language Models (LLMs) by integrating them with relevant, use-case-specific data, thereby enhancing the user experience.
Copy link
Member

Choose a reason for hiding this comment

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

Official name is "Copilot Agent Plugins" CC @fabianwilliams

Copy link
Author

Choose a reason for hiding this comment

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

@baywet @fabianwilliams, I'll make sure to give you a heads-up once the PR is ready for review.

Copy link
Author

Choose a reason for hiding this comment

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

Suggested change
Kiota now supports the generation of AI plugins, including Type-B Plugin manifests, tailored for Microsoft Copilots. These AI plugins can be used to ground Large Language Models (LLMs) by integrating them with relevant, use-case-specific data, thereby enhancing the user experience.
Kiota now supports the generation of Copilot Agent plugins, including Type-B Plugin manifests, tailored for Microsoft Copilots. These AI plugins can be used to ground Large Language Models (LLMs) by integrating them with relevant, use-case-specific data, thereby enhancing the user experience.


This article provides instructions on how to use Kiota in Visual Studio Code (VS Code) to generate AI plugins, create API manifests, and integrate them with Microsoft Copilot workflows.
Copy link
Member

Choose a reason for hiding this comment

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

This documentation page was originally dedicated to the CLI options. It'll need to be revamped once we remove the feature flag for the CLI experience.

I suggest we move the documentation for the VS Code extension to a new dedicated page to avoid mixing things, plus this page is already quite long.

Copy link
Author

Choose a reason for hiding this comment

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

I appreciate the input. I'll create a new topic.


## Prerequisites
* Visual Studio Code installed on your machine.
* Kiota extension for Visual Studio Code (VS Code).
* A basic understanding of OpenAPI and plugin generation.
* Access to Kiota or a compatible API catalog (e.g., Microsoft Graph API, GitHub API).



<!-- markdownlint-disable MD024 -->

> [!NOTE]
Expand Down
Loading