با Pipet Code Agent یک دستیار کد هوش مصنوعی بسازید

نوشتن کد می‌تواند هم پاداش‌دهنده و هم رضایت‌بخش باشد، اما تبدیل کدتان از حالت کارآمد به قابل ارائه برای همکاران، اغلب یک کار طاقت فرسا است. مدل‌های مولد هوش مصنوعی می‌توانند به شما در اضافه کردن نظرات کد، یافتن اشتباهات قبل از انجام بازبین‌های انسانی کمک کنند و مجموعه‌ای از وظایف دیگر را انجام دهند تا گردش کار کدنویسی شما آسان‌تر شود.

این آموزش به شما نشان می‌دهد که چگونه Pipet Code Agent را گسترش دهید، یک ابزار کمکی کد مبتنی بر هوش مصنوعی که توسط تیم روابط توسعه‌دهنده هوش مصنوعی در Google ساخته شده است. این پروژه منبع باز یک برنامه افزودنی برای Microsoft Visual Studio Code (VS Code) است که به شما کمک می کند تا از برخی از کارهای مهم، اما کمتر سرگرم کننده کدنویسی، مانند نظر دادن به کد خود، یافتن اشتباهات، و پیشنهاد بهبودها مراقبت کنید. برنامه افزودنی درخواست‌های کمک کدنویسی را به Gemini API ارسال می‌کند و پاسخ‌ها را در پنجره ویرایش کد شما قرار می‌دهد.

شما می توانید Pipet را تغییر دهید تا این توابع موجود برای شما بهتر عمل کنند، یا دستورات جدیدی بسازید تا از گردش کار توسعه خود بهتر پشتیبانی کند.

برای یک نمای کلی ویدیویی از پروژه و نحوه گسترش آن، از جمله بینش افرادی که آن را ساخته اند، دستیار کد AI - ساخت با هوش مصنوعی گوگل را بررسی کنید. در غیر این صورت می توانید با پیروی از دستورالعمل های زیر، تمدید پروژه را شروع کنید.

راه اندازی پروژه

این دستورالعمل‌ها شما را در راه‌اندازی پروژه Pipet Code Agent برای توسعه و آزمایش راهنمایی می‌کنند. مراحل کلی نصب برخی نرم افزارهای پیش نیاز، تنظیم چند متغیر محیطی، شبیه سازی پروژه از مخزن کد و اجرای نصب پیکربندی است.

پیش نیازها را نصب کنید

پروژه Pipet Code Agent به عنوان یک افزونه Microsoft Visual Studio Code اجرا می شود و از Node.js و ابزار npm برای مدیریت بسته ها و اجرای برنامه استفاده می کند. دستورالعمل‌های نصب زیر برای دستگاه میزبان لینوکس است.

برای نصب نرم افزار مورد نیاز:

  1. کد ویژوال استودیو را برای پلتفرم خود نصب کنید.
  2. با دنبال کردن دستورالعمل‌های نصب پلتفرم خود، node و npm را نصب کنید.

پروژه را شبیه سازی و پیکربندی کنید

کد پروژه را دانلود کرده و از دستور نصب npm برای دانلود وابستگی های مورد نیاز و پیکربندی پروژه استفاده کنید. برای بازیابی کد منبع پروژه به نرم افزار کنترل منبع git نیاز دارید.

برای دانلود و پیکربندی کد پروژه:

  1. با استفاده از دستور زیر مخزن git را کلون کنید.
    git clone https://github.com/google/generative-ai-docs
  2. اختیاری، مخزن git محلی خود را برای استفاده از پرداخت پراکنده پیکربندی کنید، بنابراین فقط فایل‌های پروژه Docs Agent را در اختیار داشته باشید.
    cd generative-ai-docs/
git sparse-checkout init --cone
git sparse-checkout set examples/gemini/node/pipet-code-agent/
  3. به دایرکتوری ریشه پروژه Pipet Code Agent بروید.
    cd generative-ai-docs/examples/gemini/node/pipet-code-agent/
  4. برای دانلود وابستگی ها و پیکربندی پروژه، دستور install را اجرا کنید:
    npm install

افزونه را پیکربندی و آزمایش کنید

اکنون باید بتوانید نصب خود را با اجرای Pipet Code Agent به عنوان افزونه توسعه در VS Code روی دستگاه خود آزمایش کنید. آزمایش یک پنجره میزبان توسعه برنامه افزودنی VS Code را باز می کند که در آن افزونه جدید در دسترس است. در این پنجره جدید، کلید API را که افزونه برای دسترسی به Google Gemini API استفاده می‌کند، پیکربندی می‌کنید.

Pipet Code Agent در پنجره Extension Development Host اجرا می شود شکل 1. پنجره میزبان توسعه پسوند کد VS با دستورات پسوند Pipet.

برای پیکربندی و آزمایش تنظیمات خود:

  1. برنامه VS Code را راه اندازی کنید.
  2. در VS Code، با انتخاب File > New Window یک پنجره جدید ایجاد کنید.
  3. پروژه Pipet Code Agent را با انتخاب File > Open Folder و انتخاب پوشه pipet-code-agent/ باز کنید.
  4. فایل pipet-code-agent/package.json را باز کنید.
  5. برنامه افزودنی را در حالت اشکال زدایی با انتخاب Run > Start Debugging اجرا کنید. این مرحله یک پنجره جداگانه میزبان توسعه برنامه افزودنی VS Code باز می کند.
  6. تنظیمات VS Code را با انتخاب Code > Settings > Settings باز کنید.
  7. یک کلید API Google Gemini از سایت Generative AI Developer دریافت کنید و رشته کلید را کپی کنید.
  8. کلید API را به عنوان تنظیمات پیکربندی تنظیم کنید. در قسمت تنظیمات جستجو ، pipet را تایپ کنید، تب User را انتخاب کنید و در Google > Gemini: تنظیمات Api Key ، روی پیوند Edit in settings.json کلیک کنید و کلید API Gemini خود را اضافه کنید:
    "google.gemini.apiKey": "your-api-key-here"
  9. تغییرات را در فایل settings.json ذخیره کنید و تب تنظیمات را ببندید.

برای تست دستورات افزونه:

  1. در پنجره VS Code Extension Development Host ، هر کدی را در پنجره ویرایشگر انتخاب کنید.
  2. با انتخاب View > Command Palette، پالت فرمان را باز کنید.
  3. در پالت فرمان، Pipet تایپ کرده و یکی از دستورات با آن پیشوند را انتخاب کنید.

دستور موجود را اصلاح کنید

اصلاح دستورات ارائه شده در Pipet Code Agent ساده ترین راه برای تغییر رفتار و قابلیت های افزونه است. دستورات نظر و بازبینی هر دو از رویکردهای چند شات با نمونه‌هایی از کد و نظرات برای آن کد و همچنین برخی دستورالعمل‌های کلی برای مدل تولیدی هوش مصنوعی استفاده می‌کنند. این اطلاعات زمینه سریع، مدل مولد Gemini را در شکل‌دهی پاسخ راهنمایی می‌کند. با تغییر دستورالعمل‌ها، مثال‌ها یا هر دو در دستورات نظر یا بررسی، می‌توانید نحوه رفتار هر یک از دستورات موجود را تغییر دهید.

این مجموعه دستورالعمل نحوه تغییر دستور review.ts را با تغییر متن فرمان دستور توضیح می دهد.

برای آماده شدن برای ویرایش دستور review.ts :

  1. برنامه VS Code را راه اندازی کنید.
  2. در VS Code، با انتخاب File > New Window یک پنجره جدید ایجاد کنید.
  3. پروژه Pipet Code Agent را با انتخاب File > Open Folder و انتخاب پوشه pipet-code-agent/ باز کنید.
  4. فایل pipet-code-agent/src/review.ts را باز کنید.

برای تغییر رفتار دستور review.ts :

  1. در فایل review.ts ، شروع ثابت PROMPT را به دستورالعمل های مختلف تغییر دهید.
    const PROMPT = '
Write review comments for following code, identifying bugs and ways to improve code quality. Examples of bugs are syntax errors or typos, out of memory errors, and boundary value errors. Examples of improving code quality are reducing complexity of code, eliminating duplicate code, and ensuring other developers
are able to understand the code.
${CODE_LABEL}
...
  2. در صورت تمایل، در فایل review.ts ، نمونه دیگری را به لیست نمونه های کد و بررسی کد اضافه کنید.
    ...
${REVIEW_LABEL}
There are duplicate lines of code in this control structure.
${CODE_LABEL}
const fixed_value = 128;
${REVIEW_LABEL}
Make sure constant names are in all capitals (FIXED_VALUE) for clarity.
';
  3. تغییرات را در فایل review.ts ذخیره کنید.

برای تست دستور اصلاح شده:

  1. در پنجره پروژه برنامه افزودنی VS Code Pipet خود، با انتخاب Run > Restart Debugging، دیباگر را مجددا راه اندازی کنید.
  2. در پنجره VS Code Extension Development Host ، هر کدی را در پنجره ویرایشگر انتخاب کنید.
  3. با انتخاب View > Command Palette، پالت فرمان را باز کنید.
  4. در پالت فرمان، Pipet تایپ کرده و Pipet را انتخاب کنید: دستور کد انتخاب شده را مرور کنید .

دستور جدید ایجاد کنید

شما می توانید Pipet را با ایجاد دستورات جدید که وظایف کاملاً جدیدی را با Gemini API انجام می دهند گسترش دهید. هر فایل فرمان ( comment.ts و review.ts ) عمدتاً مستقل است و شامل کدهایی برای جمع‌آوری متن از ویرایشگر فعال، نوشتن یک اعلان، اتصال به Gemini API، ارسال یک درخواست و رسیدگی به پاسخ است.

Pipet Code Agent با نام تابع انتخاب نشان داده شده است شکل 2. دستور توصیه نام تابع جدید در پنجره میزبان توسعه کد VS Code.

این مجموعه دستورالعمل نحوه ساخت یک دستور جدید را با استفاده از کد یک دستور موجود، comment.ts ، به عنوان یک الگو توضیح می دهد.

برای ایجاد دستوری که نام هایی را برای توابع توصیه می کند:

  1. یک کپی از فایل pipet-code-agent/src/comment.ts به نام name.ts در دایرکتوری src/ تهیه کنید.
  2. در VS Code، فایل src/name.ts را باز کنید.
  3. با ویرایش مقدار PROMPT دستورالعمل های درخواستی را در فایل name.ts تغییر دهید.
    // Provide instructions for the AI generative model
const PROMPT = `Recommend a name for this function. Explain your
reasoning in 3 sentences or less:`;
  4. نام تابع فرمان و پیام اطلاعاتی آن را تغییر دهید.
    export async function generateName() {
  vscode.window.showInformationMessage('Generating function name...');
  5. کد اسمبلی اعلان را به روز کنید تا فقط مقدار PROMPT و متن انتخاب شده در ویرایشگر را شامل شود.
      // Build the full prompt using the template.
  const fullPrompt = `${PROMPT}
"
${selectedCode}
"
`;
  6. خروجی پاسخ را برای توصیف آنچه که ایجاد می کند تغییر دهید.
        // update prefix to describe output
    let commentIntro = padding + commentPrefix + "Recommended name: (generated)\n";
    editBuilder.insert(selection.start, commentIntro);
    editBuilder.insert(selection.start, pyComment);
  7. تغییرات را در فایل review.ts ذخیره کنید.

دستور جدید را یکپارچه کنید

پس از تکمیل کد دستور جدید، باید آن را با بقیه برنامه افزودنی ادغام کنید. فایل های extension.ts و package.json را به روز کنید تا دستور جدید بخشی از افزونه شود و VS Code را برای فراخوانی دستور جدید فعال کنید.

برای ادغام دستور name با کد پسوند:

  1. در VS Code، فایل pipet-code-agent/src/extension.ts را باز کنید.
  2. فایل کد جدید را با افزودن یک دستور import جدید به پسوند اضافه کنید.
    import { generateName } from './name';
  3. با افزودن کد زیر به تابع activate() دستور جدید را ثبت کنید.
    export function activate(context: vscode.ExtensionContext) {
    ...
    vscode.commands.registerCommand('pipet-code-agent.nameFunction', generateName);
}
  4. تغییرات را در فایل extension.ts ذخیره کنید.

برای ادغام دستور name با بسته افزونه:

  1. در VS Code، فایل pipet-code-agent/package.json را باز کنید.
  2. دستور جدید را به قسمت commands فایل بسته اضافه کنید.
      "contributes": {
    "commands": [
      ...
      {
        "command": "pipet-code-agent.nameFunction",
        "title": "Pipet: Name the selected function."
      }
    ],
  3. تغییرات را در فایل package.json ذخیره کنید.

دستور جدید را تست کنید

پس از تکمیل کدنویسی دستور و ادغام آن با پسوند، می توانید آن را آزمایش کنید. دستور جدید شما فقط در پنجره VS Code Extension Development Host موجود است و نه در پنجره VS Code که در آن کد برنامه افزودنی را ویرایش کرده اید.

برای تست دستور اصلاح شده:

  1. در پنجره پروژه برنامه افزودنی VS Code Pipet خود، با انتخاب Run > Restart Debugging ، دیباگر را مجدداً راه اندازی کنید، که یک پنجره میزبان توسعه برنامه افزودنی جداگانه راه اندازی مجدد می شود.
  2. در پنجره VS Code Extension Development Host ، کدی را در پنجره ویرایشگر انتخاب کنید.
  3. با انتخاب View > Command Palette، پالت فرمان را باز کنید.
  4. در پالت فرمان، Pipet تایپ کرده و Pipet را انتخاب کنید: نام تابع انتخاب شده را نامگذاری کنید .

منابع اضافی

برای اطلاعات بیشتر در مورد پروژه Pipet Code Agent، به مخزن کد مراجعه کنید. اگر برای ساختن برنامه به کمک نیاز دارید یا به دنبال همکاران توسعه دهنده هستید، سرور Discord انجمن توسعه دهندگان Google را بررسی کنید.

برنامه های کاربردی تولید

اگر قصد دارید Docs Agent را برای مخاطبان زیادی مستقر کنید، توجه داشته باشید که استفاده شما از Google Gemini API ممکن است مشمول محدودیت نرخ و سایر محدودیت‌های استفاده باشد. اگر قصد ساختن یک برنامه تولیدی با API Gemini مانند Docs Agent را دارید، سرویس‌های Google Cloud Vertex AI را برای افزایش مقیاس‌پذیری و قابلیت اطمینان برنامه خود بررسی کنید.