Azure / Azure/azure-sdk-tools

[Activity] AI Samples generation

Open
#11,417 0 comments 0 reactions 1 assignee Claimed by @deyaaeldeen View on GitHub
AzSDK Tools Agent dev inner loop
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 2h
Merged PRs (30d)
130

Description

## 📝 Summary
We want to generate samples for SDK we produce, using only AI (and not codegeen and x-ms-examples , only English input)

## 🎯 Why This Activity Matters
Samples is a critical part of SDK customers success, and a good indicator of the scenarios that are crucial.

## ⏱️ Prerequisites
- The Bicep file exists. Creating the bicep file is out of scope of this issue.
- There is a TypeSpec to describe the API
- The SDK has been generated, and the ref doc is available

## 🛠️ Tools Required
List the tool(s) that support this activity. Link to tool issues if they exist.

## ⚠️ Pain Points to Consider
The complexity relies mostly on generating:
- Scenarios that include many calls. A scenario is not necessarly a one to one mapping "1 operation == 1 sample"
- Make sure it's idiomatic to the language

## Step1 : Building a solution that provides the same value as manually written samples

We'll take a few SDK (Storage, Doc Intell, KeyVault, etc.), and we'll describe those samples that exists today in English. For instance "A sample that downloads a blob and write it to disk as it reads it", and we'll compare the output of the tool with the manual sample

## Step 2 : TBD based on what we discover for step 1

More details soon

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.