Skip to content

Commit

Permalink
Add missing similarity_threshold parameter to API parameters page (#204)
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul-Cornell authored Sep 3, 2024
1 parent cbf0a03 commit 156ccc2
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions api-reference/api-services/api-parameters.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ The following parameters only apply when a chunking strategy is specified. Other
| `new_after_n_chars` (_int_) | `newAfterNChars` (_number_) | Applies only when the chunking strategy is specified. Cuts off new sections after reaching a length of `n` characters. (This is a soft maximum.) Default: 1500. |
| `overlap` (_int_) | `overlap` (_number_) | A prefix of this many trailing characters from the prior text-split chunk is applied to second and later chunks formed from oversized elements by text-splitting. Default: none. |
| `overlap_all` (_bool_) | `overlapAll` (_boolean_) | True to have an overlap also applied to "normal" chunks formed by combining whole elements. Use with caution, as this can introduce noise into otherwise clean semantic units. Default: none. |
| `similarity_threshold` (_float_) | `similarityThreshold` (_number_) | Applies only when the chunking strategy is set to `by_similarity`. The minimum similarity text in consecutive elements must have to be included in the same chunk. Must be between 0.0 and 1.0, exclusive (0.01 to 0.99, inclusive). Default: 0.5. |

The following parameters are specific to the Python and Javascript/TypeScript clients and are not sent to the server. [Learn more](/api-reference/api-services/sdk-python#page-splitting).

Expand Down

0 comments on commit 156ccc2

Please sign in to comment.