REST Resource: projects.locations.collections.engines

Ressource : Moteur

Métadonnées décrivant les paramètres d'entraînement et de diffusion d'un Engine.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "dataStoreIds": [
    string
  ],
  "solutionType": enum (SolutionType),
  "industryVertical": enum (IndustryVertical),
  "commonConfig": {
    object (CommonConfig)
  },
  "appType": enum (AppType),
  "disableAnalytics": boolean,
  "features": {
    string: enum (FeatureState),
    ...
  },
  "configurableBillingApproach": enum (ConfigurableBillingApproach),

  // Union field engine_config can be only one of the following:
  "chatEngineConfig": {
    object (ChatEngineConfig)
  },
  "searchEngineConfig": {
    object (SearchEngineConfig)
  },
  "mediaRecommendationEngineConfig": {
    object (MediaRecommendationEngineConfig)
  }
  // End of list of possible types for union field engine_config.

  // Union field engine_metadata can be only one of the following:
  "chatEngineMetadata": {
    object (ChatEngineMetadata)
  }
  // End of list of possible types for union field engine_metadata.
}
Champs
name

string

Immuable. Identifiant. Nom complet de la ressource du moteur.

Ce champ doit être une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères.

Le format projects/{project}/locations/{location}/collections/{collection}/engines/{engine} doit contenir entre 1 et 63 caractères, et les caractères valides sont /[a-z0-9][a-z0-9-_]*/. Dans le cas contraire, une erreur INVALID_ARGUMENT est renvoyée.
displayName

string

Obligatoire. Nom à afficher du moteur. Doit être lisible par l'humain. Chaîne encodée en UTF-8 avec une limite de 1 024 caractères.
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la création du moteur de recommandations.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. Horodatage de la dernière mise à jour du moteur de recommandation.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
dataStoreIds[]

string

Facultatif. Datastores associés à ce moteur.

Les moteurs de type SOLUTION_TYPE_SEARCH et SOLUTION_TYPE_RECOMMENDATION ne peuvent être associés qu'à un seul data store.

Si solutionType est défini sur SOLUTION_TYPE_CHAT, plusieurs DataStore dans le même Collection peuvent être associés ici.

Notez que lorsqu'il est utilisé dans CreateEngineRequest, un ID DataStore doit être fourni, car le système l'utilisera pour les initialisations nécessaires.
solutionType

enum (SolutionType)

Obligatoire. Les solutions du moteur.
industryVertical

enum (IndustryVertical)

Facultatif. Secteur d'activité enregistré par le moteur. La restriction du secteur d'activité "Moteur" est basée sur DataStore : le secteur d'activité du moteur doit correspondre à celui du DataStore associé.
commonConfig

object (CommonConfig)

Spécification de configuration courante qui spécifie les métadonnées du moteur.
appType

enum (AppType)

Facultatif. Immuable. Type d'application que représente cette ressource de moteur. REMARQUE : Il s'agit d'un nouveau concept indépendant du secteur d'activité ou du type de solution existants.
disableAnalytics

boolean

Facultatif. Indique si les données analytiques doivent être désactivées pour les recherches effectuées sur ce moteur.
features

map (key: string, value: enum (FeatureState))

Facultatif. Configuration des fonctionnalités permettant au moteur d'activer ou de désactiver des fonctionnalités. Clés compatibles :

  • * : tous les éléments géographiques. Si cette valeur est présente, tous les autres paramètres d'état des éléments géographiques sont ignorés.
  • agent-gallery
  • no-code-agent-builder
  • prompt-gallery
  • model-selector
  • notebook-lm
  • people-search
  • people-search-org-chart
  • bi-directional-audio
  • feedback
  • session-sharing
  • personalization-memory
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
configurableBillingApproach

enum (ConfigurableBillingApproach)

Facultatif. Configuration de l'approche de facturation configurable.
Champ d'union engine_config. Spécifications de configuration supplémentaires qui définissent le comportement du moteur. engine_config ne peut être qu'un des éléments suivants :
chatEngineConfig

object (ChatEngineConfig)

Configurations du Chat Engine. Ne s'applique que si solutionType est défini sur SOLUTION_TYPE_CHAT.
searchEngineConfig

object (SearchEngineConfig)

Configurations du moteur de recherche. Ne s'applique que si solutionType est défini sur SOLUTION_TYPE_SEARCH.
mediaRecommendationEngineConfig

object (MediaRecommendationEngineConfig)

Configurations pour le moteur Media. Applicable uniquement aux data stores avec les secteurs solutionType SOLUTION_TYPE_RECOMMENDATION et IndustryVertical.MEDIA.
Champ d'union engine_metadata. Métadonnées du moteur permettant de surveiller son état. engine_metadata ne peut être qu'un des éléments suivants :
chatEngineMetadata

object (ChatEngineMetadata)

Uniquement en sortie. Informations supplémentaires sur le Chat Engine. Ne s'applique que si solutionType est défini sur SOLUTION_TYPE_CHAT.

ChatEngineConfig

Configurations pour un Chat Engine.

Représentation JSON 
{
  "agentCreationConfig": {
    object (AgentCreationConfig)
  },
  "dialogflowAgentToLink": string,
  "allowCrossRegion": boolean
}
Champs
agentCreationConfig

object (AgentCreationConfig)

La configuration génère l'agent Dialogflow associé à ce moteur.

Notez que ces configurations sont utilisées une seule fois par le service Dialogflow et lui sont transmises. Cela signifie qu'ils ne peuvent pas être récupérés à l'aide des API EngineService.GetEngine ou EngineService.ListEngines après la création du moteur.
allowCrossRegion

boolean

Facultatif. Si le signal est défini sur "true", l'agent et le moteur peuvent se trouver à des emplacements différents. Sinon, ils doivent se trouver au même emplacement. Par défaut, l'indicateur est défini sur "false".

Notez que les allowCrossRegion sont consommés une seule fois par EngineService.CreateEngine et transmis à celui-ci. Cela signifie qu'ils ne peuvent pas être récupérés à l'aide des API EngineService.GetEngine ou EngineService.ListEngines après la création du moteur.

AgentCreationConfig

Configurations permettant de générer un agent Dialogflow.

Notez que ces configurations sont utilisées une seule fois par le service Dialogflow et lui sont transmises. Cela signifie qu'ils ne peuvent pas être récupérés à l'aide des API EngineService.GetEngine ou EngineService.ListEngines après la création du moteur.

Représentation JSON 
{
  "business": string,
  "defaultLanguageCode": string,
  "timeZone": string,
  "location": string
}
Champs
business

string

Nom de l'entreprise, de l'organisation ou de toute autre entité que l'agent représente. Utilisé pour l'invite LLM du connecteur de connaissances et pour la recherche de connaissances.
defaultLanguageCode

string

Obligatoire. Langue par défaut de l'agent en tant que tag de langue. Consultez la section Langues acceptées pour obtenir la liste des codes de langue actuellement compatibles.
timeZone

string

Obligatoire. Le fuseau horaire de l'agent à partir de la base de données de fuseaux horaires, par exemple, Amérique/New_York, Europe/Paris.
location

string

Emplacement de l'agent à créer. Les valeurs acceptées sont "global", "us" et "eu". Si aucune valeur n'est fournie, le moteur US créera l'agent en utilisant us-central-1 par défaut, tandis que le moteur EU créera l'agent en utilisant eu-west-1 par défaut.

SearchEngineConfig

Configurations d'un moteur de recherche.

Représentation JSON 
{
  "searchTier": enum (SearchTier),
  "searchAddOns": [
    enum (SearchAddOn)
  ]
}
Champs
searchTier

enum (SearchTier)

Niveau de fonctionnalité de recherche de ce moteur.

Les prix peuvent varier d'un niveau à l'autre. Pour en savoir plus, consultez la documentation sur les tarifs.

En l'absence de spécification, la valeur par défaut est SearchTier.SEARCH_TIER_STANDARD.
searchAddOns[]

enum (SearchAddOn)

Module complémentaire activé par ce moteur de recherche.

SearchTier

Niveaux de fonctionnalités de recherche. Les prix peuvent varier d'un niveau à l'autre. Pour en savoir plus, consultez la documentation sur les tarifs.

Enums
SEARCH_TIER_UNSPECIFIED Valeur par défaut lorsque l'énumération n'est pas spécifiée. Cette méthode n'est pas valide.
SEARCH_TIER_STANDARD Niveau Standard.
SEARCH_TIER_ENTERPRISE Niveau Enterprise.

SearchAddOn

Module complémentaire qui fournit des fonctionnalités de recherche supplémentaires.

Enums
SEARCH_ADD_ON_UNSPECIFIED Valeur par défaut lorsque l'énumération n'est pas spécifiée. Cette méthode n'est pas valide.
SEARCH_ADD_ON_LLM Module complémentaire Grand modèle de langage.

MediaRecommendationEngineConfig

Spécifications de configuration supplémentaires pour un moteur de recommandation de contenus multimédias.

Représentation JSON 
{
  "type": string,
  "optimizationObjective": string,
  "optimizationObjectiveConfig": {
    object (OptimizationObjectiveConfig)
  },
  "trainingState": enum (TrainingState),
  "engineFeaturesConfig": {
    object (EngineFeaturesConfig)
  }
}
Champs
type

string

Obligatoire. Type de moteur (par exemple, recommended-for-you.

Ce champ et optimizationObjective décrivent les métadonnées du moteur à utiliser pour contrôler l'entraînement et la diffusion du moteur.

Valeurs actuellement acceptées : recommended-for-you, others-you-may-like, more-like-this, most-popular-items.
optimizationObjective

string

Objectif d'optimisation (par exemple, cvr.

Ce champ et optimizationObjective décrivent les métadonnées du moteur à utiliser pour contrôler l'entraînement et la diffusion du moteur.

Valeurs actuellement acceptées : ctr, cvr.

Si aucune valeur n'est spécifiée, nous choisissons une valeur par défaut en fonction du type de moteur. La valeur par défaut dépend du type de recommandation :

recommended-for-you => ctr

others-you-may-like => ctr
optimizationObjectiveConfig

object (OptimizationObjectiveConfig)

Nom et valeur du seuil personnalisé pour l'objectif d'optimisation du taux de conversion. Pour targetField watch-time, target_field_value doit être une valeur entière indiquant la durée de visionnage du contenu multimédia en secondes, comprise entre 0 et 86 400 (0 exclu, 86 400 inclus) (par exemple, 90). Pour targetField watch-percentage, target_field_value doit être une valeur flottante valide comprise entre 0 et 1,0 (0 exclu, 1,0 inclus) (par exemple, 0,5).
trainingState

enum (TrainingState)

État d'entraînement du moteur (par exemple, TRAINING ou PAUSED).

Étant donné qu'une partie du coût d'exécution du service est liée à la fréquence d'entraînement, cela peut être utilisé pour déterminer quand entraîner le moteur afin de contrôler les coûts. Si aucune valeur n'est spécifiée, la valeur par défaut pour la méthode engines.create est TRAINING. La valeur par défaut de la méthode engines.patch consiste à conserver l'état tel qu'il était auparavant.
engineFeaturesConfig

object (EngineFeaturesConfig)

Facultatif. Configuration des fonctionnalités supplémentaires du moteur.

OptimizationObjectiveConfig

Seuil personnalisé pour optimizationObjective cvr.

Représentation JSON 
{
  "targetField": string,
  "targetFieldValueFloat": number
}
Champs
targetField

string

Obligatoire. Nom du champ à cibler. Valeurs actuellement acceptées : watch-percentage, watch-time.
targetFieldValueFloat

number

Obligatoire. Seuil à appliquer à la cible (par exemple, 0,5).

TrainingState

État d'entraînement du moteur.

Enums
TRAINING_STATE_UNSPECIFIED État d'entraînement non spécifié.
PAUSED L'entraînement du moteur est suspendu.
TRAINING Le moteur est en cours d'entraînement.

EngineFeaturesConfig

Plus de configurations de fonctionnalités pour le type de moteur sélectionné.

Représentation JSON 
{

  // Union field type_dedicated_config can be only one of the following:
  "recommendedForYouConfig": {
    object (RecommendedForYouFeatureConfig)
  },
  "mostPopularConfig": {
    object (MostPopularFeatureConfig)
  }
  // End of list of possible types for union field type_dedicated_config.
}
Champs
Champ d'union type_dedicated_config. Configurations liées aux fonctionnalités appliquées à un type spécifique de moteurs de recommandation de contenu multimédia. type_dedicated_config ne peut être qu'un des éléments suivants :
recommendedForYouConfig

object (RecommendedForYouFeatureConfig)

Configuration de la fonctionnalité du moteur "Recommandé pour vous".

RecommendedForYouFeatureConfig

Configurations de fonctionnalités supplémentaires pour créer un moteur recommended-for-you.

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

string

Type d'événement avec lequel le moteur est interrogé au moment de la prédiction. Si la valeur est définie sur generic, seuls view-item, media-play et media-complete seront utilisés comme context-event dans l'entraînement du moteur. Si la valeur est définie sur view-home-page, view-home-page sera également utilisé comme context-events en plus de view-item, media-play et media-complete. Actuellement compatible avec le moteur recommended-for-you. Valeurs actuellement acceptées : view-home-page, generic.

MostPopularFeatureConfig

Configurations de caractéristiques requises pour créer un moteur "Les plus populaires".

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

string (int64 format)

Période pendant laquelle le moteur est interrogé lors de l'entraînement et de la prédiction. Entiers positifs uniquement. La valeur correspond aux événements des X derniers jours. Actuellement requis pour le moteur most-popular-items.

ChatEngineMetadata

Informations supplémentaires sur un Chat Engine. Les champs de ce message sont en sortie uniquement.

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

string

Nom de ressource d'un agent Dialogflow auquel ce Chat Engine fait référence.

Format : projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

CommonConfig

Configurations courantes d'un moteur.

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

string

Nom de l'entreprise, de l'établissement ou de l'entité associés au moteur. Cela peut aider à améliorer les fonctionnalités liées aux LLM.

AppType

L'application du moteur.

Enums
APP_TYPE_UNSPECIFIED Toutes les applications non spécifiées.
APP_TYPE_INTRANET Type d'application pour la recherche sur l'intranet et Agentspace.

FeatureState

État de la fonctionnalité pour le moteur.

Enums
FEATURE_STATE_UNSPECIFIED L'état de la fonctionnalité n'est pas spécifié.
FEATURE_STATE_ON La fonctionnalité est activée pour être accessible.
FEATURE_STATE_OFF La fonctionnalité est désactivée et donc inaccessible.

ConfigurableBillingApproach

Configuration de l'approche de facturation configurable.

Enums
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED Valeur par défaut. Pour l'approche de facturation non configurable Spark et non Spark. Modèle de tarification général.
CONFIGURABLE_BILLING_APPROACH_ENABLED L'approche de facturation suit les configurations spécifiées par le client.

Méthodes

create

 Crée un objet Engine.

delete

 Supprime un Engine.

get

 Récupère un Engine.

list

 Liste tous les Engine associés au projet.

patch

 Met à jour un Engine.