REST Resource: projects.locations.dataStores.servingConfigs

Recurso: ServingConfig

Configura metadados usados para gerar resultados de veiculação (por exemplo, resultados de 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,
  "guidedSearchSpec": {
    object (GuidedSearchSpec)
  },
  "customFineTuningSpec": {
    object (CustomFineTuningSpec)
  },
  "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 da configuração de veiculação legível por humanos. Usado na interface 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 veiculaçã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 alterado, mas apenas para um modelo compatível (por exemplo, outros-que-você-pode-gostar CTR para outros-que-você-pode-gostar CVR).

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 embedding. A configuração é usada para a 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 esse ServingConfig.embedding_config.
rankingExpression

string

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

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

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

Funções aceitas:

  • 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 documentos 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 embedding doc_embedding, a expressão de classificação poderá ser 0.5 * relevanceScore + 0.3 * dotProduct(doc_embedding).
guidedSearchSpec

object (GuidedSearchSpec)

Configurações de pesquisa guiada.
customFineTuningSpec

object (CustomFineTuningSpec)

Configurações de ajuste fino personalizadas. Se SearchRequest.custom_fine_tuning_spec estiver definido, ele terá maior prioridade do que as configurações definidas aqui.
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora da criação do 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 atualizado do 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 a serem usados 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 veiculação. Máximo de 20 controles de filtro.
boostControlIds[]

string

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

string

IDs dos controles de redirecionamento. Somente a primeira ação de redirecionamento acionada será aplicada, mesmo que várias se apliquem. 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 corresponderem, 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

Condição não associar especificações. Se várias condições não associadas corresponderem, todos os controles não associados 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. Aplicado 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 ignorar especificações. Se várias condições de ignorar corresponderem, 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

Condição promover especificações.

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

object (PersonalizationSpec)

A especificação para a especificação de 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 veiculação.
genericConfig

object (GenericConfig)

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

Métodos

answer

 Método de consulta de resposta.

create

 Cria um ServingConfig.

delete

 Exclui um ServingConfig.

get

 Recebe um ServingConfig.

list

 Lista todos os ServingConfigs vinculados a esse dataStore.

patch

 Atualiza um ServingConfig.

recommend

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

searchLite

 Realiza uma pesquisa.

streamAnswer

 Método de consulta de resposta (streaming).