- HTTP リクエスト
- パスパラメータ
- リクエストの本文
- レスポンスの本文
- ProductInfo
- OutputSpec
- TitleExample
- ProductTextGenerationSuggestion
- ProductTextGenerationMetadata
商品情報から候補テキストの補完/レスポンスのセットを生成します。
HTTP リクエスト
POST https://productstudio.googleapis.com/v1/{parent=projects/*}:generateProductText
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
parent |
必須。呼び出しを行うプロジェクト。呼び出し元のプロジェクトを参照する必要があります。形式: |
リクエストの本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "titleExamples": [ { object ( |
フィールド | |
---|---|
titleExamples[] |
省略可。ユースケースに固有のタイトル改善の例を手作業で作成して提供します。TiDe は複数の商品カテゴリを処理する一般的なツールですが、ブランド アイデンティティにはカスタム機能が必要になる場合があります。ご希望があれば、こちらで指定してください。 |
productInfo |
必須。商品に関する利用可能な情報。生成 AI モデルに情報を伝えるために使用されます。 |
outputSpec |
省略可。生成されるコンテンツと、そのコンテンツが最終的なレスポンスでどのようにレンダリングされるかに直接影響する構成パラメータ。 |
レスポンスの本文
指定された商品に対して生成されたテキスト。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
JSON 表現 |
---|
{ "attributes": { string: string, ... }, "title": { object ( |
フィールド | |
---|---|
attributes |
その他の生成された属性
|
title |
生成されたタイトル。 |
description |
生成された説明。 |
metadata |
クライアントが生成に関する監査を希望する可能性のある追加情報。 |
ProductInfo
商品に関する利用可能な情報。生成 AI モデルに情報を伝えるために使用されます。
JSON 表現 |
---|
{
"productAttributes": {
string: string,
...
},
"productImage": {
object ( |
フィールド | |
---|---|
productAttributes |
必須。使用可能なすべての商品属性のマッピング。これには、タイトル、説明、ブランド、性別、色、サイズなどが含まれます。
|
productImage |
省略可。商品に関連付けられた画像。 |
OutputSpec
生成されるコンテンツと、そのコンテンツが最終的なレスポンスでどのようにレンダリングされるかに直接影響する構成パラメータ。
JSON 表現 |
---|
{ "workflowId": string, "tone": string, "editorialChanges": string } |
フィールド | |
---|---|
workflowId |
省略可。指定された商品データに対して実行するワークフロー。ワークフローは、レスポンスのタイトル、説明、またはその両方を入力できます。 |
tone |
省略可。生成されるテキストの出力トーン(例: serious、casual)。 |
editorialChanges |
省略可。生成された商品データに対する編集上の変更。例: Small を「S」に置き換える。色がすでに存在する場合は変更しない。 |
TitleExample
商品名の改善例を手作業で作成したものです。これらの例は、AI の品質を向上させるために AI に提供されます。
JSON 表現 |
---|
{ "productInfo": { string: string, ... }, "finalProductInfo": { string: string, ... }, "titleFormat": string, "category": string } |
フィールド | |
---|---|
productInfo |
必須。既存のすべての商品情報を含むマップ。例: {"title": "dress", "description": "A red dress", "brand": "Dresses4All"} 商品フィードの入力に使用する可能性のある情報。
|
finalProductInfo |
必須。productInfo と同じ形式のマップですが、すべての改善が含まれています。例: {"brand": "Dresses4All", "product": "dress", "color": "red", ...} 現時点では、これらの属性を最終的なタイトルに表示したい順序で並べます。たとえば、上記は Dresses4All dress | red になります。
|
titleFormat |
必須。タイトルを構成する属性または近似属性。たとえば、タイトル「Google GShoe M」の titleFormat は「brand | product | size」になります。 |
category |
必須。商品のカテゴリ。これにより、AI は特定の例が他の例よりも関連性が高い場合を把握できます。 |
ProductTextGenerationSuggestion
商品用に生成されたテキスト。必要に応じて品質スコアを含めることができます。
JSON 表現 |
---|
{ "text": string, "score": number, "changeSummary": string } |
フィールド | |
---|---|
text |
生成されたテキスト |
score |
生成に関連付けられた品質スコア。feedgen チームの実装スタイルに従って実装されたヒューリスティック。 |
changeSummary |
行われたすべての変更の簡単な要約。 |
ProductTextGenerationMetadata
テキスト生成に関連付けられたメタデータのラッパー データ型。
JSON 表現 |
---|
{ "metadata": { object } } |
フィールド | |
---|---|
metadata |
メタデータはかなり緩い概念です。ここでは、データはマップとしてモデル化されています。これは、単純な K:V 関連付けを超えた出力に保証された構造がないことを示すためです。最初のユースケースは、生成で追加、削除、変更された単語をトラッキングすることです。 |