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

Recurso: ServingConfig

Configura los metadatos que se usan para generar resultados de entrega (p.ej., resultados de la búsqueda o predicciones de recomendaciones). El ServingConfig se pasa en la solicitud de búsqueda y predicción, y genera resultados.

Representación 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.
}
Campos
name

string

Inmutable. Nombre completamente calificado projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}/servingConfigs/{servingConfigId}
displayName

string

Obligatorio. Es el nombre visible de la configuración de entrega legible por humanos. Se usa en la IU de Discovery.

Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 128 caracteres. De lo contrario, se muestra un error INVALID_ARGUMENT.
solutionType

enum (SolutionType)

Obligatorio. Inmutable. Especifica el tipo de solución con el que se puede asociar una configuración de entrega.
modelId

string

Es el ID del modelo que se usará en el momento de la entrega. Actualmente, solo se admiten RecommendationModels. Se puede cambiar, pero solo a un modelo compatible (p.ej., CTR de otras opciones que te pueden gustar a CVR de otras opciones que te pueden gustar).

Es obligatorio cuando SolutionType es SOLUTION_TYPE_RECOMMENDATION.
diversityLevel

string

Es la diversidad que se usará en los resultados del modelo de recomendación, p.ej., medium-diversity o high-diversity. Valores admitidos actualmente:

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

Si no se especifica, elegimos el valor predeterminado según el tipo de modelo de recomendación. Valor predeterminado: no-diversity.

Solo se puede configurar si SolutionType es SOLUTION_TYPE_RECOMMENDATION.
rankingExpression

string

La expresión de clasificación controla la clasificación personalizada en los documentos de recuperación. Para aprovechar esto, se requiere la incorporación de documentos. El parámetro de configuración de la expresión de clasificación en ServingConfig se aplica a todas las solicitudes de búsqueda que entrega la configuración de entrega. Sin embargo, si se especifica SearchRequest.ranking_expression, se anula la expresión de clasificación de ServingConfig.

La expresión de clasificación es una sola función o varias funciones que se unen con “+”.

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

Funciones admitidas:

  • double * relevanceScore
  • double * dotProduct(embedding_field_path)

Variables de función:

  • relevanceScore: Son palabras clave predefinidas que se usan para medir la relevancia entre la consulta y el documento.
  • embedding_field_path: Es el campo de incorporación de documentos que se usa con el vector de incorporación de consultas.
  • dotProduct: Es la función de incorporación entre embedding_field_path y el vector de incorporación de consultas.

Ejemplo de expresión de clasificación:

Si el documento tiene un campo de incorporación doc_embedding, la expresión de clasificación podría ser 0.5 * relevanceScore + 0.3 * dotProduct(doc_embedding).
createTime

string (Timestamp format)

Solo salida. Marca de tiempo de creación de ServingConfig.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo salida. Marca de tiempo de actualización de ServingConfig.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
filterControlIds[]

string

Son los controles de filtro que se usarán en la ruta de entrega. Se aplicarán todos los controles de filtro activados. Los controles de filtro deben estar en el mismo almacén de datos que la configuración de entrega. Se permite un máximo de 20 controles de filtro.
boostControlIds[]

string

Son los controles de mejora que se usarán en la ruta de entrega. Se aplicarán todos los controles de mejora activados. Los controles de mejora deben estar en el mismo almacén de datos que la configuración de entrega. Se permite un máximo de 20 controles de mejora.
redirectControlIds[]

string

Son los IDs de los controles de redireccionamiento. Solo se aplica la primera acción de redireccionamiento activada, incluso si se aplican varias. La cantidad máxima de especificaciones es 100.

Solo se puede configurar si SolutionType es SOLUTION_TYPE_SEARCH.
synonymsControlIds[]

string

Son las especificaciones de sinónimos de condición. Si coinciden varias condiciones de sinónimos, se ejecutarán todos los controles de sinónimos coincidentes de la lista. La cantidad máxima de especificaciones es 100.

Solo se puede configurar si SolutionType es SOLUTION_TYPE_SEARCH.
onewaySynonymsControlIds[]

string

Son las especificaciones de sinónimos unidireccionales de condición. Si coinciden varias condiciones de sinónimos unidireccionales, se ejecutarán todos los controles de sinónimos unidireccionales coincidentes de la lista. La cantidad máxima de especificaciones es 100.

Solo se puede configurar si SolutionType es SOLUTION_TYPE_SEARCH.
dissociateControlIds[]

string

Son las especificaciones de no asociar de condición. Si coinciden varias condiciones de no asociar, se ejecutarán todos los controles de no asociar coincidentes de la lista. El orden no importa. La cantidad máxima de especificaciones es 100.

Solo se puede configurar si SolutionType es SOLUTION_TYPE_SEARCH.
replacementControlIds[]

string

Son las especificaciones de reemplazo de condición. Se aplican según el orden de la lista. No se puede volver a reemplazar un término reemplazado anteriormente. La cantidad máxima de especificaciones es 100.

Solo se puede configurar si SolutionType es SOLUTION_TYPE_SEARCH.
ignoreControlIds[]

string

Son las especificaciones de ignorar de condición. Si coinciden varias condiciones de ignorar, se ejecutarán todos los controles de ignorar coincidentes de la lista. El orden no importa. La cantidad máxima de especificaciones es 100.
promoteControlIds[]

string

Son las especificaciones de promoción de condición.

La cantidad máxima de especificaciones es 100.
answerGenerationSpec

object (AnswerGenerationSpec)

Es opcional. Es la especificación para la generación de respuestas.
Configuración específica de la vertical de la industria. A continuación, se incluye una lista de campos mutuamente excluyentes. Se establecerá, como máximo, uno de los campos en una respuesta:
mediaConfig

object (MediaConfig)

Es el MediaConfig de la configuración de entrega.
genericConfig

object (GenericConfig)

Es el GenericConfig de la configuración de entrega.
Fin de los campos mutuamente excluyentes.

Métodos

answer

 Método de respuesta a la consulta.

create

 Crea un ServingConfig.

delete

 Borra un ServingConfig.

get

 Obtiene un ServingConfig.

list

 Muestra todos los ServingConfigs vinculados a este almacén de datos.

patch

 Actualiza un ServingConfig.

recommend

 Realiza una recomendación, que requiere un evento contextual del usuario.
Realiza una búsqueda.

searchLite

 Realiza una búsqueda.

streamAnswer

 Método de respuesta a la consulta (transmisión).