Skip to content

Commit

Permalink
Update _ingest-pipelines/processors/sparse-encoding.md
Browse files Browse the repository at this point in the history
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: zhichao-aws <[email protected]>
  • Loading branch information
zhichao-aws and kolchfa-aws authored Dec 25, 2024
1 parent 29f79ae commit 18d9228
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion _ingest-pipelines/processors/sparse-encoding.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The following table lists the required and optional parameters for the `sparse_e
|:---|:---|:---|:---|
`model_id` | String | Required | The ID of the model that will be used to generate the embeddings. The model must be deployed in OpenSearch before it can be used in neural search. For more information, see [Using custom models within OpenSearch]({{site.url}}{{site.baseurl}}/ml-commons-plugin/using-ml-models/) and [Neural sparse search]({{site.url}}{{site.baseurl}}/search-plugins/neural-sparse-search/).
`prune_type` | String | Optional | The prune strategy for sparse vectors. Valid values are `max_ratio`, `alpha_mass`, `top_k`, `abs_value` and `none`. Default is `none`.
`prune_ratio` | Float | Optional | The ratio for prune strategy. Once the `prune_type` is provided, `prune_ratio` field is required.
`prune_ratio` | Float | Optional | The ratio for prune strategy. Required when `prune_type` is specified.
`field_map` | Object | Required | Contains key-value pairs that specify the mapping of a text field to a `rank_features` field.
`field_map.<input_field>` | String | Required | The name of the field from which to obtain text for generating vector embeddings.
`field_map.<vector_field>` | String | Required | The name of the vector field in which to store the generated vector embeddings.
Expand Down

0 comments on commit 18d9228

Please sign in to comment.