Method: documents.searchDocumentChunks

חיפוש ידע למפתחים במסמכי התיעוד למפתחים של Google. מחזירה DocumentChunks על סמך השאילתה של המשתמש. יכול להיות שיש הרבה קטעים מאותו Document. כדי לאחזר מסמכים מלאים, משתמשים ב-DeveloperKnowledge.GetDocument או ב-DeveloperKnowledge.BatchGetDocuments עם DocumentChunk.parent שמוחזר ב-SearchDocumentChunksResponse.results.

בקשת HTTP

GET https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של שאילתה

פרמטרים
query

string

חובה. המחרוזת של השאילתה הגולמית שסופקה על ידי המשתמש, למשל 'איך יוצרים קטגוריה של Cloud Storage?'. אורך השאילתה לא יכול לחרוג מ-500 תווים. אם הערכים ארוכים מ-500 תווים, תוצג שגיאה INVALID_ARGUMENT.
pageSize

integer

אופציונלי. מציין את המספר המקסימלי של התוצאות שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה.

אם לא מציינים ערך, יוחזרו לכל היותר 5 תוצאות.

הערך המקסימלי הוא 100. ערכים גבוהים יותר יומרו ל-100.
pageToken

string

אופציונלי. מכיל טוקן של דף שהתקבל מקריאה קודמת של documents.searchDocumentChunks. צריך להזין את הטוקן כדי לאחזר את הדף הבא.
filter

string

אופציונלי. החלת מסנן מחמיר על תוצאות החיפוש. הביטוי תומך בחלק מהתחביר שמתואר בכתובת https://google.aip.dev/160.

הפונקציה documents.searchDocumentChunks מחזירה DocumentChunk, אבל המסנן מוחל על השדות DocumentChunk.document.

שדות נתמכים לסינון:

  • ‫content_length_bytes (INTEGER): האורך של השדה Document.content בבייטים.
  • ‫data_source (STRING): המקור של המסמך, לדוגמה: docs.cloud.google.com. הרשימה המלאה של מקורות הנתונים בקורפוס זמינה בכתובת https://developers.google.com/knowledge/reference/corpus-reference.
  • ‫update_time (TIMESTAMP): חותמת הזמן של העדכון המשמעותי האחרון במסמך. עדכון משמעותי הוא עדכון שמשנה את תוכן ה-Markdown או את המטא-נתונים של המסמך.
  • ‫uri (מחרוזת): ה-URI של המסמך, לדוגמה: https://docs.cloud.google.com/bigquery/docs/tables.

השדות INTEGER תומכים באופרטורים =,‏ <,‏ <=,‏ > ו->=.

שדות STRING תומכים באופרטורים = (שווה) ו-!= (לא שווה) להתאמה מדויקת של המחרוזת כולה. אין תמיכה בהתאמה חלקית, בהתאמה של קידומת ובהתאמה לביטוי רגולרי.

השדות TIMESTAMP תומכים באופרטורים =,‏ <,‏ <=,‏ > ו->=. חותמות הזמן צריכות להיות בפורמט RFC-3339, לדוגמה: "2025-01-01T00:00:00Z".

הערה: שמות השדות צריכים להיות בפורמט snake_case (למשל, data_source). הערכים בצד שמאל של ביטויי הסינון צריכים להיות מחרוזות מילוליות שמוקפות במירכאות כפולות (למשל, "docs.cloud.google.com").

אפשר לשלב בין ביטויים באמצעות האופרטורים הלוגיים AND, OR ו-NOT (או -). ל-OR יש עדיפות גבוהה יותר מאשר ל-AND. משתמשים בסוגריים כדי לקבץ ביטויים לפי סדר עדיפות.

דוגמאות:

  • סינון לפי Document.content_length_bytes: content_length_bytes < 50000
  • data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"
  • data_source != "firebase.google.com"
  • update_time < "2024-01-01T00:00:00Z"
  • update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

המחרוזת filter לא יכולה להיות ארוכה מ-500 תווים. אם הערכים ארוכים מ-500 תווים, תוצג שגיאה INVALID_ARGUMENT.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

הודעת תגובה ל-DeveloperKnowledge.SearchDocumentChunks.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "results": [
    {
      object (DocumentChunk)
    }
  ],
  "nextPageToken": string
}
שדות
results[]

object (DocumentChunk)

מכיל את תוצאות החיפוש של השאילתה שצוינה. כל DocumentChunk ברשימה הזו מכיל קטע תוכן שרלוונטי לשאילתת החיפוש. משתמשים בשדה DocumentChunk.parent של כל תוצאה עם DeveloperKnowledge.GetDocument או DeveloperKnowledge.BatchGetDocuments כדי לאחזר את התוכן המלא של המסמך.
nextPageToken

string

התגובה כוללת טוקן שאפשר לשלוח כ-pageToken כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.