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,
  "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)
  },

  // 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.

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.

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.

MediaConfig

Especifica as configurações necessárias para a descoberta de mídia. No momento, oferecemos suporte a:

  • demote_content_watched: limite para a redução de conteúdo assistido. Os clientes podem especificar se querem usar o rebaixamento de conteúdo assistido ou a página de detalhes visualizada. Ao usar a redução de classificação de conteúdo assistido, os clientes precisam especificar os minutos ou a porcentagem assistida que excedem o limite. Assim, o conteúdo será rebaixado no resultado da recomendação.
  • promote_fresh_content: dias de corte para a promoção de conteúdo novo. Os clientes podem especificar se estão usando a promoção de atualização de conteúdo. Se o conteúdo foi publicado dentro do período de corte, ele será promovido no resultado da recomendação. Só pode ser definido se SolutionType for SOLUTION_TYPE_RECOMMENDATION.
Representação JSON
{
  "demotionEventType": string,
  "demoteContentWatchedPastDays": integer,
  "contentFreshnessCutoffDays": integer,

  // Union field demote_content_watched can be only one of the following:
  "contentWatchedPercentageThreshold": number,
  "contentWatchedSecondsThreshold": number
  // End of list of possible types for union field demote_content_watched.
}
Campos
demotionEventType

string

Especifica o tipo de evento usado para reduzir o resultado da recomendação. Valores aceitos no momento:

  • view-item: item visualizado.
  • media-play: comece/retome a exibição de um vídeo, a reprodução de uma música etc.
  • media-complete: terminou ou parou no meio de um vídeo, música etc.

Se não for definida, a redução do histórico de exibição não será aplicada. A redução de classificação por atualização de conteúdo ainda será aplicada.

demoteContentWatchedPastDays

integer

Opcional. Especifica o número de dias a serem considerados para rebaixar o conteúdo assistido. Se for definido como zero ou não definido, o padrão será o máximo de 365 dias.

contentFreshnessCutoffDays

integer

Especifica a atualização de conteúdo usada para o resultado da recomendação. O conteúdo será rebaixado se tiver sido publicado há mais tempo do que os dias de corte de atualização de conteúdo.

Campo de união demote_content_watched. Especifique o limite para rebaixar o conteúdo assistido. Ele pode ser uma porcentagem ou um valor em minutos. Isso precisa ser definido para o tipo de evento media-complete. demote_content_watched pode ser apenas de um dos tipos a seguir:
contentWatchedPercentageThreshold

number

Especifica o limite de porcentagem de conteúdo assistido para rebaixamento. O valor do limite precisa estar entre [0, 1,0], inclusive.

contentWatchedSecondsThreshold

number

Especifica o limite de minutos assistidos para rebaixamento.

GenericConfig

Especifica as configurações necessárias para a descoberta genérica.No momento, oferecemos suporte a:

  • contentSearchSpec: configuração para pesquisa de conteúdo genérico.
Representação JSON
{
  "contentSearchSpec": {
    object (ContentSearchSpec)
  }
}
Campos
contentSearchSpec

object (ContentSearchSpec)

Especifica o comportamento esperado da pesquisa de conteúdo. Válido apenas para repositório de dados com pesquisa de conteúdo ativada.

AnswerGenerationSpec

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

Representação JSON
{
  "userDefinedClassifierSpec": {
    object (UserDefinedClassifierSpec)
  }
}
Campos
userDefinedClassifierSpec

object (UserDefinedClassifierSpec)

Opcional. A especificação para a especificação do classificador especificado pelo usuário.

UserDefinedClassifierSpec

A especificação do classificador definido pelo usuário.

Representação JSON
{
  "enableUserDefinedClassifier": boolean,
  "preamble": string,
  "modelId": string,
  "taskMarker": string,
  "topP": number,
  "topK": string,
  "temperature": number,
  "seed": integer
}
Campos
enableUserDefinedClassifier

boolean

Opcional. Indica se o classificador definido pelo usuário será ativado e incluído.

preamble

string

Opcional. O preâmbulo a ser usado para o classificador definido pelo usuário.

modelId

string

Opcional. O ID do modelo a ser usado para o classificador definido pelo usuário.

taskMarker

string

Opcional. O marcador de tarefa a ser usado para o classificador definido pelo usuário.

topP

number

Opcional. O valor de top-p a ser usado para o classificador definido pelo usuário.

topK

string (int64 format)

Opcional. O valor k principal a ser usado para o classificador definido pelo usuário.

temperature

number

Opcional. O valor de temperatura a ser usado para o classificador definido pelo usuário.

seed

integer

Opcional. O valor de semente a ser usado para o classificador definido pelo usuário.