Body

• chunking_settings object

  The 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

    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, amazonbedrock.

  Value is amazonbedrock.

• service_settings object Required

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

  Hide service_settings attributes Show service_settings attributes object

  • access_key string Required

    A valid AWS access key that has permissions to use Amazon Bedrock and access to models for inference requests.

  • model string Required

    The base model ID or an ARN to a custom model based on a foundational model. The base model IDs can be found in the Amazon Bedrock documentation. Note that the model ID must be available for the provider chosen and your IAM user must have access to the model.

    External documentation
  • provider string

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

    • amazontitan - available for text_embedding and completion task types
    • anthropic - available for completion task type only
    • ai21labs - available for completion task type only
    • cohere - available for text_embedding and completion task types
    • meta - available for completion task type only
    • mistral - available for completion task type only
  • region string Required

    The region that your model or ARN is deployed in. The list of available regions per model can be found in the Amazon Bedrock documentation.

    External documentation
  • rate_limit object

    This setting helps to minimize the number of rate limit errors returned from Watsonx. By default, the watsonxai service sets the number of requests allowed per minute to 120.

    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
      • llama service: 3000
      • mistral service: 240
      • openai service and task type text_embedding: 3000
      • openai service and task type completion: 500
      • voyageai service: 2000
      • watsonxai service: 120
  • secret_key string Required

    A valid AWS secret key that is paired with the access_key. For informationg about creating and managing access and secret keys, refer to the AWS documentation.

    External documentation
• task_settings object

  Settings to configure the inference task. These settings are specific to the task type you specified.

  Hide task_settings attributes Show task_settings attributes object

  • max_new_tokens number

    For a completion task, it sets the maximum number for the output tokens to be generated.

    Default value is 64.

  • temperature number

    For a completion task, it is a number between 0.0 and 1.0 that controls the apparent creativity of the results. At temperature 0.0 the model is most deterministic, at temperature 1.0 most random. It should not be used if top_p or top_k is specified.

  • top_k number

    For a completion task, it limits samples to the top-K most likely words, balancing coherence and variability. It is only available for anthropic, cohere, and mistral providers. It is an alternative to temperature; it should not be used if temperature is specified.

  • top_p number

    For a completion task, it is a number in the range of 0.0 to 1.0, to eliminate low-probability tokens. Top-p uses nucleus sampling to select top tokens whose sum of likelihoods does not exceed a certain value, ensuring both variety and coherence. It is an alternative to temperature; it should not be used if temperature is specified.