Tutorial OpenAI Assistants API

OpenAI Dev Day menandai tonggak penting dalam kecerdasan buatan, memperkenalkan serangkaian layanan AI terobosan, termasuk GPTs, GPTs App Store, GPT-4 Turbo, dan Assistants API yang inovatif.

API ini memberdayakan pengembang dengan alat AI tingkat lanjut, memungkinkan pembuatan asisten AI kustom yang andal dalam menangani beragam tugas.

Dalam tutorial ini, kami menyelami dunia Assistants, memberikan penjelajahan mendetail tentang kapabilitasnya, penerapan praktis lintas industri, dan panduan langkah demi langkah untuk mengimplementasikannya menggunakan Python. Ikuti kami menavigasi seluk-beluk membangun asisten AI pribadi Anda sendiri.

Gambaran Umum Assistants API

Saat artikel ini ditulis, Assistants API masih beta, dan tim pengembang OpenAI secara aktif menambahkan lebih banyak fitur. Namun sebelum itu, mari jelajahi apa yang ditawarkan versi saat ini!

Bagian ini memberikan wawasan lebih lanjut tentang cara kerja Assistants dan interaksi antara komponen-komponen yang mendasarinya.

Bagaimana cara kerja Assistants API?

Dua tulang punggung utama Assistants adalah model dan tools milik OpenAI.

• Tersedia beragam model, termasuk namun tidak terbatas pada: GPT-4, GPT-4 Turbo, GPT-3.5, GPT-3, DALL-E, TTS, Whisper, Embeddings, Moderation. Model-model ini digunakan oleh Assistants untuk menjalankan tugas cerdas tertentu.

• Sebaliknya, tools memberikan akses Assistants ke alat-alat yang di-host OpenAI seperti Code interpreter dan Knowledge Retrieval. Ini bahkan memungkinkan pengguna membangun tools sendiri menggunakan fitur Function Calling.

Cara kerja Assistants

Sekarang, mari jelajahi lima langkah utama yang terlibat dalam implementasi sebuah Assistant.

• Buat dan deskripsikan Assistant: Assistant adalah AI khusus yang dikembangkan menggunakan model, pedoman, dan berbagai alat.
• Inisiasi Thread: thread merepresentasikan rangkaian dialog yang dimulai pengguna, tempat pesan dapat ditambahkan untuk membentuk percakapan yang menarik.
• Tambahkan Pesan: Pesan terdiri dari masukan tekstual pengguna dan dapat mencakup teks, file, dan gambar.
• Picu Assistant: Assistant diaktifkan untuk menganalisis Thread, menggunakan alat tertentu sesuai kebutuhan, dan menghasilkan respons yang tepat.

Use Case Industri untuk Assistants API

Memanfaatkan Assistant API dapat menjadi cara yang ampuh untuk mengintegrasikan AI ke dalam berbagai proses bisnis, sehingga meningkatkan efisiensi, mengotomatisasi tugas-tugas membosankan, dan memberikan respons yang lebih cepat serta akurat terhadap pertanyaan pengguna.

Di bawah ini lima use case industri yang menarik untuk Assistant API.

Dukungan pengembangan

Assistant dapat berperan sebagai asisten coding sesuai permintaan. Dengan memanfaatkan code interpreter, ia dapat menerjemahkan cuplikan kode dari satu bahasa pemrograman ke bahasa lain, membantu pengembangan perangkat lunak dan mempermudah proses belajar bahasa baru. Fitur ini sangat berguna bagi tim yang bekerja dengan banyak bahasa pemrograman atau di lingkungan pendidikan untuk pengajaran coding.

Manajemen pengetahuan perusahaan

Fitur retrieval dapat dimanfaatkan untuk manajemen pengetahuan dalam organisasi. Dengan mengunggah dan memproses dokumen internal, laporan, dan manual, Assistant menjadi repositori pengetahuan terpusat. Karyawan dapat menanyakan informasi spesifik kepada Assistant, meningkatkan efisiensi dan mengurangi waktu pencarian informasi di kumpulan dokumen yang besar.

Otomatisasi dukungan pelanggan

Assistant dapat diintegrasikan ke dalam sistem dukungan pelanggan. Menggunakan function calling, ia dapat menjawab pertanyaan pelanggan dengan mengambil informasi dari API eksternal atau basis data, sehingga secara efektif mengotomatisasi respons untuk pertanyaan umum. Integrasi ini dapat meningkatkan pengalaman pelanggan dengan memberikan respons cepat dan akurat sekaligus mengurangi beban staf dukungan manusia.

Analisis data

Dengan mendeskripsikan fungsi untuk analisis data, pengguna dapat meminta Assistant melakukan manipulasi data yang kompleks dan menghasilkan laporan, menerjemahkan pertanyaan bahasa alami menjadi tugas analisis data terstruktur.

Otomatisasi operasi TI

Tim TI dapat menggunakan Assistant untuk mengotomatisasi operasi rutin. Dengan mendefinisikan fungsi yang sesuai dengan tugas TI umum, seperti diagnostik sistem, pemeriksaan jaringan, atau pembaruan perangkat lunak, Assistant dapat mengeksekusi tugas-tugas ini sebagai respons terhadap perintah pengguna. Kapabilitas ini dapat secara signifikan mengurangi waktu yang dihabiskan profesional TI untuk pemeliharaan rutin, sehingga mereka dapat fokus pada isu yang lebih kompleks.

Praktik Langsung: Memulai dengan OpenAI Assistants API

Dengan pemahaman tentang OpenAI API ini, mari beralih ke use case yang lebih praktis. Bagian ini berfokus pada panduan membuat asisten yang mengambil pengetahuan dari file PDF.

Notebook end-to-end lengkap tersedia di DataLab.

Alur kerja knowledge retrieval

Untuk implementasi teknis apa pun, lebih baik menyediakan alur kerja visual yang menggambarkan interaksi antara komponen utama dari keseluruhan aplikasi yang dikembangkan.

Alur kerja ini menyoroti lima langkah utama dalam implementasi asisten, dari unggah file hingga menghasilkan respons akhir.

Lima langkah utama alur kerja knowledge retrieval

• Unggah file: proses dimulai dengan mengunggah file PDF yang ingin diinteraksikan oleh pengguna.
• Pembuatan asisten: asisten dirancang khusus untuk memproses dan memahami informasi dari file PDF yang diunggah.
• Mulai interaksi: ini adalah titik awal thread percakapan, tempat pengguna memberikan pesan masukan untuk diproses oleh asisten.
• Picu asisten: kini asisten memproses pesan masukan untuk menghasilkan respons yang relevan.
• Keluaran respons: ini adalah fase akhir, tempat asisten menampilkan respons terhadap pesan pengguna.

Menyiapkan OpenAI KEY

Alat utama yang diperlukan untuk mereplikasi hasil tutorial ini dengan sukses adalah:

• Python: ini adalah bahasa pemrograman utama yang akan kita gunakan dalam tutorial ini. Opsi alternatif adalah NodeJS.
• OpenAI: paket untuk berinteraksi dengan layanan OpenAI. Cheatsheet OpenAI API in Python kami memberikan gambaran lengkap untuk menguasai dasar-dasar memanfaatkan OpenAI API.
• OS: paket sistem operasi untuk mengonfigurasi variabel lingkungan.

Langkah pertama adalah memperoleh OpenAI KEY, yang membantu mengakses model DALL-E 3. Langkah-langkah utamanya diilustrasikan di bawah ini:

Empat langkah utama membuat OpenAI KEY

Keempat langkah utama di atas cukup jelas. Namun, penting untuk membuat akun dari situs resmi OpenAI.

Anda dapat mengeksplorasi OpenAI API lebih lanjut melalui Panduan Pemula ke OpenAI API: Tutorial Praktis dan Praktik Terbaik kami. Ini memperkenalkan OpenAI API, use case-nya, pendekatan praktik langsung menggunakan API, dan seluruh praktik terbaik yang perlu diikuti.

Mulai membangun asisten

Setelah Anda memperoleh KEY, pastikan untuk tidak membagikannya kepada siapa pun. Kunci harus tetap bersifat privat. Selanjutnya, atur kunci sebagai variabel lingkungan seperti berikut agar dapat digunakan:

import os
OPENAI_API_KEY= "<YOUR PRIVATE KEY>"
os.environ["OPENAI_API_KEY"] = OPENAI_API_KEY

Unggah File

Fungsi pembantu berikut memanfaatkan fungsi “create” untuk secara otomatis mengunggah file yang ingin diinteraksikan pengguna ke akun OpenAI-nya.

Fungsi “create” memiliki dua parameter utama:

• Path ke file yang akan diunggah
• Tujuan penggunaan file tersebut, yang dalam kasus ini adalah “assistants”

def upload_file(file_path):
    
	# Upload a file with an "assistants" purpose
	file_to_upload = client.files.create(
  	file=open(file_path, "rb"),
  	purpose='assistants'
	)
     return file_to_upload

Fungsi pembantu ini akhirnya digunakan untuk memicu proses unggah paper transformers yang berada di folder data.

transformer_paper_path = "./data/transformer_paper.pdf"
file_to_upload = upload_file(transformer_paper_path)

Setelah fungsi dijalankan dengan sukses, transformer_paper.pdf diunggah dan terlihat dari tab files, seperti ditunjukkan di bawah.

Paper Transformer diunggah ke akun OpenAI

Pembuatan asisten

Pembuatan asisten dilakukan menggunakan fungsi create dari modul client.beta.assistants, dan menerima lima parameter utama:

• Nama: ini adalah nama yang diberikan pembuatnya kepada asisten. Mari kita sebut milik kita Scientific Paper Assistant.
• Instruksi: menjelaskan bagaimana asisten harus berperilaku atau menjawab pertanyaan. Dalam use case ini, asisten menerapkan instruksi berikut: “Anda adalah asisten retrieval pengetahuan yang sopan dan ahli. Gunakan dokumen yang disediakan sebagai basis pengetahuan untuk menjawab pertanyaan.”
• Model: model yang digunakan untuk retrieval pengetahuan. Model GPT-3 atau GPT-4 apa pun dapat digunakan. Artikel ini memanfaatkan model terbaru saat artikel ini ditulis, yaitu model gpt-4-1106-preview.
• Tools: jenis alat yang akan digunakan. Dua pilihan yang mungkin adalah code interpreter dan retrieval. Fokus artikel ini adalah retrieval, maka interpreter diabaikan.
• File_ids: daftar pengenal unik untuk setiap file dalam basis pengetahuan.

Fungsi pembantu create_assistant menggabungkan semua informasi ini untuk membuat asisten seperti diilustrasikan di bawah:

def create_assistant(assistant_name,
                 	my_instruction,
                 	uploaded_file,
                 	model="gpt-4-1106-preview"):
    
	my_assistant = client.beta.assistants.create(
	name = assistant_name,
	instructions = my_instruction,
	model="gpt-4-1106-preview",
	tools=[{"type": "retrieval"}],
	file_ids=[uploaded_file.id]
	)
    
	return my_assistant

Sekarang kita dapat menjalankan fungsi untuk membuat asisten menggunakan instruksi dan nama asisten:

inst="You are a polite and expert knowledge retrieval assistant. Use the documents provided as a knowledge base to answer questions"
assistant_name="Scientific Paper Assistant"

my_assistant = create_assistant(assistant_name, inst, uploaded_file)

Mulai interaksi

Setelah asisten dibuat, langkah alami berikutnya adalah memulai thread interaksi menggunakan pesan atau permintaan pengguna.

Thread dan pesan dibuat menggunakan fungsi create dari client.beta.threads dan client.beta.threads.messages masing-masing.

Kedua fitur ini digabungkan menggunakan fungsi pembantu initiate_interaction.

def initiate_interaction(user_message, uploaded_file):
    
	my_thread = client.beta.threads.create()
	message = client.beta.threads.messages.create(thread_id=my_thread.id,
                                              	role="user",
                                              	content=user_message,
                                              	file_ids=[uploaded_file.id]
	)
    
	return my_thread

Interaksi dapat dimulai dari variabel user_message:

user_message = "Why do authors use the self-attention strategy in the paper?"
my_thread = initiate_interaction(user_message, uploaded_file)

Memicu asisten dan menghasilkan respons

Dari thread di atas, asisten dapat dipicu untuk memberikan respons terhadap pesan pengguna. Aksi pemicu didefinisikan dalam fungsi pembantu trigger_assistant, dan responsnya diberikan oleh variabel response.

def trigger_assistant():
	run = client.beta.threads.runs.create(
  	thread_id = my_thread.id,
  	assistant_id = my_assistant.id,
	)


trigger_assistant()

messages = client.beta.threads.messages.list(
  thread_id = my_thread.id
)

response = messages.data[0].content[0].text.value
response

Respons berikut dihasilkan setelah eksekusi kode di atas berhasil.

Respons asisten terhadap pesan pengguna

Respons ini persis seperti yang disebutkan oleh para penulis sebagai jawaban atas pertanyaan di halaman 6.

Kutipan yang menyebutkan respons dari paper transformer

Praktik Terbaik Saat Menggunakan OpenAI Assistants API

Saat memanfaatkan Assistant API dalam sebuah proyek, penting untuk mematuhi praktik terbaik guna memastikan kinerja dan pengalaman pengguna yang optimal. Berikut beberapa poin kunci yang perlu dipertimbangkan.

• Tetapkan tujuan yang jelas: rumuskan sasaran spesifik untuk Assistant agar memenuhi tujuan dan kebutuhan pengguna secara efektif.

• Optimalkan data masukan: kualitas dan relevansi data yang digunakan, seperti file yang diunggah, sangat menentukan keakuratan dan efisiensi respons Assistant.

• Utamakan privasi pengguna: terapkan protokol privasi data yang kuat untuk melindungi informasi pengguna dan mematuhi hukum perlindungan data yang relevan.

• Uji dan iterasikan: uji Assistant secara rutin dalam skenario dunia nyata dan lakukan iterasi berdasarkan umpan balik untuk meningkatkan kinerja dan pengalaman pengguna.

• Sediakan dokumentasi yang jelas: tawarkan panduan komprehensif tentang penggunaan Assistant, membantu pengguna memahami fungsionalitas dan keterbatasannya.


Kesimpulan

Singkatnya, artikel ini telah membahas Assistants API, menyoroti cara kerjanya dan bagaimana ia dapat digunakan di berbagai industri. Kami memulai dengan memperkenalkan API dan fungsi utamanya sebagai landasan untuk pemahaman yang lebih dalam.

Selanjutnya, kami meninjau fitur spesifik Assistants API dan membahas bagaimana fitur-fitur tersebut dapat diterapkan di berbagai sektor bisnis, menunjukkan kegunaannya yang luas.

Kami juga menyediakan panduan langkah demi langkah untuk mulai menggunakan Assistants API, sehingga memudahkan Anda menyiapkannya sesuai kebutuhan.

Selain itu, kami membagikan beberapa praktik terbaik penting yang perlu diingat saat menggunakan API, memastikan Anda mendapatkan hasil maksimal.

Singkatnya, Assistants API adalah alat yang serbaguna dan berharga yang dapat diadaptasi untuk banyak kegunaan, menawarkan manfaat signifikan bagi mereka yang mempelajarinya dengan efektif.

Ingin meningkatkan pengalaman Anda dengan API OpenAI dan merangkul pendekatan yang lebih kreatif? Panduan Komprehensif ke DALL-E 3 API kami akan membantu Anda menemukan kekuatan transformatif DALL-E 3 API, mencakup fitur utama, penerapan industri, dan tips bagi pengguna untuk membuka potensi kreatif mereka.

Jika Anda benar-benar baru dalam topik ini, mulailah dengan kursus Working with the OpenAI API kami.