Add AWS Bedrock rerank model invalid param

[em-le-ts]

Self Checks

• This is only for bug report, if you would like to ask a question, please head to Discussions.
• I have searched for existing issues search for existing issues, including closed ones.
• I confirm that I am using English to submit this report (我已阅读并同意 Language Policy).
• [FOR CHINESE USERS] 请务必使用英文提交 Issue，否则会被关闭。谢谢！:）
• Please do not modify this template :) and fill in all the required fields.

Dify version

v0.14.2

Cloud or Self Hosted

Self Hosted (Docker)

Steps to reproduce

Access setting page -> Add model provider -> AWS Bedrock

• amazon.rerank-v1 -> Got unknown model prefix amazon
• cohere.rerank-v3-5:0
  => "ValidationException: Malformed input request: #: required key [query] not found#: required key [documents] not found#: required key [api_version] not found#: extraneous key [stream] is not permitted#: extraneous key [prompt] is not permitted, please reformat your input and try again."

AWS configuration:

• Using rerank model at tokyo region

✔️ Expected Behavior

No response

❌ Actual Behavior

No response

[dosubot]

Hey @em-le-ts! I'm here to help you with any bugs, questions, or contributions. Let's work together to solve the issue you're facing.

To resolve the "ValidationException: Malformed input request" error when adding the AWS Bedrock rerank model in your self-hosted Dify v0.14.2 setup, ensure the following:

1. Model Credentials: Include the aws_region key in the credentials dictionary. This is mandatory. The aws_access_key_id and aws_secret_access_key are optional if credentials are obtained from the environment.

2. Query and Documents: Ensure the query parameter is a non-empty string, and docs is a list of strings. Both are required.

3. Reranking Configuration: The rerankingConfiguration must include a valid modelArn, constructed using the model and aws_region. Ensure top_n is provided if you want to limit the number of results.

4. AWS Region: The aws_region should be one of the supported regions, such as ap-northeast-1 for Tokyo, as specified in your configuration.

5. Input Parameters: Remove any extraneous keys like stream and prompt from your input, as they are not permitted.

By ensuring these parameters and configurations are correctly set, you should be able to resolve the error ^[1][2].

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Other}

[em-le-ts]

@dosu Currently, I using Dify UI to integration AWS Bedrock model provider, so it can't add any param.
Help me share document for API add model provider with bedrock rerank

[dosubot]

To integrate AWS Bedrock as a model provider using the API, you can refer to the following example and documentation:

1. YAML Configuration: You can use a YAML configuration file to define the model provider. Here's a sample configuration for adding a model provider:

provider: bedrock
label:
  en_US: AWS Bedrock
description:
  en_US: AWS Bedrock's rerank models
icon_small:
  en_US: icon_s_en.svg
icon_large:
  en_US: icon_l_en.svg
background: "#F0F0EB"
help:
  title:
    en_US: Get your AWS credentials
  url:
    en_US: https://aws.amazon.com/console/
supported_model_types:
  - rerank
configurate_methods:
  - predefined-model
provider_credential_schema:
  credential_form_schemas:
    - variable: aws_access_key_id
      label:
        en_US: Access Key ID
      type: secret-input
      required: true
      placeholder:
        en_US: Enter your AWS Access Key ID
    - variable: aws_secret_access_key
      label:
        en_US: Secret Access Key
      type: secret-input
      required: true
      placeholder:
        en_US: Enter your AWS Secret Access Key
    - variable: aws_region
      label:
        en_US: AWS Region
      type: text-input
      required: true
      placeholder:
        en_US: Enter your AWS Region
models:
  rerank:
    predefined:
      - "models/rerank/*.yaml"
    position: "models/rerank/_position.yaml"
extra:
  python:
    provider_source: provider/bedrock.py
    model_sources:
      - "models/rerank/rerank.py"

2. Python Implementation: Implement the provider class in Python. Here's a basic example:

import logging
from dify_plugin.entities.model import ModelType
from dify_plugin.errors.model import CredentialsValidateFailedError
from dify_plugin import ModelProvider

logger = logging.getLogger(__name__)

class BedrockProvider(ModelProvider):
    def validate_provider_credentials(self, credentials: dict) -> None:
        try:
            model_instance = self.get_model_instance(ModelType.RERANK)
            model_instance.validate_credentials(model="your-model-id", credentials=credentials)
        except CredentialsValidateFailedError as ex:
            raise ex
        except Exception as ex:
            logger.exception(f"{self.get_provider_schema().provider} credentials validate failed")
            raise ex

These examples illustrate how to configure and implement a model provider using the Dify API. For more detailed instructions, you can refer to the Dify documentation on creating model providers ^[1].

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Other}

[em-le-ts]

Hi team, please help me review this bug.
Or guild me if missing any information.
Thanks.

[crazywoola]

Please check the version 0.15.0, we have several fixes related to bedrock since 0.14.2.

[em-le-ts]

hi @crazywoola , I updated latest version ( v0.15.0 ), but this issue not fixed ( same error as description )
Please help check again 🙏

[pandabearambat]

Hi this bug is currently still exist, im using the renrank model either and its happening only via curl api cli and not from preview on the same workflow id
Invoke-WebRequest : {"code": "invalid_param", "message": "Run failed: [bedrock] Error: PluginInvokeError: {"args":{"description":"[models] Error: An error occurred
(ValidationException) when calling the Rerank operation: Cannot provide numberOfResults value that exceeds the number of
sources."},"error_type":"InvokeError","message":"[models] Error: An error occurred (ValidationException) when calling the Rerank operation: Cannot provide numberOfResults
value that exceeds the number of sources."}", "status": 400}
At line:15 char:1

• Invoke-WebRequest -Uri "http://iltlvvmappium1.net.plm.eds.com/v1/chat ...

•   + CategoryInfo          : InvalidOperation: (System.Net.HttpWebRequest:HttpWebRequest) [Invoke-WebRequest], WebException
    + FullyQualifiedErrorId : WebCmdletWebResponseException,Microsoft.PowerShell.Commands.InvokeWebRequestCommand