Check the parameters you can configure for Shaper in pipeline YAML.
YAML Init Parameters
These are the parameters you can specify in pipeline YAML:
Parameter | Type | Possible values | Description |
---|---|---|---|
api_key | Secret | Default: {"type": "env_var", "env_vars": ["OPENAI_API_KEY"], "strict": False} | The OpenAI API key. Required. |
model | String | Default: text-embedding-ada-002 | The name of the model to use. Required. |
dimensions | Integer | Default: None | The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.Optional. |
api_base_url | String | Default: None | Overrides the default base URL for all HTTP requests. Optional. |
organization | String | Default: None | The Organization ID. See OpenAI's production best practices for more information. Optional. |
prefix | String | Default: "" (empty string) | A string to add at the beginning of each text. Required. |
suffix | String | Default: "" (empty string) | A string to add at the end of each text. Required. |
batch_size | Integer | Default: 32 | Number of Documents to encode at once. Required. |
progress_bar | Boolean | True , False Default: True | If True, shows a progress bar when running. Required. |
meta_fields_to_embed | List | Default: None | List of meta fields that will be embedded along with the document text. Optional. |
embedding_separator | String | Default: "\n" | Separator used to concatenate the meta fields to the document text. Required. |
timeout | Float | Default: None | Timeout for OpenAI client calls. If not set, it is inferred from the OPENAI_TIMEOUT environment variable or set to 30.Optional. |
max_retries | Integer | Default: None | Maximum retries to establish contact with OpenAI if it returns an internal error. If not set, it is inferred from the OPENAI_MAX_RETRIES environment variable or set to 5.Optional. |
REST API Runtime Parameters
There are no runtime parameters you can pass to this component when making a request to the Search REST API endpoint.