Body Required

• chunking_settings object

  The chunking configuration object. Applies only to the text_embedding task type. Not applicable to the rerank, completion, or chat_completion task types.

  External documentation
  Hide chunking_settings attributes Show chunking_settings attributes object

  • max_chunk_size number

    The maximum size of a chunk in words. This value cannot be lower than 20 (for sentence strategy) or 10 (for word strategy). This value should not exceed the window size for the associated model.

    Default value is 250.

  • overlap number

    The number of overlapping words for chunks. It is applicable only to a word chunking strategy. This value cannot be higher than half the max_chunk_size value.

    Default value is 100.

  • sentence_overlap number

    The number of overlapping sentences for chunks. It is applicable only for a sentence chunking strategy. It can be either 1 or 0.

    Default value is 1.

  • separator_group string

    Only applicable to the recursive strategy and required when using it.

    Sets a predefined list of separators in the saved chunking settings based on the selected text type. Values can be markdown or plaintext.

    Using this parameter is an alternative to manually specifying a custom separators list.

  • separators array[string]

    Only applicable to the recursive strategy and required when using it.

    A list of strings used as possible split points when chunking text.

    Each string can be a plain string or a regular expression (regex) pattern. The system tries each separator in order to split the text, starting from the first item in the list.

    After splitting, it attempts to recombine smaller pieces into larger chunks that stay within the max_chunk_size limit, to reduce the total number of chunks generated.

  • strategy string

    The chunking strategy: sentence, word, none or recursive.

    • If strategy is set to recursive, you must also specify:

      • max_chunk_size
      • either separators orseparator_group

    Learn more about different chunking strategies in the linked documentation.

    Default value is sentence.

    External documentation
• service string Required

  The type of service supported for the specified task type. In this case, openshift_ai.

  Value is openshift_ai.

• service_settings object Required

  Settings used to install the inference model. These settings are specific to the openshift_ai service.

  Hide service_settings attributes Show service_settings attributes object

  • api_key string Required

    A valid API key for your OpenShift AI endpoint. Can be found in Token authentication section of model related information.

  • url string Required

    The URL of the OpenShift AI hosted model endpoint.

  • model_id string

    The name of the model to use for the inference task. Refer to the hosted model's documentation for the name if needed. Service has been tested and confirmed to be working with the following models:

    • For text_embedding task - gritlm-7b.
    • For completion and chat_completion tasks - llama-31-8b-instruct.
    • For rerank task - bge-reranker-v2-m3.
  • max_input_tokens number

    For a text_embedding task, the maximum number of tokens per input before chunking occurs.

  • similarity string

    For a text_embedding task, the similarity measure. One of cosine, dot_product, l2_norm.

    Values are cosine, dot_product, or l2_norm.

  • rate_limit object

    This setting helps to minimize the number of rate limit errors returned from the OpenShift AI API. By default, the openshift_ai service sets the number of requests allowed per minute to 3000.

    Hide rate_limit attribute Show rate_limit attribute object

    • requests_per_minute number

      The number of requests allowed per minute. By default, the number of requests allowed per minute is set by each service as follows:

      • alibabacloud-ai-search service: 1000
      • anthropic service: 50
      • azureaistudio service: 240
      • azureopenai service and task type text_embedding: 1440
      • azureopenai service and task type completion: 120
      • cohere service: 10000
      • contextualai service: 1000
      • elastic service and task type chat_completion: 240
      • googleaistudio service: 360
      • googlevertexai service: 30000
      • hugging_face service: 3000
      • jinaai service: 2000
      • llama service: 3000
      • mistral service: 240
      • openai service and task type text_embedding: 3000
      • openai service and task type completion: 500
      • openshift_ai service: 3000
      • voyageai service: 2000
      • watsonxai service: 120
• task_settings object

  Settings to configure the inference task. Applies only to the rerank task type. Not applicable to the text_embedding, completion, or chat_completion task types. These settings are specific to the task type you specified.

  Hide task_settings attributes Show task_settings attributes object

  • return_documents boolean

    For a rerank task, whether to return the source documents in the response.

  • top_n number

    For a rerank task, the number of most relevant documents to return.