API: Financial Report Evaluator - grade based


📖 To learn more, take a look at our complete API

📤 Example Request

  1. Generate an api key below👇

  2. Install node-fetch & add the GOOEY_API_KEY to your environment variables.
    Never store the api key in your code and don't use direcly in the browser.

$ npm install node-fetch
$ export GOOEY_API_KEY=sk-xxxx
  1. Use this sample code to call the API.
    If you encounter any issues, write to us at [email protected] and make sure to include the full code snippet and the error message.
import fetch from 'node-fetch';

const payload = {
  "input_prompt": " \"\"\" \n    Given the human made report: \\n\n   {{ report }} \n    Here is AI generated report: \\n\n    {{ genreport }} \nHere is the finance report: \\n\n{{ financereport }} \n  You are a financial report evaluator assess and evaluate the [gen report] in comparison with the [report]. Please ensure AI report maintains coherence, accuracy, and consistency with prior non-AI-generated reports. Grade the [gen report] on a scale of 1 to 5. 1 being the reports dont match at all, and 5 being that the reports match very well and to extreme technical accuracy. \n\n    Criteria: \n      - relevance: Is the AI generated report similar in writing and communication style and flow of report to the human made report?\"\n      - accuracy: Is the AI generated report accurate in technical terminology\n     - comparative consistent: Is the AI generated report comparable in same level of depth, insight, and accuracy as human made report?\n     - logical coherence: Does the AI generated report have logical flow and structure?\n     - fact and number checker: Does the AI generated report consistent and logical match the numbers and facts mentioned in the Finance Report?\n\n    Your response should be as follows:\n\n    GRADE: (1 mark for each criteria being met)\n    (line break)\n    JUSTIFICATION: (Write out in a step by step manner your reasoning about the criterion to be sure that your conclusion is correct. Use one or two sentences maximum. Keep the answer as concise as possible.)\n  IMPROVEMENTS: (Write out in one or two sentences, all the areas in the AI generated report that require improvements in comparison to the human made report)\n    \"\"\"",
  "selected_models": [
    "gpt_3_5_turbo_16k"
  ]
};

async function gooeyAPI() {
  const response = await fetch("https://api.gooey.ai/v2/CompareLLM?example_id=vpp46bk9", {
    method: "POST",
    headers: {
      "Authorization": "bearer " + process.env["GOOEY_API_KEY"],
      "Content-Type": "application/json",
    },
    body: JSON.stringify(payload),
  });

  if (!response.ok) {
    throw new Error(response.status);
  }

  const result = await response.json();
  console.log(response.status, result);
}

gooeyAPI();
  1. Generate an api key below👇

  2. Install requests & add the GOOEY_API_KEY to your environment variables.
    Never store the api key in your code.

$ python3 -m pip install requests
$ export GOOEY_API_KEY=sk-xxxx
  1. Use this sample code to call the API.
    If you encounter any issues, write to us at [email protected] and make sure to include the full code snippet and the error message.
import os
import requests

payload = {
    "input_prompt": ' """ \n    Given the human made report: \\n\n   {{ report }} \n    Here is AI generated report: \\n\n    {{ genreport }} \nHere is the finance report: \\n\n{{ financereport }} \n  You are a financial report evaluator assess and evaluate the [gen report] in comparison with the [report]. Please ensure AI report maintains coherence, accuracy, and consistency with prior non-AI-generated reports. Grade the [gen report] on a scale of 1 to 5. 1 being the reports dont match at all, and 5 being that the reports match very well and to extreme technical accuracy. \n\n    Criteria: \n      - relevance: Is the AI generated report similar in writing and communication style and flow of report to the human made report?"\n      - accuracy: Is the AI generated report accurate in technical terminology\n     - comparative consistent: Is the AI generated report comparable in same level of depth, insight, and accuracy as human made report?\n     - logical coherence: Does the AI generated report have logical flow and structure?\n     - fact and number checker: Does the AI generated report consistent and logical match the numbers and facts mentioned in the Finance Report?\n\n    Your response should be as follows:\n\n    GRADE: (1 mark for each criteria being met)\n    (line break)\n    JUSTIFICATION: (Write out in a step by step manner your reasoning about the criterion to be sure that your conclusion is correct. Use one or two sentences maximum. Keep the answer as concise as possible.)\n  IMPROVEMENTS: (Write out in one or two sentences, all the areas in the AI generated report that require improvements in comparison to the human made report)\n    """',
    "selected_models": ["gpt_3_5_turbo_16k"],
}

response = requests.post(
    "https://api.gooey.ai/v2/CompareLLM?example_id=vpp46bk9",
    headers={
        "Authorization": "bearer " + os.environ["GOOEY_API_KEY"],
    },
    json=payload,
)
assert response.ok, response.content

result = response.json()
print(response.status_code, result)
  1. Generate an api key below👇

  2. Install curl & add the GOOEY_API_KEY to your environment variables.
    Never store the api key in your code.

export GOOEY_API_KEY=sk-xxxx
  1. Run the following curl command in your terminal.
    If you encounter any issues, write to us at [email protected] and make sure to include the full curl command and the error message.
curl 'https://api.gooey.ai/v2/CompareLLM?example_id=vpp46bk9' \
  -H "Authorization: bearer $GOOEY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "input_prompt": " \"\"\" \n    Given the human made report: \\n\n   {{ report }} \n    Here is AI generated report: \\n\n    {{ genreport }} \nHere is the finance report: \\n\n{{ financereport }} \n  You are a financial report evaluator assess and evaluate the [gen report] in comparison with the [report]. Please ensure AI report maintains coherence, accuracy, and consistency with prior non-AI-generated reports. Grade the [gen report] on a scale of 1 to 5. 1 being the reports dont match at all, and 5 being that the reports match very well and to extreme technical accuracy. \n\n    Criteria: \n      - relevance: Is the AI generated report similar in writing and communication style and flow of report to the human made report?\"\n      - accuracy: Is the AI generated report accurate in technical terminology\n     - comparative consistent: Is the AI generated report comparable in same level of depth, insight, and accuracy as human made report?\n     - logical coherence: Does the AI generated report have logical flow and structure?\n     - fact and number checker: Does the AI generated report consistent and logical match the numbers and facts mentioned in the Finance Report?\n\n    Your response should be as follows:\n\n    GRADE: (1 mark for each criteria being met)\n    (line break)\n    JUSTIFICATION: (Write out in a step by step manner your reasoning about the criterion to be sure that your conclusion is correct. Use one or two sentences maximum. Keep the answer as concise as possible.)\n  IMPROVEMENTS: (Write out in one or two sentences, all the areas in the AI generated report that require improvements in comparison to the human made report)\n    \"\"\"",
  "selected_models": [
    "gpt_3_5_turbo_16k"
  ]
}'

🎁 Example Response

{4 Items
"id"
:
string
"trun63cxq2go"
"url"
:
string
"https://gooey.ai/compare-large-language-models/"
"created_at"
:
string
"2023-09-19T04:50:04.252548+00:00"
"output"
:
{1 Items
"output_text"
:
{1 Items
"gpt_3_5_turbo_16k"
:
[
]1 Items
}
}
}

Please Login to generate the $GOOEY_API_KEY