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),
  "enabledActions": {
    string: {
      object (ActionList)
    },
    ...
  },
  "enabledTools": {
    string: {
      object (ToolList)
    },
    ...
  },
  "customerPolicy": {
    object (CustomerPolicy)
  }
}
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.
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.

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é.

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.

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.

patch

 Met à jour un Assistant.

streamAssist

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