Quickstart

Concepts

Learn about the key concepts in Maxim

Prompts

Prompts are text-based inputs provided to AI models to guide their responses and influence the behaviour of the model. The structure and complexity of prompts can vary based on the specific AI model and the intended use case. Prompts may range from simple questions to detailed instructions or multi-turn conversations. They can be optimised or fine-tuned using a range of configuration options, such as variables and other model parameters like temperature, max tokens, etc, to achieve the desired output.

Here's an example of a multi-turn prompt structure:

TurnContentPurpose
Initial promptYou are a helpful AI assistant specialized in geography.Sets the context for the interaction (optional, model-dependent)
User inputWhat's the capital of France?The first query for the AI to respond to
Model responseThe capital of France is Paris.The model's response to the first query
User inputWhat's its population?A follow-up question, building on the previous context
Model responseAs of 2023, the estimated population of Paris is about 2.2 million people in the city proper.The model's response to the follow-up question

You can find more about prompts here.

Prompt comparisons

Prompt comparisons help evaluate different prompts side-by-side to determine which ones produce the best results for a given task. They allow for easy comparison of prompt structures, outputs, and performance metrics across multiple models or configurations.

You can find more about prompt comparisons here.

Prompt chains

Prompt chains are structured sequences of AI interactions designed to tackle complex tasks through a series of interconnected steps. Prompt chains provide a visual representation of the workflow, support agentic behavior, allow for code-based and API configuration.

You can find more about prompt chains here.

Workflows

Workflows enable end-to-end testing of AI applications via HTTP endpoints. They allow seamless integration of existing AI services without code changes, featuring payload configuration with dynamic variables, playground testing, and output mapping for evaluation.

You can find more about workflows here.

Test runs

Test runs are controlled executions of prompts, prompt-chains or workflows to evaluate their performance, accuracy, and behavior under various conditions. They can be single or comparison runs providing detailed summaries, performance metrics, and debug information for every entry to assess AI model performance.

You can find more about test runs here.

Evaluators

Evaluators are tools or metrics used to assess the quality, accuracy, and effectiveness of AI model outputs. We have various types of evaluators that can be customized and integrated into workflows and test runs. See below for more details.

You can find more about evaluators here.

Evaluator typeDescription
AIUses AI models to assess outputs
ProgrammaticApplies predefined rules or algorithms
StatisticalUtilizes statistical methods for evaluation
HumanInvolves human judgment and feedback
API-basedLeverages external APIs for assessment
You can find more about our evaluators here.

Logging

Logging records and stores information about AI model interactions, outputs, and performance metrics for analysis and debugging. It provides comprehensive log views, detailed trace information, and performance metrics. Logging integrates with evaluation tools and enables dataset curation for evaluation and fine-tuning needs. This feature helps developers monitor, troubleshoot, and optimize their AI applications throughout the development lifecycle.

You can find more about logging here.

Datasets

Datasets are collections of data used for training, testing, and evaluating AI models within workflows and evaluations. They allow users to test their prompts and AI systems against their own data, and include features for data structure management, integration with AI workflows, and privacy controls.

You can find more about datasets here.

Context sources

Context sources handle and organize contextual information that AI models use to understand and respond to queries more effectively. They support Retrieval-Augmented Generation (RAG) and include API integration, sample input testing, and seamless incorporation into AI workflows. Context sources enable developers to enhance their AI models' performance by providing relevant background information for more accurate and contextually appropriate responses.

You can find more about context sources here.

Prompt tools

Prompt tools are utilities that assist in creating, refining, and managing prompts, enhancing the efficiency of working with AI prompts. They feature custom function creation, a playground environment, and integration with workflows.

You can find more about prompt tools here.

On this page