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

Risorsa: ServingConfig

Configura i metadati utilizzati per generare i risultati in fase di pubblicazione (ad es. risultati di ricerca o previsioni di suggerimenti). ServingConfig viene passato nella richiesta di ricerca e previsione e genera risultati.

Rappresentazione JSON
{
  "name": string,
  "displayName": string,
  "solutionType": enum (SolutionType),
  "modelId": string,
  "diversityLevel": string,
  "rankingExpression": string,
  "createTime": string,
  "updateTime": string,
  "filterControlIds": [
    string
  ],
  "boostControlIds": [
    string
  ],
  "redirectControlIds": [
    string
  ],
  "synonymsControlIds": [
    string
  ],
  "onewaySynonymsControlIds": [
    string
  ],
  "dissociateControlIds": [
    string
  ],
  "replacementControlIds": [
    string
  ],
  "ignoreControlIds": [
    string
  ],
  "promoteControlIds": [
    string
  ],
  "answerGenerationSpec": {
    object (AnswerGenerationSpec)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "mediaConfig": {
    object (MediaConfig)
  },
  "genericConfig": {
    object (GenericConfig)
  }
  // End of mutually exclusive fields.
}
Campi
name

string

Immutabile. Nome completo projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}/servingConfigs/{servingConfigId}

displayName

string

Obbligatorio. Nome visualizzato della configurazione di pubblicazione leggibile. Utilizzato nell'interfaccia utente di Discovery.

Questo campo deve essere una stringa con codifica UTF-8 con un limite di lunghezza di 128 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

solutionType

enum (SolutionType)

Obbligatorio. Immutabile. Specifica il tipo di soluzione a cui può essere associata una configurazione di pubblicazione.

modelId

string

L'ID del modello da utilizzare in fase di pubblicazione. Al momento sono supportati solo RecommendationModel. Può essere modificato, ma solo in un modello compatibile (ad es. CTR di altri-che-potrebbero-piacerti in CVR di altri-che-potrebbero-piacerti).

Obbligatorio quando SolutionType è SOLUTION_TYPE_RECOMMENDATION.

diversityLevel

string

La quantità di diversità da utilizzare nei risultati del modello di suggerimento, ad es. medium-diversity o high-diversity. Valori attualmente supportati:

  • no-diversity
  • low-diversity
  • medium-diversity
  • high-diversity
  • auto-diversity

Se non viene specificato, scegliamo il valore predefinito in base al tipo di modello di suggerimento. Valore predefinito: no-diversity.

Può essere impostato solo se SolutionType è SOLUTION_TYPE_RECOMMENDATION.

rankingExpression

string

L'espressione di ranking controlla il ranking personalizzato sui documenti di recupero. Per sfruttare questa funzionalità, è necessario l'embedding dei documenti. L'impostazione dell'espressione di ranking in ServingConfig si applica a tutte le richieste di ricerca gestite dalla configurazione di pubblicazione. Tuttavia, se viene specificato SearchRequest.ranking_expression, questo sostituisce l'espressione di ranking di ServingConfig.

L'espressione di ranking è una singola funzione o più funzioni unite da "+".

  • rankingExpression = function, { " + ", function };

Funzioni supportate:

  • double * relevanceScore
  • double * dotProduct(embedding_field_path)

Variabili di funzione:

  • relevanceScore: parole chiave predefinite, utilizzate per misurare la pertinenza tra query e documento.
  • embedding_field_path: il campo di embedding del documento utilizzato con il vettore di embedding della query.
  • dotProduct: funzione di embedding tra embedding_field_path e il vettore di embedding della query.

Esempio di espressione di ranking:

Se il documento ha un campo di embedding doc_embedding, l'espressione di ranking potrebbe essere 0.5 * relevanceScore + 0.3 * dotProduct(doc_embedding).

createTime

string (Timestamp format)

Solo output. Timestamp di creazione di ServingConfig.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z 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 di aggiornamento di ServingConfig.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z 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".

filterControlIds[]

string

Controlli dei filtri da utilizzare nel percorso di pubblicazione. Verranno applicati tutti i controlli dei filtri attivati. I controlli dei filtri devono trovarsi nello stesso datastore della configurazione di pubblicazione. Massimo 20 controlli dei filtri.

boostControlIds[]

string

Controlli di aumento da utilizzare nel percorso di pubblicazione. Verranno applicati tutti i controlli di aumento attivati. I controlli di aumento devono trovarsi nello stesso datastore della configurazione di pubblicazione. Massimo 20 controlli di aumento.

redirectControlIds[]

string

ID dei controlli di reindirizzamento. Viene applicata solo la prima azione di reindirizzamento attivata, anche se ne vengono applicate più. Il numero massimo di specifiche è 100.

Può essere impostato solo se SolutionType è SOLUTION_TYPE_SEARCH.

synonymsControlIds[]

string

Specifiche dei sinonimi delle condizioni. Se corrispondono più condizioni di sinonimi, verranno eseguiti tutti i controlli dei sinonimi corrispondenti nell'elenco. Il numero massimo di specifiche è 100.

Può essere impostato solo se SolutionType è SOLUTION_TYPE_SEARCH.

onewaySynonymsControlIds[]

string

Specifiche dei sinonimi unidirezionali delle condizioni. Se corrispondono più condizioni di sinonimi unidirezionali, verranno eseguiti tutti i controlli dei sinonimi unidirezionali corrispondenti nell'elenco. Il numero massimo di specifiche è 100.

Può essere impostato solo se SolutionType è SOLUTION_TYPE_SEARCH.

dissociateControlIds[]

string

Specifiche delle condizioni di non associazione. Se corrispondono più condizioni di non associazione, verranno eseguiti tutti i controlli di non associazione corrispondenti nell'elenco. L'ordine non è importante. Il numero massimo di specifiche è 100.

Può essere impostato solo se SolutionType è SOLUTION_TYPE_SEARCH.

replacementControlIds[]

string

Specifiche di sostituzione delle condizioni. Applicato in base all'ordine nell'elenco. Un termine sostituito in precedenza non può essere sostituito di nuovo. Il numero massimo di specifiche è 100.

Può essere impostato solo se SolutionType è SOLUTION_TYPE_SEARCH.

ignoreControlIds[]

string

Specifiche di ignoranza delle condizioni. Se corrispondono più condizioni di ignoranza, verranno eseguiti tutti i controlli di ignoranza corrispondenti nell'elenco. L'ordine non è importante. Il numero massimo di specifiche è 100.

promoteControlIds[]

string

Specifiche di promozione delle condizioni.

Il numero massimo di specifiche è 100.

answerGenerationSpec

object (AnswerGenerationSpec)

Facoltativo. La specifica per la generazione delle risposte.

Configurazione specifica per il settore verticale. Di seguito è riportato un elenco di campi che si escludono a vicenda. Al massimo uno dei campi verrà impostato in una risposta:
mediaConfig

object (MediaConfig)

MediaConfig della configurazione di pubblicazione.

genericConfig

object (GenericConfig)

GenericConfig della configurazione di pubblicazione.

Fine dei campi che si escludono a vicenda.

Metodi

answer

Metodo di risposta alla query.

create

Crea un ServingConfig.

delete

Elimina un ServingConfig.

get

Ottiene un ServingConfig.

list

Elenca tutti i ServingConfig collegati a questo datastore.

patch

Aggiorna un ServingConfig.

recommend

Fornisce un suggerimento, che richiede un evento utente contestuale.
Esegue una ricerca.

searchLite

Esegue una ricerca.

streamAnswer

Metodo di risposta alla query (streaming).