Knowledge Assist

בדף הזה מופיעה תיעוד ה-API של מודול ממשק המשתמש Generative knowledge assist, שנקרא גם Knowledge Assist V2. המודול הזה משמש נציגים לשאילתות במאגרי הידע של החברה ולקבלת תשובות שמבוססות על AI גנרטיבי.

Usage

מייבאים את המודול לדף ה-HTML באמצעות הקוד הבא:

<script src="https://www.gstatic.com/agent-assist-ui-modules/v2/knowledge_assist.js"></script>

מטמיעים את המודול באמצעות התג הבא:

<agent-assist-knowledge-assist-v2>

מאפיינים

שם המאפיין סוג תגובה
session-id מחרוזת מזהה סשן אופציונלי לשימוש שלא מבוסס על שיחה.
הורה מחרוזת שם המיקום של פרויקט האב שבו יש להשתמש לשימוש שלא מבוסס על שיחה. דוגמה: "projects/foo/locations/global"

Usage

מאפיינים הם מאפייני רכיב מבוססי-מחרוזת שאפשר להגדיר אותם בדרכים הבאות:

ישירות מתבנית ה-HTML:

<element-selector property-name="value">

מתוך קוד ה-JavaScript:

var el = document.querySelector('element-selector');
el.setAttribute('property-name', 'value');

קלט

שם המאפיין סוג תגובה
config KnowledgeAssistV2Config הגדרות אופציונליות למודול Knowledge Assist V2.

Usage

הקלט הוא בדרך כלל אובייקטים של JavaScript או סוגים מורכבים אחרים של מאפיינים שצריך להקצות ישירות למופע של הרכיב:

const el = document.querySelector('element-selector');
el.propertyName = value;

סוגים

בקטע הבא מפורטים הסוגים המותאמים אישית שבהם נעשה שימוש ברכיב.

KnowledgeAssistV2Config

interface KnowledgeAssistV2Config {
  articleLinkConfig: {
    /**
     * Whether to open the article in a new tab, or as a popup. Defaults to new
     * tab.
     */
    target?: "blank" | "popup";
    /**
     * Options to configure the popup's size and location. See
     * https://developer.mozilla.org/en-US/docs/Web/API/Window/open#window_features.
     */
    popupWindowOptions?: string;
    /**
     * The field name on the document metadata if a separate article link source
     * is provided.
     */
    linkMetadataKey?: string;
  };
  showCopyAnswer: boolean;
  showPasteAnswer: boolean;
}