מבצע חיפוש סמנטי ב-Corpus
.
בקשת HTTP
POST https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
name |
חובה. שם ה- |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"query": string,
"metadataFilters": [
{
object ( |
שדות | |
---|---|
query |
חובה. מחרוזת שאילתה לביצוע חיפוש סמנטי. |
metadataFilters[] |
אפשרות. סינון לפי מטא-נתונים מסוג שאילתה לדוגמה ברמת המסמך: (שנה >= 2020 OR שנה < 2010) AND (ז'אנר = דרמה OR ז'אנר = פעולה)
שאילתה לדוגמה ברמת קבוצת הנתונים, עבור טווח מספרי של ערכים: (שנה > 2015 וגם שנה <= 2020)
הערה: תווי AND עבור אותו מקש נתמכים רק עבור ערכים מספריים. ערכי מחרוזת תומכים רק ב-OR (או) לאותו מפתח. |
resultsCount |
אפשרות. המספר המרבי של אם לא צוין, יוחזרו עד 10 ערכי |
גוף התשובה
תשובה מ-corpora.query
שמכילה רשימה של מקטעים רלוונטיים.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{
"relevantChunks": [
{
object ( |
שדות | |
---|---|
relevantChunks[] |
המקטעים הרלוונטיים. |
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:
https://www.googleapis.com/auth/generative-language.retriever
https://www.googleapis.com/auth/generative-language.retriever.readonly
למידע נוסף, קראו את הסקירה הכללית על אימות.