Sobre os atributos do produto

A Vertex AI para Pesquisa para varejo pode usar os atributos do produto para indexação, atributo dinâmico, capacidade de pesquisa, filtragem e qualidade do modelo. Nesta página, discutimos a definição de configurações de atributos do produto e como elas são tratadas dependendo do método e da configuração usados.

Tipos de atributo

Os atributos do produto podem ter diferentes configurações padrão e opções permitidas, dependendo do tipo.

• Atributos do sistema: os atributos predefinidos do sistema são campos Product existentes que fornecem mais informações sobre o produto. Isso inclui atributos do produto, como marca, disponibilidade, cor e tamanho. Para todos os atributos de sistema disponíveis para produtos, consulte a documentação de referência do Product.

• Atributos personalizados: são atributos extras definidos usando o campo Product.attributes. Por exemplo, isso pode incluir nomes de lojas, fornecedores ou estilo. Para exemplos e limites para atributos personalizados, consulte a documentação de referência do Product.attributes.

• Atributos no nível do inventário: atributos personalizados ou do sistema que fornecem informações no nível da loja sobre o produto. É possível usar atributos de nível de inventário para produtos com propriedades que variam significativamente entre lojas e regiões, como itens de mercado, ou para produtos que têm promoções específicas da loja.

  inventories.price e inventories.originalPrice são atributos de sistema numérico predefinidos pela Vertex AI para Pesquisa para varejo. É possível criar atributos personalizados no nível do inventário, que podem ser textuais ou numéricos. Os atributos no nível do inventário são indexáveis por padrão. A definição de atributos pesquisáveis e dinâmicos não é compatível com atributos em nível de inventário.

Configurações disponíveis

As definições de configuração de atributos afetam o comportamento da pesquisa e das recomendações no site.

A pesquisa usa as seguintes configurações de atributos:

• Indexável: a pesquisa pode filtrar e atribuir atributos usando esse atributo.
• Filtros de atributos dinâmicos: a pesquisa pode usar esse atributo automaticamente como um atributo dinâmico com base no comportamento anterior do usuário, como cliques e visualizações. Para ativar o atributo dinâmico para um atributo, Indexable precisa ser definido como verdadeiro para esse atributo.
• Pesquisável: este atributo é pesquisável por consultas de pesquisa, o que aumenta o recall desse atributo. Esse controle é aplicável apenas a atributos de texto.
• Recuperável: se definida como "true", a pesquisa retornará esse atributo em respostas a consultas de pesquisa. Se todos os atributos tiverem "Recuperável" definido como falso, os resultados da pesquisa conterão apenas o nome do produto ou, para variantes, o nome do produto e as informações de cor.

A seção "Recomendações" usa as seguintes configurações de atributos:

• Filtrável (pré-lançamento público): esse atributo pode ser usado em expressões de filtro de recomendações. Esse controle é aplicável apenas a atributos de texto.

Indexável

Se um atributo estiver definido como indexável, a pesquisa poderá filtrar um atributo usando o atributo.

• Atributos do sistema: a indexação está sempre ativada para atributos predefinidos do sistema. Não é possível desativar essa configuração para atributos do sistema.
• Atributos personalizados: ativados por padrão. É possível desativar a indexabilidade de qualquer atributo personalizado. Se você planeja tornar um atributo personalizado indexável, ele precisa seguir o padrão de regex [a-zA-Z0-9][a-zA-Z0-9_]*. Por exemplo, key0LikeThis ou KEY_1_LIKE_THIS.
• Atributos de nível de inventário: sempre ativados para atributos em nível de inventário do sistema. Essa configuração não pode ser alterada. Ativado por padrão para atributos personalizados no nível do inventário. Essa configuração pode ser desativada.
• Dependências: N/A

As mudanças na configuração do índice entram em vigor imediatamente após a importação dos dados do catálogo. Caso contrário, pode levar até 12 horas ou mais para que as alterações entrem em vigor. É possível testar se as mudanças foram aplicadas na página Avaliar.

Atributos dinâmicos

Quando os filtros de atributos dinâmicos estão ativados para um atributo, a pesquisa pode usá-lo como um atributo dinâmico. Os atributos dinâmicos podem ser adicionados automaticamente a uma pesquisa com base no comportamento anterior do usuário, como cliques e visualizações.

• Atributos do sistema: ativados por padrão se a indexabilidade estiver definida como verdadeira. É possível desativar os atributos dinâmicos de qualquer atributo do sistema.
• Atributos personalizados: ativados por padrão se a indexabilidade estiver definida como verdadeira. É possível desativar os atributos dinâmicos para qualquer atributo personalizado.
• Atributos no nível do inventário: não compatíveis.
• Dependências: para ativar a criação de atributos dinâmicos, é necessário primeiro ativar a indexabilidade desse atributo.

A definição do atributo dinâmico para um atributo sempre global. A configuração de atributos dinâmicos aplicada a esse atributo é usada por produtos no catálogo que o utilizam.

As mudanças na configuração do atributo dinâmico levam até dois dias. É possível testar se as mudanças foram aplicadas na página Avaliar.

Para atributos numéricos personalizados, os buckets precisam ser especificados na solicitação. Os valores numéricos não são agrupados automaticamente.

Pesquisável

Se um atributo for definido como pesquisável, o recall desse atributo em consultas de pesquisa será aprimorado.

Somente valores de atributos textuais podem ter a pesquisa ativada. Ele não se aplica a atributos numéricos.

• Atributos do sistema: os atributos de sistema textual predefinidos para Product têm as configurações de pesquisa definidas pela Vertex AI para Pesquisa para varejo. Não é possível mudar essas configurações.
• Atributos personalizados: desativados por padrão. É possível ativar essa configuração para qualquer atributo textual personalizado.
• Atributos no nível do inventário: não compatíveis.
• Dependências: N/A

Embora os produtos com um atributo pesquisável tenham mais chances de aparecer nos resultados da pesquisa para esse atributo, não há garantia de que eles apareçam.

Filtragem de recomendações

Atenção: esse recurso está em pré-lançamento público.

Se um atributo tiver a filtragem de recomendações ativada, ele poderá ser usado em expressões de filtro de recomendações para filtrar produtos nas previsões.

• Atributos do sistema: desativados por padrão. Você pode ativar essa configuração para qualquer atributo de texto do sistema predefinido para Product, exceto FulfillmentInfo e title. Incompatível com atributos numéricos.
• Atributos personalizados: desativados por padrão. É possível ativar essa configuração para qualquer atributo de texto personalizado para Product. Incompatível com atributos numéricos.
• Atributos no nível do inventário: compatíveis apenas com o valor availability IN_STOCK.
• Dependências: N/A

Modos de configuração

O modo de configuração determina como as configurações do atributo são tratadas e quais podem ser definidas.

• Modo de configuração no nível do catálogo (padrão): nesse modo, as configurações de atributos no nível do catálogo são usadas como a fonte da verdade.
• Modo de configuração no nível do produto (descontinuado): nesse modo, as configurações de atributos no nível do produto são usadas como a fonte da verdade.

Antes, a configuração no nível do produto era o modo padrão. Se você ainda estiver no modo de configuração no nível do produto e precisar alternar para o modo de configuração no nível de catálogo, entre em contato com o suporte. A pesquisa não oferece suporte para retornar ao modo de configuração no nível do produto depois da troca.

Para verificar o modo de configuração, acesse a página Controles do console da Pesquisa for Retail. Se a opção Indexable estiver disponível como uma coluna na guia Controles em todo o site, o modelo de configuração estará no nível de catálogo. Se a coluna Indexável não estiver disponível na guia Controles em todo o site, o modelo de configuração está no nível do produto.

Métodos de configuração

Você pode definir configurações de atributos das seguintes maneiras:

• Console da Pesquisa para varejo: defina configurações de atributos no nível do catálogo usando o console da Pesquisa for Retail. Isso configura atributos globalmente em todos os produtos. Quais dessas configurações estão disponíveis no console depende do modo de configuração.

• O método da API AttributeConfig: defina configurações de atributos no nível do catálogo usando a API. Isso configura atributos em todos os produtos.

• O método de API Product (descontinuado): defina atributos personalizados no nível do produto usando o método de API Product. A definição de atributos com esse método não está disponível para novos usuários e não é recomendada.

Configurar atributos no console

É possível definir opções de atributo globalmente em todos os produtos na página Controles do console da Pesquisa for Retail na guia Controles em todo o site. Para mais detalhes sobre como definir isso no console, consulte Gerenciar controles de atributos em todo o site.

Para usar esse recurso, o modo de configuração precisa estar no nível de catálogo.

As mudanças nas definições de configuração de atributos para indexáveis e pesquisáveis entram em vigor imediatamente após a ingestão do catálogo. Caso contrário, pode levar até 12 horas ou mais para que as alterações entrem em vigor. É possível testar se as mudanças foram aplicadas na página Avaliar.

Configurar atributos com AttributesConfig

O recurso da API AttributesConfig permite gerenciar as configurações de atributos no nível do catálogo.

Os campos a seguir definem opções de atributo no nível do catálogo:

• CatalogAttribute.indexableOption: define a opção indexável para um atributo.
• CatalogAttribute.dynamicFacetableOption: define a opção de filtros dinâmicos para um atributo.
• CatalogAttribute.searchableOption: define a opção pesquisável de um atributo.
• CatalogAttribute.recommendationsFilteringOption (Acesso antecipado): define a opção de filtragem de recomendações para um atributo.

Para recuperar todas as configurações de atributos, use o método GetAttributesConfig.

Atualizar vários atributos

Use o método updateAttributesConfig para atualizar vários atributos no nível do catálogo.

Os atributos de catálogo incluídos na solicitação são atualizados no catálogo ou inseridos, se não existirem. Se não houver valor nesse campo, um valor padrão será atribuído a ele.

O número máximo de atributos de catálogo permitidos em uma solicitação é 1.000.

Atualizar um atributo individual

Os métodos abaixo são usados para atualizar atributos de catálogo individuais:

• AddCatalogAttribute: adiciona uma configuração de atributo individual a um atributo de catálogo.

  Consulte a documentação de referência da API para AddCatalogAttribute.

• ReplaceCatalogAttribute: modifica uma configuração de atributo individual. Isso substitui o CatalogAttribute especificado no AttributesConfig atualizando o atributo de catálogo com o mesmo CatalogAttribute.key.

  Consulte a documentação de referência da API para ReplaceCatalogAttribute.

• RemoveCatalogAttribute: remove uma configuração de atributo individual do AttributesConfig.

  Apenas CatalogAttributes que não estão em uso pelos produtos podem ser excluídos. Se um CatalogAttribute estiver em uso, RemoveCatalogAttribute não o exclui, mas redefine as propriedades de configuração para os valores padrão. CatalogAttribute.inUse será definido como True se o atributo estiver em uso por qualquer produto.

  Consulte a documentação de referência da API para RemoveCatalogAttribute.

Configurar atributos com o método Product (descontinuado)

A definição de atributos com esse método não está disponível para novos usuários e não é recomendada.

Os campos a seguir definem configurações indexáveis e pesquisáveis para um produto específico usando o método de API Product:

• Product.attributes.indexable.
• Product.attributes.searchable. Disponível apenas para atributos personalizados.