Seções da documentação

Procedência

Todo resultado diz como foi calculado: cada resultado de calculadora, cada item de lote e cada resultado de trabalho traz um objeto provenance com os mesmos nove membros. Ele não altera os valores que o acompanham.

Os nove membros

Membros da procedência
Membro	Tipo	Descrição
`method`	string	O que calculou os valores: calculator:<slug>, ou o método do handler de um trabalho.
`version`	string	O motor que os calculou, <component>@<revision>: api@…, worker@…, mcp@…, web@…. Um build que não sabe a própria revisão diz isso (api@dev).
`formulaRef`	string \| null	A fonte publicada da fórmula, ou null quando nenhuma é citada.
`assumptions`	{code, text}[]	O que o método supõe. Vazio significa que nenhuma premissa é declarada, não que não haja nenhuma.
`validRange`	object	status (inside, outside ou unknown), os limites de cada entrada com a sua unidade, as entradas fora deles e, quando houver, a faixa validada e o erro no pior caso de um modelo ajustado.
`computedAt`	string	Quando, em ISO-8601 em UTC, com milissegundos.
`inputs`	object	As entradas a partir das quais os valores foram calculados, depois de aplicados os padrões.
`seed`	integer \| null	A semente de um cálculo aleatório; null em todas as calculadoras.
`elapsedSeconds`	number	Quanto tempo o cálculo levou.

Entradas fora da faixa declarada

Uma entrada fora da faixa para a qual uma calculadora é declarada ainda é calculada. validRange.status passa a ser outside, validRange.outside nomeia a entrada, e um aviso que nomeia a entrada e o limite é adicionado a warnings. Quando uma calculadora usa um modelo ajustado, validRange.model dá a faixa validada do modelo e o seu erro no pior caso, e se as entradas estavam dentro dela.

Resultados antigos

Um resultado guardado antes de setembro de 2026 traz apenas method, version, seed, inputs e elapsedSeconds: interprete um membro ausente como desconhecido, não como vazio. Novos membros podem ser adicionados; nenhum é renomeado ou removido.

curl -X POST https://rftools.io/api/py/v1/calculate \
  -H "X-API-Key: $RFTOOLS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "vswr-return-loss",
    "inputs": {
      "vswr": 150
    }
  }'

import rftools

client = rftools.Client()  # reads RFTOOLS_API_KEY, or the key `rftools login` saved

result = client.calculate("vswr-return-loss", {"vswr": 150})
print(result.values)
print(result.warnings, result.provenance.formula_ref)

const response = await fetch("https://rftools.io/api/py/v1/calculate", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.RFTOOLS_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "slug": "vswr-return-loss",
    "inputs": {
      "vswr": 150
    }
  }),
});
console.log(response.status, await response.json());

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	body := []byte(`{
	  "slug": "vswr-return-loss",
	  "inputs": {
	    "vswr": 150
	  }
	}`)
	req, err := http.NewRequest("POST", "https://rftools.io/api/py/v1/calculate", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("RFTOOLS_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.Status, string(out))
}

application/json

{
  "slug": "vswr-return-loss",
  "values": {
    "gamma": 0.9867549668874173,
    "returnLoss": 0.11581357761790759,
    "mismatchLoss": 15.798026442026972,
    "reflectedPct": 97.3685364676988,
    "transmittedPct": 2.6314635323012037
  },
  "warnings": [
    "Input 'vswr' = 150 is outside the range this calculator is stated for (1 to 100 :1); the result is extrapolated."
  ],
  "errors": [],
  "provenance": {
    "method": "calculator:vswr-return-loss",
    "version": "api@3f2c1a9b04de",
    "formulaRef": "Pozar, \"Microwave Engineering\" 4th ed., Chapter 2",
    "assumptions": [],
    "validRange": {
      "status": "outside",
      "bounds": {
        "vswr": {
          "min": 1,
          "max": 100,
          "unit": ":1"
        }
      },
      "outside": [
        "vswr"
      ],
      "model": null
    },
    "computedAt": "2026-09-24T14:05:11.003Z",
    "inputs": {
      "vswr": 150
    },
    "seed": null,
    "elapsedSeconds": 0.003
  }
}

Calculado, sinalizado em validRange.outside, com um aviso.

{
  "slug": "vswr-return-loss",
  "values": {
    "gamma": 0.3333333333333333,
    "returnLoss": 9.54242509439325,
    "mismatchLoss": 0.5115252244738131,
    "reflectedPct": 11.11111111111111,
    "transmittedPct": 88.88888888888889
  },
  "warnings": [],
  "errors": [],
  "provenance": {
    "method": "calculator:vswr-return-loss",
    "version": "api@3f2c1a9b04de",
    "formulaRef": "Pozar, \"Microwave Engineering\" 4th ed., Chapter 2",
    "assumptions": [],
    "validRange": {
      "status": "inside",
      "bounds": {
        "vswr": {
          "min": 1,
          "max": 100,
          "unit": ":1"
        }
      },
      "outside": [],
      "model": null
    },
    "computedAt": "2026-09-24T14:05:11.003Z",
    "inputs": {
      "vswr": 2
    },
    "seed": null,
    "elapsedSeconds": 0.003
  }
}