Inference
Usage instructions for the Client SDK for Inference
Quickstart
To read all inferences for a patient with MRN $PATIENT_MRN and model ID $MODEL_ID with username $USERNAME and private key filename $PRIVATE_KEY_FILENAME, run:
from client_sdk import InferenceAPIClient
async with InferenceAPIClient(
username="$USERNAME",
private_key_filename="$PRIVATE_KEY_FILENAME",
) as client:
inferences = await client.get_inferences(
model_id="$MODEL_ID",
patient_mrn="$PATIENT_MRN",
)import { InferenceAPIClient } from 'bunkerhill-inference-api/client';
const client = new InferenceAPIClient('$USERNAME', '$PRIVATE_KEY_FILENAME');
const inferences = await client.getInferences(
'$MODEL_ID',
'$PATIENT_MRN',
);InferenceAPIClient Reference
InferenceAPIClient ReferenceConstructor
Method signature
def __init__(
self,
username: str,
private_key_filename: Optional[str] = None,
private_key_string: Optional[str] = None,
base_url: str = 'https://api.bunkerhillhealth.com/',
) -> None:
...Parameters
username(str): The username to authenticate the client.private_key_filename(Optional[str]): Filename of the RSA private key.private_key_string(Optional[str]): The RSA private key as a string.base_url(str, has a default): The base URL of the Inference API. Defaults to 'https://api.bunkerhillhealth.com/'.
Notes
At least one of
private_key_filenameorprivate_key_stringmust be provided.
get_inferences
get_inferencesGets a list of Inference objects for a given patient and a given model from the Inference API. Must be called from an async context.
Method signature
def get_inferences(
self,
model_id: str,
patient_mrn: str,
) -> List[Inference]:
...Parameters
model_id(str): The model ID of the model.patient_mrn(str): The medical record number (MRN) of the patient.
Returns
List[Inference]: A list of JSON Dicts, one for each inference. See the Inference API documentation for more details on the format of these Dicts.
Notes
You must have authorization to the specified
model_id. If not, a403error will be raised.Only inferences corresponding to institutions that you are authorized to will be returned.
Constructor
Method signature
constructor(
username: string,
privateKeyFilename?: string,
privateKeyString?: string,
baseUrl: string = 'https://api.bunkerhillhealth.com/',
) {}Parameters
username(string): The username to authenticate the client.privateKeyFilename(string, optional): Filename of the RSA private key.privateKeyString(string, optional): The RSA private key as a string.baseUrl(string, has a default): The base URL of the Inference API. Defaults to 'https://api.bunkerhillhealth.com/'.
Notes
At least one of
privateKeyFilenameorprivateKeyStringmust be provided.
getInferences
getInferencesFetches a list of Inference objects for a given patient and a given model from the Inference API. Must be called from an async context.
Method signature
async getInferences(
modelId: string,
patientMrn: string,
): Promise<Inference[]> {}Parameters
modelId(str): The model ID of the model.patientMrn(str): The medical record number (MRN) of the patient.
Returns
Promise<Inference[]>: A list of JSON Dicts, one for each inference. See Inference JSON Format for more details on the format of these Dicts.
Notes
You must have authorization to the specified
modelId. If not, a403error will be raised.Only inferences corresponding to institutions that you are authorized to will be returned.
Last updated