REST Resource: projects.locations.collections.engines.assistants

Ressource : Assistant

Ressource Assistant Discovery Engine.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "generationConfig": {
    object (GenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "defaultWebGroundingToggleOff": boolean,
  "vertexAiAgentConfigs": [
    {
      object (VertexAiAgentConfig)
    }
  ],
  "enabledActions": {
    string: {
      object (ActionList)
    },
    ...
  },
  "enabledTools": {
    string: {
      object (ToolList)
    },
    ...
  },
  "customerPolicy": {
    object (CustomerPolicy)
  },
  "vertexAiSearchToolConfig": {
    object (VertexAiSearchToolConfig)
  },
  "styleAndFormattingInstructions": string,
  "agentConfigs": [
    {
      object (AgentConfig)
    }
  ],
  "enableEndUserAgentCreation": boolean,
  "disableLocationContext": boolean
}
Champs
name

string

Immuable. Nom de ressource de l'assistant. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Il doit s'agir d'une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères.
displayName

string

Obligatoire. Nom à afficher de l'assistant.

Il doit s'agir d'une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 128 caractères.
description

string

Facultatif. Description pour obtenir des informations supplémentaires. Il doit s'afficher dans l'interface utilisateur de configuration, et non aux utilisateurs de l'assistant.
generationConfig

object (GenerationConfig)

Facultatif. Configuration pour la génération de la réponse de l'assistant.
googleSearchGroundingEnabled
(deprecated)

boolean

Facultatif. Obsolète. Utilisez plutôt webGroundingType.
webGroundingType

enum (WebGroundingType)

Facultatif. Type d'ancrage Web à utiliser.
defaultWebGroundingToggleOff

boolean

Facultatif. Ce champ contrôle le bouton bascule de l'ancrage Web par défaut pour les utilisateurs finaux si webGroundingType est défini sur WEB_GROUNDING_TYPE_GOOGLE_SEARCH ou WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. Par défaut, ce champ est défini sur "false". Si webGroundingType est défini sur WEB_GROUNDING_TYPE_GOOGLE_SEARCH ou WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, l'ancrage Web est activé par défaut pour les utilisateurs finaux dans l'UI. Si la valeur est "true", le bouton d'ancrage sera désactivé par défaut dans l'UI. Les utilisateurs finaux peuvent toujours activer l'ancrage Web dans l'interface utilisateur si cette option est activée.
vertexAiAgentConfigs[]
(deprecated)

object (VertexAiAgentConfig)

Facultatif. Obsolète : sera remplacé par les agents Dialogflow dans AgentService. Liste des agents Vertex AI accessibles via l'assistant.
enabledActions
(deprecated)

map (key: string, value: object (ActionList))

Facultatif. Obsolète : sera remplacé par enabledTools. Actions activées sur cet assistant. Les clés sont le nom du connecteur, par exemple "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector. Les valeurs sont les actions activées par l'administrateur pour l'instance du connecteur. L'administrateur peut activer de manière sélective plusieurs actions sur l'une des instances de connecteur qu'il a créées dans le projet. Par exemple, {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
enabledTools

map (key: string, value: object (ToolList))

Facultatif. Remarque : pas encore implémenté. Utilisez plutôt enabledActions. Outils activés sur cet assistant. Les clés sont le nom du connecteur, par exemple "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector. Les valeurs sont les outils activés par l'administrateur pour l'instance de connecteur. L'administrateur peut activer sélectivement plusieurs outils sur l'une des instances de connecteur qu'il a créées dans le projet. Par exemple : {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
customerPolicy

object (CustomerPolicy)

Facultatif. Règles applicables aux clients pour l'Assistant.
vertexAiSearchToolConfig

object (VertexAiSearchToolConfig)

Facultatif. Options de configuration de l'outil Vertex AI Search.
styleAndFormattingInstructions
(deprecated)

string

Facultatif. Obsolète. Veuillez utiliser [addtional_system_instructions][GenerationConfig.SystemInstruction.additional_system_instructions] à la place. Extrait d'instruction système courant pour définir le style, le ton et la mise en forme de la conversation. Ajouté à toutes les requêtes LLM via le code de substitution [STYLE_AND_FORMATTING_INSTRUCTIONS].
agentConfigs[]

object (AgentConfig)

Facultatif. Liste des agents que vous pouvez contacter via l'assistant.
enableEndUserAgentCreation

boolean

Facultatif. Indique si les utilisateurs finaux sont autorisés à créer des agents dans Agentspace.
disableLocationContext

boolean

Facultatif. Indique s'il faut désactiver le contexte de localisation de l'utilisateur. Par défaut, le contexte de localisation de l'utilisateur est activé.

GenerationConfig

Configuration pour la génération de la réponse de l'assistant.

Représentation JSON 
{
  "systemInstruction": {
    object (SystemInstruction)
  },
  "defaultLanguage": string
}
Champs
systemInstruction

object (SystemInstruction)

Instruction système, également appelée préambule de requête pour les appels LLM. Consultez également https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions.
defaultLanguage

string

Langue par défaut à utiliser pour générer la réponse de l'assistant. Utilisez un code de langue ISO 639-1, tel que en. Si aucune langue n'est spécifiée, elle sera détectée automatiquement.

SystemInstruction

Instruction système, également appelée préambule de requête pour les appels LLM.

Représentation JSON 
{
  "additionalSystemInstruction": string
}
Champs
additionalSystemInstruction

string

Facultatif. Instruction système supplémentaire qui sera ajoutée à l'instruction système par défaut.

WebGroundingType

Type d'ancrage Web à utiliser.

Enums
WEB_GROUNDING_TYPE_UNSPECIFIED Paramètre par défaut non spécifié. Cela revient à désactiver la fonctionnalité.
WEB_GROUNDING_TYPE_DISABLED L'ancrage Web est désactivé.

VertexAiAgentConfig

Obsolète : utilisez plutôt les agents Dialogflow dans AgentService. Représente un agent Vertex AI externe accessible via l'assistant.

Représentation JSON 
{
  "displayName": string,
  "name": string,
  "toolDescription": string
}
Champs
displayName

string

Obligatoire. Nom à afficher de l'agent Vertex AI utilisé comme référence dans l'assistant.
name

string

Obligatoire. Nom de ressource de l'agent Vertex AI. Format : projects/{project}/locations/{location}/agents/{agent}
toolDescription

string

Obligatoire. Description de l'outil de l'agent Vertex AI. Elle permettra au LLM de déterminer si l'agent est pertinent pour la question de l'utilisateur et si la question doit être transmise à l'agent.

ActionList

Obsolète : sera remplacé par ToolList. Actions activées sur un connecteur

Représentation JSON 
{
  "actionInfo": [
    {
      object (ActionInfo)
    }
  ]
}
Champs
actionInfo[]

object (ActionInfo)

Liste des actions avec les informations correspondantes.

ActionInfo

Obsolète : sera remplacé par ToolInfo. Informations permettant d'identifier une action.

Représentation JSON 
{
  "actionName": string,
  "actionDisplayName": string
}
Champs
actionName

string

Nom de l'action tel que défini par DataConnectorService.QueryAvailableActions.
actionDisplayName

string

Nom à afficher de l'action.

ToolList

Outils activés sur un connecteur

Représentation JSON 
{
  "toolInfo": [
    {
      object (ToolInfo)
    }
  ]
}
Champs
toolInfo[]

object (ToolInfo)

Liste des outils avec les informations correspondantes.

ToolInfo

Informations permettant d'identifier un outil.

Représentation JSON 
{
  "toolName": string,
  "toolDisplayName": string
}
Champs
toolName

string

Nom de l'outil tel que défini par DataConnectorService.QueryAvailableActions. Remarque : action est utilisé dans les API DataConnectorService, mais il est identique à tool.
toolDisplayName

string

Nom à afficher de l'outil.

CustomerPolicy

Règle définie par le client pour l'assistant.

Représentation JSON 
{
  "bannedPhrases": [
    {
      object (BannedPhrase)
    }
  ],
  "modelArmorConfig": {
    object (ModelArmorConfig)
  }
}
Champs
bannedPhrases[]

object (BannedPhrase)

Facultatif. Liste des expressions interdites.
modelArmorConfig

object (ModelArmorConfig)

Facultatif. Configuration de Model Armor à utiliser pour désinfecter les requêtes utilisateur et les réponses de l'assistant.

BannedPhrase

Définition d'une expression interdite définie par le client. Une expression interdite ne doit pas figurer dans la requête utilisateur ni dans la réponse du LLM, sous peine de voir la réponse refusée.

Représentation JSON 
{
  "phrase": string,
  "matchType": enum (BannedPhraseMatchType),
  "ignoreDiacritics": boolean
}
Champs
phrase

string

Obligatoire. Contenu de la chaîne brute à interdire.
matchType

enum (BannedPhraseMatchType)

Facultatif. Type de correspondance pour l'expression interdite.
ignoreDiacritics

boolean

Facultatif. Si la valeur est "true", les signes diacritiques (par exemple, les accents et les trémas) sont ignorés lors de la mise en correspondance des expressions interdites. Par exemple, "cafe" correspondrait à "café".

BannedPhraseMatchType

Méthode de correspondance pour l'expression interdite.

Enums
BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED La valeur par défaut est SIMPLE_STRING_MATCH.
SIMPLE_STRING_MATCH L'expression interdite est considérée comme correspondante si elle est trouvée n'importe où dans le texte en tant que sous-chaîne exacte.
WORD_BOUNDARY_STRING_MATCH Une expression interdite ne correspond que si le motif trouvé dans le texte est entouré de délimiteurs de mots. L'expression elle-même peut toujours contenir des délimiteurs de mots.

ModelArmorConfig

Configuration des modèles Model Armor définis par le client à utiliser pour nettoyer les requêtes utilisateur et les réponses de l'assistant.

Représentation JSON 
{
  "userPromptTemplate": string,
  "responseTemplate": string,
  "failureMode": enum (FailureMode)
}
Champs
userPromptTemplate

string

Facultatif. Nom de ressource du modèle Model Armor pour assainir les requêtes utilisateur. Format : projects/{project}/locations/{location}/templates/{templateId}

Si aucune valeur n'est spécifiée, aucune désinfection ne sera appliquée à la requête utilisateur.
responseTemplate

string

Facultatif. Nom de ressource du modèle Model Armor permettant de nettoyer les réponses de l'assistant. Format : projects/{project}/locations/{location}/templates/{templateId}

Si aucune valeur n'est spécifiée, aucune désinfection ne sera appliquée à la réponse de l'assistant.
failureMode

enum (FailureMode)

Facultatif. Définit le mode d'échec pour la désinfection Model Armor.

FailureMode

Détermine le comportement lorsque Model Armor ne parvient pas à traiter une requête.

Enums
FAILURE_MODE_UNSPECIFIED Mode d'échec non spécifié. Le comportement par défaut est FAIL_CLOSED.
FAIL_OPEN En cas d'échec du traitement de Model Armor, la requête est autorisée à se poursuivre sans aucune modification.
FAIL_CLOSED En cas d'échec du traitement de Model Armor, la requête est rejetée.

VertexAiSearchToolConfig

Options de configuration de l'outil Vertex AI Search que l'assistant peut utiliser pour traiter les requêtes.

Représentation JSON 
{
  "llmSystemInstructions": string
}
Champs
llmSystemInstructions
(deprecated)

string

Obsolète. Veuillez ne pas utiliser ce champ. Instructions système pour répondre en fonction des résultats de recherche de Vertex AI Search. Notez que la réponse générée par l'outil de recherche peut différer de la réponse finale de l'assistant.

En général, les instructions système sont un ensemble d'instructions en langage naturel que le modèle traite avant de traiter les requêtes. Elle indique au modèle comment il doit se comporter et répondre aux requêtes. Consultez https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions.

Exemple : "Utilise uniquement les informations des sources pour répondre. Veille également à mettre en forme la réponse avec Markdown."

Si aucune valeur n'est spécifiée, la valeur par défaut interne sera utilisée.

AgentConfig

Options de configuration pour les agents que l'assistant peut appeler lors du traitement des requêtes.

Représentation JSON 
{
  "id": string,
  "displayName": string,
  "toolDescription": string,
  "icon": {
    object (Image)
  },
  "authorizations": [
    string
  ],

  // Union field connection_info can be only one of the following:
  "vertexAiSdkAgentConnectionInfo": {
    object (VertexAiSdkAgentConnectionInfo)
  },
  "httpAgentConnectionInfo": {
    object (HttpAgentConnectionInfo)
  }
  // End of list of possible types for union field connection_info.
}
Champs
id

string

Obligatoire. ID d'agent unique lisible par l'humain. Doit correspondre à l'expression régulière suivante : [a-z][a-zA-Z0-9_-]*.
displayName

string

Obligatoire. Nom à afficher de l'agent utilisé comme référence dans l'assistant.
toolDescription

string

Obligatoire. Description de l'outil d'agent. Elle permettra au LLM de déterminer si l'agent est pertinent pour la question de l'utilisateur et si la question doit être transmise à l'agent.
icon

object (Image)

Obligatoire. Icône représentant l'agent dans l'UI.
authorizations[]

string

Facultatif. Noms de ressources des autorisations requises. Si l'utilisateur n'est pas autorisé, le service renvoie un certain nombre d'URI d'autorisation que l'utilisateur doit ouvrir dans un navigateur et autoriser. Une fois toutes les autorisations accordées, l'utilisateur peut réessayer la requête, et les autorisations seront transmises à l'agent.

Format : projects/{project}/locations/{location}/authorizations/{authorization}
Champ d'union connection_info. Configuration de la connexion de l'agent. connection_info ne peut être qu'un des éléments suivants :
vertexAiSdkAgentConnectionInfo

object (VertexAiSdkAgentConnectionInfo)

Obligatoire. Informations de connexion pour un agent du SDK Vertex AI
httpAgentConnectionInfo

object (HttpAgentConnectionInfo)

Obligatoire. Informations de connexion pour un agent HTTP.

VertexAiSdkAgentConnectionInfo

Informations de connexion pour un agent du SDK Vertex AI. Actuellement, seuls les agents exposés via les Reasoning Engines sont compatibles.

Représentation JSON 
{
  "reasoningEngine": string
}
Champs
reasoningEngine

string

Nom de ressource du moteur de raisonnement exposant l'agent. Format : projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}

HttpAgentConnectionInfo

Agent accessible par l'assistant via HTTP.

Représentation JSON 
{
  "httpUri": string
}
Champs
httpUri

string

Obligatoire. Adresse HTTP de l'agent (par exemple, "https://example.com/agent1").

Image

Représente une image.

Représentation JSON 
{

  // Union field storage_method can be only one of the following:
  "uri": string,
  "content": string
  // End of list of possible types for union field storage_method.
}
Champs
Champ d'union storage_method. Il peut s'agir d'un URI ou du contenu encodé sous forme de chaîne base64. storage_method ne peut être qu'un des éléments suivants :
uri

string

Obligatoire. URI de l'image.
content

string

Obligatoire. Contenu du fichier image encodé en base64.

Méthodes

assist

 Aide l'utilisateur à répondre à une requête.

create

 Crée un Assistant.

delete

 Supprime un Assistant.

get

 Récupère un Assistant.

list

 Répertorie tous les Assistant d'un Engine.

listAvailableAgentViews

 Liste les données permettant d'afficher les agents sous un Assistant qui sont disponibles pour l'appelant.

patch

 Met à jour un Assistant.

streamAssist

 Aide l'utilisateur à répondre à une requête en streaming.