Skip to content

Commit 17a6025

Browse files
authored
add the new attirbutes for content customisation (#56)
1 parent 23a7325 commit 17a6025

File tree

4 files changed

+18
-13
lines changed

4 files changed

+18
-13
lines changed

packages/generative-experiences-api-client/README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -86,15 +86,16 @@ client
8686
.then((response) => console.log(response));
8787
```
8888

89-
| Prop name | Type | Default | Description | Notes |
90-
| --- | --- | --- | --- | --- |
91-
| `category` | `string` | N/A | The category to use for retrieving/generating the headlines. | `required` |
92-
| `nbHeadlines` | `number \| undefined` | 4 | The number of headlines to display. | - |
93-
| `source` | `'combined' \| 'generated' \| 'index'` | `index` | The source of the headlines. | - |
94-
| `tone` | `'natural' \| 'friendly' \| 'professional'` | `natural` | The model will use a specific tone when provided. | - |
95-
| `language_code` | `'english' \| 'german' \| 'french'` | `english` | The language code used for generating headlines. | - |
96-
| `content_to_avoid` | `string` | - | The content that the model should avoid when generating headlines. | - |
97-
| `onlyPublished` | `boolean` | `true` | Only display published guides. | - |
89+
| Prop name | Type | Default | Description | Notes |
90+
|------------------|---------------------------------------------| --- |-------------------------------------------------------------------------------------------| --- |
91+
| `category` | `string` | N/A | The category to use for retrieving/generating the headlines. | `required` |
92+
| `nbHeadlines` | `number \| undefined` | 4 | The number of headlines to display. | - |
93+
| `source` | `'combined' \| 'generated' \| 'index'` | `index` | The source of the headlines. | - |
94+
| `tone` | `'natural' \| 'friendly' \| 'professional'` | `natural` | The model will use a specific tone when provided. | - |
95+
| `language_code` | `'english' \| 'german' \| 'french'` | `english` | The language code used for generating headlines. | - |
96+
| `custom_content` | `string` | - | The extended instrcutions that the model should take into account for generating content. | - |
97+
| `keywords` | `string[]` | - | A list of keywords that the model should highlight in the generated content. | - |
98+
| `onlyPublished` | `boolean` | `true` | Only display published guides. | - |
9899

99100
### Shopping Guide Content
100101

@@ -145,7 +146,8 @@ client
145146
| `type` | `'shopping_guide' \| 'category_guide'` | `shopping_guide` | The type of guide to generate. | Used if `source` is `generated` |
146147
| `tone` | `'natural' \| 'friendly' \| 'professional'` | `natural` | The model will use a specific tone when provided. | - |
147148
| `language_code` | `'english' \| 'german' \| 'french'` | `english` | The language code used for generating content. | - |
148-
| `content_to_avoid` | `string` | - | The content that the model should avoid when generating headlines. | - |
149+
| `custom_content` | `string` | - | The extended instrcutions that the model should take into account for generating content. | - |
150+
| `keywords` | `string[]` | - | A list of keywords that the model should highlight in the generated content. | - |
149151
| `onlyPublished` | `boolean` | `true` | Only display published guides. | - |
150152

151153
### Gather Feedback

packages/generative-experiences-api-client/src/types/shopping-guides-content.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ export type ShoppingGuideContentRequestParameters = {
3131
* @default 'natural'
3232
*/
3333
tone?: string;
34-
content_to_avoid?: string;
34+
custom_content?: string;
35+
keywords?: string[];
3536
};
3637

3738
export type ShoppingGuideContentOptionsForIndex = {

packages/generative-experiences-api-client/src/types/shopping-guides-headlines.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ export type ShoppingGuideHeadlinesRequestParameters = {
3333
* @default 'natural'
3434
*/
3535
tone?: string;
36-
content_to_avoid?: string;
36+
custom_content?: string;
37+
keywords?: string[];
3738
wait?: boolean;
3839
};
3940

packages/generative-experiences-api-client/src/types/shopping-guides-product-comparison.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,6 @@ export type ProductsComparisonOptions = {
1212
* @default 'natural'
1313
*/
1414
tone?: string;
15-
content_to_avoid?: string;
15+
custom_content?: string;
16+
keywords?: string[];
1617
};

0 commit comments

Comments
 (0)