Alat Python
Alat Python memberdayakan Anda untuk menawarkan cuplikan kode yang disesuaikan sebagai simpul yang dapat dieksekusi mandiri dalam alur prompt. Anda dapat dengan mudah membuat alat Python, mengedit kode, dan memverifikasi hasil.
Input
Nama | Tipe | Deskripsi | Wajib diisi |
---|---|---|---|
Kode | string | Cuplikan kode Python | Ya |
Input | - | Daftar parameter fungsi alat dan penugasannya | - |
Jenis
Jenis | Contoh Python | Deskripsi |
---|---|---|
int | param: int | Jenis bilangan bulat |
bool | param: bool | Jenis Boolean |
string | param: str | Jenis String |
ganda | param: float | Jenis Ganda |
list | param: list atau param: List[T] | Jenis daftar |
object | param: dict atau param: Dict[K, V] | Tipe objek |
Koneksi | param: CustomConnection | Jenis koneksi ditangani secara khusus |
Parameter dengan Connection
anotasi jenis diperlakukan sebagai input koneksi, yang berarti:
- Ekstensi alur perintah memperlihatkan pemilih untuk memilih koneksi.
- Selama waktu eksekusi, alur prompt mencoba menemukan koneksi dengan nama yang sama dari nilai parameter yang diteruskan.
Catatan
Anotasi Union[...]
jenis hanya didukung untuk jenis koneksi, misalnya, param: Union[CustomConnection, OpenAIConnection]
.
Output
Output adalah pengembalian fungsi alat Python.
Menulis dengan alat Python
Gunakan panduan berikut untuk menulis dengan alat Python.
Panduan
Kode alat Python harus terdiri dari kode Python lengkap, termasuk impor modul yang diperlukan.
Kode alat Python harus berisi fungsi yang dihiasi dengan
@tool
(fungsi alat), yang berfungsi sebagai titik masuk untuk eksekusi. Terapkan@tool
dekorator hanya sekali dalam cuplikan.Sampel di bagian berikutnya mendefinisikan alat
my_python_tool
Python , yang dihiasi dengan@tool
.Parameter fungsi alat Python harus ditetapkan di bagian .
Inputs
Sampel di bagian berikutnya menentukan input
message
dan menetapkannyaworld
.Fungsi alat Python memiliki pengembalian.
Sampel di bagian berikutnya mengembalikan string yang digabungkan.
Kode
Cuplikan berikut menunjukkan struktur dasar fungsi alat. Alur perintah membaca fungsi dan mengekstrak input dari parameter fungsi dan mengetik anotasi.
from promptflow import tool
from promptflow.connections import CustomConnection
# The inputs section will change based on the arguments of the tool function, after you save the code
# Adding type to arguments and return value will help the system show the types properly
# Please update the function name/signature per need
@tool
def my_python_tool(message: str, my_conn: CustomConnection) -> str:
my_conn_dict = dict(my_conn)
# Do some function call with my_conn_dict...
return 'hello ' + message
Input
Nama | Tipe | Nilai sampel dalam YAML alur | Nilai yang diteruskan ke fungsi |
---|---|---|---|
pesan | string | world |
world |
my_conn | CustomConnection |
my_conn |
Objek CustomConnection |
Alur perintah mencoba menemukan koneksi bernama my_conn
selama waktu eksekusi.
Output
"hello world"
Koneksi kustom di alat Python
Jika Anda mengembangkan alat Python yang memerlukan panggilan layanan eksternal dengan autentikasi, gunakan koneksi kustom dalam alur perintah. Anda dapat menggunakannya untuk menyimpan kunci akses dengan aman lalu mengambilnya dalam kode Python Anda.
Membuat koneksi kustom
Buat koneksi kustom yang menyimpan semua kunci API model bahasa besar Anda atau kredensial lain yang diperlukan.
Buka alur perintah di ruang kerja Anda, lalu buka tab Koneksi .
Pilih Buat>Kustom.
Di panel kanan, Anda dapat menentukan nama koneksi Anda. Anda dapat menambahkan beberapa pasangan kunci-nilai untuk menyimpan kredensial dan kunci Anda dengan memilih Tambahkan pasangan kunci-nilai.
Catatan
Untuk mengatur satu pasangan kunci-nilai sebagai rahasia, pilih kotak centang adalah rahasia . Opsi ini mengenkripsi dan menyimpan nilai kunci Anda. Pastikan setidaknya satu pasangan kunci-nilai diatur sebagai rahasia. Jika tidak, koneksi tidak berhasil dibuat.
Menggunakan koneksi kustom di Python
Untuk menggunakan koneksi kustom dalam kode Python Anda:
Di bagian kode di simpul Python Anda, impor pustaka
from promptflow.connections import CustomConnection
koneksi kustom . Tentukan parameter input jenisCustomConnection
dalam fungsi alat.Uraikan input ke bagian input, lalu pilih koneksi kustom target Anda di menu dropdown Nilai .
Contohnya:
from promptflow import tool
from promptflow.connections import CustomConnection
@tool
def my_python_tool(message: str, myconn: CustomConnection) -> str:
# Get authentication key-values from the custom connection
connection_key1_value = myconn.key1
connection_key2_value = myconn.key2