REST Resource: projects.locations.collections.engines

Risorsa: motore

Metadati che descrivono i parametri di addestramento e pubblicazione di un Engine.

Rappresentazione 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.
}
Campi
name

string

Immutabile. Identificatore. Il nome risorsa completo del motore.

Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri.

Formato: il motore projects/{project}/locations/{location}/collections/{collection}/engines/{engine} deve contenere da 1 a 63 caratteri e i caratteri validi sono /[a-z0-9][a-z0-9-_]*/. In caso contrario, viene restituito un errore INVALID_ARGUMENT.
displayName

string

Obbligatorio. Il nome visualizzato del motore. Deve essere leggibile. Stringa codificata UTF-8 con un limite di 1024 caratteri.
createTime

string (Timestamp format)

Solo output. Timestamp della creazione del motore per suggerimenti.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo output. Timestamp dell'ultimo aggiornamento di Recommendation Engine.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
dataStoreIds[]

string

Facoltativo. I datastore associati a questo motore.

Per i motori di tipo SOLUTION_TYPE_SEARCH e SOLUTION_TYPE_RECOMMENDATION, è possibile associarli al massimo a un datastore.

Se solutionType è SOLUTION_TYPE_CHAT, qui possono essere associati più DataStore nello stesso Collection.

Tieni presente che, se utilizzato in CreateEngineRequest, deve essere fornito un ID DataStore, che verrà utilizzato dal sistema per le inizializzazioni necessarie.
solutionType

enum (SolutionType)

Obbligatorio. Le soluzioni del motore.
industryVertical

enum (IndustryVertical)

Facoltativo. Il verticale di settore registrato dal motore. La limitazione del verticale del settore Motori si basa su DataStore: il verticale su Motori deve corrispondere al verticale del datastore collegato al motore.
commonConfig

object (CommonConfig)

Specifica di configurazione comune che specifica i metadati del motore.
appType

enum (AppType)

Facoltativo. Immutabile. Il tipo di applicazione rappresentato da questa risorsa del motore. NOTA: questo è un nuovo concetto indipendente dal tipo di soluzione o dal settore verticale esistente.
disableAnalytics

boolean

Facoltativo. Se disattivare o meno l'analisi per le ricerche eseguite su questo motore.
features

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

Facoltativo. Configurazione delle funzionalità per il motore per attivare o disattivare le funzionalità. Chiavi supportate:

  • *: tutte le funzionalità, se presenti, tutte le altre impostazioni di stato delle funzionalità vengono ignorate.
  • 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)

Facoltativo. Configurazione per l'approccio di fatturazione configurabile.
Campo unione engine_config. Specifiche di configurazione aggiuntive che definiscono il comportamento del motore. engine_config può essere solo uno dei seguenti:
chatEngineConfig

object (ChatEngineConfig)

Configurazioni per il motore di chat. Applicabile solo se solutionType è SOLUTION_TYPE_CHAT.
searchEngineConfig

object (SearchEngineConfig)

Configurazioni per il motore di ricerca. Applicabile solo se solutionType è SOLUTION_TYPE_SEARCH.
mediaRecommendationEngineConfig

object (MediaRecommendationEngineConfig)

Configurazioni per Media Engine. Applicabile solo ai datastore con verticale solutionType SOLUTION_TYPE_RECOMMENDATION e IndustryVertical.MEDIA.
Campo unione engine_metadata. Metadati del motore per monitorare lo stato del motore. engine_metadata può essere solo uno dei seguenti:
chatEngineMetadata

object (ChatEngineMetadata)

Solo output. Informazioni aggiuntive su Chat Engine. Applicabile solo se solutionType è SOLUTION_TYPE_CHAT.

ChatEngineConfig

Configurazioni per un motore di chat.

Rappresentazione JSON 
{
  "agentCreationConfig": {
    object (AgentCreationConfig)
  },
  "dialogflowAgentToLink": string,
  "allowCrossRegion": boolean
}
Campi
agentCreationConfig

object (AgentCreationConfig)

La configurazione per generare l'agente Dialogflow associato a questo motore.

Tieni presente che queste configurazioni vengono utilizzate una sola volta e trasmesse al servizio Dialogflow. Ciò significa che non possono essere recuperati utilizzando le API EngineService.GetEngine o EngineService.ListEngines dopo la creazione del motore.
allowCrossRegion

boolean

Facoltativo. Se il flag è impostato su true, l'agente e il motore possono trovarsi in posizioni diverse. In caso contrario, devono trovarsi nella stessa posizione. Il flag è impostato su false per impostazione predefinita.

Tieni presente che i allowCrossRegion vengono utilizzati una sola volta e trasferiti a EngineService.CreateEngine. Ciò significa che non possono essere recuperati utilizzando le API EngineService.GetEngine o EngineService.ListEngines dopo la creazione del motore.

AgentCreationConfig

Configurazioni per generare un agente Dialogflow.

Tieni presente che queste configurazioni vengono utilizzate una sola volta e trasmesse al servizio Dialogflow. Ciò significa che non possono essere recuperati utilizzando le API EngineService.GetEngine o EngineService.ListEngines dopo la creazione del motore.

Rappresentazione JSON 
{
  "business": string,
  "defaultLanguageCode": string,
  "timeZone": string,
  "location": string
}
Campi
business

string

Nome dell'azienda, dell'organizzazione o di un'altra persona giuridica rappresentata dall'agente. Utilizzato per il prompt LLM del connettore di conoscenza e per la ricerca di conoscenza.
defaultLanguageCode

string

Obbligatorio. La lingua predefinita dell'agente come tag di lingua. Consulta la sezione Supporto delle lingue per un elenco dei codici di lingua attualmente supportati.
timeZone

string

Obbligatorio. Il fuso orario dell'agente dal database dei fusi orari, ad esempio America/New_York, Europe/Paris.
location

string

Posizione dell'agente per la creazione dell'agente, valori supportati: global/us/eu. Se non viene specificato, us Engine creerà l'agente utilizzando us-central-1 per impostazione predefinita; eu Engine creerà l'agente utilizzando eu-west-1 per impostazione predefinita.

SearchEngineConfig

Configurazioni per un motore di ricerca.

Rappresentazione JSON 
{
  "searchTier": enum (SearchTier),
  "searchAddOns": [
    enum (SearchAddOn)
  ]
}
Campi
searchTier

enum (SearchTier)

Il livello della funzionalità di ricerca di questo motore.

I diversi livelli potrebbero avere prezzi diversi. Per saperne di più, consulta la documentazione sui prezzi.

Se non specificato, il valore predefinito è SearchTier.SEARCH_TIER_STANDARD.
searchAddOns[]

enum (SearchAddOn)

Il componente aggiuntivo che questo motore di ricerca attiva.

SearchTier

Livelli delle funzionalità di ricerca. I diversi livelli potrebbero avere prezzi diversi. Per saperne di più, consulta la documentazione sui prezzi.

Enum
SEARCH_TIER_UNSPECIFIED Valore predefinito quando l'enumerazione non è specificata. Questo valore non è valido.
SEARCH_TIER_STANDARD Livello Standard.
SEARCH_TIER_ENTERPRISE Livello Enterprise.

SearchAddOn

Componente aggiuntivo che fornisce funzionalità aggiuntive per la ricerca.

Enum
SEARCH_ADD_ON_UNSPECIFIED Valore predefinito quando l'enumerazione non è specificata. Questo valore non è valido.
SEARCH_ADD_ON_LLM Componente aggiuntivo del modello linguistico di grandi dimensioni.

MediaRecommendationEngineConfig

Specifiche di configurazione aggiuntive per un motore di suggerimenti sui contenuti multimediali.

Rappresentazione JSON 
{
  "type": string,
  "optimizationObjective": string,
  "optimizationObjectiveConfig": {
    object (OptimizationObjectiveConfig)
  },
  "trainingState": enum (TrainingState),
  "engineFeaturesConfig": {
    object (EngineFeaturesConfig)
  }
}
Campi
type

string

Obbligatorio. Il tipo di motore. Ad esempio, recommended-for-you.

Questo campo, insieme a optimizationObjective, descrive i metadati del motore da utilizzare per controllare l'addestramento e la pubblicazione del motore.

Valori attualmente supportati: recommended-for-you, others-you-may-like, more-like-this, most-popular-items.
optimizationObjective

string

L'obiettivo di ottimizzazione, ad esempio cvr.

Questo campo, insieme a optimizationObjective, descrive i metadati del motore da utilizzare per controllare l'addestramento e la pubblicazione del motore.

Valori attualmente supportati: ctr, cvr.

Se non specificato, scegliamo il valore predefinito in base al tipo di motore. Il valore predefinito dipende dal tipo di consiglio:

recommended-for-you => ctr

others-you-may-like => ctr
optimizationObjectiveConfig

object (OptimizationObjectiveConfig)

Nome e valore della soglia personalizzata per l'obiettivo di ottimizzazione del tasso di conversione. Per targetField watch-time, target_field_value deve essere un valore intero che indica il tempo di avanzamento dei contenuti multimediali in secondi compreso tra (0, 86400] (escluso 0, incluso 86400) (ad es. 90). Per targetField watch-percentage, target_field_value deve essere un valore float valido compreso tra (0, 1.0] (escluso 0, incluso 1.0) (ad es. 0,5).
trainingState

enum (TrainingState)

Lo stato di addestramento del motore (ad es. TRAINING o PAUSED).

Poiché parte del costo di esecuzione del servizio è la frequenza di addestramento, questo può essere utilizzato per determinare quando addestrare il motore al fine di controllare i costi. Se non specificato: il valore predefinito per il metodo engines.create è TRAINING. Il valore predefinito per il metodo engines.patch è mantenere lo stato invariato.
engineFeaturesConfig

object (EngineFeaturesConfig)

Facoltativo. Configurazione delle funzionalità aggiuntive del motore.

OptimizationObjectiveConfig

Soglia personalizzata per optimizationObjective cvr.

Rappresentazione JSON 
{
  "targetField": string,
  "targetFieldValueFloat": number
}
Campi
targetField

string

Obbligatorio. Il nome del campo da scegliere come target. Valori attualmente supportati: watch-percentage, watch-time.
targetFieldValueFloat

number

Obbligatorio. La soglia da applicare al target (ad es. 0,5).

TrainingState

Lo stato di addestramento del motore.

Enum
TRAINING_STATE_UNSPECIFIED Stato di addestramento non specificato.
PAUSED L'addestramento del motore è in pausa.
TRAINING Il motore è in fase di addestramento.

EngineFeaturesConfig

Altre configurazioni delle funzionalità del tipo di motore selezionato.

Rappresentazione 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.
}
Campi
Campo unione type_dedicated_config. Configurazioni correlate alle funzionalità applicate a un tipo specifico di motori di suggerimenti multimediali. type_dedicated_config può essere solo uno dei seguenti:
recommendedForYouConfig

object (RecommendedForYouFeatureConfig)

Configurazione della funzionalità del motore consigliata per te.

RecommendedForYouFeatureConfig

Configurazioni delle funzionalità aggiuntive per la creazione di un motore recommended-for-you.

Rappresentazione JSON 
{
  "contextEventType": string
}
Campi
contextEventType

string

Il tipo di evento con cui viene eseguita una query sul motore al momento della previsione. Se impostato su generic, verranno utilizzati solo view-item, media-play e media-complete come context-event nell'addestramento del motore. Se impostato su view-home-page, view-home-page verrà utilizzato anche come context-events oltre a view-item, media-play e media-complete. Attualmente supportato per il motore recommended-for-you. Valori attualmente supportati: view-home-page, generic.

MostPopularFeatureConfig

Configurazioni delle funzionalità necessarie per creare un motore Più popolari.

Rappresentazione JSON 
{
  "timeWindowDays": string
}
Campi
timeWindowDays

string (int64 format)

La finestra temporale in cui viene eseguita la query del motore durante l'addestramento e la previsione. Solo numeri interi positivi. Il valore corrisponde agli eventi degli ultimi X giorni. Attualmente richiesto per il motore most-popular-items.

ChatEngineMetadata

Informazioni aggiuntive su un motore di chat. I campi di questo messaggio sono solo di output.

Rappresentazione JSON 
{
  "dialogflowAgent": string
}
Campi
dialogflowAgent

string

Il nome della risorsa di un agente Dialogflow a cui fa riferimento questo motore di chat.

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

CommonConfig

Configurazioni comuni per un motore.

Rappresentazione JSON 
{
  "companyName": string
}
Campi
companyName

string

Il nome della società, dell'attività o dell'entità associata al motore. L'impostazione di questa opzione può contribuire a migliorare le funzionalità correlate a LLM.

AppType

L'app del motore.

Enum
APP_TYPE_UNSPECIFIED Tutte le app non specificate.
APP_TYPE_INTRANET Tipo di app per la ricerca intranet e Agentspace.

FeatureState

Lo stato della funzionalità per il motore.

Enum
FEATURE_STATE_UNSPECIFIED Lo stato della funzionalità non è specificato.
FEATURE_STATE_ON La funzionalità è attivata per essere accessibile.
FEATURE_STATE_OFF La funzionalità è disattivata per non essere accessibile.

ConfigurableBillingApproach

Configurazione per l'approccio di fatturazione configurabile.

Enum
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED Valore predefinito. Per l'approccio di fatturazione non configurabile Spark e non Spark. Modello di prezzi generale.
CONFIGURABLE_BILLING_APPROACH_ENABLED L'approccio di fatturazione segue le configurazioni specificate dal cliente.

Metodi

create

 Crea un Engine.

delete

 Elimina un Engine.

get

 Riceve un Engine.

list

 Elenca tutti i Engine associati al progetto.

patch

 Aggiorna un Engine

pause

 Mette in pausa l'addestramento di un motore esistente.

resume

 Riprende l'addestramento di un motore esistente.

tune

 Ottimizza un motore esistente.