LLM Proxy

List of messages to send to the endpoint in the OpenAI style, each of them following this format:

messages=[
  {"role": "system", // Available choices are user, system or assistant
   "content": "You are a helpful assistant."
  },
  {"role": "user", "content": "Hello!"}
]

Image processing: If you want to use the image processing feature, you need to use the following format to upload the image.

{
  "role": "user",
  "content": [
    {
        "type": "text",
        "text": "What’s in this image?"
    },
    {
        "type": "image_url",
        "image_url": {
        "url": "https://as1.ftcdn.net/v2/jpg/01/34/53/74/1000_F_134537443_VendrqyXIWyHrZgxdIsfyKUost734JDP.jpg"
        }
    }
  ]
}

Specify which model to use. See the list of model here

Whether to stream back partial progress token by token

A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide an array of functions the model may generate JSON inputs for.

{
    "type": "function",
    "function": {
      "name": "get_current_weather",
      "description": "Get the current weather in a given location",
      "parameters": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "description": "The city and state, e.g. San Francisco, CA"
          },
          "unit": {
            "type": "string",
            "enum": ["celsius", "fahrenheit"]
          }
        },
        "required": ["location"]
      }
    }
  }

Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools.

none is the default when no tools are present. auto is the default if tools are present.

Specifying a particular tool via the code below forces the model to call that tool.

{
  "type": "function",
  "function": {"name": "name_of_the_function"},
}

Specify how much to penalize new tokens based on their existing frequency in the text so far. Decreases the model’s likelihood of repeating the same line verbatim

Maximum number of tokens to generate in the response

Controls randomness in the output in the range of 0-2, higher temperature will a more random response.

How many chat completion choices are generated for each input message.

Caveat! While this can help improve generation quality by picking the optimal choice, this could also lead to more token usage.

Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

Echo back the prompt in addition to the completion

Stop sequence

Specify how much to penalize new tokens based on whether they appear in the text so far. Increases the model’s likelihood of talking about new topics

Used to modify the probability of tokens appearing in the response

An object specifying the format that the model must output. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models newer than gpt-3.5-turbo-1106.

Setting to { "type": "json_object" } enables JSON mode, which guarantees the message the model generates is valid JSON.

You must have a “json” as a keyword in the prompt to use this feature.

response_schema = {
    "type": "array", # or "string", "number", "object", "boolean"....
    "items": { # items only for array type
        "type": "object", 
        "properties": {  # properties only for object type
          "number": { "type": "number" },
          "street_name": { "type": "string" },
          "street_type": { "enum": ["Street", "Avenue", "Boulevard"] }
        } 
    },
}

response_format={
        "type": "json_object",
        "response_schema": response_schema,
    },

Whether to enable parallel function calling during tool use.

Balance the load of your requests between different models. See the details of load balancing here.

{
// you don't need to specify the model parameter, otherwise, the model parameter will overwrite the load balance group
    "messages": [
        {
            "role": "user",
            "content": "Hi, how are you?"
        }
    ],
    "load_balance_group": {
        "group_id":"THE_GROUP_ID" // from Load balancing page
    }
}

{
  "load_balance_group": {
      "group_id":"THE_GROUP_ID", // from Load balancing page
      "models": [
        {
          "model": "azure/gpt-35-turbo",
          "weight": 1
        },
        {
          "model": "azure/gpt-4",
          "credentials": { // add your own credentials if you want to use your own Azure credentials or custom model name
              "api_base": "Your own Azure api_base",
              "api_version": "Your own Azure api_version",
              "api_key": "Your own Azure api_key"
          },
          "weight": 1
        } 
      ]
  }
}

Specify the list of backup models (ranked by priority) to respond in case of a failure in the primary model. See the details of fallback models here.

{
// ...other parameters...
  "fallback_models": [
    "gemini/gemini-pro",
    "mistral/mistral-small",
    "gpt-4o"
  ]
}

You can pass in your customer’s credentials for supported providers and use their credits when our proxy is calling models from those providers.
See details here

"customer_credentials": {

  "openai": {
    "api_key": "YOUR_OPENAI_API_KEY",
  }
}

One-off credential overrides. Instead of using what is uploaded for each provider, this targets credentials for individual models.

Go to provider page to see how to add your own credentials and override them for a specific model.

"credential_override": {
    "azure/gpt-4o":{ // override for a specific model.
      "api_key": "your-api-key",
      "api_base": "your-api-base-url",
      "api_version": "your-api-version",
    }
  }

Enable or disable caches. Check the details of caches here.

{
    "cache_enabled": true
}

This parameter specifies the time-to-live (TTL) for the cache in seconds.

{
    "cache_ttl": 3600 // in seconds
}

This parameter specifies the cache options. Currently we support cache_by_customer option, you can set it to true or false. If cache_by_customer is set to true, the cache will be stored by the customer identifier.

{
    "cache_options": { // optional
        "cache_by_customer": true // or false
    }
}

The prompt template to use for the completion. You can build and deploy prompts in the Prompt.

  "prompt_message" [an array of messages]

{
"prompt": {
      "prompt_id": "prompt_id", //paste this from the prompt management page
      "variables": {
        "variable_name": "variable_value"
      },
      "version": 1
      // "echo": true //optional parameter
    }
}

When set to true, only the request and performance metrics will be recorded, input and output messages will be omitted from the log.

Specify the list of models for the Keywords AI LLM router to choose between. If not specified, all models will be used. See the list of models here

If only one model is specified, it will be treated as if the model parameter is used and the router will not trigger.

When the model parameter is used, the router will not trigger, and this parameter behaves as fallback_models.

The list of providers to exclude from the LLM router’s selection. All models under the provider will be excluded. See the list of providers here

This only excludes providers in the LLM router, if model parameter takes precedence over this parameter, andfallback_models and safety net will still use the excluded models to catch failures.

The list of models to exclude from the LLM router’s selection. See the list of models here

This only excludes models in the LLM router, if model parameter takes precedence over this parameter, andfallback_models and safety net will still use the excluded models to catch failures.

You can add any key-value pair to this metadata field for your reference. Check the details of metadata here.

Contact team@keywordsai.co if you need extra parameter support for your use case.

{
  "my_value_key": "my_value"
}

Use this as a tag to identify the user associated with the API call. See the details of customer identifier here.

{
    //...other_params,
    "customer_identifier": "user_123"
}

This is the email address of the user associated with the API call. You can add your corresponding user’s email address to the request.

You could also edit customer’s emails on the platform. Check the details of user editing here.

{
    //...other_params,
    "customer_email": "hendrix@keywordsai.co"
}

See logs as a conversation log thread. Pass all logs with the same thread_identifier to see them in the same thread.

{
    //...other_params,
    "thread_identifier": "test_thread"
}

Adding this returns the summarization of the response in the response body. If streaming is on, the metrics will be streamed as the last chunk.

You can pass in a dictionary of your customer’s API keys for specific models. If the router selects a model that is in the dictionary, it will attempt to use the customer’s API key for calling the model before using your integration API key or Keywords AI’s default API key.

{
  "gpt-3.5-turbo": "your_customer_api_key",
  "gpt-4": "your_customer_api_key"
}

Balance the load of your requests between different models. See the details of load balancing here.

{
  // ...other parameters...
  "loadbalance_models": [
      {
          "model": "claude-3-5-sonnet-20240620",
          "weight": 34,
          "credentials": { // Your own Anthropic API key, optional for team plan and above
              "api_key": "Your own Anthropic API key"
          }
      },
      {
          "model": "azure/gpt-35-turbo",
          "weight": 34,
          "credentials": { // Your own Azure credentials, optional for team plan and above
              "api_base": "Your own Azure api_base",
              "api_version": "Your own Azure api_version",
              "api_key": "Your own Azure api_key"
          }
      }
  ]
}