Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.syllable.ai/llms.txt

Use this file to discover all available pages before exploring further.

A tool is a function that an agent can use to carry out actions like calling external APIs or looking up information in a data source, as part of following the instructions defined in the prompt. This tool will use Helix to search a website for up-to-date information regarding mortgage interest rates. Helix is a Syllable service that is capable of searching a webpage to answer a specific question. For this tool, we will use Helix to search the Bankrate website for current mortgage interest rates. Helix allows us to search any website directly, making it easy to access and use data that would normally require the integration of a specific API endpoint.  Name the tool search_current_mortgage_rate and copy and paste the following tool schema. 
{
  "type": "endpoint",
  "tool": {
    "type": "function",
    "function": {
      "name": "search_current_mortgage_rate",
      "description": "Look up information about mortgage and interest rates, housing market and economic outlooks, and lender information from a website.",
      "parameters": {
        "type": "object",
        "required": [
          "question",
          "web"
        ],
        "properties": {
          "question": {
            "type": "string",
            "description": "A user question, e.g. What are the current weekly averages for fixed rate mortgages?"
          },
          "web": {
            "type": "string",
            "description": "The website to search, e.g. https://syllable.ai",
            "default": "https://www.bankrate.com/"
          }
        }
      }
    }
  },
  "endpoint": {
    "url": "http://helix-app/v1/search",
    "method": "post",
    "argumentLocation": "body"
  },
  "defaults": null,
  "staticParameters": [
    {
      "name": "web",
      "description": "The website to search.",
      "required": true,
      "type": "string",
      "default": "https://www.bankrate.com/"
    }
  ],
  "result": null
}