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

Recurso: ServingConfig

Configura los metadatos que se usan para generar resultados en el momento de la entrega (p.ej., resultados de la búsqueda o predicciones de recomendaciones). El objeto 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,
  "embeddingConfig": {
    object (EmbeddingConfig)
  },
  "rankingExpression": string,
  "createTime": string,
  "updateTime": string,
  "filterControlIds": [
    string
  ],
  "boostControlIds": [
    string
  ],
  "redirectControlIds": [
    string
  ],
  "synonymsControlIds": [
    string
  ],
  "onewaySynonymsControlIds": [
    string
  ],
  "dissociateControlIds": [
    string
  ],
  "replacementControlIds": [
    string
  ],
  "ignoreControlIds": [
    string
  ],
  "promoteControlIds": [
    string
  ],
  "personalizationSpec": {
    object (PersonalizationSpec)
  },
  "answerGenerationSpec": {
    object (AnswerGenerationSpec)
  },

  // Union field vertical_config can be only one of the following:
  "mediaConfig": {
    object (MediaConfig)
  },
  "genericConfig": {
    object (GenericConfig)
  }
  // End of list of possible types for union field vertical_config.
}
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 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 publicación.

modelId

string

Es el ID del modelo que se usará en el momento de la entrega. Actualmente, solo se admiten los RecommendationModels. Se puede cambiar, pero solo a un modelo compatible (p.ej., de la CTR de otras que podrían gustarte al CVR de otras que podrían gustarte).

Obligatorio cuando SolutionType es SOLUTION_TYPE_RECOMMENDATION.

diversityLevel

string

Es la cantidad de 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.

embeddingConfig

object (EmbeddingConfig)

Trae tu propia configuración de incorporación. La configuración se usa para la recuperación semántica de la búsqueda. La recuperación se basa en el producto escalar de SearchRequest.EmbeddingSpec.EmbeddingVector.vector y las incorporaciones de documentos que proporciona este EmbeddingConfig. Si se proporciona SearchRequest.EmbeddingSpec.EmbeddingVector.vector, se anula este ServingConfig.embedding_config.

rankingExpression

string

La expresión de clasificación controla la clasificación personalizada de los documentos recuperados. Para aprovechar esta función, 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 se entregan con 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 unidas por "+".

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

Funciones compatibles:

  • 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 búsqueda y el documento.
  • embedding_field_path: Es el campo de incorporación de documentos que se usa con el vector de incorporación de la búsqueda.
  • dotProduct: Es la función de embedding entre embedding_field_path y el vector de embedding de la búsqueda.

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. Es la marca de tiempo de creación de ServingConfig.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. 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. Es la marca de tiempo de actualización de ServingConfig.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. 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 la publicación. Se permite un máximo de 20 controles de filtros.

boostControlIds[]

string

Controles de refuerzo que se usarán en la ruta de entrega. Se aplicarán todos los controles de potenciación activados. Los controles de refuerzo deben estar en el mismo almacén de datos que la configuración de la publicación. Se pueden aplicar un máximo de 20 controles de potenciación.

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 los sinónimos de condiciones. 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 los sinónimos unidireccionales de la 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

La condición no asocia especificaciones. Si coinciden varias condiciones de no asociación, se ejecutarán todos los controles de no asociación 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 la condición. Se aplican según el orden en la lista. No se puede volver a reemplazar un término que ya se reemplazó. La cantidad máxima de especificaciones es 100.

Solo se puede configurar si SolutionType es SOLUTION_TYPE_SEARCH.

ignoreControlIds[]

string

Especificaciones de ignorar la 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 la promoción de condiciones.

La cantidad máxima de especificaciones es 100.

personalizationSpec

object (PersonalizationSpec)

Es la especificación de la personalización.

Ten en cuenta que, si se configuran ServingConfig.personalization_spec y SearchRequest.personalization_spec, SearchRequest.personalization_spec anula ServingConfig.personalization_spec.

answerGenerationSpec

object (AnswerGenerationSpec)

Opcional. Es la especificación para la generación de respuestas.

Campo de unión vertical_config. Es la configuración específica de la vertical de la industria. vertical_config puede ser solo uno de los siguientes:
mediaConfig

object (MediaConfig)

Es el MediaConfig de la configuración de entrega.

genericConfig

object (GenericConfig)

Es el GenericConfig de la configuración de entrega.

Métodos

answer

Es el método de respuesta a la consulta.

get

Obtiene un objeto ServingConfig.

list

Enumera todos los objetos ServingConfig vinculados a este almacén de datos.

patch

Actualiza un objeto ServingConfig.

recommend

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

searchLite

Realiza una búsqueda.

streamAnswer

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