contoso creative writer

page_type	ภาษา	สินค้า	urlfragment	ชื่อ	คำอธิบาย
ตัวอย่าง	นักพัฒนาซอฟต์แวร์ งูหลาม JS ตัวพิมพ์ใหญ่ ทุบตี bicep	สีฟ้า Azure-Openai Azure-bing-web Azure-cognitive-search	นักเขียน contoso-creative	ผู้ช่วยการเขียนเชิงสร้างสรรค์ - การทำงานกับตัวแทนโดยใช้ Protty (การใช้งาน Python)	การใช้ Azure OpenAI Agent กับ Python การรวมการค้นหา Bing Search API และ Azure AI เพื่อสร้างบทความตามหัวข้อและคำสั่งของผู้ใช้

ผู้ช่วยการเขียนเชิงสร้างสรรค์: การทำงานกับตัวแทนโดยใช้ Pretcy (การใช้งาน Python)

สารบัญ

• คุณสมบัติ
• ข้อกำหนดบัญชี Azure
• เริ่มต้น
  • GitHub Codespaces
  • vs รหัส dev คอนเทนเนอร์
  • สภาพแวดล้อมในท้องถิ่น
    • ข้อกำหนดเบื้องต้น
    • การเริ่มต้นโครงการ
• การปรับใช้
• ทดสอบตัวอย่าง
  • การประเมินผล
• คำแนะนำ
  • ความพร้อมใช้งานของภูมิภาค
  • ค่าใช้จ่าย
  • แนวทางการรักษาความปลอดภัย
• ทรัพยากร
• จรรยาบรรณ

เปิดหน้าต่างเทอร์มินัล

ลงชื่อเข้าใช้บัญชี Azure ของคุณ คุณจะต้องเข้าสู่ระบบทั้ง Azure Developer CLI และ Azure CLI:

ฉัน. ครั้งแรกกับ Azure Developer CLI

azd auth login

ii. จากนั้นลงชื่อเข้าใช้กับ Azure CLI

az login --use-device-code

จัดหาทรัพยากรและปรับใช้รหัส:

azd up

คุณจะได้รับแจ้งให้เลือกรายละเอียดบางอย่างเกี่ยวกับทรัพยากรที่ปรับใช้ของคุณรวมถึงสถานที่ เพื่อเป็นการเตือนเราขอแนะนำ Canada East เป็นภูมิภาคสำหรับโครงการนี้ เมื่อการปรับใช้เสร็จสมบูรณ์คุณควรจะสามารถเลื่อนขึ้นในเทอร์มินัลของคุณและดู URL ที่แอปได้รับการปรับใช้ มันควรจะดูคล้ายกับ Ingress Updated. Access your app at https://env-name.codespacesname.eastus2.azurecontainerapps.io/ นี้ Ingress Updated. Access your app at https://env-name.codespacesname.eastus2.azurecontainerapps.io/ นำทางไปที่ลิงค์เพื่อลองใช้แอพทันที!

เมื่อขั้นตอนข้างต้นเสร็จสมบูรณ์คุณสามารถทดสอบตัวอย่างได้

vs รหัส dev คอนเทนเนอร์

ตัวเลือกที่เกี่ยวข้องคือ VS Code DEV Containers ซึ่งจะเปิดโครงการในรหัส Local Vs ของคุณโดยใช้ส่วนขยายของ DEV Containers:

1. เริ่ม Docker Desktop (ติดตั้งหากยังไม่ได้ติดตั้ง)

2. เปิดโครงการ:

3. ในหน้าต่างรหัส VS ที่เปิดขึ้นเมื่อไฟล์โครงการปรากฏขึ้น (อาจใช้เวลาหลายนาที) ให้เปิดหน้าต่างเทอร์มินัล

4. ติดตั้งแพ็คเกจที่ต้องการ:

    cd src/api
   pip install -r requirements.txt

   เมื่อคุณทำตามขั้นตอนเหล่านี้เสร็จสิ้นการปรับใช้

สภาพแวดล้อมในท้องถิ่น

ข้อกำหนดเบื้องต้น

• Azure Developer CLI (AZD)
• Python 3.10+
• Docker Desktop
• กระตวน

หมายเหตุสำหรับผู้ใช้ Windows: หากคุณไม่ได้ใช้คอนเทนเนอร์เพื่อเรียกใช้ตัวอย่างนี้ตะขอของเราจะเป็นสคริปต์เชลล์ทั้งหมด ในการจัดเตรียมตัวอย่างนี้อย่างถูกต้องในขณะที่เราทำงานอัปเดตเราแนะนำให้ใช้ Git Bash

การเริ่มต้นโครงการ

1. สร้างโฟลเดอร์ใหม่และสลับไปที่เทอร์มินัลจากนั้นเรียกใช้คำสั่งนี้เพื่อดาวน์โหลดรหัสโครงการ:

   azd init -t agent-openai-python-prompty

   โปรดทราบว่าคำสั่งนี้จะเริ่มต้นที่เก็บ GIT ดังนั้นคุณไม่จำเป็นต้องโคลนที่เก็บนี้

2. ติดตั้งแพ็คเกจที่ต้องการ:

    cd src/api
   pip install -r requirements.txt

การปรับใช้

เมื่อคุณเปิดโครงการใน codespaces, dev containers หรือในพื้นที่แล้วคุณสามารถปรับใช้กับ Azure ได้

1. ลงชื่อเข้าใช้บัญชี Azure ของคุณ คุณจะต้องเข้าสู่ระบบทั้ง Azure Developer CLI และ Azure CLI:

   ฉัน. ครั้งแรกกับ Azure Developer CLI

   azd auth login

   ii. จากนั้นลงชื่อเข้าใช้กับ Azure CLI

   az login --use-device-code

   หากคุณมีปัญหาใด ๆ กับคำสั่งนั้นคุณอาจต้องการลองใช้ azd auth login --use-device-code

   สิ่งนี้จะสร้างโฟลเดอร์ภายใต้ .azure/ ในโครงการของคุณเพื่อจัดเก็บการกำหนดค่าสำหรับการปรับใช้นี้ คุณอาจมีสภาพแวดล้อม AZD หลายสภาพหากต้องการ

2. จัดหาทรัพยากรและปรับใช้รหัส:

   azd up

   โครงการนี้ใช้ gpt-35-turbo-0613 , gpt-4-1106-Preview และ gpt-4o-2024-05-13 ซึ่งอาจไม่สามารถใช้ได้ในทุกภูมิภาค Azure ตรวจสอบความพร้อมใช้งานของภูมิภาคที่ทันสมัยและเลือกภูมิภาคในระหว่างการปรับใช้ตาม เราขอแนะนำให้ใช้ Canada East สำหรับโครงการนี้

   หลังจากเรียกใช้ AZD ขึ้นคุณอาจถูกถามคำถามต่อไปนี้ในระหว่าง Github Setup :

   Do you want to configure a GitHub action to automatically deploy this repo to Azure when you push code changes ?
   (Y/n) Y

   คุณควรตอบกลับด้วย N เนื่องจากไม่ใช่ขั้นตอนที่จำเป็นและใช้เวลาในการตั้งค่า

ทดสอบตัวอย่าง

ที่เก็บตัวอย่างนี้มีโฟลเดอร์ตัวแทนที่มีโฟลเดอร์ย่อยสำหรับแต่ละเอเจนต์ แต่ละโฟลเดอร์เอเจนต์มีไฟล์พรอมต์ที่มีการกำหนดพรอมต์ของเอเจนต์และไฟล์ Python ที่มีรหัสที่ใช้เรียกใช้ การสำรวจไฟล์เหล่านี้จะช่วยให้คุณเข้าใจว่าแต่ละตัวแทนกำลังทำอะไรอยู่ โฟลเดอร์ของเอเจนต์ยังมีไฟล์ orchestrator.py ที่สามารถใช้ในการเรียกใช้โฟลว์ทั้งหมดและเพื่อสร้างบทความ เมื่อคุณเรียกใช้ azd up โหลดไปยังร้านค้าเวกเตอร์การค้นหา Azure AI และชื่อดัชนี contoso-products ถูกสร้างขึ้น

เพื่อทดสอบตัวอย่าง:

1. รันตัวอย่างเว็บแอปในเครื่องโดยใช้เซิร์ฟเวอร์ fastapi

   ก่อนไปยังโฟลเดอร์ SRC/API

    cd ./src/api

   เรียกใช้ Fastapi Webserver

   fastapi dev main.py

   หมายเหตุสำคัญ : หากคุณใช้งานในรหัสคุณจะต้องเปลี่ยนการมองเห็นพอร์ต 8000 และ 5173 ของ API เป็น public ในแท็บ PORTS VS Code Terminal ของคุณ แท็บพอร์ตควรมีลักษณะเช่นนี้:

   

   หากคุณเปิดลิงค์เซิร์ฟเวอร์ในเบราว์เซอร์คุณจะเห็นข้อผิดพลาดที่ไม่พบ URL นี่เป็นเพราะเรายังไม่ได้สร้างเส้นทาง URL ที่บ้านใน Fastapi เราได้สร้างเส้นทาง A /get_article ซึ่งใช้เพื่อส่งผ่านบริบทและคำแนะนำโดยตรงไปยังไฟล์ get_article.py ซึ่งเรียกใช้เวิร์กโฟลว์ตัวแทน

   (ไม่บังคับ) เราได้สร้างเว็บอินเตอร์เฟสซึ่งเราจะทำงานต่อไป แต่คุณสามารถทดสอบ API ได้ตามที่คาดไว้โดยเรียกใช้สิ่งนี้ในเบราว์เซอร์:

    http://127.0.0.1:8080/get_article?context=Write an article about camping in alaska&instructions=find specifics about what type of gear they would need and explain in detail
   

2. เมื่อเซิร์ฟเวอร์ Fastapi กำลังทำงานอยู่คุณสามารถเรียกใช้เว็บแอปได้แล้ว ในการทำเช่นนี้เปิดหน้าต่างเทอร์มินัลใหม่และนำทางไปยังโฟลเดอร์เว็บโดยใช้คำสั่งนี้:

    cd ./src/web

   ก่อนติดตั้งแพ็คเกจโหนด:

   npm install

   จากนั้นเรียกใช้เว็บแอปด้วยเว็บเซิร์ฟเวอร์ dev ในพื้นที่:

   npm run dev

   สิ่งนี้จะเปิดตัวแอพซึ่งคุณสามารถใช้บริบทตัวอย่างและคำแนะนำเพื่อเริ่มต้นใช้งาน ในหน้า 'ทีมสร้างสรรค์' คุณสามารถตรวจสอบผลลัพธ์ของแต่ละเอเจนต์ได้โดยคลิกที่มัน แอพควรมีลักษณะเช่นนี้:

   เปลี่ยนคำแนะนำและบริบทเพื่อสร้างบทความที่คุณเลือก

3. เพื่อจุดประสงค์ในการดีบักคุณอาจต้องการทดสอบใน Python โดยใช้ orchestrator logic

   ในการเรียกใช้ตัวอย่างโดยใช้เพียงตรรกะ orchestrator ให้ใช้คำสั่งต่อไปนี้:

    cd ./src/api
   python -m orchestrator
   

การติดตาม

เพื่อเปิดใช้งานเซิร์ฟเวอร์การติดตามพรอมต์:

 export LOCAL_TRACING=true

จากนั้นเริ่ม orchestrator:

 cd ./src/api
python -m orchestrator

เมื่อคุณสามารถเห็นบทความได้ถูกสร้างขึ้นโฟลเดอร์ .runs ควรปรากฏใน ./src/api api เลือกโฟลเดอร์นี้และคลิกไฟล์ .tracy ในนั้น สิ่งนี้แสดงให้คุณเห็นฟังก์ชั่น Python ทั้งหมดที่เรียกว่าเพื่อสร้างบทความ สำรวจแต่ละส่วนและดูว่าคุณสามารถหาข้อมูลที่เป็นประโยชน์ได้

การประเมินผล

CONTOSO Creative Writer ใช้ผู้ประเมินเพื่อประเมินคุณภาพการตอบสนองของแอปพลิเคชัน ตัวชี้วัด 4 ตัวที่ประเมินในโครงการนี้คือการเชื่อมโยงกันความคล่องแคล่วความเกี่ยวข้องและการต่อสายดิน มีการเขียนสคริปต์แบบ evaluate.py เองเพื่อเรียกใช้ evaulations ทั้งหมดสำหรับคุณ

1. ในการเรียกใช้สคริปต์เรียกใช้คำสั่งต่อไปนี้:

 cd ./src/api
python -m evaluate.evaluate

• ตรวจสอบ: คุณเห็นคะแนนสำหรับการเชื่อมโยงกันความคล่องแคล่วความเกี่ยวข้องและการต่อสายดิน
• ตรวจสอบ: คะแนนอยู่ระหว่าง 1 ถึง 5

2. เพื่อทำความเข้าใจสิ่งที่กำลังประเมินเปิดไฟล์ src/api/evaluate/eval_inputs.jsonl
   • สังเกตว่า 3 ตัวอย่างของการวิจัยผลิตภัณฑ์และบริบทการมอบหมายจะถูกเก็บไว้ในไฟล์นี้ ข้อมูลนี้จะถูกส่งไปยัง Orchestrator เพื่อให้แต่ละตัวอย่างมี:
   • แต่ละตัวอย่างจะมีการประเมินผลและจะเพิ่มบริบทการวิจัยผลิตภัณฑ์และบทความสุดท้ายทั้งหมดเมื่อให้คะแนนการตอบสนอง

การตั้งค่า CI/CD ด้วยการกระทำของ GitHub

เทมเพลตนี้ถูกตั้งค่าให้เรียกใช้ CI/CD เมื่อคุณผลักดันการเปลี่ยนแปลงไปยัง repo ของคุณ เมื่อกำหนดค่า CI/CD การประเมินผลในการกระทำของ GitHub จากนั้นปรับใช้แอพของคุณโดยอัตโนมัติเมื่อ Push to Main

ในการตั้งค่า CI/CD ด้วยการกระทำของ GitHub ในที่เก็บของคุณให้เรียกใช้คำสั่งต่อไปนี้:

azd pipeline config

คำแนะนำ

ความพร้อมใช้งานของภูมิภาค

เทมเพลตนี้ใช้ gpt-35-turbo-0613 , gpt-4-1106-Preview และ gpt-4o-2024-05-13 ซึ่งอาจไม่สามารถใช้ได้ในทุกภูมิภาค Azure ตรวจสอบความพร้อมใช้งานของภูมิภาคที่ทันสมัยและเลือกภูมิภาคระหว่างการปรับใช้ตามความเหมาะสม

• เราขอแนะนำให้ใช้ Canada East

ค่าใช้จ่าย

คุณสามารถประเมินค่าใช้จ่ายของสถาปัตยกรรมของโครงการนี้ด้วยเครื่องคิดเลขราคาของ Azure

• การสมัครสมาชิก Azure พร้อม Access Open สำหรับ Bing Search API
• การสมัครสมาชิก Azure พร้อมการเข้าถึง Access สำหรับการค้นหา Azure AI

ความปลอดภัย

บันทึก

เมื่อใช้เทมเพลตนี้โปรดระบุว่าเทมเพลตจะใช้ข้อมูลประจำตัวที่มีการจัดการหรือ Vault คีย์

เทมเพลตนี้มีทั้งตัวตนที่มีการจัดการหรือคีย์ Vault ที่สร้างขึ้นเพื่อขจัดความจำเป็นสำหรับนักพัฒนาในการจัดการข้อมูลรับรองเหล่านี้ แอปพลิเคชันสามารถใช้ข้อมูลประจำตัวที่มีการจัดการเพื่อรับโทเค็น Microsoft Entra โดยไม่ต้องจัดการข้อมูลรับรองใด ๆ นอกจากนี้เราได้เพิ่มเครื่องมือการกระทำของ GitHub ที่สแกนไฟล์โครงสร้างพื้นฐาน-ตามรหัสและสร้างรายงานที่มีปัญหาที่ตรวจพบ เพื่อให้แน่ใจว่าแนวทางปฏิบัติที่ดีที่สุดใน repo ของคุณเราขอแนะนำให้ทุกคนที่สร้างโซลูชันตามเทมเพลตของเราตรวจสอบให้แน่ใจว่าการตั้งค่าการสแกน GitHub Secret ถูกเปิดใช้งานใน repos ของคุณ

ทรัพยากร

• เอกสารแจ้งเตือน
• พัฒนาแอพ Python ที่ใช้บริการ Azure AI

จรรยาบรรณ

โครงการนี้ได้นำรหัสการดำเนินงานของ Microsoft โอเพ่นซอร์สมาใช้

ทรัพยากร:

• Microsoft Open Source Code
• รหัสที่พบบ่อย
• ติดต่อ [email protected] พร้อมคำถามหรือข้อสงสัย

สำหรับข้อมูลเพิ่มเติมโปรดดูจรรยาบรรณคำถามที่พบบ่อยหรือติดต่อ [email protected] พร้อมคำถามหรือความคิดเห็นเพิ่มเติมใด ๆ

แนวทาง AI ที่รับผิดชอบ

โครงการนี้เป็นไปตามแนวทาง AI ที่รับผิดชอบด้านล่างและแนวทางปฏิบัติที่ดีที่สุดโปรดตรวจสอบก่อนที่จะใช้โครงการนี้:

• แนวทาง AI รับผิดชอบของ Microsoft
• การปฏิบัติ AI ที่รับผิดชอบสำหรับโมเดล Azure Openai
• การประเมินความปลอดภัยหมายเหตุความโปร่งใส