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

Recurso: ServingConfig

Configura metadados usados para gerar resultados no momento da exibição (por exemplo, resultados da pesquisa ou previsões de recomendação). O ServingConfig é transmitido na solicitação 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 de exibição legível da configuração de exibição. Usado na interface do usuário do Discovery.

Esse campo precisa ser uma string codificada em UTF-8 com um limite de 128 caracteres. Caso contrário, um erro INVALID_ARGUMENT será retornado.
solutionType

enum (SolutionType)

Obrigatório. Imutável. Especifica o tipo de solução a que uma configuração de exibição pode ser associada.
modelId

string

O ID do modelo a ser usado no momento da veiculação. No momento, apenas RecommendationModels são aceitos. Pode ser mudado, mas apenas para um modelo compatível (por exemplo, CTR de "Outras categorias que você pode gostar" para CVR de "Outras categorias que você pode gostar").

Obrigatório quando SolutionType é SOLUTION_TYPE_RECOMMENDATION.
diversityLevel

string

A quantidade de diversidade a ser usada nos resultados do modelo de recomendação, por exemplo, medium-diversity ou high-diversity. Valores aceitos no momento:

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

Se não for especificado, vamos escolher o padrão com base no tipo de modelo de recomendação. Valor padrão: no-diversity.

Só pode ser definido se SolutionType for SOLUTION_TYPE_RECOMMENDATION.
embeddingConfig

object (EmbeddingConfig)

Traga sua própria configuração de incorporação. A configuração é usada para recuperação semântica de pesquisa. A recuperação é baseada no produto escalar de SearchRequest.EmbeddingSpec.EmbeddingVector.vector e nos embeddings de documentos fornecidos por esse EmbeddingConfig. Se SearchRequest.EmbeddingSpec.EmbeddingVector.vector for fornecido, ele vai substituir este ServingConfig.embedding_config.
rankingExpression

string

A expressão de classificação controla a classificação personalizada nos documentos de recuperação. Para aproveitar isso, é necessário incorporar documentos. A configuração de expressão de classificação em ServingConfig se aplica a todas as solicitações de pesquisa atendidas pela configuração de veiculação. No entanto, se SearchRequest.ranking_expression for especificado, ele vai substituir a expressão de classificação da ServingConfig.

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

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

Funções compatíveis:

  • 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 embedding de documento usado com o vetor de embedding de consulta.
  • dotProduct: função de embedding entre embedding_field_path e vetor de embedding de consulta.

Exemplo de expressão de classificação:

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

string (Timestamp format)

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

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. 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. Carimbo de data/hora da atualização de ServingConfig.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
filterControlIds[]

string

Controles de filtro para usar no caminho de veiculação. Todos os controles de filtro acionados serão aplicados. Os controles de filtro precisam estar no mesmo repositório de dados que a configuração de exibição. Máximo de 20 controles de filtros.
boostControlIds[]

string

Controles de reforço para usar no caminho de veiculação. Todos os controles de reforço acionados serão aplicados. Os controles de reforço precisam estar no mesmo repositório de dados que a configuração de exibição. Máximo de 20 controles de otimização.
redirectControlIds[]

string

IDs dos controles de redirecionamento. Apenas a primeira ação de redirecionamento acionada é aplicada, mesmo que várias sejam válidas. 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ção. Se várias condições de sinônimos corresponderem, todos os controles de sinônimos correspondentes na lista serã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ção. Se várias condições de sinônimos unidirecionais forem correspondentes, todos os controles de sinônimos unidirecionais correspondentes na lista serã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 forem correspondentes, todos os controles de não associação correspondentes na lista serão executados. A ordem não importa. 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ção. Aplicados de acordo com a ordem na lista. Um termo substituído anteriormente não pode ser substituído novamente. O número máximo de especificações é 100.

Só pode ser definido se SolutionType for SOLUTION_TYPE_SEARCH.
ignoreControlIds[]

string

Condição para ignorar especificações. Se várias condições de ignorar forem correspondentes, todos os controles de ignorar correspondentes na lista serão executados. A ordem não importa. O número máximo de especificações é 100.
promoteControlIds[]

string

Especificações de promoção condicional.

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

object (PersonalizationSpec)

A especificação da personalização.

Se ServingConfig.personalization_spec e SearchRequest.personalization_spec estiverem definidos, SearchRequest.personalization_spec vai substituir 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 do segmento do setor. vertical_config pode ser apenas de um dos tipos a seguir:
mediaConfig

object (MediaConfig)

O MediaConfig da configuração de exibição.
genericConfig

object (GenericConfig)

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

Métodos

answer

 Método de consulta de resposta.

get

 Recebe um ServingConfig.

list

 Lista todas as ServingConfigs vinculadas a este dataStore.

patch

 Atualiza um ServingConfig.

recommend

 Faz uma recomendação, o que exige um evento contextual do usuário.
Realiza uma pesquisa.

searchLite

 Realiza uma pesquisa.

streamAnswer

 Método de consulta de resposta (streaming).