- Resource: Assistant
- WebGroundingType
- VertexAiAgentConfig
- ActionList
- ActionInfo
- ToolList
- ToolInfo
- CustomerPolicy
- BannedPhrase
- BannedPhraseMatchType
- VertexAiSearchToolConfig
- Methods
Resource: Assistant
Discovery Engine Assistant resource.
JSON representation |
---|
{ "name": string, "displayName": string, "description": string, "googleSearchGroundingEnabled": boolean, "webGroundingType": enum ( |
Fields | |
---|---|
name |
Immutable. Resource name of the assistant. Format: It must be a UTF-8 encoded string with a length limit of 1024 characters. |
displayName |
Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters. |
description |
Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant. |
googleSearchGroundingEnabled |
Optional. Deprecated. Use |
webGroundingType |
Optional. The type of web grounding to use. |
vertexAiAgentConfigs[] |
Optional. Deprecated: Will be replaced by Dialogflow agents in AgentService. List of Vertex AI Agents that can be reached through the assistant. |
enabledActions |
Optional. Deprecated: will be replaced by |
enabledTools |
Optional. Note: not implemented yet. Use |
customerPolicy |
Optional. Customer policy for the assistant. |
vertexAiSearchToolConfig |
Optional. Configuration options for the Vertex AI Search tool. |
styleAndFormattingInstructions |
Optional. Common system instruction snippet for setting conversation style, tone and formatting. Added to all LLM prompts via the placeholder |
WebGroundingType
The type of web grounding to use.
Enums | |
---|---|
WEB_GROUNDING_TYPE_UNSPECIFIED |
Default, unspecified setting. This is the same as disabled. |
WEB_GROUNDING_TYPE_DISABLED |
Web grounding is disabled. |
WEB_GROUNDING_TYPE_GOOGLE_SEARCH |
Grounding with Google Search is enabled. |
WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH |
Grounding with Enterprise Web Search is enabled. |
VertexAiAgentConfig
Deprecated: Use Dialogflow agents in AgentService instead. Represents an external Vertex AI Agent that can be reached through the assistant.
JSON representation |
---|
{ "displayName": string, "name": string, "toolDescription": string } |
Fields | |
---|---|
displayName |
Required. Display name of the Vertex AI Agent used for reference in the assistant. |
name |
Required. Resource name of the Vertex AI Agent. Format: |
toolDescription |
Required. The tool description of the Vertex AI Agent. This description will be used by the LLM to decide whether the agent is relevant to the user question and the question should be routed to the agent. |
ActionList
Deprecated: Will be replaced by ToolList
instead. The enabled actions on a connector
JSON representation |
---|
{
"actionInfo": [
{
object ( |
Fields | |
---|---|
actionInfo[] |
The list of actions with corresponding action information. |
ActionInfo
Deprecated: Will be replaced by ToolInfo
instead. Information to identify an action.
JSON representation |
---|
{ "actionName": string, "actionDisplayName": string } |
Fields | |
---|---|
actionName |
The name of the action as defined by DataConnectorService.QueryAvailableActions. |
actionDisplayName |
The display name of the action. |
ToolList
The enabled tools on a connector
JSON representation |
---|
{
"toolInfo": [
{
object ( |
Fields | |
---|---|
toolInfo[] |
The list of tools with corresponding tool information. |
ToolInfo
Information to identify a tool.
JSON representation |
---|
{ "toolName": string, "toolDisplayName": string } |
Fields | |
---|---|
toolName |
The name of the tool as defined by DataConnectorService.QueryAvailableActions. Note: it's using |
toolDisplayName |
The display name of the tool. |
CustomerPolicy
Customer-defined policy for the assistant.
JSON representation |
---|
{
"bannedPhrases": [
{
object ( |
Fields | |
---|---|
bannedPhrases[] |
Optional. List of banned phrases. |
BannedPhrase
Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused.
JSON representation |
---|
{
"phrase": string,
"matchType": enum ( |
Fields | |
---|---|
phrase |
Required. The raw string content to be banned. |
matchType |
Optional. Match type for the banned phrase. |
ignoreDiacritics |
Optional. If true, diacritical marks (e.g., accents, umlauts) are ignored when matching banned phrases. For example, "cafe" would match "café". |
BannedPhraseMatchType
The matching method for the banned phrase.
Enums | |
---|---|
BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED |
Defaults to SIMPLE_STRING_MATCH. |
SIMPLE_STRING_MATCH |
The banned phrase matches if it is found anywhere in the text as an exact substring. |
WORD_BOUNDARY_STRING_MATCH |
Banned phrase only matches if the pattern found in the text is surrounded by word delimiters. The phrase itself may still contain word delimiters. |
VertexAiSearchToolConfig
Configuration options for the Vertex AI Search tool that the assistant may use when processing queries.
JSON representation |
---|
{ "llmSystemInstructions": string } |
Fields | |
---|---|
llmSystemInstructions |
System instructions for answering based on the search results of Vertex AI Search. Note that the answer produced by the search tool may differ from the final answer of the assistant. In general, system instructions are a set of natural language instructions that the model processes before it processes prompts. It tells the model how it should behave and respond to prompts. See https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions Example: "Use information only from the sources to answer. Also, make sure to nicely format the answer with Markdown." If not specified, the internal default will be used. |
Methods |
|
---|---|
|
Creates an Assistant . |
|
Deletes an Assistant . |
|
Gets an Assistant . |
|
Lists all Assistant s under an Engine . |
|
Updates an Assistant |
|
Assists the user with a query in a streaming fashion. |