להצגה ב-AI מבית Google | כדאי לנסות notebook של Colab | הצגת notebook ב-GitHub |
במדריך הזה תלמדו על דוגמה לחילוץ נתונים מובְנים. תוכלו להיעזר ב-Gemini API כדי לחלץ מסיפור את רשימות הדמויות, קשרי הגומלין, המקומות והמקומות.
הגדרה
pip install -U -q google-generativeai
import pathlib
import textwrap
import google.generativeai as genai
from IPython.display import display
from IPython.display import Markdown
from google.api_core import retry
def to_markdown(text):
text = text.replace('•', ' *')
return Markdown(textwrap.indent(text, '> ', predicate=lambda _: True))
אחרי שמקבלים את מפתח ה-API, מעבירים אותו ל-SDK. תוכל לעשות זאת בשתי דרכים:
- מכניסים את המפתח למשתנה הסביבה
GOOGLE_API_KEY
(ערכת ה-SDK תאסוף אותו משם באופן אוטומטי). - צריך להעביר את המפתח אל
genai.configure(api_key=...)
genai.configure(api_key=GOOGLE_API_KEY)
המשימה לדוגמה
במדריך הזה תוחלץ ישויות מסיפורים בשפה טבעית. בתור למטה מופיע סיפור שנכתב על ידי Gemini.
new_story = False
if new_story:
model = genai.GenerativeModel(model_name='models/gemini-1.5-pro-latest')
response = model.generate_content("""
Write a long story about a girl with magic backpack, her family, and at
least one other charater. Make sure everyone has names. Don't forget to
describe the contents of the backpack, and where everyone and everything
starts and ends up.""", request_options={'retry': retry.Retry()})
story = response.text
print(response.candidates[0].citation_metadata)
else:
story = """In the quaint town of Willow Creek, nestled amidst rolling hills and whispering willows, resided a young girl named Anya. As she stepped out of the creaky wooden door of her modest cottage, her heart skipped a beat with excitement and anticipation. Today was her first day of school, and she couldn't wait to show off her prized possession - a magical backpack.\n\nHanded down to her from her grandmother, the backpack was no ordinary satchel. Its soft, emerald-green fabric shimmered with an ethereal glow, and its leather straps held secrets that only Anya knew. Within its capacious interior lay an enchanted world, filled with wonders that would ignite her imagination and change her life forever.\n\nAnya's parents, kind-hearted Elise and wise-bearded Edward, bid her farewell with warm embraces. "Remember, my dear," whispered her mother, "use your magic wisely and for good." Her father added, "Always seek knowledge, and let the backpack be your trusted companion."\n\nWith a skip in her step, Anya set off towards the town's only schoolhouse. On her way, she passed her best friend, Samuel, a curious and adventurous boy with a mischievous grin. "Hey, Anya," he called out. "Can I see your backpack?"\n\nAnya hesitated for a moment before unzipping the flap and revealing its contents. Samuel's eyes widened in amazement as he peered inside. There, nestled amidst pencils and notebooks, were a shimmering sword, a book of ancient spells, a tiny compass that always pointed north, and a magical key that could open any lock.\n\nTogether, they marveled at the backpack's wonders, promising to keep its secrets safe. As they approached the schoolhouse, Anya noticed a group of older children huddled together, their faces etched with fear. Curiosity getting the better of her, she cautiously approached.\n\n"What's wrong?" she asked.\n\nA tall, lanky boy stepped forward. "There's a monster in the forest," he stammered. "It's been terrorizing the town, attacking animals and even people."\n\nAnya's heart sank. The town of Willow Creek was small and peaceful, and the thought of a monster brought a shiver down her spine. She knew she had to do something to protect her family and friends.\n\nWithout a moment's hesitation, Anya opened her backpack and retrieved the shimmering sword. With a determined gleam in her eye, she turned to her terrified peers. "Don't worry," she said, her voice steady. "I'll take care of it."\n\nWith Samuel close behind her, Anya ventured into the shadowy depths of the forest. The trees seemed to whisper secrets as she passed, and the undergrowth rustled with unseen creatures. As they walked deeper into the forest, the air grew heavy and the ground beneath their feet trembled.\n\nSuddenly, they came to a clearing, and there before their eyes was the monster - a massive beast with sharp teeth, glowing red eyes, and claws that could crush a human with ease. The creature roared, a thunderous sound that shook the forest to its core.\n\nFear surged through Anya, but she refused to let it consume her. She drew the sword from its sheath and charged towards the monster. The blade shimmered in the sunlight, and as it struck the beast's hide, a blinding light erupted, enveloping everything in its radiance.\n\nWhen the light faded, the monster was gone, and in its place was a pile of shattered crystals. Anya had defeated the creature with the magic of her backpack, proving that even the smallest of objects could hold the greatest of powers.\n\nAs she and Samuel returned to the town, they were greeted as heroes. The people of Willow Creek rejoiced, and the legend of Anya, the girl with the magic backpack, was passed down through generations. And so, Anya continued her adventures, using the backpack's wonders to make the world a better place, one magical step at a time."""
to_markdown(story)
בעיירה הייחודית ווילו קריק, ששוכנת בין גבעות משתפלות וערבות ערבה, גרה ילדה צעירה בשם אניה. כשיצאה מדלת העץ החורנית בקוטג' הצנוע שלה, לבה דילג על הפעימה בהתרגשות וציפייה. היום היה היום הראשון שלה בבית הספר, והיא חיפשה להשוויץ בחפצים האהובים עליה - תיק גב קסום.
לאחר שקיבלנו את תיק הגב מסבתא שלה, הוא לא היה תיק גב רגיל. הבד הרך בצבע ירוק אזמרגד נוצץ בזוהר שמימי, ורצועות העור שלו הכילו סודות שרק אניה ידעה. בתוך החלל הפנימי המרווח שלו שוכן עולם קסום מלא בפלאים שיציתו את דמימה וישנו את חייה לנצח.
ההורים של אניה, איריס טובה הלב ואדוארד בעל הזקן, מגישים אותה לפרידה בחיבוקים חמים. "לזכור, יקירתי", לחשה לאמא שלה, "השתמש בקסם שלך בחוכמה ולטוב." אבא שלה הוסיף, "תמיד צריך לחפש ידע ולתת לתיק הגב להיות בן משפחה מהימן".
לאחר שקיבלה מדלג בשלב, אניה יצאה לכיוון בית הספר היחיד בעיר. בדרך היא עברה על החבר הכי טוב שלה, סמואל, ילד סקרן והרפתקאות עם חיוך שובב. "היי, אניה," הוא קרא. "אפשר לראות את תיק הגב שלך?"
אניה היססה לרגע לפני חילצת את הכנף וחשפה את התוכן שלו. עיניו של סמואל נפרצו בתדהמה כשהציץ פנימה. בין העפרונות והמחברת היו חרב מנצנצת, ספר של כשפים עתיקים, מצפן זעיר שתמיד פונה צפונה ומפתח קסום שיכול לפתוח כל מנעול.
ביחד הם התעניינו בפלאים של תיק הגב, והבטחו לשמור על סודותיו. כשהתקרבו לבית הספר, אניה שמה לב לקבוצת ילדים גדולים יותר שמצטרפים יחד, והפנים שלהם נחרטו בפחד. היא ניגשה זהירותי כדי לשפר את הסקרנות.
"מה לא בסדר?" היא שאלה.
ילד גבוה ושנוע צעד קדימה. "יש מפלצת ביער", הוא גממה. "הוא מפחיד בעיר, תוקפים בעלי חיים ואפילו אנשים."
הלב של אניה נשבר. העיירה ווילו קריק הייתה קטנה ושלווה, והמחשבה על מפלצת גרמה לרעד בעמוד השדרה. היא ידעה שהיא צריכה לעשות משהו כדי להגן על המשפחה והחברים שלה.
ללא היסוס של רגע, אניה פתחה את תיק הגב ולקחה את החב המנצנצת. עיניים נוצצות בעיניים, היא פנתה לחבריה המבוהלים. "אל דאגה," היא אמרה, הקול שלה יציב. "אני אטפל בזה".
כששמואל עומד מאחוריה, אניה יצאה למעמקים המוצללים של היער. נראה שהעצים לוחשים סודות כשהיא חולפת, והצמחייה רחשה יצורים בלתי נראים. ככל שהם הלכו עמוק יותר לתוך היער, האוויר הפך לכבד והאדמה שמתחת לכפות הרגליים רעדה.
פתאום הם התפרצו, ולפני מעיניהם הייתה המפלצת – חיה ענקית עם שיניים חדות, עיניים אדומות זוהרות וטפרים שיכולים לרסק בני אדם בקלות. היצור שאג, צליל רועם שרעיד את היער עד לליבו.
הפחד גובר אצל אניה, אבל היא סירבה לתת לו להאכיל אותה. היא משכה את החב מהמעטפת שלה ונכנסה אל המפלצת. הלהב נציץ באור השמש, וכשהימצאו בהסתרה של החיה, התפוצץ אור מסנוור שעטף את כל הזוהר שלו.
כשהאור דעך, המפלצת נעלמה ובמקומה הייתה ערימה של גבישים מנופצים. אניה הביסה את היצור בעזרת הקסם של תיק הגב שלה, והוכיחה שאפילו החפצים הקטנים ביותר יכולים להחזיק בכוחות הגבוהים ביותר.
כשהיא וסמואל חזרו לעיר, הם התקבלו כגיבורים. אנשי ווילו קריק שמחו, והאגדה של אניה, הילדה עם תיק הקסמים, הועברה לדורות הבאים. וכך, אניה המשיכה בהרפתקאותיה ונעזרת בפלאים של תיק הגב כדי להפוך את העולם למקום טוב יותר, צעד אחד אחר קסום.
שימוש בשפה טבעית
מודלים גדולים של שפה הם כלים רבי עוצמה לריבוי משימות. בדרך כלל אפשר לבקש מ-Gemini מה שרוצים, וזה בסדר.
ב-Gemini API אין מצב JSON, לכן יש כמה דברים שחשוב לשים לב אליהם כשיוצרים מבני נתונים באופן הזה:
- לפעמים הניתוח נכשל.
- לא ניתן לאכוף את הסכימה בקפידה.
בקטע הבא תפתרו את הבעיות האלה. קודם כל, נסו הנחיה פשוטה בשפה טבעית שהסכימה כתובה כטקסט. זה לא עבר אופטימיזציה:
model = genai.GenerativeModel(
model_name='models/gemini-1.5-pro-latest')
response = model.generate_content(
textwrap.dedent("""\
Please return JSON describing the the people, places, things and relationships from this story using the following schema:
{"people": list[PERSON], "places":list[PLACE], "things":list[THING], "relationships": list[RELATIONSHIP]}
PERSON = {"name": str, "description": str, "start_place_name": str, "end_place_name": str}
PLACE = {"name": str, "description": str}
THING = {"name": str, "description": str, "start_place_name": str, "end_place_name": str}
RELATIONSHIP = {"person_1_name": str, "person_2_name": str, "relationship": str}
All fields are required.
Important: Only return a single piece of valid JSON text.
Here is the story:
""") + story,
generation_config={'response_mime_type':'application/json'}
)
response.text
'{"people": [\n {\n "name": "Anya",\n "description": "A young girl who lives in the town of Willow Creek with her parents, Elise and Edward. She possesses a magical backpack that was handed down to her from her grandmother.",\n "start_place_name": "Willow Creek",\n "end_place_name": "Willow Creek"\n },\n {\n "name": "Elise",\n "description": "Anya\'s kind-hearted mother",\n "start_place_name": "Willow Creek",\n "end_place_name": "Willow Creek"\n },\n {\n "name": "Edward",\n "description": "Anya\'s wise-bearded father",\n "start_place_name": "Willow Creek",\n "end_place_name": "Willow Creek"\n },\n {\n "name": "Samuel",\n "description": "Anya\'s best friend, a curious and adventurous boy with a mischievous grin.",\n "start_place_name": "Willow Creek",\n "end_place_name": "Willow Creek"\n },\n {\n "name": "Monster",\n "description": "A massive beast with sharp teeth, glowing red eyes, and claws that could crush a human with ease.",\n "start_place_name": "Forest",\n "end_place_name": "Forest"\n }\n], "places": [\n {\n "name": "Willow Creek",\n "description": "A quaint town nestled amidst rolling hills and whispering willows."\n },\n {\n "name": "Forest",\n "description": "A shadowy place with rustling undergrowth and whispering trees."\n },\n {\n "name": "Schoolhouse",\n "description": "The only school in the town of Willow Creek."\n },\n {\n "name": "Anya\'s home",\n "description": "A modest cottage with a creaky wooden door."\n }\n], "things": [\n {\n "name": "Magic backpack",\n "description": "A magical backpack that was handed down to Anya from her grandmother. Its soft, emerald-green fabric shimmered with an ethereal glow, and its leather straps held secrets that only Anya knew.",\n "start_place_name": "Anya\'s home",\n "end_place_name": "Forest"\n },\n {\n "name": "Shimmering sword",\n "description": "A sword that shimmered in the sunlight and could strike with blinding light.",\n "start_place_name": "Magic backpack",\n "end_place_name": "Forest"\n },\n {\n "name": "Book of ancient spells",\n "description": "A book that contained ancient spells.",\n "start_place_name": "Magic backpack",\n "end_place_name": "Forest"\n },\n {\n "name": "Tiny compass",\n "description": "A compass that always pointed north.",\n "start_place_name": "Magic backpack",\n "end_place_name": "Forest"\n },\n {\n "name": "Magical key",\n "description": "A key that could open any lock.",\n "start_place_name": "Magic backpack",\n "end_place_name": "Forest"\n },\n {\n "name": "Shattered crystals",\n "description": "The remains of the monster after it was defeated by Anya\'s magic backpack.",\n "start_place_name": "Forest",\n "end_place_name": "Forest"\n }\n], "relationships": [\n {\n "person_1_name": "Anya",\n "person_2_name": "Elise",\n "relationship": "mother-daughter"\n },\n {\n "person_1_name": "Anya",\n "person_2_name": "Edward",\n "relationship": "father-daughter"\n },\n {\n "person_1_name": "Anya",\n "person_2_name": "Samuel",\n "relationship": "best friends"\n }\n]}'
הפעולה הזו החזירה מחרוזת json. אפשר לנסות לנתח אותו:
import json
print(json.dumps(json.loads(response.text), indent=4))
{ "people": [ { "name": "Anya", "description": "A young girl who lives in the town of Willow Creek with her parents, Elise and Edward. She possesses a magical backpack that was handed down to her from her grandmother.", "start_place_name": "Willow Creek", "end_place_name": "Willow Creek" }, { "name": "Elise", "description": "Anya's kind-hearted mother", "start_place_name": "Willow Creek", "end_place_name": "Willow Creek" }, { "name": "Edward", "description": "Anya's wise-bearded father", "start_place_name": "Willow Creek", "end_place_name": "Willow Creek" }, { "name": "Samuel", "description": "Anya's best friend, a curious and adventurous boy with a mischievous grin.", "start_place_name": "Willow Creek", "end_place_name": "Willow Creek" }, { "name": "Monster", "description": "A massive beast with sharp teeth, glowing red eyes, and claws that could crush a human with ease.", "start_place_name": "Forest", "end_place_name": "Forest" } ], "places": [ { "name": "Willow Creek", "description": "A quaint town nestled amidst rolling hills and whispering willows." }, { "name": "Forest", "description": "A shadowy place with rustling undergrowth and whispering trees." }, { "name": "Schoolhouse", "description": "The only school in the town of Willow Creek." }, { "name": "Anya's home", "description": "A modest cottage with a creaky wooden door." } ], "things": [ { "name": "Magic backpack", "description": "A magical backpack that was handed down to Anya from her grandmother. Its soft, emerald-green fabric shimmered with an ethereal glow, and its leather straps held secrets that only Anya knew.", "start_place_name": "Anya's home", "end_place_name": "Forest" }, { "name": "Shimmering sword", "description": "A sword that shimmered in the sunlight and could strike with blinding light.", "start_place_name": "Magic backpack", "end_place_name": "Forest" }, { "name": "Book of ancient spells", "description": "A book that contained ancient spells.", "start_place_name": "Magic backpack", "end_place_name": "Forest" }, { "name": "Tiny compass", "description": "A compass that always pointed north.", "start_place_name": "Magic backpack", "end_place_name": "Forest" }, { "name": "Magical key", "description": "A key that could open any lock.", "start_place_name": "Magic backpack", "end_place_name": "Forest" }, { "name": "Shattered crystals", "description": "The remains of the monster after it was defeated by Anya's magic backpack.", "start_place_name": "Forest", "end_place_name": "Forest" } ], "relationships": [ { "person_1_name": "Anya", "person_2_name": "Elise", "relationship": "mother-daughter" }, { "person_1_name": "Anya", "person_2_name": "Edward", "relationship": "father-daughter" }, { "person_1_name": "Anya", "person_2_name": "Samuel", "relationship": "best friends" } ] }
זה פשוט יחסית ולרוב עובד, אבל אפשר להפוך אותו לקפדני או חזק יותר על ידי הגדרת הסכימה באמצעות תכונת הקריאה לפונקציה של ה-API.
שימוש בפונקציות קריאה
אם עדיין לא עברתם על המדריך מידע בסיסי על הפעלה של פונקציות, כדאי שתבדקו קודם.
באמצעות פונקציה שמפעילה את הפונקציה והפרמטרים שלה מתוארים ל-API
בתור genai.protos.FunctionDeclaration
. במקרים בסיסיים, ה-SDK יכול ליצור
FunctionDeclaration
מהפונקציה ומההערות שלה. ככה.
בינתיים תצטרכו להגדיר אותם במפורש.
הגדרת הסכימה
בתור התחלה, מגדירים את person
כאובייקט עם שדות מחרוזת name
, description
, start_place_name
, end_place_name
.
person = genai.protos.Schema(
type = genai.protos.Type.OBJECT,
properties = {
'name': genai.protos.Schema(type=genai.protos.Type.STRING),
'description': genai.protos.Schema(type=genai.protos.Type.STRING),
'start_place_name': genai.protos.Schema(type=genai.protos.Type.STRING),
'end_place_name': genai.protos.Schema(type=genai.protos.Type.STRING)
},
required=['name', 'description', 'start_place_name', 'end_place_name']
)
לאחר מכן צריך להגדיר אנשים כ-ARRAY
מתוך person
אובייקטים:
people = genai.protos.Schema(
type=genai.protos.Type.ARRAY,
items=person
)
לאחר מכן חוזרים על הפעולות האלה לכל אחת מהישויות שרוצים לחלץ:
place = genai.protos.Schema(
type = genai.protos.Type.OBJECT,
properties = {
'name': genai.protos.Schema(type=genai.protos.Type.STRING),
'description': genai.protos.Schema(type=genai.protos.Type.STRING),
}
)
places = genai.protos.Schema(
type=genai.protos.Type.ARRAY,
items=place
)
thing = genai.protos.Schema(
type = genai.protos.Type.OBJECT,
properties = {
'name': genai.protos.Schema(type=genai.protos.Type.STRING),
'description': genai.protos.Schema(type=genai.protos.Type.STRING),
}
)
things = genai.protos.Schema(
type=genai.protos.Type.ARRAY,
items=thing
)
relationship = genai.protos.Schema(
type = genai.protos.Type.OBJECT,
properties = {
'person_1_name': genai.protos.Schema(type=genai.protos.Type.STRING),
'person_2_name': genai.protos.Schema(type=genai.protos.Type.STRING),
'relationship': genai.protos.Schema(type=genai.protos.Type.STRING),
}
)
relationships = genai.protos.Schema(
type=genai.protos.Type.ARRAY,
items=relationship
)
עכשיו יוצרים את FunctionDeclaration
:
add_to_database = genai.protos.FunctionDeclaration(
name="add_to_database",
description=textwrap.dedent("""\
Adds entities to the database.
"""),
parameters=genai.protos.Schema(
type=genai.protos.Type.OBJECT,
properties = {
'people': people,
'places': places,
'things': things,
'relationships': relationships
}
)
)
שליחת קריאה ל-API
כמו שראיתם בקטע יסודות הקריאה לפונקציות, עכשיו אפשר להעביר את הפונקציה FunctionDeclaration
הזו לארגומנט tools
של ה-constructor של genai.GenerativeModel
(ה-constructor יקבל גם ייצוג JSON מקביל של הצהרת הפונקציה):
model = genai.GenerativeModel(
model_name='models/gemini-1.5-pro-latest',
tools = [add_to_database])
בכל פעם שתפעילו את ה-API, ה-SDK ישלח את הכלים יחד עם ההנחיה שלכם, והמודל צריך לקרוא לפונקציה שהגדרתם:
result = model.generate_content(f"""
Please add the people, places, things, and relationships from this story to the database:
{story}
""",
# Force a function call
tool_config={'function_calling_config':'ANY'})
עכשיו אין טקסט לניתוח. התוצאה היא מבנה נתונים.
'text' in result.candidates[0].content.parts[0]
False
'function_call' in result.candidates[0].content.parts[0]
True
fc = result.candidates[0].content.parts[0].function_call
print(type(fc))
<class 'google.ai.generativelanguage_v1beta.types.content.FunctionCall'>
המחלקה genai.protos.FunctionCall
מבוססת על מאגרי נתונים זמניים של פרוטוקול Google,
ממירים אותו לאובייקט מוכר יותר שתואם ל-JSON:
print(json.dumps(type(fc).to_dict(fc), indent=4))
{ "name": "add_to_database", "args": { "things": [ { "name": "Magical Backpack", "description": "Anya's prized possession, the Magical Backpack, is no ordinary satchel. Its soft, emerald-green fabric shimmers with an ethereal glow, and its leather straps have secrets that only Anya knows. Within its capacious interior lay an enchanted world, filled with wonders that would ignite her imagination and change her life forever." }, { "name": "Shimmering Sword", "description": "Among the wonders in Anya's Magical Backpack, lies a shimmering sword. With a determined gleam in her eye, she retrieved the shimmering sword and charged towards the monster." }, { "description": "Residing within the Magical Backpack, the Book of Ancient Spells holds secrets untold.", "name": "Book of Ancient Spells" }, { "description": "Tucked away in the Magical Backpack is a tiny compass that always points north.", "name": "Tiny Compass that Always Points North" }, { "description": "Hidden within the Magical Backpack is a magical key that can open any lock.", "name": "Magical Key that Can Open Any Lock" } ], "relationships": [ { "relationship": "Mother-Daughter", "person_1_name": "Anya", "person_2_name": "Elise" }, { "person_2_name": "Edward", "relationship": "Father-Daughter", "person_1_name": "Anya" }, { "person_2_name": "Samuel", "person_1_name": "Anya", "relationship": "Best Friends" } ], "people": [ { "name": "Anya", "description": "Anya, the main character of the story, is a young girl with a magical backpack.", "start_place_name": "Willow Creek", "end_place_name": "Unknown" }, { "name": "Elise", "description": "Anya's mother, Elise is a kind-hearted woman.", "end_place_name": "Unknown", "start_place_name": "Willow Creek" }, { "start_place_name": "Willow Creek", "end_place_name": "Unknown", "name": "Edward", "description": "Anya's father, Edward is a wise-bearded man." }, { "end_place_name": "Unknown", "start_place_name": "Willow Creek", "description": "Anya's best friend, Samuel is a curious and adventurous boy with a mischievous grin.", "name": "Samuel" } ], "places": [ { "description": "The quaint town of Willow Creek is nestled amidst rolling hills and whispering willows.", "name": "Willow Creek" }, { "description": "The town's only schoolhouse.", "name": "Schoolhouse" }, { "description": "A shadowy place filled with secrets and dangers, the Forest is home to a terrifying monster.", "name": "Forest" } ] } }
סיכום
ה-API יכול לטפל בבעיות חילוץ נתונים מובנים באמצעות קלט טקסט ופלט טקסט בלבד, אבל השימוש בקריאה לפונקציות הוא כנראה מהימן יותר, כי הוא מאפשר להגדיר סכימה מחמירה ומבטל שלב ניתוח שעלול להיות מועד לשגיאות.