הערה: התיעוד הזה רלוונטי למהדורות Standard,‏ Plus ו-Frontline של Gemini Enterprise. מידע על מהדורת Business זמין במרכז העזרה של Gemini Enterprise – מהדורת Business.

Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

קבלת תוצאות חיפוש (גרסה קודמת)

בדף הזה מוסבר איך מקבלים תוצאות חיפוש באמצעות ה-API.

אתם יכולים לבצע קריאות ל-API ולשלב את הקריאות האלה בשרת או באפליקציה שלכם. בדף הזה יש דוגמאות קוד שמראות איך לבצע שאילתות חיפוש באמצעות ספריות הלקוח של gRPC עם חשבון שירות.

קבלת תוצאות חיפוש

אפשר לקבל תוצאות חיפוש באמצעות ה-API.

REST

כדי להשתמש ב-API כדי לקבל תוצאות חיפוש של אפליקציה עם נתונים מובנים או לא מובנים, משתמשים ב-method‏ engines.servingConfigs.search:

הערה: אפשר לחפש באפליקציה באמצעות השיטה engines.servingConfigs.search, ואפשר לחפש במאגר נתונים באמצעות השיטה dataStores.servingConfigs.search. לפרוצדורה הבאה, Google ממליצה לחפש באמצעות engines.servingConfigs.search.

מוצאים את מזהה האפליקציה. אם כבר יש לכם מזהה אפליקציה, דלגו לשלב הבא.
1. נכנסים לדף Gemini Enterprise במסוף Google Cloud .
  
  מעבר אל 'אפליקציות'
2. בדף אפליקציות, מאתרים את שם האפליקציה ומעתיקים את המזהה שלה מהעמודה מזהה.
תצוגה מקדימה של תוצאות החיפוש.

מונח חשוב: ב-Gemini Enterprise, המונח אפליקציה יכול לשמש לחלופין למונח מנוע בהקשר של ממשקי API. מנוע Gemini Enterprise הוא מנוע חיפוש כללי שבו השדה app_type מוגדר ל-APP_TYPE_INTRANET.
```
curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search:search" \
-d '{
"query": "QUERY",
"userPseudoId": "USER_PSEUDO_ID",
"pageSize": "PAGE_SIZE",
"offset": "OFFSET",
"orderBy": "ORDER_BY",
"filter": "FILTER",
"boostSpec": "BOOST_SPEC",
"facetSpec": "FACET_SPEC",
"queryExpansionSpec": "QUERY_EXPANSION_SPEC",
"spellCorrectionSpec": "SPELL_CORRECTION_SPEC",
"contentSearchSpec": "CONTENT_SEARCH_SPEC",
"dataStoreSpecs": [{"DATA_STORE_SPEC"}],
}'
```
מחליפים את מה שכתוב בשדות הבאים:
- ‫PROJECT_ID: מזהה הפרויקט.
- ‫APP_ID: המזהה של האפליקציה שרוצים לשלוח אליה שאילתה.
- ‫QUERY: טקסט השאילתה לחיפוש.
- ‫USER_PSEUDO_ID: מחרוזת בקידוד UTF-8, שמשמשת כמזהה ייחודי עם פסאודונימיזציה למעקב אחרי המשתמשים. האורך המקסימלי הוא 128 תווים. ‫Google ממליצה בחום להשתמש בשדה הזה כי הוא משפר את ביצועי המודל ואת איכות ההתאמה האישית. אפשר להשתמש בקובץ Cookie של HTTP בשדה הזה, כדי לזהות באופן ייחודי מבקר במכשיר יחיד. ריכזנו כאן כמה דברים חשובים שכדאי לזכור:
  - המזהה הזה לא משתנה כשהמבקר נכנס לאתר או יוצא ממנו.
  - אסור להגדיר את אותו מזהה למספר משתמשים. במקרים אחרים, שימוש באותו מזהה משתמש לכמה משתמשים עלול לגרום לשילוב של היסטוריית האירועים של משתמשים שונים ולהפחית את איכות המודל.
  - השדה הזה לא יכול לכלול פרטים אישיים מזהים (PII).
  - עבור בקשת חיפוש או בקשת עיון נתונה, השדה הזה צריך להיות ממופה לשדה userPseudoId המתאים באירועי המשתמש.
  מידע נוסף זמין במאמר userPseudoId.
- ‫PAGE_SIZE: מספר התוצאות שמוחזרות מהחיפוש. הגודל המקסימלי המותר של הדף תלוי בסוג הנתונים. אם גודל הדף גדול מהערך המקסימלי, הוא ישתנה לערך המקסימלי.
- ‫OFFSET: אופציונלי. האינדקס ההתחלתי של התוצאות. ערך ברירת המחדל הוא 0.
  
  לדוגמה, אם ההיסט הוא 2, גודל הדף הוא 10 ויש 15 תוצאות להחזרה, התוצאות 2 עד 11 מוחזרות בדף הראשון.
- ‫ORDER_BY: אופציונלי. הסדר שבו התוצאות מסודרות.
- ‫FILTER: אופציונלי. שדה טקסט לסינון החיפוש באמצעות ביטוי סינון. ערך ברירת המחדל הוא מחרוזת ריקה, כלומר לא מוחל מסנן.
  
  לדוגמה: color: ANY("red", "blue") AND score: IN(*, 100.0e)
  
  מידע נוסף זמין במאמר בנושא סינון חיפוש של נתונים מובְנים או לא מובְנים.
- ‫BOOST_SPEC: אופציונלי. מפרט להדגשה או להסתרת מסמכים. ערכים:
  - ‫BOOST: מספר בשיטת נקודה צפה בטווח [‎-1,1]. אם הערך שלילי, התוצאות יורדות בדירוג (הן יופיעו בחלק התחתון של התוצאות). אם הערך חיובי, התוצאות מקודמות (מופיעות גבוה יותר בתוצאות).
  - ‫CONDITION: a ביטוי סינון טקסט לבחירת המסמכים שעליהם יוחל ה-boost. המסנן צריך להחזיר ערך בוליאני.
  מידע על שיפור תוצאות חיפוש מובנה זמין במאמר שיפור תוצאות חיפוש.
- ‫FACET_SPEC: אופציונלי. מפרט של היבט לביצוע חיפוש עם היבטים.
- ‫QUERY_EXPANSION_SPEC: אופציונלי. הגדרה לקביעה של התנאים שבהם יתבצע הרחבת שאילתה. ערך ברירת המחדל הוא DISABLED.
- ‫SPELL_CORRECTION_SPEC: אופציונלי. מפרט לקביעה של התנאים שבהם צריך לבצע תיקון שגיאות כתיב. ערך ברירת המחדל הוא AUTO.
- ‫CONTENT_SEARCH_SPEC: אופציונלי. לקבלת תקצירים, תשובות, פלחים וסיכומים מחיפוש. לנתונים לא מובנים בלבד. למידע נוסף:
  - שימוש בתקצירים ובתוכן שחולץ
  - קבלת סיכומים של חיפושים
- ‫DATA_STORE_SPEC: מסננים של מאגר נתונים ספציפי לחיפוש. אפשר להשתמש בזה אם אפליקציית החיפוש שלכם מקושרת לכמה מאגרי נתונים. מידע נוסף זמין במאמר בנושא DataStoreSpec.
- צפייה בתוצאות חיפוש מודרך בתגובה לחיפוש:
  
  תוצאות חיפוש מודרכות מוחזרות עם תשובות לחיפושים מובנים ולא מובנים. תוצאת החיפוש המודרך מכילה רשימה של צמדי מפתח/ערך של מאפיינים שחולצו על סמך מסמכי תוצאות החיפוש. כך המשתמשים יכולים לשפר את תוצאות החיפוש שלהם באמצעות מפתחות וערכים של מאפיינים כמסננים.
  
  בדוגמה הזו לתגובה, הצבע הירוק שימש לסינון תוצאות החיפוש על ידי שליחת בקשת חיפוש חדשה עם שדה הסינון שצוין כ-_gs.color: ANY("green"):
```
{
"guidedSearchResult": {
  "refinementAttributes": [
    {
      "attributeKey": "_gs.color",
      "attributeValue": "green"
    },
    {
      "attributeKey": "_gs.category",
      "attributeValue": "shoe"
    }
  ]
}
}
```

קבלת ציוני רלוונטיות של מסמכים בתוצאות החיפוש

הציונים של רלוונטיות המסמך מבוססים על הדמיון בין השאילתה לבין המסמך. הציונים מחולקים ל-11 קטגוריות בטווח: 0, 0.1, 0.2 ועד 1.0. ככל שהציון גבוה יותר, כך המסמך רלוונטי יותר.

כדאי להשתמש בציוני הרלוונטיות של המסמכים בתרחישי השימוש הבאים:

סינון אחרי החיפוש על סמך ציון הרלוונטיות כדי להסיר תוצאות לא רלוונטיות
דירוג אחרי החיפוש או כקלט לאפליקציות אחרות
ניפוי באגים: ציוני הרלוונטיות יכולים לספק תובנות לגבי הסיבות להחזרת תוצאות חיפוש מסוימות

לכל תוצאת חיפוש אפשר להחזיר ציון רלוונטיות:

  "results": [
    {
      "id": "DOCUMENT_ID",
      "document": {
      ...
      },
      "modelScores": {
        "relevance_score": {
          "values": [
            DOCUMENT-RELEVANCE-SCORE
          ]
        }
      }
    },
    ...

אפשר גם לעיין בדוגמה לפקודה שמופיעה בהמשך.

לפני שמתחילים: מוודאים שאפליקציית החיפוש משויכת למאגר נתונים מובְנים או לא מובְנים.

REST

כדי לבקש שציוני הרלוונטיות של המסמכים יוחזרו עם תוצאות החיפוש, משתמשים בשיטה engines.servingConfigs.search באופן הבא:

מוצאים את מזהה האפליקציה. אם כבר יש לכם מזהה אפליקציה, דלגו לשלב הבא.
1. נכנסים לדף Gemini Enterprise במסוף Google Cloud .
  
  מעבר אל 'אפליקציות'
2. בדף אפליקציות, מאתרים את שם האפליקציה ומעתיקים את המזהה שלה מהעמודה מזהה.

מריצים את פקודת ה-Curl הבאה כדי לקבל את הציונים שמוחזרים עם תוצאות החיפוש.

curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search:search" \
-d '{
     "servingConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search",
     "query": "QUERY",
     "relevanceScoreSpec": {
       "returnRelevanceScore": true
     }
}'

‫PROJECT_ID: מזהה הפרויקט.
‫APP_ID: המזהה של האפליקציה שרוצים לשלוח אליה שאילתה.
‫QUERY: טקסט השאילתה לחיפוש.

דוגמה לפקודה ולתוצאה חלקית

curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/servingConfigs/default_search:search" \
-d '{
      "servingConfig": "projects/my-project-123/locations/global/collections/default_collection/engines/my-app/servingConfigs/default_search",
      "query": "When was Verily founded and what is its mission?",
      "relevanceScoreSpec": {
        "returnRelevanceScore": true
      }
}'

{
  "results": [
    {
      "id": "f1b0d98bd2a078a6dfb4f809c3028565",
      "document": {
        "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/f1b0d98bd2a078a6dfb4f809c3028565",
        "id": "f1b0d98bd2a078a6dfb4f809c3028565",
        "derivedStructData": {
          "link": "gs://cloud-samples-data/gen-app-builder/search/alphabet-investor-pdfs/2019_alphabet_annual_report.pdf",
          "extractive_answers": [
            {
              "pageNumber": "70",
              "content": "VERILY Verily is a life science and healthcare company with a mission to make the world's health data useful so that people enjoy healthier lives. In December 2018, Verily received $900 million in cash from a $1.0 billion investment round. The remaining $100 million was received in the first quarter of 2019."
            }
          ],
          "title": "2019_alphabet_annual_report"
        }
      },
      "modelScores": {
        "relevance_score": {
          "values": [
            0.7
          ]
        }
      }
    },
    {
      "id": "0371b29bfa18ac43896b86a7b63d00b0",
      "document": {
        "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/0371b29bfa18ac43896b86a7b63d00b0",
        "id": "0371b29bfa18ac43896b86a7b63d00b0",
        "derivedStructData": {
          "link": "gs://cloud-samples-data/gen-app-builder/search/alphabet-investor-pdfs/20190429_alphabet_10Q.pdf",
          "title": "GOOG 10-Q Q1 2019",
          "extractive_answers": [
            {
              "content": "Verily Verily is a life science company with a mission to make the world's health data useful so that people enjoy healthier lives. In December 2018, Verily received $900 million in cash from a $1.0 billion investment round. The remaining $100 million was received in the first quarter of 2019.",
              "pageNumber": "21"
            }
          ]
        }
      },
     "modelScores": {
        "relevance_score": {
          "values": [
            0.5
          ]
        }
      }
    },
    ...
    {
      "id": "e6bbd0d82dc2a2fc7ccf1bd82ac6334f",
      "document": {
        "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/e6bbd0d82dc2a2fc7ccf1bd82ac6334f",
        "id": "e6bbd0d82dc2a2fc7ccf1bd82ac6334f",
        "derivedStructData": {
          "title": "2021_Q1_Earnings_Transcript",
          "link": "gs://cloud-samples-data/gen-app-builder/search/alphabet-investor-pdfs/2021_Q1_Earnings_Transcript.pdf",
          "extractive_answers": [
            {
              "pageNumber": "2",
              "content": "Our strength in AI and ML is also helping Financial Services customers improve efficiency of payments, reduce fraud and risk, and deliver faster payment solutions."
            }
          ]
        }
      },
      "modelScores": {
        "relevance_score": {
          "values": [
            0
          ]
        }
      }
    }
  ],
  "totalSize": 76,
  "attributionToken": "8QHw8AoLCIW4_b0GELHd3lgSJDY3YmU1ZGMwLTAwMDAtMmM1OC04NzcyLTc0NzQ0NjNiOGMyNSIHR0VORVJJQyqcAcb77TDHy_MX8tntMI6-nRWK4uQwwvCeFYX77TDvifIwq8SKLauR3zCq-LMt0IrIMNSynRWc1rctv_7kML7l3zDZveQwkPeyMMP77TD12e0wpd_hMIfi5DCRv9owgvvtMJWSxTCOkckwu-XfMK7Eii3sifIwqJHfMKjf4TCt-LMtlL_aMJ_Wty23t4wto4CXIs2KyDDcveQwwv7kMDABShIweDU3MGFkYWI4MzQ4NmY0MGE",
  "nextPageToken": "UjMjhjYzYDN0cDN30iM3cDOtgTNjJTLwADMw0iZiRWNlJ2N2QiGBUd0gWLEG4bjhWICMIBM1IgC",
  "summary": {},
  "queryExpansionInfo": {}
}

הסיכום של החיפוש משתנה בהתאם למודל

אם אתם יוצרים סיכומים של שאילתות החיפוש, יכול להיות שתשימו לב שהסיכומים שונים בתוצאות במסוף ובתוצאות ב-API. אם אתם רואים את ההודעה הזו, סביר להניח שהסיבה לכך היא שהמסוף משתמש במודל LLM שונה מה-API. בדוגמאות הקוד ובדוגמאות של curl שבדף הזה נעשה שימוש במודל LLM יציב.

כדי לשנות או להציג את מודל ה-LLM שבו נעשה שימוש בדף Preview בממשק המשתמש, עוברים לדף Configurations > הכרטיסייה UI של האפליקציה.
במקרה של קריאות לשיטות, מודל ברירת המחדל הוא המודל היציב. כדי להשתמש במודל LLM שאינו המודל היציב, אפשר לעיין במאמרים ציון מודל הסיכום וציון מודל התשובה.

קבלת תוצאות חיפוש (גרסה קודמת) קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

קבלת תוצאות חיפוש

REST

קבלת ציוני רלוונטיות של מסמכים בתוצאות החיפוש

REST

דוגמה לפקודה ולתוצאה חלקית

הסיכום של החיפוש משתנה בהתאם למודל

קבלת תוצאות חיפוש (גרסה קודמת)