- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- ProductInfo
- OutputSpec
- TitleExample
- ProductTextGenerationSuggestion
- ProductTextGenerationMetadata
Gera um conjunto de conclusões/respostas de texto candidatas com base nas informações do produto.
Solicitação HTTP
POST https://productstudio.googleapis.com/v1/{parent=projects/*}:generateProductText
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
parent |
Obrigatório. Projeto para fazer uma chamada. Precisa se referir ao projeto de um autor da chamada. Formato: |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "titleExamples": [ { object ( |
Campos | |
---|---|
titleExamples[] |
Opcional. Forneça alguns exemplos criados manualmente de melhorias de título que são exclusivas do seu caso de uso. O TiDe é uma ferramenta geral que lida com várias categorias de produtos, mas a identidade da sua marca pode exigir funcionalidades personalizadas. Especifique isso aqui. |
productInfo |
Obrigatório. Informações disponíveis sobre o produto. Usado para informar os modelos de IA generativa. |
outputSpec |
Opcional. Parâmetros de configuração que influenciam diretamente o conteúdo gerado e como ele é renderizado na resposta final. |
Corpo da resposta
Texto gerado para um produto fornecido.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{ "attributes": { string: string, ... }, "title": { object ( |
Campos | |
---|---|
attributes |
Qualquer outro atributo gerado Um objeto com uma lista de pares |
title |
Título gerado. |
description |
Descrição gerada. |
metadata |
Outras informações que os clientes podem querer auditar sobre a geração. |
ProductInfo
Informações disponíveis sobre o produto. Usado para informar os modelos de IA generativa.
Representação JSON |
---|
{
"productAttributes": {
string: string,
...
},
"productImage": {
object ( |
Campos | |
---|---|
productAttributes |
Obrigatório. Um mapeamento de todos os atributos de produto disponíveis. Isso pode incluir título, descrição, marca, gênero, cor, tamanho etc. Um objeto com uma lista de pares |
productImage |
Opcional. Imagem associada ao produto. |
OutputSpec
Parâmetros de configuração que influenciam diretamente o conteúdo gerado e como ele é renderizado na resposta final.
Representação JSON |
---|
{ "workflowId": string, "tone": string, "editorialChanges": string } |
Campos | |
---|---|
workflowId |
Opcional. O fluxo de trabalho a ser executado para os dados de produtos fornecidos. Os fluxos de trabalho podem preencher o título, a descrição ou ambos da resposta. |
tone |
Opcional. O tom de saída desejado para o texto gerado, por exemplo, sério ou casual. |
editorialChanges |
Opcional. Qualquer mudança editorial nos dados de produtos gerados, por exemplo, substituir "Pequeno" por "P", não modificar a cor se ela já estiver presente. |
TitleExample
Um exemplo feito à mão de melhoria no título de um produto. Esses exemplos são fornecidos à IA para melhorar a qualidade dela.
Representação JSON |
---|
{ "productInfo": { string: string, ... }, "finalProductInfo": { string: string, ... }, "titleFormat": string, "category": string } |
Campos | |
---|---|
productInfo |
Obrigatório. Um mapa que contém todas as informações do produto. Por exemplo: {"title": "dress", "description": "A red dress", "brand": "Dresses4All"} Qualquer informação que você possa usar para preencher seu feed de produtos. Um objeto com uma lista de pares |
finalProductInfo |
Obrigatório. Um mapa no mesmo formato de productInfo, mas com todas as melhorias incluídas. Por exemplo, {"brand": "Dresses4All", "product": "dress", "color": "red", ...} Por enquanto, ordene esses atributos na ordem em que você quer que eles apareçam no título final. Por exemplo, o código acima vai se tornar: Dresses4All dress | red Um objeto com uma lista de pares |
titleFormat |
Obrigatório. Os atributos ou atributos aproximados que compõem o título. Por exemplo, o título "Google GShoe M" titleFormat pode ser "marca | produto | tamanho". |
category |
Obrigatório. A categoria do produto. Isso ajuda a IA a entender quando determinados exemplos são mais relevantes do que outros. |
ProductTextGenerationSuggestion
Texto gerado para um produto, incluindo opcionalmente a pontuação de qualidade.
Representação JSON |
---|
{ "text": string, "score": number, "changeSummary": string } |
Campos | |
---|---|
text |
O texto gerado |
score |
O índice de qualidade associado à geração. A heurística foi implementada de acordo com os estilos de implementação da equipe do feedgen. |
changeSummary |
Um breve resumo de todas as mudanças feitas. |
ProductTextGenerationMetadata
Tipo de dados wrapper para metadados associados à geração de texto.
Representação JSON |
---|
{ "metadata": { object } } |
Campos | |
---|---|
metadata |
Metadados são um conceito bastante amplo. Os dados são modelados como um mapa aqui para indicar que não há uma estrutura garantida para a saída além de uma associação simples de chave:valor. O primeiro caso de uso é rastrear palavras adicionadas, removidas ou alteradas nas gerações. |