สร้างรหัสการเรียกใช้สําหรับฟังก์ชันข้อมูลผู้ใช้

เมื่อคุณเผยแพร่ฟังก์ชันข้อมูลผู้ใช้แล้ว คุณสามารถเรียกใช้ฟังก์ชันเหล่านั้นจากรายการ Fabric หรือแอปพลิเคชันภายนอกได้ แทนที่จะเขียนโค้ดการเรียกใช้ตั้งแต่เริ่มต้น ให้ใช้คุณลักษณะ สร้างรหัสการเรียกใช้ เพื่อสร้างเทมเพลตโค้ดที่พร้อมใช้งานโดยอัตโนมัติ

เลือกตัวเลือกการสร้างโค้ดตามสถานการณ์การรวมของคุณ:

• โค้ด Fabric Notebooks (Python) - สําหรับการเรียกใช้ฟังก์ชันจากภายใน Fabric Notebooks ซึ่งเป็นวิธีหนึ่งในการรวมเข้ากับรายการ Fabric สําหรับรายการ Fabric อื่นๆ เช่น ไปป์ไลน์และ Activator โปรดดูเอกสารประกอบการรวม
• รหัสแอปพลิเคชันไคลเอ็นต์ (Python, C#, Node.js) - สําหรับการเรียกใช้ฟังก์ชันของคุณจากแอปพลิเคชันภายนอกผ่านจุดสิ้นสุด REST ที่ไม่ซ้ํากันซึ่งแต่ละฟังก์ชันเปิดเผย ซึ่งเปิดใช้งานการรวมกับเว็บแอป บริการ หรือระบบใดๆ ภายนอก Fabric
• ข้อมูลจําเพาะ OpenAPI (JSON, YAML) - สําหรับแพลตฟอร์มการจัดการ API, เอเจนต์ AI หรือการสร้าง SDK ไคลเอ็นต์ ใช้สิ่งนี้เพื่อรวมฟังก์ชันของคุณเข้ากับ Azure API Management กําหนดค่าระบบ AI หรือสร้างไลบรารีสําหรับแอปพลิเคชันภายนอก

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

ก่อนที่คุณจะสร้างรหัสการเรียกใช้ คุณต้องมีสิ่งต่อไปนี้

• รายการฟังก์ชันข้อมูลผู้ใช้ที่เผยแพร่ซึ่งมีฟังก์ชันอย่างน้อยหนึ่งฟังก์ชัน
• การเข้าถึงรายการฟังก์ชันข้อมูลผู้ใช้ในพอร์ทัล Fabric
• อย่างน้อย ดําเนินการ สิทธิ์ในรายการฟังก์ชันข้อมูลผู้ใช้เพื่อสร้างและใช้รหัสการเรียกใช้

สร้างโค้ดสําหรับสมุดบันทึกผ้า

เมื่อรวมเข้ากับรายการ Fabric ให้ใช้ตัวเลือกนี้เพื่อเรียกใช้ฟังก์ชันของคุณจาก Fabric Notebooks รหัสที่สร้างขึ้นใช้ยูทิลิตี้ในตัว mssparkutils.userDataFunction ซึ่งให้วิธีง่ายๆ ในการเรียกใช้ฟังก์ชันโดยไม่ต้องจัดการการรับรองความถูกต้องหรือปลายทาง วิธีนี้เหมาะอย่างยิ่งสําหรับเวิร์กโฟลว์การประมวลผลข้อมูล การวิเคราะห์เชิงสํารวจ และไปป์ไลน์แมชชีนเลิร์นนิ่งภายในสภาพแวดล้อม Fabric

1. เปิดรายการ ฟังก์ชันข้อมูลผู้ใช้ ของคุณในพอร์ทัล Fabric

2. บนแท็บ หน้าแรก ให้เลือก สร้างรหัส>การเรียกใช้รหัสไคลเอ็นต์

3. ภายใต้ เรียกใช้จาก ให้เลือก สมุดบันทึก จากดรอปดาวน์

4. เลือกชื่อฟังก์ชันที่คุณต้องการเรียกใช้

5. โค้ดจะถูกสร้างขึ้นโดยอัตโนมัติใน Python (Python เป็นภาษาเดียวที่มีให้สําหรับรหัสเรียกใช้สมุดบันทึก)

   

6. คัดลอกข้อมูลโค้ดที่สร้างขึ้น

7. วางลงในเซลล์ใหม่ในสมุดบันทึกผ้าของคุณ

8. อัปเดตพารามิเตอร์ฟังก์ชันด้วยค่าจริงของคุณ โค้ดที่สร้างขึ้นจะมีข้อคิดเห็นที่แสดงตําแหน่งที่จะอัปเดต:

   # UPDATE BELOW: Update the request body based on the inputs to your function
   myFunctions.hello_fabric(name = "string")
   

9. เรียกใช้เซลล์เพื่อเรียกใช้ฟังก์ชันของคุณ

สําหรับข้อมูลเพิ่มเติม โปรดดู ยูทิลิตี้ฟังก์ชันข้อมูลผู้ใช้ Fabric Notebook

สร้างโค้ดสําหรับแอปพลิเคชันไคลเอ็นต์

เมื่อรวมเข้ากับแอปพลิเคชันภายนอก ให้ใช้ตัวเลือกนี้เพื่อเรียกใช้ฟังก์ชันของคุณผ่านปลายทาง REST ที่ไม่ซ้ํากันซึ่งแต่ละฟังก์ชันแสดงให้เห็น รหัสที่สร้างขึ้นรวมถึงการตั้งค่าการรับรองความถูกต้องโดยใช้ Microsoft Entra ID และจัดการโฟลว์คําขอ/การตอบสนอง HTTP สิ่งนี้ทําให้คุณสามารถเรียกใช้ฟังก์ชัน Fabric ของคุณจากเว็บแอป แอปบนอุปกรณ์เคลื่อนที่ ไมโครเซอร์วิส หรือระบบใดๆ ภายนอกสภาพแวดล้อม Fabric

1. เปิดรายการ ฟังก์ชันข้อมูลผู้ใช้ ของคุณในพอร์ทัล Fabric

2. บนแท็บ หน้าแรก ให้เลือก สร้างรหัส>การเรียกใช้รหัสไคลเอ็นต์

3. ภายใต้ เรียกใช้จาก ให้เลือก แอปพลิเคชันไคลเอ็นต์ จากดรอปดาวน์

4. เลือกชื่อฟังก์ชันที่คุณต้องการเรียกใช้

5. เลือกภาษาโปรแกรมของคุณ:

   • Python
   • C#
   • Node.js

   

6. คัดลอกรหัสที่สร้างขึ้นและเพิ่มลงในแอปพลิเคชันของคุณ

7. ตรวจสอบโครงสร้างโค้ด:

   • การรับรองความถูกต้อง - ใช้ InteractiveBrowserCredential เพื่อรับโทเค็น (สําหรับการพัฒนา/การทดสอบเท่านั้น)
   • URL ปลายทาง - ตําแหน่งข้อมูล REST ที่ไม่ซ้ํากันสําหรับฟังก์ชันเฉพาะของคุณ
   • เนื้อหาคําขอ - มีพารามิเตอร์อินพุตที่ฟังก์ชันของคุณคาดหวัง

8. อัปเดตส่วนด้วย request_body ค่าพารามิเตอร์จริงของคุณ โค้ดที่สร้างขึ้นจะมีข้อคิดเห็นที่แสดงตําแหน่งที่จะอัปเดต:

   # UPDATE HERE: Update the request body based on the inputs to your function 
   request_body = {
       "name": "string"
   }
   

9. สําหรับแอปพลิเคชันที่ใช้งานจริง ให้แทนที่รหัสการรับรองความถูกต้องด้วยการลงทะเบียนแอปพลิเคชัน Microsoft Entra ID ที่เหมาะสม รหัสที่สร้างขึ้นประกอบด้วยคําเตือนและลิงก์ไปยังคําแนะนําสําหรับการรับรองความถูกต้องตามการใช้งานจริง

สําหรับคําแนะนําที่สมบูรณ์รวมถึงการตั้งค่าการรับรองความถูกต้องของการผลิต โปรดดู เรียกใช้ฟังก์ชันข้อมูลผู้ใช้จากแอปพลิเคชัน Python

สร้างข้อกําหนด OpenAPI

เมื่อคุณต้องการรวมฟังก์ชันของคุณกับแพลตฟอร์มการจัดการ API, ตัวแทน AI หรือสร้าง SDK ไคลเอ็นต์สําหรับแอปพลิเคชันภายนอก ให้ใช้ตัวเลือกนี้เพื่อสร้างข้อมูลจําเพาะ OpenAPI ข้อมูลจําเพาะ OpenAPI ให้คําอธิบายที่เครื่องอ่านได้เกี่ยวกับตําแหน่งข้อมูล REST ของฟังก์ชัน ทําให้เครื่องมือและระบบสามารถค้นหาและผสานรวมกับฟังก์ชันของคุณโดยทางโปรแกรมได้ง่าย

1. เปิดรายการ ฟังก์ชันข้อมูลผู้ใช้ ของคุณในพอร์ทัล Fabric

2. บนแท็บ หน้าแรก ให้เลือก สร้างรหัส>การเรียกใช้ข้อมูลจําเพาะ OpenAPI

3. ในกล่องโต้ตอบ สร้างข้อมูลจําเพาะ OpenAPI ให้เลือกรูปแบบผลลัพธ์ของคุณ:

   • Json
   • YAML

   

4. คัดลอกข้อมูลจําเพาะที่สร้างขึ้น ข้อกําหนดประกอบด้วย:

   • ฟังก์ชันที่เผยแพร่ทั้งหมดในรายการฟังก์ชันข้อมูลผู้ใช้
   • สคีมาคําขอและการตอบกลับสําหรับแต่ละฟังก์ชัน
   • ข้อกําหนดการรับรองความถูกต้อง (โทเค็นผู้ถือ)
   • การตอบสนองข้อผิดพลาด HTTP มาตรฐาน (400, 401, 403, 408, 413, 500)
   • สรุปและคําอธิบายฟังก์ชัน (จาก docstrings)

ปรับปรุงเอาต์พุต OpenAPI ด้วย docstrings

คุณภาพของข้อมูลจําเพาะ OpenAPI ของคุณขึ้นอยู่กับเอกสารประกอบในโค้ดฟังก์ชันของคุณ เมื่อระบบต่างๆ เช่น Azure API Management, ตัวแทน AI หรือเครื่องมือเอกสาร API ใช้ข้อมูลจําเพาะ OpenAPI ของคุณ ระบบเหล่านี้จะอาศัยคําอธิบายที่ชัดเจนเพื่อทําความเข้าใจว่าฟังก์ชันของคุณทําอะไร

ตัวสร้าง OpenAPI จะดึงข้อมูลจากสตริงฟังก์ชันของคุณโดยอัตโนมัติ เพิ่มคุณสมบัติเหล่านี้ลงในฟังก์ชันของคุณเพื่อสร้างเอกสารประกอบ API ที่ครอบคลุม:

• สรุป - คําอธิบายบรรทัดเดียวที่ปรากฏในแค็ตตาล็อก API และมุมมองระดับสูง
• คําอธิบาย - คําอธิบายโดยละเอียดเกี่ยวกับสิ่งที่ฟังก์ชันทํา อินพุตที่คาดหวัง และสิ่งที่ส่งคืน

ตัวอย่างฟังก์ชันพร้อมเอกสารประกอบที่เหมาะสม:

@udf.function()
def hello_fabric(name: str) -> str:
    """
    Summary: A Python function that prints your name and the time.
    Description: This function takes a string input and concatenates it with the current time 
    to give you a warm welcome to User Data Functions. Returns a string and provides a log entry.
    """
    logging.info('Python UDF trigger function processed a request.')
    return f"Welcome to Fabric Functions, {name}, at {datetime.datetime.now()}!"

เมื่อคุณสร้างข้อมูลจําเพาะ OpenAPI ค่า docstring เหล่านี้จะ summary เติมฟิลด์ และ description ใน Schema OpenAPI ทําให้นักพัฒนาและระบบเข้าใจวิธีใช้ฟังก์ชันของคุณได้ง่ายขึ้น

การใช้งานทั่วไปสําหรับโค้ดที่สร้างขึ้น

เมื่อคุณสร้างรหัสการเรียกใช้แล้ว คุณสามารถใช้รหัสดังกล่าวเพื่อรวมฟังก์ชันของคุณเข้ากับสถานการณ์ต่างๆ ได้:

การรวมรายการผ้า:

• เรียกใช้ฟังก์ชันจากโน้ตบุ๊กสําหรับการประมวลผลข้อมูล แมชชีนเลิร์นนิ่ง และการวิเคราะห์เชิงสํารวจ
• ประสานฟังก์ชันในไปป์ไลน์สําหรับเวิร์กโฟลว์การแปลงข้อมูล
• ฟังก์ชันทริกเกอร์จากกฎ Activator เพื่อตอบสนองต่อเหตุการณ์แบบเรียลไทม์

การรวมแอปพลิเคชันภายนอก:

• เรียกใช้ฟังก์ชันจากเว็บแอป แอปบนอุปกรณ์เคลื่อนที่ หรือไมโครเซอร์วิสโดยใช้รหัสแอปพลิเคชันไคลเอ็นต์
• นําเข้าข้อมูลจําเพาะ OpenAPI ไปยัง Azure API Management หรือเกตเวย์ API อื่นๆ สําหรับการจัดการแบบรวมศูนย์
• สร้าง SDK ไคลเอ็นต์โดยใช้ OpenAPI Generator เพื่อการผสานรวมที่สอดคล้องกันในหลายระบบ
• กําหนดค่าตัวแทน AI เพื่อค้นหาและเรียกใช้ฟังก์ชันของคุณโดยใช้ข้อกําหนด OpenAPI
• ทดสอบและตรวจสอบฟังก์ชันโดยใช้เครื่องมือเช่น Postman หรือ Swagger UI

เนื้อหาที่เกี่ยวข้อง

• เรียกใช้ฟังก์ชันข้อมูลผู้ใช้จากแอปพลิเคชัน Python - คําแนะนําที่สมบูรณ์สําหรับการเรียกฟังก์ชันจากแอป Python ภายนอก
• ยูทิลิตี้ Fabric Notebook - ข้อมูลอ้างอิงสําหรับการเรียกฟังก์ชันจากโน้ตบุ๊ก
• การผสานรวมกับไปป์ไลน์ Fabric - ใช้ฟังก์ชันในไปป์ไลน์ข้อมูล
• โมเดลการเขียนโปรแกรม Python - เรียนรู้วิธีเขียนฟังก์ชันด้วยสตริงเอกสารที่เหมาะสม