Skip to content

Commit d2e8015

Browse files
authored
Document userProvided embedders have no templates (#3141)
1 parent b423e3d commit d2e8015

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

reference/api/settings.mdx

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2529,15 +2529,20 @@ If a `field` does not exist in a document, its `value` is `nil`.
25292529

25302530
For best results, build short templates that only contain highly relevant data. If working with a long field, consider [truncating it](https://shopify.github.io/liquid/filters/truncatewords/). If you do not manually set it, `documentTemplate` will include all searchable and non-null document fields. This may lead to suboptimal performance and relevancy.
25312531

2532-
This field is optional but strongly encouraged for all embedders.
2532+
This field is incompatible with `userProvided` embedders.
2533+
2534+
This field is optional but strongly encouraged for all other embedders.
25332535

25342536
##### `documentTemplateMaxBytes`
25352537

25362538
The maximum size of a rendered document template. Longer texts are truncated to fit the configured limit.
25372539

25382540
`documentTemplateMaxBytes` must be an integer. It defaults to `400`.
25392541

2540-
This field is optional for all embedders.
2542+
This field is incompatible with `userProvided` embedders.
2543+
2544+
This field is optional for all other embedders.
2545+
25412546

25422547
##### `dimensions`
25432548

0 commit comments

Comments
 (0)