# CaraML Docs ## CaraML Docs - [What is CaraML?](https://docs.caraml.dev/introduction/readme.md) - [Architecture](https://docs.caraml.dev/introduction/architecture.md) - [Feature Store Architecture](https://docs.caraml.dev/introduction/architecture/feature-store-architecture.md) - [Models Architecture](https://docs.caraml.dev/introduction/architecture/architecture.md) - [Routers Architecture](https://docs.caraml.dev/introduction/architecture/routers-architecture.md) - [Experiments Architecture](https://docs.caraml.dev/introduction/architecture/experiments-architecture.md) - [Pipelines Architecture](https://docs.caraml.dev/introduction/architecture/pipelines-architecture.md) - [Core Concepts](https://docs.caraml.dev/introduction/core-concepts.md) - [Models Concepts](https://docs.caraml.dev/introduction/core-concepts/00_introduction.md) - [Router Concepts](https://docs.caraml.dev/introduction/core-concepts/concepts.md) - [Experiment Concepts](https://docs.caraml.dev/introduction/core-concepts/concepts-1.md) - [Projects](https://docs.caraml.dev/user-guides/projects.md) - [Create a project](https://docs.caraml.dev/user-guides/projects/create-project.md) - [Managing secrets](https://docs.caraml.dev/user-guides/projects/secrets.md) - [Feature Store](https://docs.caraml.dev/user-guides/feature-store.md) - [Models](https://docs.caraml.dev/user-guides/01_getting_started.md) - [Create a Model](https://docs.caraml.dev/user-guides/01_getting_started/02_creating_a_model.md) - [Custom Model](https://docs.caraml.dev/user-guides/01_getting_started/02_creating_a_model/01_custom_model.md) - [Deploy a Model](https://docs.caraml.dev/user-guides/01_getting_started/03_deploying_a_model.md) - [Deploying a Model Version](https://docs.caraml.dev/user-guides/01_getting_started/03_deploying_a_model/01_deploying_a_model_version.md) - [Severing a Model Version](https://docs.caraml.dev/user-guides/01_getting_started/03_deploying_a_model/02_serving_a_model_version.md) - [Configuring Transformer](https://docs.caraml.dev/user-guides/01_getting_started/03_deploying_a_model/03_configuring_transformers.md) - [Standard Transformer](https://docs.caraml.dev/user-guides/01_getting_started/03_deploying_a_model/03_configuring_transformers/01_standard_transformer.md) - [Standard Transformer Expressions](https://docs.caraml.dev/user-guides/01_getting_started/03_deploying_a_model/03_configuring_transformers/01_standard_transformer/01_standard_transformer_expressions.md) - [Standard Transformer UPI](https://docs.caraml.dev/user-guides/01_getting_started/03_deploying_a_model/03_configuring_transformers/01_standard_transformer/02_standard_transformer_upi.md) - [Custom Transformer](https://docs.caraml.dev/user-guides/01_getting_started/03_deploying_a_model/03_configuring_transformers/02_custom_transformer.md) - [Deleting a Model](https://docs.caraml.dev/user-guides/01_getting_started/04_deleting_a_model.md) - [Configuring Alerts](https://docs.caraml.dev/user-guides/01_getting_started/05_configuring_alerts.md) - [Batch Prediction](https://docs.caraml.dev/user-guides/01_getting_started/06_batch_prediction.md) - [Model Schema](https://docs.caraml.dev/user-guides/01_getting_started/10_model_schema.md) - [Model Observability](https://docs.caraml.dev/user-guides/01_getting_started/11_model_observability.md) - [Routers](https://docs.caraml.dev/user-guides/router.md) - [Creating a Router](https://docs.caraml.dev/user-guides/router/create-a-router.md) - [Configure general settings](https://docs.caraml.dev/user-guides/router/create-a-router/configure-general-settings.md) - [Configure routes](https://docs.caraml.dev/user-guides/router/create-a-router/configure-routes.md) - [Configure traffic rules](https://docs.caraml.dev/user-guides/router/create-a-router/configure-traffic-rules.md) - [Configure autoscaling](https://docs.caraml.dev/user-guides/router/create-a-router/configure-autoscaling.md) - [Configure experiment engine](https://docs.caraml.dev/user-guides/router/create-a-router/configure-experiment-engine.md) - [Configure enricher](https://docs.caraml.dev/user-guides/router/create-a-router/configure-enricher.md) - [Configure ensembler](https://docs.caraml.dev/user-guides/router/create-a-router/configure-ensembler.md) - [Configure logging](https://docs.caraml.dev/user-guides/router/create-a-router/configure-logging-request-response.md) - [Viewing Routers](https://docs.caraml.dev/user-guides/router/viewing-routers.md) - [Configuration](https://docs.caraml.dev/user-guides/router/viewing-routers/configuration.md) - [History](https://docs.caraml.dev/user-guides/router/viewing-routers/history.md) - [Logs](https://docs.caraml.dev/user-guides/router/viewing-routers/logs.md) - [More actions](https://docs.caraml.dev/user-guides/router/viewing-routers/more-actions.md) - [Edit Routers](https://docs.caraml.dev/user-guides/router/edit-router.md) - [Monitoring router](https://docs.caraml.dev/user-guides/router/monitor-a-router.md) - [Monitor Router Performance](https://docs.caraml.dev/user-guides/router/monitor-a-router/monitor-router-performance.md) - [Configure Alerts](https://docs.caraml.dev/user-guides/router/monitor-a-router/configure-alerts.md) - [Undeploying Router](https://docs.caraml.dev/user-guides/router/undeploying-router.md) - [Redeploying Router](https://docs.caraml.dev/user-guides/router/redeploy-a-router.md) - [Redeploy undeployed router](https://docs.caraml.dev/user-guides/router/redeploy-a-router/redeploy-undeployed-router.md) - [Redeploy version from history](https://docs.caraml.dev/user-guides/router/redeploy-a-router/redeploy-version-from-history.md) - [Redeploy version from version details page](https://docs.caraml.dev/user-guides/router/redeploy-a-router/redeploy-from-version-detail.md) - [Deleting Router](https://docs.caraml.dev/user-guides/router/delete-a-router.md) - [Deleting router versions](https://docs.caraml.dev/user-guides/router/delete-a-router/delete-router-version.md) - [Deleting router versions from details page](https://docs.caraml.dev/user-guides/router/delete-a-router/delete-router-version-from-details-page.md) - [Deleting routers](https://docs.caraml.dev/user-guides/router/delete-a-router/delete-router.md) - [Deleting Emsemblers](https://docs.caraml.dev/user-guides/router/delete-an-ensembler.md) - [Delete an Ensembler without related entity](https://docs.caraml.dev/user-guides/router/delete-an-ensembler/delete-an-ensembler.md) - [Delete an Ensembler with active entities](https://docs.caraml.dev/user-guides/router/delete-an-ensembler/delete-an-ensembler-active.md) - [Delete an Ensembler with inactive entities](https://docs.caraml.dev/user-guides/router/delete-an-ensembler/delete-an-ensembler-inactive.md) - [Experiments](https://docs.caraml.dev/user-guides/01_getting_started-1.md) - [View Experiment Settings](https://docs.caraml.dev/user-guides/01_getting_started-1/02_viewing_settings.md) - [Modify Experiment Settings](https://docs.caraml.dev/user-guides/01_getting_started-1/03_modifying_settings.md) - [Creating Experiments](https://docs.caraml.dev/user-guides/01_getting_started-1/04_creating_experiments.md) - [Viewing Experiments](https://docs.caraml.dev/user-guides/01_getting_started-1/05_viewing_experiments.md) - [Modifying Experiments](https://docs.caraml.dev/user-guides/01_getting_started-1/06_modifying_experiments.md) - [Running Experiments](https://docs.caraml.dev/user-guides/01_getting_started-1/07_running_experiments.md) - [Monitoring Experiments](https://docs.caraml.dev/user-guides/01_getting_started-1/08_monitoring_experiments.md) - [Creating Treatments](https://docs.caraml.dev/user-guides/01_getting_started-1/09_creating_treatments.md) - [Viewing Treatments](https://docs.caraml.dev/user-guides/01_getting_started-1/10_viewing_treatments.md) - [Modifying Treatments](https://docs.caraml.dev/user-guides/01_getting_started-1/11_modifying_treatments.md) - [Creating Segments](https://docs.caraml.dev/user-guides/01_getting_started-1/12_creating_segments.md) - [Viewing Segments](https://docs.caraml.dev/user-guides/01_getting_started-1/13_viewing_segments.md) - [Modifying Segments](https://docs.caraml.dev/user-guides/01_getting_started-1/14_modifying_segments.md) - [Creating Custom Segmenters](https://docs.caraml.dev/user-guides/01_getting_started-1/15_creating_custom_segmenters.md) - [Viewing Custom Segmenters](https://docs.caraml.dev/user-guides/01_getting_started-1/16_viewing_custom_segmenters.md) - [Modifying Custom Segmenters](https://docs.caraml.dev/user-guides/01_getting_started-1/17_modifiying_custom_segmenters.md) - [Pipelines](https://docs.caraml.dev/user-guides/pipelines.md) - [Model Sample Notebooks](https://docs.caraml.dev/tutorial-and-examples/07_examples.md) - [Deploy Standard Models](https://docs.caraml.dev/tutorial-and-examples/07_examples/01_standard_model.md) - [Deploy PyFunc Model](https://docs.caraml.dev/tutorial-and-examples/07_examples/02_pyfunc_model.md) - [Using Transformers](https://docs.caraml.dev/tutorial-and-examples/07_examples/03_transformer.md) - [Run Batch Prediction Job](https://docs.caraml.dev/tutorial-and-examples/07_examples/04_batch_prediction.md) - [Others examples on Models](https://docs.caraml.dev/tutorial-and-examples/07_examples/05_others.md) - [Router Examples](https://docs.caraml.dev/tutorial-and-examples/router-examples.md) - [Feature Store Examples](https://docs.caraml.dev/tutorial-and-examples/feature-store-examples.md) - [Pipeline Examples](https://docs.caraml.dev/tutorial-and-examples/pipeline-examples.md) - [Performing load test in CaraML](https://docs.caraml.dev/tutorial-and-examples/performing-load-test-in-caraml.md) - [Best practice for CaraML](https://docs.caraml.dev/tutorial-and-examples/best-practice-for-caraml.md) - [Feature Store SDK](https://docs.caraml.dev/caraml-sdk/feature-store-sdk.md) - [Models SDK](https://docs.caraml.dev/caraml-sdk/models-sdk.md) - [Routers SDK](https://docs.caraml.dev/caraml-sdk/routers-sdk.md) - [Pipeline SDK](https://docs.caraml.dev/caraml-sdk/pipeline-sdk.md) - [CaraML System FAQ](https://docs.caraml.dev/troubleshooting-and-faqs/caraml-system-faq.md) - [Models FAQ](https://docs.caraml.dev/troubleshooting-and-faqs/models-faq.md) - [System Limitations](https://docs.caraml.dev/troubleshooting-and-faqs/models-faq/08_limitations.md) - [Troubleshooting Deployment Errors](https://docs.caraml.dev/troubleshooting-and-faqs/models-faq/09_troubleshooting_deployment_errors.md) - [E2E Test](https://docs.caraml.dev/troubleshooting-and-faqs/models-faq/e2e-test.md) - [Routers FAQ](https://docs.caraml.dev/troubleshooting-and-faqs/routers-faq.md) - [Experiments FAQ](https://docs.caraml.dev/troubleshooting-and-faqs/experiments-faq.md) - [Feature Store FAQ](https://docs.caraml.dev/troubleshooting-and-faqs/feature-store-faq.md) - [Pipelines FAQ](https://docs.caraml.dev/troubleshooting-and-faqs/pipelines-faq.md) - [CaraML Error Messages](https://docs.caraml.dev/troubleshooting-and-faqs/caraml-error-messages.md) - [Deploying CaraML](https://docs.caraml.dev/deployment-guide/deploying-caraml.md) - [Local Development](https://docs.caraml.dev/deployment-guide/deploying-caraml/local-development.md) - [Monitoring and alerting](https://docs.caraml.dev/deployment-guide/monitoring-and-alerting.md) - [Configure a monitoring backend](https://docs.caraml.dev/deployment-guide/monitoring-and-alerting/configure-monitoring-backend.md) - [Configure an alerting backend](https://docs.caraml.dev/deployment-guide/monitoring-and-alerting/configure-alerting-backend.md) - [Prerequisites and Dependencies](https://docs.caraml.dev/deployment-guide/prerequisites-and-dependencies.md) - [System Benchmark results](https://docs.caraml.dev/deployment-guide/system-benchmark-results.md) - [Experiment Treatment Service](https://docs.caraml.dev/deployment-guide/treatment-service.md) - [CaraML Release Notes](https://docs.caraml.dev/release-notes/caraml-release-notes.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.caraml.dev/introduction/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.