vm: Retrieve a validmind (vm) connection object using reticulate

In validmind: Interface to the 'ValidMind' Platform

Retrieve a validmind (vm) connection object using reticulate

Description

Retrieve a validmind (vm) connection object using reticulate

Usage

vm(
  api_key,
  api_secret,
  model,
  python_version = Sys.getenv("VALIDMIND_PYTHON", Sys.which("python")),
  api_host = "http://localhost:3000/api/v1/tracking",
  document = NULL
)

Arguments

api_key	The ValidMind API key
api_secret	The ValidMind API secret
model	The ValidMind model
python_version	The path to the Python binary to use. Defaults to the VALIDMIND_PYTHON environment variable, or the system Python.
api_host	The ValidMind host, defaulting to local
document	The document type to associate with this session (e.g. "documentation", "validation-report"). Defaults to NULL.

Value

A validmind connection object, obtained from 'reticulate', which orchestrates the connection to the ValidMind API

Examples

## Not run: 
vm_r <- vm(
   api_host="https://app.prod.validmind.ai/api/v1/tracking",
   api_key="<your_api_key_here>",
   api_secret="<your_api_secret_here>",
   model="<your_model_id_here>",
   document="documentation"
 )

## End(Not run)

validmind documentation built on March 26, 2026, 1:06 a.m.