Skip to content

Commit e2ef1b2

Browse files
committed
chen - update doc
Signed-off-by: Jialiang Liang <jiallian@amazon.com>
1 parent 1bd30fa commit e2ef1b2

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

docs/user/ppl/interfaces/endpoint.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,16 @@ Expected output (trimmed):
280280
| `post_tags` | Array of string | No | Tags inserted after highlighted tokens. Defaults to `</em>`. |
281281
| `fragment_size` | Integer | No | Maximum character size of a highlight fragment. Defaults to `100`. |
282282

283+
### Limits
284+
285+
| Constraint | Max value | Description |
286+
|---|---|---|
287+
| Highlight fields | 100 | Maximum number of fields in the `highlight` array or `fields` object. |
288+
| Pre/post tags | 10 | Maximum number of entries in each `pre_tags` or `post_tags` array. |
289+
| Fragment size | > 0 | Must be a positive integer. |
290+
291+
Exceeding these limits returns an error.
292+
283293
### Notes
284294

285295
- Highlighting requires a search term in the PPL statement (e.g. `source=accounts "Holmes"`). Without a search term (e.g. just `source=accounts`), the `highlights` array entries will be empty.

0 commit comments

Comments
 (0)