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

Recurso: ServingConfig

Configura metadados que são usados para gerar resultados no momento da publicação (por exemplo, resultados da pesquisa ou previsões de recomendações). O ServingConfig é transmitido no pedido de pesquisa e previsão, e gera resultados.

Representação 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

Imutável. Nome totalmente qualificado projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}/servingConfigs/{servingConfigId}

displayName

string

Obrigatório. O nome a apresentar da configuração de publicação legível. Usado na IU do Discovery.

Este campo tem de ser uma string codificada em UTF-8 com um limite de 128 carateres. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

solutionType

enum (SolutionType)

Obrigatório. Imutável. Especifica o tipo de solução ao qual uma configuração de publicação pode ser associada.

modelId

string

O ID do modelo a usar no momento da publicação. Atualmente, apenas são suportados RecommendationModels. Pode ser alterado, mas apenas para um modelo compatível (por exemplo, CTR de outros utilizadores que podem gostar para CVR de outros utilizadores que podem gostar).

Obrigatório quando SolutionType é SOLUTION_TYPE_RECOMMENDATION.

diversityLevel

string

A diversidade a usar nos resultados do modelo de recomendação, por exemplo, medium-diversity ou high-diversity. Valores atualmente suportados:

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

Se não for especificado, escolhemos a predefinição com base no tipo de modelo de recomendação. Valor predefinido: no-diversity.

Só pode ser definido se SolutionType for SOLUTION_TYPE_RECOMMENDATION.

embeddingConfig

object (EmbeddingConfig)

Use a sua própria configuração de incorporação. A configuração é usada para a obtenção semântica de pesquisas. A obtenção baseia-se no produto escalar de SearchRequest.EmbeddingSpec.EmbeddingVector.vector e nas incorporações de documentos fornecidas por este EmbeddingConfig. Se for fornecido um SearchRequest.EmbeddingSpec.EmbeddingVector.vector, este substitui o ServingConfig.embedding_config.

rankingExpression

string

A expressão de classificação controla a classificação personalizada nos documentos de obtenção. Para tirar partido desta funcionalidade, é necessária a incorporação de documentos. A definição da expressão de classificação em ServingConfig aplica-se a todos os pedidos de pesquisa publicados pela configuração de publicação. No entanto, se SearchRequest.ranking_expression for especificado, substitui a expressão de classificação ServingConfig.

A expressão de classificação é uma única função ou várias funções unidas por "+".

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

Funções suportadas:

  • double * relevanceScore
  • double * dotProduct(embedding_field_path)

Variáveis de função:

  • relevanceScore: palavras-chave predefinidas, usadas para medir a relevância entre a consulta e o documento.
  • embedding_field_path: o campo de incorporação de documentos usado com o vetor de incorporação de consultas.
  • dotProduct: função de incorporação entre embedding_field_path e o vetor de incorporação de consultas.

Exemplo de expressão de classificação:

Se o documento tiver um campo de incorporação doc_embedding, a expressão de classificação pode ser 0.5 * relevanceScore + 0.3 * dotProduct(doc_embedding).

createTime

string (Timestamp format)

Apenas saída. Data/hora de criação de ServingConfig.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Apenas saída. Data/hora da atualização de ServingConfig.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

filterControlIds[]

string

Controlos de filtros a usar no caminho de publicação. Todos os controlos de filtros acionados são aplicados. Os controlos de filtros têm de estar no mesmo arquivo de dados que a configuração de publicação. Máximo de 20 controlos de filtros.

boostControlIds[]

string

Controlos de aumento a usar no caminho de publicação. Todos os controlos de aumento acionados são aplicados. Os controlos de aumento têm de estar no mesmo repositório de dados que a configuração de publicação. Máximo de 20 controlos de aumento.

redirectControlIds[]

string

IDs dos controlos de redirecionamento. Apenas é aplicada a primeira ação de redirecionamento acionada, mesmo que existam várias. O número máximo de especificações é 100.

Só pode ser definido se SolutionType for SOLUTION_TYPE_SEARCH.

synonymsControlIds[]

string

Especificações de sinónimos de condições. Se existirem várias condições de sinónimos correspondentes, todos os controlos de sinónimos correspondentes na lista são executados. O número máximo de especificações é 100.

Só pode ser definido se SolutionType for SOLUTION_TYPE_SEARCH.

onewaySynonymsControlIds[]

string

Especificações de sinónimos unidirecionais de condições. Se existirem várias condições de sinónimos unidirecionais correspondentes, todos os controlos de sinónimos unidirecionais correspondentes na lista são executados. O número máximo de especificações é 100.

Só pode ser definido se SolutionType for SOLUTION_TYPE_SEARCH.

dissociateControlIds[]

string

A condição não associa especificações. Se várias condições de não associação corresponderem, todos os controlos de não associação correspondentes na lista são executados. A ordem não é importante. O número máximo de especificações é 100.

Só pode ser definido se SolutionType for SOLUTION_TYPE_SEARCH.

replacementControlIds[]

string

Especificações de substituição de condições. Aplicadas de acordo com a ordem na lista. Não é possível substituir novamente um termo substituído anteriormente. O número máximo de especificações é 100.

Só pode ser definido se SolutionType for SOLUTION_TYPE_SEARCH.

ignoreControlIds[]

string

Especificações de ignorar condições. Se existirem várias condições de ignorar correspondentes, todos os controlos de ignorar correspondentes na lista são executados. A ordem não é importante. O número máximo de especificações é 100.

promoteControlIds[]

string

Condição de promoção de especificações.

O número máximo de especificações é 100.

personalizationSpec

object (PersonalizationSpec)

A especificação da especificação de personalização.

Tenha em atenção que, se ServingConfig.personalization_spec e SearchRequest.personalization_spec estiverem definidos, SearchRequest.personalization_spec substitui ServingConfig.personalization_spec.

answerGenerationSpec

object (AnswerGenerationSpec)

Opcional. A especificação para a geração de respostas.

Campo de união vertical_config. Configuração específica da vertical da indústria. vertical_config só pode ser uma das seguintes opções:
mediaConfig

object (MediaConfig)

O MediaConfig da configuração de publicação.

genericConfig

object (GenericConfig)

O GenericConfig da configuração de publicação.

Métodos

answer

Método de consulta de respostas.

get

Obtém um ServingConfig.

list

Apresenta todas as ServingConfigs associadas a este dataStore.

patch

Atualiza um ServingConfig.

recommend

Faz uma recomendação, que requer um evento do utilizador contextual.
Faz uma pesquisa.

searchLite

Faz uma pesquisa.

streamAnswer

Método answerQuery (streaming).