Sections de la documentation

Provenance

Chaque résultat indique comment il a été calculé : chaque résultat de calculateur, chaque élément de lot et chaque résultat de tâche porte un objet provenance avec les mêmes neuf membres. Il ne modifie en rien les valeurs qui l'accompagnent.

Les neuf membres

Membres de la provenance
Membre	Type	Description
`method`	string	Ce qui a calculé les valeurs : calculator:<slug>, ou la méthode du gestionnaire d'une tâche.
`version`	string	Le moteur qui les a calculées, <component>@<revision> : api@…, worker@…, mcp@…, web@…. Une version compilée qui ne connaît pas sa révision le dit (api@dev).
`formulaRef`	string \| null	La source publiée de la formule, ou null si aucune n'est nommée.
`assumptions`	{code, text}[]	Ce que suppose la méthode. Vide signifie qu'aucune hypothèse n'est indiquée, pas qu'il n'y en a aucune.
`validRange`	object	status (inside, outside ou unknown), les bornes de chaque entrée avec son unité, les entrées qui en sortent et, le cas échéant, la plage validée et l'erreur maximale d'un modèle ajusté.
`computedAt`	string	Quand, en ISO-8601 et en UTC, à la milliseconde.
`inputs`	object	Les entrées à partir desquelles les valeurs ont été calculées, après application des valeurs par défaut.
`seed`	integer \| null	La graine d'un calcul aléatoire ; null pour tous les calculateurs.
`elapsedSeconds`	number	La durée du calcul.

Entrées hors de la plage indiquée

Une entrée hors de la plage pour laquelle un calculateur est prévu est tout de même calculée. validRange.status vaut outside, validRange.outside nomme l'entrée, et un avertissement nommant l'entrée et la borne est ajouté à warnings. Lorsqu'un calculateur utilise un modèle ajusté, validRange.model donne la plage validée du modèle et son erreur maximale, et indique si les entrées s'y trouvaient.

Résultats anciens

Un résultat stocké avant septembre 2026 ne porte que method, version, seed, inputs et elapsedSeconds : lisez un membre absent comme inconnu, pas comme vide. De nouveaux membres peuvent être ajoutés ; aucun n'est renommé ni supprimé.

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
  }
}

Calculé, signalé dans validRange.outside, avec un avertissement.

{
  "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
  }
}