Method: projects.generateProductText

根据商品信息生成一组候选文本补全/回答。

HTTP 请求

POST https://productstudio.googleapis.com/v1/{parent=projects/*}:generateProductText

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。要拨打电话的项目。必须引用调用者的项目。格式：projects/{project-id}。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "titleExamples": [
    {
      object (TitleExample)
    }
  ],
  "productInfo": {
    object (ProductInfo)
  },
  "outputSpec": {
    object (OutputSpec)
  }
}
字段
titleExamples[]

object (TitleExample)

可选。提供一些针对您的使用情形量身打造的标题改进示例。TiDe 是一款可处理多个产品类别的通用工具，但您的品牌标识可能需要自定义功能。您可以在此处指定。
productInfo

object (ProductInfo)

必需。有关产品的可用信息。用于为生成式 AI 模型提供参考依据。
outputSpec

object (OutputSpec)

可选。直接影响生成的内容以及该内容在最终回答中的呈现方式的配置参数。

响应正文

为指定商品生成的文本。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "attributes": {
    string: string,
    ...
  },
  "title": {
    object (ProductTextGenerationSuggestion)
  },
  "description": {
    object (ProductTextGenerationSuggestion)
  },
  "metadata": {
    object (ProductTextGenerationMetadata)
  }
}
字段
attributes

map (key: string, value: string)

任何其他生成的属性

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
title

object (ProductTextGenerationSuggestion)

生成的标题。
description

object (ProductTextGenerationSuggestion)

生成的说明。
metadata

object (ProductTextGenerationMetadata)

客户可能希望审核的有关生成的其他信息。

ProductInfo

有关产品的可用信息。用于为生成式 AI 模型提供参考依据。

JSON 表示法 
{
  "productAttributes": {
    string: string,
    ...
  },
  "productImage": {
    object (Image)
  }
}
字段
productAttributes

map (key: string, value: string)

必需。所有可用商品属性的映射。这可能包括商品名、说明、品牌、适用性别、颜色、尺寸等。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
productImage

object (Image)

可选。与商品相关联的图片。

OutputSpec

直接影响生成的内容以及该内容在最终回答中的呈现方式的配置参数。

JSON 表示法 
{
  "workflowId": string,
  "tone": string,
  "editorialChanges": string
}
字段
workflowId

string

可选。要针对所提供的商品数据执行的工作流程。工作流可能会填充回答的标题、说明或两者都填充。
tone

string

可选。生成文本所需的输出语气，例如严肃、随意。
editorialChanges

string

可选。对生成的商品数据进行任何编辑更改。例如，将“小号”替换为“S”，如果颜色已存在，则不修改颜色。

TitleExample

手工制作的商品名改进示例。这些示例会提供给 AI，以提升其质量。

JSON 表示法 
{
  "productInfo": {
    string: string,
    ...
  },
  "finalProductInfo": {
    string: string,
    ...
  },
  "titleFormat": string,
  "category": string
}
字段
productInfo

map (key: string, value: string)

必需。包含所有现有产品信息的地图。例如：{"title": "dress", "description": "A red dress", "brand": "Dresses4All"} 您可能用于填充商品 Feed 的任何信息。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
finalProductInfo

map (key: string, value: string)

必需。与 productInfo 格式相同的地图，但包含所有改进。例如，{"brand": "Dresses4All", "product": "dress", "color": "red", ...} 目前，请按您希望这些属性在最终商品名中显示的顺序对它们进行排序。例如，上述属性将变为：Dresses4All dress | red

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
titleFormat

string

必需。构成商品名的属性或近似属性。例如，商品名“Google GShoe M”的 titleFormat 可以是“brand | product | size”。
category

string

必需。商品的类别。这有助于 AI 了解某些示例何时比其他示例更相关。

ProductTextGenerationSuggestion

为商品生成的文本，可以选择性地包含其品质得分。

JSON 表示法 
{
  "text": string,
  "score": number,
  "changeSummary": string
}
字段
text

string

生成的文本
score

number

与生成相关联的质量得分。根据 feedgen 团队的实现风格实现启发式方法。
changeSummary

string

对所有已做出的更改的简要总结。

ProductTextGenerationMetadata

与文本生成关联的任何元数据的封装容器数据类型。

JSON 表示法 
{
  "metadata": {
    object
  }
}
字段
metadata

object (Struct format)

元数据是一个相当宽泛的概念。此处的数据以映射形式呈现，表示输出结果除了简单的 K:V 关联之外，没有其他保证的结构。第一个使用场景是跟踪生成内容中添加/移除/更改的字词。