Conventions used

There are a number of text conventions used throughout this book.

Code in text: Indicates code words in text, database table names, folder names, filenames, file extensions, pathnames, dummy URLs, user input, and Twitter handles. Here is an example: “Make sure you have installed LangSmith by running pip install -U langsmith.”

A block of code is set as follows:

def format_evaluator_inputs(run: Run, example: Example):
    return {
        "input": example.inputs["question"],
        "prediction": next(iter(run.outputs.values())),
        "reference": example.outputs["answer"],
    }

Any command-line input or output is written as follows:

splitter = RecursiveCharacterTextSplitter(chunk_size=250, 
    chunk_overlap=20)

Bold: Indicates a new term, an important word, or words that you see onscreen. For instance, words in menus or dialog boxes appear in bold. Here is an example: “Clicking on the SUCCESS or FAILURE button will display details of the test for each input and output in the dataset.”

Tips or important notes

Appear like this.