Body

• chunking_settings object

  Chunking configuration object

  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 higher than 300 or lower than 20 (for sentence strategy) or 10 (for word strategy).

    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 Required

    This parameter is only applicable when using the recursive chunking strategy.

    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] Required

    A list of strings used as possible split points when chunking text with the recursive strategy.

    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

  Value is azureaistudio.

• service_settings object Required
  Hide service_settings attributes Show service_settings attributes object

  • api_key string Required

    A valid API key of your Azure AI Studio model deployment. This key can be found on the overview page for your deployment in the management section of your Azure AI Studio account.

    IMPORTANT: You need to provide the API key only once, during the inference model creation. The get inference endpoint API does not retrieve your API key. After creating the inference model, you cannot change the associated API key. If you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key.

    External documentation
  • endpoint_type string Required

    The type of endpoint that is available for deployment through Azure AI Studio: token or realtime. The token endpoint type is for "pay as you go" endpoints that are billed per token. The realtime endpoint type is for "real-time" endpoints that are billed per hour of usage.

    External documentation
  • target string Required

    The target URL of your Azure AI Studio model deployment. This can be found on the overview page for your deployment in the management section of your Azure AI Studio account.

  • provider string Required

    The model provider for your deployment. Note that some providers may support only certain task types. Supported providers include:

    • cohere - available for text_embedding and completion task types
    • databricks - available for completion task type only
    • meta - available for completion task type only
    • microsoft_phi - available for completion task type only
    • mistral - available for completion task type only
    • openai - available for text_embedding and completion task types
  • rate_limit object

    This setting helps to minimize the number of rate limit errors returned from the service.

    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
      • elastic service and task type chat_completion: 240
      • googleaistudio service: 360
      • googlevertexai service: 30000
      • hugging_face service: 3000
      • jinaai service: 2000
      • mistral service: 240
      • openai service and task type text_embedding: 3000
      • openai service and task type completion: 500
      • voyageai service: 2000
      • watsonxai service: 120
• task_settings object
  Hide task_settings attributes Show task_settings attributes object

  • do_sample number

    For a completion task, instruct the inference process to perform sampling. It has no effect unless temperature or top_p is specified.

  • max_new_tokens number

    For a completion task, provide a hint for the maximum number of output tokens to be generated.

    Default value is 64.

  • temperature number

    For a completion task, control the apparent creativity of generated completions with a sampling temperature. It must be a number in the range of 0.0 to 2.0. It should not be used if top_p is specified.

  • top_p number

    For a completion task, make the model consider the results of the tokens with nucleus sampling probability. It is an alternative value to temperature and must be a number in the range of 0.0 to 2.0. It should not be used if temperature is specified.

  • user string

    For a text_embedding task, specify the user issuing the request. This information can be used for abuse detection.

  • return_documents boolean

    For a rerank task, return doc text within the results.

  • top_n number

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