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

Recurso: ServingConfig

Configura metadados que são usados para gerar resultados de tempo de 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,
  "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 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, a CTR de outros utilizadores que podem gostar para a CVR de outros utilizadores que podem gostar).

Obrigatório quando SolutionType é SOLUTION_TYPE_RECOMMENDATION.
diversityLevel

string

A quantidade de 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.
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.
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 do setor. 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.

MediaConfig

Especifica as configurações necessárias para a descoberta de conteúdo multimédia. Atualmente, suportamos:

  • demote_content_watched: limite para a despromoção de conteúdo visto. Os clientes podem especificar se usam a despromoção de conteúdo visto ou a página de detalhes vista. Com a despromoção de conteúdo visto, os clientes têm de especificar os minutos vistos ou a percentagem que excede o limite. Se o conteúdo exceder o limite, é despromovido 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 a usar a promoção de atualidade do conteúdo. Se o conteúdo tiver sido publicado dentro do período limite, é 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 despromover o resultado da recomendação. Valores atualmente suportados:

  • view-item: artigo visto.
  • media-play: iniciar/retomar a visualização de um vídeo, a reprodução de uma música, etc.
  • media-complete: terminou ou parou a meio de um vídeo, uma música, etc.

Se não estiver definida, a despromoção do histórico de visualizações não é aplicada. A despromoção da atualidade do conteúdo continua a ser aplicada.
demoteContentWatchedPastDays

integer

Opcional. Especifica o número de dias a considerar para despromover conteúdo visto. Se for definido como zero ou não estiver definido, a predefinição é o máximo de 365 dias.
contentFreshnessCutoffDays

integer

Especifica a atualização do conteúdo usado para o resultado da recomendação. O conteúdo é despromovido se tiver sido publicado há mais dias do que o limite de atualização do conteúdo.
Campo de união demote_content_watched. Especifique o limite para despromover conteúdo visto. O limite pode ser uma percentagem ou um valor em minutos. Tem de ser definido para o tipo de evento media-complete. demote_content_watched só pode ser uma das seguintes opções:
contentWatchedPercentageThreshold

number

Especifica o limite percentual de conteúdo visto para a despromoção. O valor do limite tem de estar entre [0 e 1,0], inclusive.
contentWatchedSecondsThreshold

number

Especifica o limite de minutos de conteúdo visto para a despromoção.

GenericConfig

Especifica as configurações necessárias para a descoberta genérica.Atualmente, suportamos:

  • contentSearchSpec: configuração para a 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. Só é válido para um arquivo de dados com a 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 da especificação do classificador especificada pelo utilizador.

UserDefinedClassifierSpec

A especificação do classificador definido pelo utilizador.

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

boolean

Opcional. Se deve ou não ativar e incluir o classificador definido pelo utilizador.
preamble

string

Opcional. O preâmbulo a usar para o classificador definido pelo utilizador.
modelId

string

Opcional. O ID do modelo a usar para o classificador definido pelo utilizador.
taskMarker

string

Opcional. O marcador de tarefa a usar para o classificador definido pelo utilizador.
topP

number

Opcional. O valor top-p a usar para o classificador definido pelo utilizador.
topK

string (int64 format)

Opcional. O valor top-k a usar para o classificador definido pelo utilizador.
temperature

number

Opcional. O valor de temperatura a usar para o classificador definido pelo utilizador.
seed

integer

Opcional. O valor inicial a usar para o classificador definido pelo utilizador.

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