Stay organized with collections
Save and categorize content based on your preferences.
This page contains the API documentation for the Knowledge Assist UI module. This module is used to show helpful articles and FAQ suggestions to agents during the course of a conversation.
Usage
Import the module in your HTML page using the following code:
See the following section for the custom types used by the component.
KnowledgeAssistConfig
interfaceKnowledgeAssistConfig{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;};}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[[["\u003cp\u003eThis page documents the API for the Knowledge Assist UI module, which provides agents with article and FAQ suggestions during conversations.\u003c/p\u003e\n"],["\u003cp\u003eThe module can be imported into an HTML page using a specific script tag and embedded using the \u003ccode\u003e<agent-assist-knowledge-assist>\u003c/code\u003e tag.\u003c/p\u003e\n"],["\u003cp\u003eThe module's behavior can be customized through attributes like \u003ccode\u003efeatures\u003c/code\u003e, which is a comma-separated string specifying the desired features (ARTICLE_SUGGESTION, FAQ, and ARTICLE_SEARCH).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003econfig\u003c/code\u003e input allows for more advanced customization of the module using a \u003ccode\u003eKnowledgeAssistConfig\u003c/code\u003e object, that enables settings for article links, including the target window and popup options.\u003c/p\u003e\n"]]],[],null,["# Knowledge Assist\n\nThis page contains the API documentation for the [Knowledge Assist](/agent-assist/docs/knowledge-documents) UI module. This module is used to show helpful articles and FAQ suggestions to agents during the course of a conversation.\n\nUsage\n-----\n\nImport the module in your HTML page using the following code: \n\n \u003cscript src=\"https://www.gstatic.com/agent-assist-ui-modules/v1/knowledge_assist.js\"\u003e\u003c/script\u003e\n\nEmbed the module using the following tag: \n\n \u003cagent-assist-knowledge-assist\u003e\n\nAttributes\n----------\n\n### Usage\n\nAttributes are string-based component properties which can be set in the following ways:\n\nFrom your HTML template directly: \n\n \u003celement-selector property-name=\"value\"\u003e\n\nFrom your JavaScript code: \n\n var el = document.querySelector('element-selector');\n el.setAttribute('property-name', 'value');\n\nInputs\n------\n\n### Usage\n\nInputs are typically JavaScript objects or other complex property types which must be assigned on the element instance directly: \n\n const el = document.querySelector('element-selector');\n el.propertyName = value;\n\nTypes\n-----\n\nSee the following section for the custom types used by the component.\n\n### KnowledgeAssistConfig\n\n interface KnowledgeAssistConfig {\n articleLinkConfig: {\n /**\n * Whether to open the article in a new tab, or as a popup. Defaults to new\n * tab.\n */\n target?: \"blank\" | \"popup\";\n /**\n * Options to configure the popup's size and location. See\n * https://developer.mozilla.org/en-US/docs/Web/API/Window/open#window_features.\n */\n popupWindowOptions?: string;\n /**\n * The field name on the document metadata if a separate article link source\n * is provided.\n */\n linkMetadataKey?: string;\n };\n }"]]