חיפוש במסמכים של מאגר נתונים אחד.
הפונקציה מחזירה קטעים מדורגים של מסמכי משנה, שכל אחד מהם מפנה למסמך שממנו הוא הגיע וכולל את המקור שנדרש כדי לצטט אותו.
בקשת HTTP
POST https://vectorsearch.googleapis.com/v1beta/{parent}/documents:search
פרמטרים של הנתיב
| פרמטרים | |
|---|---|
parent |
חובה. ה-DataStore שבו רוצים לחפש. פורמט: |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
|---|
{ "topK": integer, "documentIds": [ string ], "rankingSpec": { object ( |
| שדות | |
|---|---|
topK |
זה שינוי אופציונלי. מספר התוצאות שיוצגו. ברירת המחדל היא 10. ערכים גבוהים יותר יומרו ל-100. |
documentIds[] |
זה שינוי אופציונלי. הגבלת החיפוש למזהי המסמכים האלה. מקסימום 100. אם הוא ריק, החיפוש יתבצע בכל מאגר הנתונים. |
rankingSpec |
זה שינוי אופציונלי. קובע את דירוג התוצאות. |
filter |
זה שינוי אופציונלי. החיפוש מוגבל לפלחים שתואמים למסנן הזה, אובייקט JSON בנתיבי השדות של
השוואות: {"$and": [{"metadata.year": {"$gte": 2025}}, {"unstructured_details.page_range.start_page": {"$lte": 20}}]} |
outputFields |
זה שינוי אופציונלי. השדות שיוחזרו בכל תוצאה. |
| חובה. השאילתה לחיפוש. צריך להגדיר סוג שאילתה אחד בדיוק. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
textQuery |
שאילתת טקסט. |
| סוף השדות שמוציאים זה את זה. | |
גוף התשובה
הודעת התשובה של DocumentSearchService.SearchDocuments.
אם הפעולה מצליחה, גוף התשובה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
|---|
{ "results": [ { object ( |
| שדות | |
|---|---|
results[] |
פלט בלבד. הקטעים במסמך שתואמים לקריטריונים של החיפוש, מסודרים לפי רלוונטיות. |
warnings[] |
פלט בלבד. אזהרות או שגיאות לא קריטיות שהתרחשו במהלך הביצוע. |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/vectorsearchhttps://www.googleapis.com/auth/vectorsearch.readonly
ניתן למצוא מידע נוסף כאן: Authentication Overview.
TextQuery
שאילתת טקסט.
| ייצוג ב-JSON |
|---|
{ "text": string } |
| שדות | |
|---|---|
text |
חובה. הטקסט שאותו מחפשים. |
RankingSpec
קובע את דירוג התוצאות.
| ייצוג ב-JSON |
|---|
{
"rerankingSpec": {
object ( |
| שדות | |
|---|---|
rerankingSpec |
זה שינוי אופציונלי. שולטת בשלב הדירוג מחדש. |
RerankingSpec
הגדרת הדירוג הסמנטי החוזר שמוחל על תוצאות מועמדות אחרי אחזור היברידי ו-Reciprocal Rank Fusion (RRF).
| ייצוג ב-JSON |
|---|
{ "enabled": boolean, "rankOversamplingFactor": integer } |
| שדות | |
|---|---|
enabled |
זה שינוי אופציונלי. אם לדרג מחדש את התוצאות הממוזגות. ברירת המחדל היא False: התוצאות מוחזרות בסדר של מיזוג RRF, אלא אם המתקשר מביע הסכמה. כשהאפשרות הזו מופעלת, הדירוג מחדש משתמש ב- אין תמיכה ב-DataStore מסוג |
rankOversamplingFactor |
זה שינוי אופציונלי. הגורם שלפיו מתבצעת דגימת יתר של המועמדים לפני הדירוג מחדש. המספר הכולל של המועמדים שאוחזרו לדירוג מחדש הוא המערכת מתעלמת מהמאפיין הזה, אלא אם הערך של כדי לדרג מחדש בלי דגימת יתר, מגדירים את השדה הזה ל-1. |
OutputFields
השדות שיוחזרו בכל DocumentSearchResult, מעבר לשדות שכל תוצאה כוללת.
| ייצוג ב-JSON |
|---|
{ "metadata": [ string ] } |
| שדות | |
|---|---|
metadata[] |
זה שינוי אופציונלי. מאפייני מטא-נתונים שיוחזרו ב- |
DocumentSearchResult
קטע תואם אחד במסמך.
| ייצוג ב-JSON |
|---|
{ "document": { object ( |
| שדות | |
|---|---|
document |
פלט בלבד. המסמך שממנו הגיע הפלח, כולל שם המשאב והמיקום ב-Cloud Storage שממנו הוא הועבר. שימו לב שלא כל השדות של המסמך מאוכלסים. כדי לקבל את המסמך המלא, צריך להפעיל את documents.get בשם המסמך שהוחזר. |
פרטים על המיקום של הקטע במסמך. השדה שמוגדר תלוי ב-document_type של מאגר הנתונים הראשי. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: |
|
videoDetails |
מוגדר כאשר |
unstructuredDetails |
מוגדר כאשר |
| סוף השדות שמוציאים זה את זה. | |
VideoSegmentDetails
מאתר קטע במסמך וידאו.
| ייצוג ב-JSON |
|---|
{ "startOffset": string, "endOffset": string } |
| שדות | |
|---|---|
startOffset |
פלט בלבד. איפה הקטע הזה מתחיל, ביחס לתחילת סרטון המקור. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-" |
endOffset |
פלט בלבד. איפה הקטע הזה מסתיים, ביחס להתחלה של סרטון המקור. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-" |
UnstructuredSegmentDetails
מאתר קטע במסמך לא מובנה ומעביר את הטקסט שלו.
| ייצוג ב-JSON |
|---|
{
"contentSnippet": string,
"pageRange": {
object ( |
| שדות | |
|---|---|
contentSnippet |
פלט בלבד. תוכן הטקסט של הקטע. |
pageRange |
פלט בלבד. המיקום של הקטע במסמך המקור. ההגדרה הזו מיועדת לקובצי PDF, PowerPoint ו-Excel, שבהם דף הוא דף PDF, שקף או גיליון. בקובצי HTML, טקסט פשוט, Markdown, JSON, XML ו-Word, צריך להגדיר את זה רק כשהקובץ מפוצל לדפים ( |
PageRange
טווח דפים במסמך המקור. הדפים מבוססים על 1 והטווח כולל. דף בודד מיוצג בתור startPage == endPage.
| ייצוג ב-JSON |
|---|
{ "startPage": string, "endPage": string } |
| שדות | |
|---|---|
startPage |
פלט בלבד. הדף הראשון בטווח. |
endPage |
פלט בלבד. הדף האחרון בטווח. |