Method: projects.locations.collections.engines.servingConfigs.streamAnswer

שיטת מענה לשאילתה (סטרימינג).

היא מקבלת AnswerQueryRequest אחד ומחזירה כמה הודעות AnswerQueryResponse בזרם.

בקשת HTTP


POST https://discoveryengine.googleapis.com/v1beta/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:streamAnswer

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

פרמטרים של נתיב

פרמטרים
servingConfig

string

חובה. שם המשאב של הגדרת ההצגה servingConfigs.search, כמו projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config או projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config.

או שם המשאב של הגדרת התצורה של מנוע הסוכן שמשרת את התצורה, כמו: projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer. (לשימוש כש-enableAgentInvocation מוגדר כ-True, ומוגדר מנוע סוכן מותאם אישית של AI_MODE)

השדה הזה משמש לזיהוי השם של הגדרת ההצגה, כלומר קבוצת המודלים שמשמשים לביצוע החיפוש.

גוף הבקשה

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

ייצוג ב-JSON 
{
  "query": {
    object (Query)
  },
  "session": string,
  "safetySpec": {
    object (SafetySpec)
  },
  "relatedQuestionsSpec": {
    object (RelatedQuestionsSpec)
  },
  "groundingSpec": {
    object (GroundingSpec)
  },
  "answerGenerationSpec": {
    object (AnswerGenerationSpec)
  },
  "searchSpec": {
    object (SearchSpec)
  },
  "queryUnderstandingSpec": {
    object (QueryUnderstandingSpec)
  },
  "asynchronousMode": boolean,
  "userPseudoId": string,
  "userLabels": {
    string: string,
    ...
  },
  "endUserSpec": {
    object (EndUserSpec)
  }
}
שדות
query

object (Query)

חובה. שאילתת המשתמש הנוכחי.
session

string

שם המשאב של הסשן. לא נדרשת.

אם לא מגדירים את שדה הסשן, ה-API פועל במצב ללא סשן.

אנחנו תומכים במצב סשן אוטומטי: משתמשים יכולים להשתמש בתו הכללי - כמזהה סשן. מזהה חדש ייווצר ויוקצה באופן אוטומטי.
safetySpec

object (SafetySpec)

מפרט המודל.
relatedQuestionsSpec

object (RelatedQuestionsSpec)

מפרט של שאלות קשורות.
groundingSpec

object (GroundingSpec)

זה שינוי אופציונלי. מפרט העיגון.
answerGenerationSpec

object (AnswerGenerationSpec)

מפרט ליצירת תשובות.
searchSpec

object (SearchSpec)

מפרט של servingConfigs.search.
queryUnderstandingSpec

object (QueryUnderstandingSpec)

מפרט להבנת שאילתות.
asynchronousMode
(deprecated)

boolean

הוצא משימוש: השדה הזה הוצא משימוש. תהיה תמיכה ב-Streaming Answer API.

שליטה במצב אסינכרוני.

אם האפשרות הזו מופעלת, התשובה תוחזר עם שם המשאב של התשובה או הסשן, בלי התשובה הסופית. משתמשי ה-API צריכים לבצע את הבדיקה כדי לקבל את הסטטוס העדכני של התשובה או הסשן באמצעות קריאה ל-method‏ ConversationalSearchService.GetAnswer או ConversationalSearchService.GetSession.
userPseudoId

string

מזהה ייחודי למעקב אחרי מבקרים. לדוגמה, אפשר להטמיע את זה באמצעות קובץ Cookie של HTTP, שאמור לזהות באופן ייחודי מבקר במכשיר יחיד. המזהה הייחודי הזה לא אמור להשתנות אם המבקר מתחבר לאתר או יוצא ממנו.

בשדה הזה לא יכול להיות ערך קבוע כמו unknown_visitor.

השדה חייב להיות מחרוזת בקידוד UTF-8, עם מגבלת אורך של 128 תווים. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.
userLabels

map (key: string, value: string)

התוויות של המשתמש שמוחלות על משאב צריכות לעמוד בדרישות הבאות:

  • לכל משאב יכולות להיות כמה תוויות, עד 64 לכל היותר.
  • כל תווית חייבת להיות צמד מפתח/ערך.
  • האורך המינימלי של המפתחות הוא תו אחד, והאורך המקסימלי הוא 63 תווים. המפתחות לא יכולים להיות ריקים. הערכים יכולים להיות ריקים, והאורך המקסימלי שלהם הוא 63 תווים.
  • המפתחות והערכים יכולים להכיל רק אותיות קטנות, ספרות, קווים תחתונים ומקפים. כל התווים צריכים להיות בקידוד UTF-8, ואפשר להשתמש בתווים בינלאומיים.
  • החלק של המפתח בתווית חייב להיות ייחודי. עם זאת, אפשר להשתמש באותו מפתח עם כמה משאבים.
  • המפתחות צריכים להתחיל באות קטנה או בתו בינלאומי.

פרטים נוספים מופיעים במאמר Google Cloud Document.
endUserSpec

object (EndUserSpec)

זה שינוי אופציונלי. מפרט משתמש הקצה.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל זרם של מופעי AnswerQueryResponse.

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

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

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב servingConfig:

  • discoveryengine.servingConfigs.answer

מידע נוסף מופיע במאמרי העזרה בנושא IAM.