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?'.
pageSize

integer

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

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

הערך המקסימלי הוא 20. ערכים מעל 20 יגרמו לשגיאה INVALID_ARGUMENT.
pageToken

string

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

string

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

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

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

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

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

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

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

דוגמאות:

  • dataSource = "docs.cloud.google.com" OR dataSource = "firebase.google.com"
  • dataSource != "firebase.google.com"
  • updateTime < "2024-01-01T00:00:00Z"
  • updateTime >= "2025-01-22T00:00:00Z" AND (dataSource = "developer.chrome.com" OR dataSource = "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/cloud-platform

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

DocumentChunk

‫DocumentChunk מייצג חלק מהתוכן מתוך Document במאגר המידע DeveloperKnowledge. כדי לאחזר את כל תוכן המסמך, מעבירים את parent אל DeveloperKnowledge.GetDocument או אל DeveloperKnowledge.BatchGetDocuments.

ייצוג JSON 
{
  "parent": string,
  "id": string,
  "content": string,
  "document": {
    object (Document)
  }
}
שדות
parent

string

פלט בלבד. מכיל את שם המשאב של המסמך שממנו נלקח החלק הזה. פורמט: documents/{uri_without_scheme} דוגמה: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

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

string

פלט בלבד. מכיל את התוכן של נתח המסמך.
document

object (Document)

פלט בלבד. מייצג מטא-נתונים לגבי Document שממנו נלקח החלק הזה. הDocumentView של ההודעה הזו בDocument יוגדר כDOCUMENT_VIEW_BASIC. הוא נכלל כאן לנוחותכם, כדי שלקוחות לא יצטרכו להתקשר אל DeveloperKnowledge.GetDocument או אל DeveloperKnowledge.BatchGetDocuments אם הם צריכים רק את שדות המטא-נתונים. אחרת, אפליקציות הלקוח צריכות להשתמש ב-DeveloperKnowledge.GetDocument או ב-DeveloperKnowledge.BatchGetDocuments כדי לאחזר את התוכן המלא של המסמך.