Ringkasan
Model Bahasa Besar (LLM) sangat andal dalam memecahkan berbagai jenis masalah. Namun, konfigurasinya dibatasi oleh batasan berikut:
- LLM dibekukan setelah pelatihan, sehingga pengetahuan yang ada dalamnya tidak diperbarui.
- LLM tidak dapat membuat kueri atau mengubah data eksternal.
Panggilan fungsi dapat mengatasi kekurangan ini. Anda dapat menggunakan panggilan fungsi untuk menentukan fungsi kustom dan menyediakannya ke model AI generatif. Misalnya, Anda dapat menentukan fungsi get_weather
yang mengambil parameter lokasi dan menampilkan informasi tentang kondisi cuaca di lokasi tersebut.
Saat memproses perintah, model dapat memilih untuk mendelegasikan tugas pemrosesan data tertentu ke fungsi yang Anda identifikasi. Model tidak memanggil fungsi secara langsung. Sebagai gantinya, model ini memberikan output data terstruktur
yang mencakup fungsi yang akan dipanggil dan parameter value yang akan digunakan. Misalnya, untuk
perintah What is the weather like in Boston?
, model dapat mendelegasikan pemrosesan
ke fungsi get_weather
dan memberikan nilai parameter lokasi Boston, MA
.
Anda dapat menggunakan output terstruktur dari model untuk memanggil API eksternal. Misalnya, Anda dapat menghubungkan ke API layanan cuaca, memberikan lokasi
Boston, MA
, dan menerima informasi tentang suhu, tutupan awan, dan kondisi
angin.
Anda kemudian dapat memberikan output API kembali ke model, sehingga model dapat menyelesaikan responsnya terhadap perintah. Untuk contoh cuaca, model dapat memberikan
respons berikut: It is currently 38 degrees Fahrenheit in Boston, MA with partly cloudy skies.
Model berikut memberikan dukungan untuk panggilan fungsi:
Model | Versi | Tahap peluncuran panggilan fungsi | Dukungan untuk panggilan fungsi paralel | Dukungan untuk panggilan fungsi paksa |
---|---|---|---|---|
Gemini 1.0 Pro |
gemini-1.0-pro-001 |
Ketersediaan Umum | Tidak | Tidak |
Gemini 1.0 Pro |
gemini-1.0-pro-002 |
Ketersediaan Umum | Tidak | Tidak |
Gemini 1.5 Flash |
gemini-1.5-flash-001 |
Ketersediaan Umum | Ya | Tidak |
Gemini 1.5 Pro |
gemini-1.5-pro-001 |
Ketersediaan Umum | Ya | Ya |
Kasus penggunaan panggilan fungsi
Anda dapat menggunakan panggilan fungsi untuk tugas berikut:
Kasus penggunaan | Contoh deskripsi | Contoh link |
---|---|---|
Mengekstrak entity dari cerita natural language | Ekstrak daftar karakter, hubungan, hal, dan tempat dari sebuah cerita. | Ekstraksi data terstruktur menggunakan panggilan fungsi [Vertex AI SDK untuk notebook Python] |
Mengkueri dan memahami database SQL menggunakan natural language | Minta model untuk mengonversi pertanyaan seperti What percentage of orders are returned? ke dalam kueri SQL dan membuat fungsi yang mengirimkan kueri ini ke BigQuery. |
Membangun Aplikasi Eksplorasi Data BigQuery yang didukung AI menggunakan Panggilan Fungsi di Gemini [Postingan blog] |
Bantu pelanggan berinteraksi dengan bisnis | Buat fungsi yang terhubung ke API bisnis, sehingga model dapat memberikan jawaban akurat untuk kueri seperti Do you have the Pixel 8 Pro in stock? atau Is there a store in Mountain View, CA that I can visit to try it out? |
Panggilan Fungsi dengan Vertex AI Gemini API & Python SDK [Vertex AI SDK untuk notebook Python] |
Contoh REST | ||
Contoh chat Vertex AI SDK untuk Python | ||
Membangun aplikasi AI generatif dengan terhubung ke API publik | Melakukan konversi antarmata uang. Buat fungsi yang terhubung ke aplikasi pertukaran mata uang, sehingga model dapat memberikan jawaban akurat untuk kueri seperti What's the exchange rate for euros to dollars today? |
Cara Berinteraksi dengan API Menggunakan Panggilan Fungsi di Gemini [Codelab] |
Dapatkan info cuaca untuk lokasi tertentu. Buat fungsi yang terhubung ke API layanan meteorologi, sehingga model dapat memberikan jawaban akurat untuk kueri seperti What's the weather like in Paris? |
Panggilan Fungsi dengan Vertex AI Gemini API & Python SDK [Vertex AI SDK untuk notebook Python] | |
Panggilan fungsi: Framework native untuk menghubungkan Gemini ke sistem, data, dan API eksternal [Postingan blog] | ||
Contoh teks Vertex AI SDK untuk Python dan Node.js | ||
Contoh chat Node.js, Java, dan Go | ||
Konversi alamat menjadi koordinat lintang dan bujur. Buat fungsi yang mengonversi data lokasi terstruktur menjadi koordinat lintang dan bujur. Minta model untuk mengidentifikasi alamat jalan, kota, negara bagian/provinsi, dan kode pos dalam kueri seperti I want to get the lat/lon coordinates for the following address: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, US. |
Panggilan Fungsi dengan Vertex AI Gemini API & Python SDK [Vertex AI SDK untuk notebook Python] | |
Menafsirkan perintah suara | Membuat fungsi yang sesuai dengan tugas di dalam kendaraan. Misalnya, Anda dapat membuat fungsi yang menyalakan radio atau mengaktifkan penyejuk udara. Kirim file audio dari perintah suara pengguna ke model, dan minta model untuk mengonversi audio menjadi teks dan mengidentifikasi fungsi yang ingin dipanggil pengguna. | |
Mengotomatiskan alur kerja berdasarkan pemicu lingkungan | Membuat fungsi untuk mewakili proses yang dapat diotomatiskan. Berikan data dari sensor lingkungan kepada model dan minta model untuk mengurai dan memproses data guna menentukan apakah satu atau beberapa alur kerja harus diaktifkan. Misalnya, suatu model dapat memproses data suhu di gudang dan memilih untuk mengaktifkan fungsi sprinkler. | |
Mengotomatiskan penetapan tiket dukungan | Berikan tiket dukungan, log, dan aturan kontekstual kepada model. Minta model untuk memproses semua informasi ini untuk menentukan kepada siapa tiket tersebut harus ditetapkan. Panggil fungsi untuk menetapkan tiket kepada orang yang disarankan oleh model. | |
Mengambil informasi dari pusat informasi | Membuat fungsi yang mengambil artikel akademik tentang subjek tertentu dan meringkasnya. Memungkinkan model untuk menjawab pertanyaan tentang mata pelajaran akademik dan memberikan kutipan untuk jawabannya. |
Membuat aplikasi panggilan fungsi
Agar pengguna dapat berinteraksi dengan model dan menggunakan panggilan fungsi, Anda harus membuat kode yang melakukan tugas berikut:
- Lakukan inisialisasi model.
- Menentukan perintah pengguna.
- Tentukan dan jelaskan serangkaian fungsi yang tersedia menggunakan deklarasi fungsi.
- Kirimkan perintah pengguna dan deklarasi fungsi ke model.
- Panggil fungsi menggunakan output data terstruktur dari model.
- Berikan output fungsi ke model.
Anda dapat membuat aplikasi yang mengelola semua tugas ini. Aplikasi ini dapat berupa chatbot teks, agen suara, alur kerja otomatis, atau program lainnya.
Anda dapat menggunakan panggilan fungsi untuk menghasilkan satu respons teks atau untuk mendukung sesi chat. Respons teks ad hoc berguna untuk tugas bisnis tertentu, termasuk pembuatan kode. Sesi chat berguna dalam skenario percakapan berformat bebas, di mana pengguna cenderung mengajukan pertanyaan lanjutan.
Jika menggunakan panggilan fungsi untuk menghasilkan respons tunggal, Anda harus memberikan konteks interaksi lengkap kepada model. Di sisi lain, jika Anda menggunakan panggilan fungsi dalam konteks sesi chat, sesi tersebut akan menyimpan konteks untuk Anda dan menyertakannya dalam setiap permintaan model. Pada kedua kasus tersebut, Vertex AI menyimpan histori interaksi di sisi klien.
Panduan ini menunjukkan cara menggunakan panggilan fungsi untuk menghasilkan satu respons teks. Untuk melihat contoh menyeluruh, lihat Contoh teks. Untuk mempelajari cara menggunakan panggilan fungsi guna mendukung sesi chat, lihat Contoh Chat.
Melakukan inisialisasi model
Berikut adalah contoh cara melakukan inisialisasi model:
Python
import vertexai
from vertexai.generative_models import (
Content,
FunctionDeclaration,
GenerationConfig,
GenerativeModel,
Part,
Tool,
)
# Initialize Vertex AI
# TODO(developer): Update and un-comment below lines
# project_id = 'PROJECT_ID'
vertexai.init(project=project_id, location="us-central1")
# Initialize Gemini model
model = GenerativeModel(model_name="gemini-1.0-pro-001")
Menentukan perintah pengguna
Berikut adalah contoh {i>prompt<i} pengguna: "Bagaimana cuaca di Jakarta?"
Berikut adalah contoh cara menentukan dialog pengguna:
Python
# Define the user's prompt in a Content object that we can reuse in model calls
user_prompt_content = Content(
role="user",
parts=[
Part.from_text("What is the weather like in Boston?"),
],
)
Untuk praktik terbaik terkait perintah pengguna, lihat Praktik terbaik - Perintah pengguna.
Menentukan dan menjelaskan serangkaian fungsi yang tersedia
Aplikasi harus mendeklarasikan serangkaian fungsi yang dapat digunakan model untuk memproses perintah. Setiap deklarasi fungsi harus menyertakan nama fungsi dan parameter fungsi. Sebaiknya sertakan juga deskripsi fungsi di setiap deklarasi fungsi.
Jumlah maksimum deklarasi fungsi yang dapat diberikan dengan permintaan adalah 128.
Function name
Aplikasi dan model menggunakan nama fungsi untuk mengidentifikasi fungsi.
Untuk praktik terbaik terkait nama fungsi, lihat Praktik terbaik - Nama fungsi.
Parameter fungsi
Parameter fungsi harus disediakan dalam format yang kompatibel dengan skema OpenAPI.
Vertex AI menawarkan dukungan terbatas untuk skema OpenAPI. Atribut berikut didukung: type
, nullable
, required
, format
, description
, properties
, items
, enum
. Atribut berikut tidak
didukung: default
, optional
, maximum
, oneOf
.
Saat menggunakan curl, tentukan skema menggunakan JSON. Saat Anda menggunakan Vertex AI SDK untuk Python, tentukan skema menggunakan kamus Python.
Untuk praktik terbaik terkait parameter fungsi, lihat Praktik terbaik - Parameter fungsi.
Deskripsi fungsi
Model ini menggunakan deskripsi fungsi untuk memahami tujuan fungsi dan untuk menentukan apakah fungsi tersebut berguna dalam memproses kueri pengguna.
Untuk praktik terbaik terkait deskripsi fungsi, lihat Praktik terbaik - Deskripsi fungsi.
Contoh deklarasi fungsi
Python: deklarasi sederhana
Berikut adalah contoh deklarasi fungsi sederhana di Python:
function_name = "get_current_weather"
get_current_weather_func = FunctionDeclaration(
name=function_name,
description="Get the current weather in a given location",
parameters={
"type": "object",
"properties": {"location": {"type": "string", "description": "The city name of the location for which to get the weather."}},
},
)
Python: array item
Berikut adalah contoh deklarasi fungsi dengan array item:
extract_sale_records_func = FunctionDeclaration(
name="extract_sale_records",
description="Extract sale records from a document.",
parameters={
"type": "object",
"properties": {
"records": {
"type": "array",
"description": "A list of sale records",
"items": {
"description": "Data for a sale record",
"type": "object",
"properties": {
"id": {"type": "integer", "description": "The unique id of the sale."},
"date": {"type": "string", "description": "Date of the sale, in the format of MMDDYY, e.g., 031023"},
"total_amount": {"type": "number", "description": "The total amount of the sale."},
"customer_name": {"type": "string", "description": "The name of the customer, including first name and last name."},
"customer_contact": {"type": "string", "description": "The phone number of the customer, e.g., 650-123-4567."},
},
"required": ["id", "date", "total_amount"],
},
},
},
"required": ["records"],
},
)
Mengirimkan perintah dan deklarasi fungsi ke model
Saat pengguna memberikan perintah, aplikasi harus menyediakan perintah pengguna dan deklarasi fungsi kepada model. Untuk mengonfigurasi cara model menghasilkan hasil, aplikasi dapat menyediakan konfigurasi pembuatan pada model. Untuk mengonfigurasi cara model menggunakan deklarasi fungsi, aplikasi dapat menyediakan konfigurasi alat kepada model. Panggilan fungsi tidak mendukung input multimodal.
Konfigurasi pembuatan
Model ini dapat membuat hasil yang berbeda untuk parameter value yang berbeda. Parameter
suhu akan mengontrol tingkat keacakan dalam generasi ini.
Suhu yang lebih rendah cocok untuk fungsi yang memerlukan parameter value deterministik, sedangkan suhu yang lebih tinggi cocok untuk fungsi dengan parameter yang menerima parameter value yang lebih beragam atau kreatif. Suhu 0
bersifat
determenistik. Dalam hal ini, respons untuk perintah tertentu sebagian besar
determenistik, tetapi masih dapat dilakukan dengan sedikit variasi. Untuk mempelajari
lebih lanjut, lihat Gemini API.
Untuk menetapkan parameter ini, kirimkan konfigurasi pembuatan (generation_config
)
beserta perintah dan deklarasi fungsi. Anda dapat memperbarui
parameter temperature
selama percakapan chat menggunakan Vertex AI
API dan generation_config
yang telah diupdate. Untuk contoh setelan
parameter temperature
, lihat
Cara mengirimkan perintah dan deklarasi fungsi.
Untuk praktik terbaik terkait konfigurasi pembuatan, lihat Praktik terbaik - Konfigurasi pembuatan.
Konfigurasi alat
Anda dapat menempatkan beberapa batasan terkait cara model harus menggunakan deklarasi fungsi yang Anda sediakan. Misalnya, daripada mengizinkan model memilih antara respons natural language dan panggilan fungsi, Anda dapat memaksanya untuk hanya memprediksi panggilan fungsi ("panggilan fungsi paksa"). Anda juga dapat memilih untuk menyediakan serangkaian lengkap deklarasi fungsi kepada model, tetapi membatasi responsnya ke sebagian fungsi tersebut.
Untuk menempatkan batasan ini, kirimkan konfigurasi alat (tool_config
) beserta perintah dan deklarasi fungsi. Dalam konfigurasi, Anda dapat
menentukan salah satu mode berikut:
Mode | Deskripsi |
---|---|
AUTO | Perilaku model default. Model memutuskan apakah akan memprediksi panggilan fungsi atau respons natural language. |
APA PUN | Model hanya boleh memprediksi panggilan fungsi. Untuk membatasi model ke subset fungsi, tentukan nama fungsi yang diizinkan di allowed_function_names . |
NONE | Model tidak boleh memprediksi panggilan fungsi. Perilaku ini setara dengan permintaan model tanpa deklarasi fungsi terkait. |
Mode ANY
konfigurasi alat ("panggilan fungsi paksa") adalah fitur Pratinjau. Fitur ini hanya didukung untuk model Gemini 1.5 Pro
.
Untuk mempelajari lebih lanjut, lihat Function Calling API.
Cara mengirimkan perintah dan deklarasi fungsi
Berikut adalah contoh cara mengirimkan perintah dan deklarasi fungsi ke model, serta membatasi model untuk hanya memprediksi panggilan fungsi get_current_weather
.
Python
# Define a tool that includes the function declaration get_current_weather_func
weather_tool = Tool(
function_declarations=[get_current_weather_func],
)
# Send the prompt and instruct the model to generate content using the Tool object that you just created
response = model.generate_content(
user_prompt_content,
generation_config={"temperature": 0},
tools=[weather_tool],
tool_config=ToolConfig(
function_calling_config=ToolConfig.FunctionCallingConfig(
# ANY mode forces the model to predict a function call
mode=ToolConfig.FunctionCallingConfig.Mode.ANY,
# Allowed functions to call when the mode is ANY. If empty, any one of
# the provided functions are called.
allowed_function_names=["get_current_weather"],
))
)
response_function_call_content = response.candidates[0].content
Jika model menentukan bahwa model memerlukan output dari fungsi tertentu, respons yang diterima aplikasi dari model akan berisi nama fungsi dan parameter value yang harus digunakan untuk memanggil fungsi.
Berikut adalah contoh respons model terhadap perintah pengguna "What is the weather like in Boston?". Model ini mengusulkan untuk memanggil
fungsi get_current_weather
dengan parameter Boston, MA
.
candidates { content { role: "model" parts { function_call { name: "get_current_weather" args { fields { key: "location" value { string_value: "Boston, MA" } } } } } } ... }
Untuk perintah seperti "Dapatkan detail cuaca di New Delhi dan San Francisco?",
model dapat mengusulkan beberapa panggilan fungsi paralel. Panggilan fungsi paralel
adalah fitur Pratinjau. Hal ini didukung oleh
model
Gemini 1.5 Pro
dan Gemini 1.5 Flash
. Untuk mempelajari lebih lanjut, lihat Contoh panggilan fungsi paralel.
Memanggil API eksternal
Jika aplikasi menerima nama fungsi dan parameter value dari model, aplikasi harus terhubung ke API eksternal dan memanggil fungsi.
Contoh berikut menggunakan data sintetis untuk menyimulasikan payload respons dari API eksternal:
Python
# Check the function name that the model responded with, and make an API call to an external system
if (
response.candidates[0].content.parts[0].function_call.name
== "get_current_weather"
):
# Extract the arguments to use in your API call
location = (
response.candidates[0].content.parts[0].function_call.args["location"]
)
# Here you can use your preferred method to make an API request to fetch the current weather, for example:
# api_response = requests.post(weather_api_url, data={"location": location})
# In this example, we'll use synthetic data to simulate a response payload from an external API
api_response = """{ "location": "Boston, MA", "temperature": 38, "description": "Partly Cloudy",
"icon": "partly-cloudy", "humidity": 65, "wind": { "speed": 10, "direction": "NW" } }"""
Untuk praktik terbaik terkait pemanggilan API, lihat Praktik terbaik - pemanggilan API.
Memberikan output fungsi ke model
Setelah menerima respons dari API eksternal, aplikasi harus memberikan respons ini pada model. Berikut adalah contoh cara melakukannya dengan Python:
Python
response = model.generate_content(
[
user_prompt_content, # User prompt
response_function_call_content, # Function call response
Content(
parts=[
Part.from_function_response(
name="get_current_weather",
response={
"content": api_response, # Return the API response to Gemini
},
)
],
),
],
tools=[weather_tool],
)
# Get the model summary response
summary = response.candidates[0].content.parts[0].text
Jika model telah mengusulkan beberapa panggilan fungsi paralel, aplikasi harus
memberikan kembali semua respons ke model. Panggilan fungsi paralel adalah
fitur Pratinjau. Hal ini didukung oleh
model
Gemini 1.5 Pro
dan Gemini 1.5 Flash
. Untuk mempelajari lebih lanjut, lihat Contoh panggilan fungsi paralel.
Model gemini-1.0-pro-001
dan gemini-1.0-pro-002
dapat menentukan bahwa
output fungsi lain diperlukan untuk merespons perintah. Dalam hal ini,
respons yang diterima aplikasi dari model berisi nama
fungsi lain dan serangkaian parameter value lainnya.
Jika model menentukan bahwa respons API sudah cukup untuk merespons perintah pengguna, model akan membuat respons natural language dan menampilkannya ke aplikasi. Dalam hal ini, aplikasi harus meneruskan respons kembali kepada pengguna. Berikut adalah contoh respons:
It is currently 38 degrees Fahrenheit in Boston, MA with partly cloudy skies. The humidity is 65% and the wind is blowing at 10 mph from the northwest.
Contoh teks
Anda dapat menggunakan panggilan fungsi untuk menghasilkan satu respons teks. Respons teks ad hoc berguna untuk tugas bisnis tertentu, termasuk pembuatan kode.
Jika menggunakan panggilan fungsi untuk menghasilkan respons tunggal, Anda harus memberikan konteks interaksi lengkap kepada model. Vertex AI menyimpan histori interaksi di sisi klien.
Python
Contoh ini menunjukkan skenario teks dengan satu fungsi dan satu
dialog. Class tersebut menggunakan class GenerativeModel
dan metodenya. Untuk mengetahui informasi
selengkapnya tentang penggunaan Vertex AI SDK untuk Python dengan model multimodal
Gemini, lihat
Pengantar class multimodal di Vertex AI SDK untuk Python.
Python
Untuk mempelajari cara menginstal atau mengupdate Vertex AI SDK untuk Python, lihat Menginstal Vertex AI SDK untuk Python. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi Python API.
Node.js
Contoh ini menunjukkan skenario teks dengan satu fungsi dan satu dialog.
Node.js
Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Node.js di Panduan memulai Vertex AI menggunakan library klien. Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API Node.js Vertex AI.
Untuk melakukan autentikasi ke Vertex AI, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
REST
Contoh ini menunjukkan skenario teks dengan tiga fungsi dan satu perintah.
Dalam contoh ini, Anda memanggil model AI generatif dua kali.
- Pada panggilan pertama, Anda memberikan prompt dan deklarasi fungsi ke model.
- Dalam panggilan kedua, Anda akan memberikan respons API kepada model.
Permintaan model pertama
Permintaan harus menentukan dialog dalam parameter text
. Contoh ini menentukan
perintah berikut: "Bioskop mana di Jakarta yang menayangkan film Barbie?".
Permintaan juga harus menentukan alat (tools
) dengan serangkaian deklarasi fungsi (functionDeclarations
). Deklarasi fungsi ini harus ditentukan dalam format yang kompatibel dengan skema OpenAPI. Contoh ini menentukan fungsi berikut:
find_movies
menemukan judul film yang diputar di bioskop.find_theatres
menemukan bioskop berdasarkan lokasi.get_showtimes
menemukan waktu mulai untuk film yang diputar di bioskop tertentu.
Untuk mempelajari lebih lanjut parameter permintaan model, lihat Gemini API.
Ganti my-project dengan nama project Google Cloud Anda.
Permintaan model pertama
PROJECT_ID=my-project MODEL_ID=gemini-1.0-pro API=streamGenerateContent curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://us-central1-aiplatform.googleapis.com/v1/projects/${PROJECT_ID}/locations/us-central1/publishers/google/models/${MODEL_ID}:${API} -d '{ "contents": { "role": "user", "parts": { "text": "Which theaters in Mountain View show the Barbie movie?" } }, "tools": [ { "function_declarations": [ { "name": "find_movies", "description": "find movie titles currently playing in theaters based on any description, genre, title words, etc.", "parameters": { "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA or a zip code e.g. 95616" }, "description": { "type": "string", "description": "Any kind of description including category or genre, title words, attributes, etc." } }, "required": [ "description" ] } }, { "name": "find_theaters", "description": "find theaters based on location and optionally movie title which are is currently playing in theaters", "parameters": { "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA or a zip code e.g. 95616" }, "movie": { "type": "string", "description": "Any movie title" } }, "required": [ "location" ] } }, { "name": "get_showtimes", "description": "Find the start times for movies playing in a specific theater", "parameters": { "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA or a zip code e.g. 95616" }, "movie": { "type": "string", "description": "Any movie title" }, "theater": { "type": "string", "description": "Name of the theater" }, "date": { "type": "string", "description": "Date for requested showtime" } }, "required": [ "location", "movie", "theater", "date" ] } } ] } ] }'
Untuk perintah "Bioskop mana di Mountain View yang menampilkan film Barbie?", model
mungkin akan menampilkan fungsi find_theatres
dengan parameter Barbie
dan
Mountain View, CA
.
Respons terhadap permintaan model pertama
[{ "candidates": [ { "content": { "parts": [ { "functionCall": { "name": "find_theaters", "args": { "movie": "Barbie", "location": "Mountain View, CA" } } } ] }, "finishReason": "STOP", "safetyRatings": [ { "category": "HARM_CATEGORY_HARASSMENT", "probability": "NEGLIGIBLE" }, { "category": "HARM_CATEGORY_HATE_SPEECH", "probability": "NEGLIGIBLE" }, { "category": "HARM_CATEGORY_SEXUALLY_EXPLICIT", "probability": "NEGLIGIBLE" }, { "category": "HARM_CATEGORY_DANGEROUS_CONTENT", "probability": "NEGLIGIBLE" } ] } ], "usageMetadata": { "promptTokenCount": 9, "totalTokenCount": 9 } }]
Permintaan model kedua
Contoh ini menggunakan data sintetis, bukan memanggil API eksternal.
Ada dua hasil, masing-masing dengan dua parameter (name
dan address
):
name
:AMC Mountain View 16
,address
:2000 W El Camino Real, Mountain View, CA 94040
name
:Regal Edwards 14
,address
:245 Castro St, Mountain View, CA 94040
Ganti my-project dengan nama project Google Cloud Anda.
Permintaan model kedua
PROJECT_ID=my-project MODEL_ID=gemini-1.0-pro API=streamGenerateContent curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://us-central1-aiplatform.googleapis.com/v1/projects/${PROJECT_ID}/locations/us-central1/publishers/google/models/${MODEL_ID}:${API} -d '{ "contents": [{ "role": "user", "parts": [{ "text": "Which theaters in Mountain View show the Barbie movie?" }] }, { "role": "model", "parts": [{ "functionCall": { "name": "find_theaters", "args": { "location": "Mountain View, CA", "movie": "Barbie" } } }] }, { "parts": [{ "functionResponse": { "name": "find_theaters", "response": { "name": "find_theaters", "content": { "movie": "Barbie", "theaters": [{ "name": "AMC Mountain View 16", "address": "2000 W El Camino Real, Mountain View, CA 94040" }, { "name": "Regal Edwards 14", "address": "245 Castro St, Mountain View, CA 94040" }] } } } }] }], "tools": [{ "functionDeclarations": [{ "name": "find_movies", "description": "find movie titles currently playing in theaters based on any description, genre, title words, etc.", "parameters": { "type": "OBJECT", "properties": { "location": { "type": "STRING", "description": "The city and state, e.g. San Francisco, CA or a zip code e.g. 95616" }, "description": { "type": "STRING", "description": "Any kind of description including category or genre, title words, attributes, etc." } }, "required": ["description"] } }, { "name": "find_theaters", "description": "find theaters based on location and optionally movie title which are is currently playing in theaters", "parameters": { "type": "OBJECT", "properties": { "location": { "type": "STRING", "description": "The city and state, e.g. San Francisco, CA or a zip code e.g. 95616" }, "movie": { "type": "STRING", "description": "Any movie title" } }, "required": ["location"] } }, { "name": "get_showtimes", "description": "Find the start times for movies playing in a specific theater", "parameters": { "type": "OBJECT", "properties": { "location": { "type": "STRING", "description": "The city and state, e.g. San Francisco, CA or a zip code e.g. 95616" }, "movie": { "type": "STRING", "description": "Any movie title" }, "theater": { "type": "STRING", "description": "Name of the theater" }, "date": { "type": "STRING", "description": "Date for requested showtime" } }, "required": ["location", "movie", "theater", "date"] } }] }] }'
Respons model mungkin mirip dengan respons berikut:
Respons terhadap permintaan model kedua
{ "candidates": [ { "content": { "parts": [ { "text": " OK. Barbie is showing in two theaters in Mountain View, CA: AMC Mountain View 16 and Regal Edwards 14." } ] } } ], "usageMetadata": { "promptTokenCount": 9, "candidatesTokenCount": 27, "totalTokenCount": 36 } }
Contoh chat
Anda dapat menggunakan panggilan fungsi untuk mendukung sesi chat. Sesi chat berguna dalam skenario percakapan bentuk bebas, di mana pengguna cenderung mengajukan pertanyaan lanjutan.
Jika Anda menggunakan panggilan fungsi dalam konteks sesi chat, sesi tersebut akan menyimpan konteks untuk Anda dan menyertakannya dalam setiap permintaan model. Vertex AI menyimpan histori interaksi di sisi klien.
Python
Contoh ini menunjukkan skenario chat dengan dua fungsi dan dua
perintah berurutan. Class tersebut menggunakan class GenerativeModel
dan metodenya. Untuk
mengetahui informasi selengkapnya tentang penggunaan Vertex AI SDK untuk Python dengan model multimodal, lihat
Pengantar class multimodal di Vertex AI SDK untuk Python.
Untuk mempelajari cara menginstal atau mengupdate Python, lihat Menginstal Vertex AI SDK untuk Python. Untuk informasi lebih lanjut, lihat dokumentasi referensi Python API.
Java
Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Java di Panduan memulai Vertex AI menggunakan library klien. Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API Java Vertex AI.
Untuk melakukan autentikasi ke Vertex AI, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Go
Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Go di Panduan memulai Vertex AI menggunakan library klien. Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API Go Vertex AI.
Untuk melakukan autentikasi ke Vertex AI, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Node.js
Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Node.js di Panduan memulai Vertex AI menggunakan library klien. Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API Node.js Vertex AI.
Untuk melakukan autentikasi ke Vertex AI, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Contoh panggilan fungsi paralel
Untuk perintah seperti "Dapatkan detail cuaca di New Delhi dan San Francisco?",
model dapat mengusulkan beberapa panggilan fungsi paralel. Panggilan fungsi paralel
adalah fitur Pratinjau. Hal ini didukung oleh
model
Gemini 1.5 Pro
dan Gemini 1.5 Flash
.
REST
Contoh ini menunjukkan skenario dengan satu fungsi get_current_weather
.
Perintah pengguna adalah "Dapatkan detail cuaca di New Delhi dan San Francisco?". Model ini mengusulkan dua panggilan fungsi get_current_weather
paralel: satu dengan parameter New Delhi
dan satu lagi dengan parameter San Francisco
.
Panggilan fungsi paralel adalah fitur
Pratinjau. Hal ini didukung oleh
model Gemini 1.5 Pro
dan Gemini 1.5 Flash
.
Untuk mempelajari lebih lanjut parameter permintaan model, lihat Gemini API.
candidates { content { role: "model" parts: [ { function_call { name: "get_current_weather" args { fields { key: "location" value { string_value: "New Delhi" } } } } }, { function_call { name: "get_current_weather" args { fields { key: "location" value { string_value: "San Francisco" } } } } } ] } ... }
Perintah berikut menunjukkan cara memberikan output fungsi ke model. Ganti my-project dengan nama project Google Cloud Anda.
Permintaan model
PROJECT_ID=my-project MODEL_ID=gemini-1.5-pro-001 VERSION="v1" LOCATION="us-central1" ENDPOINT=${LOCATION}-aiplatform.googleapis.com API="generateContent" curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://${ENDPOINT}/${VERSION}/projects/${PROJECT_ID}/locations/${LOCATION}/publishers/google/models/${MODEL_ID}:${API} -d '{ "contents": [ { "role": "user", "parts": { "text": "What is difference in temperature in New Delhi and San Francisco?" } }, { "role": "model", "parts": [ { "functionCall": { "name": "get_current_weather", "args": { "location": "New Delhi" } } }, { "functionCall": { "name": "get_current_weather", "args": { "location": "San Francisco" } } } ] }, { "role": "user", "parts": [ { "functionResponse": { "name": "get_current_weather", "response": { "temperature": 30.5, "unit": "C" } } }, { "functionResponse": { "name": "get_current_weather", "response": { "temperature": 20, "unit": "C" } } } ] } ], "tools": [ { "function_declarations": [ { "name": "get_current_weather", "description": "Get the current weather in a specific location", "parameters": { "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA or a zip code e.g. 95616" } }, "required": [ "location" ] } } ] } ] }'
Respons natural language yang dibuat oleh model mirip dengan berikut ini:
Respons model
[ { "candidates": [ { "content": { "parts": [ { "text": "The temperature in New Delhi is 30.5C and the temperature in San Francisco is 20C. The difference is 10.5C. \n" } ] }, "finishReason": "STOP", ... } ] ... } ]
Praktik terbaik
Function name
Jangan gunakan karakter titik (.
), tanda hubung (-
), atau spasi pada nama fungsi.
Sebagai gantinya, gunakan karakter garis bawah (_
) atau karakter lainnya.
Parameter fungsi
Tulis deskripsi parameter yang jelas dan panjang, termasuk detail seperti
format atau nilai pilihan Anda. Misalnya, untuk
fungsi book_flight_ticket
:
- Berikut adalah contoh yang baik dari deskripsi parameter
departure
:Use the 3 char airport code to represent the airport. For example, SJC or SFO. Don't use the city name.
- Berikut adalah contoh yang buruk dari deskripsi parameter
departure
:the departure airport
Jika memungkinkan, gunakan parameter dengan jenis yang sesuai untuk mengurangi halusinasi model. Misalnya,
jika parameter value berasal dari himpunan terbatas, tambahkan kolom enum
,
bukan menempatkan kumpulan nilai ke dalam deskripsi. Jika nilai parameter
selalu berupa bilangan bulat, setel jenisnya ke integer
, bukan number
.
Deskripsi fungsi
Tulis deskripsi fungsi dengan jelas dan panjang. Misalnya, untuk fungsi book_flight_ticket
:
- Berikut adalah contoh deskripsi fungsi yang baik:
book flight tickets after confirming users' specific requirements, such as time, departure, destination, party size and preferred airline
- Berikut adalah contoh deskripsi fungsi yang buruk:
book flight ticket
Perintah pengguna
Untuk mendapatkan hasil terbaik, awali perintah pengguna dengan detail berikut:
- Konteks tambahan untuk model-misalnya,
You are a flight API assistant to help with searching flights based on user preferences.
- Detail atau petunjuk tentang cara dan waktu untuk menggunakan fungsi-misalnya,
Don't make assumptions on the departure or destination airports. Always use a future date for the departure or destination time.
- Petunjuk untuk mengajukan pertanyaan klarifikasi jika kueri pengguna bersifat ambigu, misalnya,
Ask clarifying questions if not enough information is available.
Konfigurasi pembuatan
Untuk parameter suhu, gunakan 0
atau nilai rendah lainnya. Hal ini menginstruksikan
model untuk memberikan hasil yang lebih meyakinkan dan mengurangi halusinasi.
Pemanggilan API
Jika model mengusulkan pemanggilan fungsi yang akan mengirim pesanan, mengupdate database, atau memiliki konsekuensi yang signifikan, validasikan panggilan fungsi dengan pengguna sebelum mengeksekusinya.
Harga
Harga untuk panggilan fungsi didasarkan pada jumlah karakter dalam input dan output teks. Untuk mempelajari lebih lanjut, lihat harga Vertex AI.
Di sini, input teks (prompt) mengacu pada perintah pengguna untuk perubahan percakapan saat ini, deklarasi fungsi untuk perubahan percakapan saat ini, dan histori percakapan. Histori percakapan mencakup kueri, panggilan fungsi, dan respons fungsi dari percakapan sebelumnya. Vertex AI memangkas histori percakapan menjadi 32.000 karakter.
Output teks (respons) mengacu pada panggilan fungsi dan respons teks untuk perubahan percakapan saat ini.