Method: answerQuery

עונה על שאילתה באמצעות יצירה מבוססת-קרקע.

בקשת HTTP

POST https://developerknowledge.googleapis.com/v1alpha:answerQuery

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

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "query": string,
  "filter": string
}
שדות
query

string

חובה. השאילתה שעליה צריך לענות.
filter

string

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

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

  • ‫contentLengthBytes (INTEGER): האורך של השדה Document.content בבייטים.
  • ‫dataSource (STRING): המקור של המסמך, לדוגמה: 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.

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

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

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

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

דוגמאות:

  • סינון לפי Document.content_length_bytes: contentLengthBytes < 50000
  • 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.AnswerQuery.

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

ייצוג ב-JSON 
{
  "answer": {
    object (Answer)
  }
}
שדות
answer

object (Answer)

התשובה לשאילתה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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.

תשובה

תשובה לשאילתה.

ייצוג ב-JSON 
{
  "answerText": string,
  "citations": [
    {
      object (AnswerCitation)
    }
  ],
  "references": [
    {
      object (AnswerReference)
    }
  ]
}
שדות
answerText

string

מכיל את הטקסט של התשובה.
citations[]

object (AnswerCitation)

פלט בלבד. כוללת ציטוטים לתשובה.
references[]

object (AnswerReference)

פלט בלבד. מכיל הפניות לתשובה.

AnswerCitation

פרטי ציטוט של פלח.

ייצוג ב-JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
שדות
startIndex

integer

פלט בלבד. מציין את תחילת הקטע, שנמדד בבייטים (Unicode בקידוד UTF-8), כולל. אם יש תווים מרובי-בייטים, כמו תווים שאינם ASCII, מדידת האינדקס ארוכה יותר מאורך המחרוזת.
endIndex

integer

פלט בלבד. מציין את סוף הפלח, שנמדד בבייטים (Unicode בקידוד UTF-8), לא כולל. אם יש תווים מרובי-בייטים, כמו תווים שאינם ASCII, מדידת האינדקס ארוכה יותר מאורך המחרוזת.
sources[]

object (CitationSource)

פלט בלבד. מכיל את מקורות הציטוטים של הפלח המשויך.

CitationSource

מקור הציטוט.

ייצוג ב-JSON 
{
  "referenceIndex": integer
}
שדות
referenceIndex

integer

פלט בלבד. מכיל את האינדקס של Answer.AnswerReference בשדה החוזר references.

AnswerReference

מייצג הפניה למקור.

ייצוג ב-JSON 
{

  // Union field content can be only one of the following:
  "documentReference": {
    object (DocumentReference)
  }
  // End of list of possible types for union field content.
}
שדות
שדה איחוד content. מכיל את התוכן של ההפניה. הערך content יכול להיות רק אחד מהבאים:
documentReference

object (DocumentReference)

פלט בלבד. מסמך העזר.

DocumentReference

מייצג הפניה למסמך.

ייצוג ב-JSON 
{
  "documentChunk": {
    object (DocumentChunk)
  }
}
שדות
documentChunk

object (DocumentChunk)

פלט בלבד. מכיל את נתח המסמך. השדה documentChunk.id לא מוגדר ויהיה ריק.