# Limina Docs

## Docs

- [Introduction](https://docs.getlimina.ai/introduction.md): Limina's end-user documentation for our container-based de-identification service including installation, FAQs, API reference, tutorials, integrations, & more.
- [Container Quickstart](https://docs.getlimina.ai/container-quickstart/quickstart-guide.md): This quickstart guide will help you get started with setting up the Limina PII de-identification Docker container on your local machine.
- [Usage Quickstart](https://docs.getlimina.ai/container-quickstart/api-quickstart.md): API Quickstart
- [Deployment planning checklist](https://docs.getlimina.ai/container-quickstart/deployment-checklist.md): This introductory guide will help you understand the initial steps required for a successful deployment
- [Github Examples](https://docs.getlimina.ai/examples/github-examples.md): Detailed code walkthroughs
- [Named Entity Recognition Demo](https://docs.getlimina.ai/demo/ner.md): Limina's web demo allows you to easily test out our industry-leading PII identification, redaction, and synthetic PII technology.
- [Prerequisites and System Requirements](https://docs.getlimina.ai/installation/prerequisites-and-system-requirements.md): Detailing the prerequisites that are required to run Limina's container, as well as the minimum and recommended hardwire requirements.
- [Grabbing the Image](https://docs.getlimina.ai/installation/grabbing-the-image.md): Grabbing the Image describes how to load the Limina image. It can be pulled from Docker Hub or via an encrypted container image export.
- [Running the Container](https://docs.getlimina.ai/installation/running-the-container.md): Running the Container covers how to create and run the container on your local machine and authentication.
- [Deploying into Production](https://docs.getlimina.ai/installation/deploying-into-production.md): Deploying into Production describes how to run the Limina container in production with orchestrators such as AWS ECS.
- [Kubernetes Setup Guide](https://docs.getlimina.ai/installation/kubernetes-setup-guide.md): This guide will help you to get started with the deployment of Limina container in a Kubernetes cluster including prerequisites & more.
- [Installing on AWS](https://docs.getlimina.ai/installation/aws/index.md): Limina's detailed installation instructions on AWS including prerequisites, requirements, deployment, benchmarks, concurrency, and more.
- [AWS EKS Deployment Guide](https://docs.getlimina.ai/installation/aws/eks-guide.md): How to deploy Limina in EKS
- [AWS Automated ECS Deployment Guide](https://docs.getlimina.ai/installation/aws/automated-ecs-guide.md): How to automatically deploy Limina in ECS for the best performance
- [AWS Manual ECS Deployment Guide](https://docs.getlimina.ai/installation/aws/manual-ecs-guide.md): How to deploy Limina in ECS manually
- [Configuration & Operations](https://docs.getlimina.ai/configuration-and-operations/index.md): Limina's detailed configuration instructions including prerequisites, requirements, deployment, benchmarks, concurrency, and more.
- [Customizing Detection](https://docs.getlimina.ai/configuration-and-operations/entity-detection-and-redaction/customizing-detection.md): This guide presents advanced techniques to help customize the PII entity detection.
- [Customizing Redaction](https://docs.getlimina.ai/configuration-and-operations/entity-detection-and-redaction/customizing-redaction.md): This guide presents advanced techniques to help customize the creation of redacted output.
- [Accuracy Modes](https://docs.getlimina.ai/configuration-and-operations/entity-detection-and-redaction/accuracy-modes.md): Learn about accuracy modes such as 'standard', 'high', and 'high_multilingual' models compatible with the Limina container for PII detection and redaction.
- [Language Detection](https://docs.getlimina.ai/configuration-and-operations/entity-detection-and-redaction/language-detection.md): Limina language detection capabilities and implications
- [Gibberish Detection](https://docs.getlimina.ai/configuration-and-operations/entity-detection-and-redaction/gibberish-detection.md): Score how nonsensical the text around each detected entity is, to help surface false positives
- [Processing Files](https://docs.getlimina.ai/configuration-and-operations/working-with-files/processing-files/index.md): This guide will get you started with file deidentification.
- [Processing Audio Files](https://docs.getlimina.ai/configuration-and-operations/working-with-files/processing-files/audio.md): This guide will get you started with Audio deidentification.
- [Processing CSV Files](https://docs.getlimina.ai/configuration-and-operations/working-with-files/processing-files/csv.md): This guide will get you started with CSV deidentification.
- [Processing DCM/DICOM Files](https://docs.getlimina.ai/configuration-and-operations/working-with-files/processing-files/dcm-dicom.md): This guide will get you started with DICOM deidentification.
- [Processing Excel (XLS/XLSX) Files](https://docs.getlimina.ai/configuration-and-operations/working-with-files/processing-files/excel.md): This guide will get you started with XLSX deidentification.
- [Processing Image Files](https://docs.getlimina.ai/configuration-and-operations/working-with-files/processing-files/image.md): This guide will get you started with Image deidentification.
- [Processing JSON Files](https://docs.getlimina.ai/configuration-and-operations/working-with-files/processing-files/json.md): This guide will get you started with json deidentification.
- [Processing PDF Files, Standard versus Enhanced](https://docs.getlimina.ai/configuration-and-operations/working-with-files/processing-files/pdf-comparison.md): This guide shows the differences between PDF Processing Types
- [Processing PDF Files (Standard)](https://docs.getlimina.ai/configuration-and-operations/working-with-files/processing-files/pdf-standard.md): This guide will get you started with pdf deidentification.
- [Processing PDF Files (Enhanced)](https://docs.getlimina.ai/configuration-and-operations/working-with-files/processing-files/pdf-enhanced.md): This guide will get you started with pdf deidentification.
- [Processing PowerPoint (PPT/PPTX) Files](https://docs.getlimina.ai/configuration-and-operations/working-with-files/processing-files/powerpoint.md): This guide will get you started with PPTX deidentification.
- [Processing TXT Files](https://docs.getlimina.ai/configuration-and-operations/working-with-files/processing-files/txt.md): This guide will get you started with TXT deidentification.
- [Processing Word (DOC/DOCX) Files](https://docs.getlimina.ai/configuration-and-operations/working-with-files/processing-files/word.md): This guide will get you started with docx deidentification.
- [Processing XML Files](https://docs.getlimina.ai/configuration-and-operations/working-with-files/processing-files/xml.md): This guide will get you started with XML deidentification.
- [Guide for OCR Modes Available with Limina DEID Container](https://docs.getlimina.ai/configuration-and-operations/working-with-files/processing-files/ocr-modes.md): Explore the best OCR modes including Standard OCR, Azure Computer Vision OCR, Azure Document Intelligence, and Hybrid OCR compatible with Limina DEID container for efficient document processing and redaction.
- [Customizing Object Detection](https://docs.getlimina.ai/configuration-and-operations/working-with-files/processing-files/customizing-object-detection.md): This guide presents advanced techniques to help customize object detection.
- [Using remote storage](https://docs.getlimina.ai/configuration-and-operations/working-with-files/processing-files/mounted-storage.md): Using remote storage
- [Processing Structured Data Sources](https://docs.getlimina.ai/configuration-and-operations/working-with-files/structured-data.md): This guide illustrates how to use Limina on Structured Data sources such as Databases, JSON, CSV and XML files
- [Supported File Types](https://docs.getlimina.ai/configuration-and-operations/working-with-files/supported-file-types.md): Support File Types like PDFs, CSVs, JSON and more. View the full list of supported file types Limina can identify and redact, including images, audio, and documents.
- [Named Entity Recognition](https://docs.getlimina.ai/configuration-and-operations/advanced-features/ner.md): This guide explains how to detect PII in text and files without redaction
- [Detect, Parse, and Validate Entities in Text](https://docs.getlimina.ai/configuration-and-operations/advanced-features/analyze-text.md): This guide explains how to use Limina to analyze your text by detecting, parsing, and validating PII in text
- [Guide For Integrating Limina DEID Container With Azure OCR](https://docs.getlimina.ai/configuration-and-operations/advanced-features/azure-ocr.md): Learn how to seamlessly integrate Limina's DEID container with Azure OCR for efficient redaction of PII in images and documents.
- [LLM Prompt Redaction](https://docs.getlimina.ai/configuration-and-operations/advanced-features/llms.md): Learn how to use the headless or API version of Limina to preserve privacy inside applications using LLMs like ChatGPT and GPT4.
- [Websocket Endpoint](https://docs.getlimina.ai/configuration-and-operations/advanced-features/websockets.md): Documentation for using Limina's Websocket endpoint.
- [Benchmarks](https://docs.getlimina.ai/configuration-and-operations/container-management/benchmarks.md): Benchmarks provides some performance numbers on the CPU and GPU containers including recommendations for best throughput.
- [Performance Tips](https://docs.getlimina.ai/configuration-and-operations/container-management/performance-tips.md): Limina shares tips and recommendations to get the best performance from our PII identification & detection machine learning models.
- [Concurrency](https://docs.getlimina.ai/configuration-and-operations/container-management/concurrency.md): The recommended level of concurrency (the optimal number of simultaneous requests to make to the container) for the CPU and GPU containers.
- [Logstash & Dashboards](https://docs.getlimina.ai/configuration-and-operations/container-management/logstash-and-dashboards.md): How to integration Limina with elastic search for monitoring.
- [Upgrade & Migration Guide](https://docs.getlimina.ai/configuration-and-operations/container-management/upgrade-guide.md): This guide will help you migrate from version 3 to version 4 of the Limina product
- [Security](https://docs.getlimina.ai/configuration-and-operations/container-management/security.md): Learn more about the processes and measures the engineering team engages in to build Limina's software in a security conscious manner.
- [CORS Configuration](https://docs.getlimina.ai/configuration-and-operations/container-management/cors-configuration.md): An introduction to working with CORS and the Limina Container.
- [Environment Variables](https://docs.getlimina.ai/configuration-and-operations/container-management/environment-variables.md): Environment Variables provides a comprehensive list of supported environment variables that you can configure with Limina container.
- [Python Client](https://docs.getlimina.ai/product-guides/thin-client.md): Documentation for developing using Limina's Python client.
- [Container Playground](https://docs.getlimina.ai/product-guides/container-playground.md): Container Playground: Your Limina Sandbox
- [Supported Entity Types](https://docs.getlimina.ai/entities/supported-entity-types.md): View the full list of 50+ entity types Limina can identify and redact, covering the GDPR, CPRA, HIPAA Safe Harbor and QUEBEC_PRIVACY_ACT.
- [Supported Object Entity Types](https://docs.getlimina.ai/entities/supported-object-entities.md): View the full list of object entity types Limina can detect and redact.
- [Translated Labels](https://docs.getlimina.ai/entities/translated-entity-labels.md): View the full list of translated Labels for entity types
- [Supported Languages](https://docs.getlimina.ai/languages.md): View the full list of 49+ languages Limina can identify and redact, including regional varieties, support level, and ISO codes.
- [クイックスタートガイド](https://docs.getlimina.ai/ja/container-quickstart/quickstart-guide.md): このクイックスタートガイドでは、Limina コンテナの PII 検出、秘匿化機能のローカルセットアップを説明します。
- [Limina の使用を開始する](https://docs.getlimina.ai/ja/installation/getting-started.md): Limina API クイックスタート
- [Frequently Asked Questions](https://docs.getlimina.ai/faq.md): Answers to frequently asked questions.
- [Acknowledgements and Licenses](https://docs.getlimina.ai/acknowledgement.md)
- [Process Text](https://docs.getlimina.ai/latest/process-text.md): Detect entities such as PII, PHI or PCI in the provided text strings using Private AI's entity detection engine. After entity detection, any entities found can be redacted, masked or replaced with AI-generated synthetic entities.
- [NER Text](https://docs.getlimina.ai/latest/ner-text.md): Detect entities such as PII, PHI or PCI in the provided text strings using Private AI's entity detection engine.
- [Analyze Text](https://docs.getlimina.ai/latest/analyze-text.md): Detect entities in the provided text strings using Private AI's entity detection engine and return the results of the analysis and validation of each entity.
- [Reidentify Text](https://docs.getlimina.ai/latest/reidentify-text.md): This route is intended to improve integrations with LLMs such as ChatGPT. Entities that are removed prior to sending to the LLM can be re-injected into the response from the LLM to improve user experience.
- [Process Files Base64](https://docs.getlimina.ai/latest/process-files-base64.md): Detect entities such as PII, PHI or PCI in a base64-encoded file using Private AI's entity detection engine. After entity detection, a copy of the file with all entities removed is created and returned.
- [Process Files Uri](https://docs.getlimina.ai/latest/process-files-uri.md): Detect entities such as PII, PHI or PCI in the file located at the provided URI using Private AI's entity detection engine. After entity detection, a copy of the file with all entities removed is created and placed in the folder specified by `PAI_OUTPUT_FILE_DIR` on the local host.
- [Ner Files Base64](https://docs.getlimina.ai/latest/ner-files-base64.md): Detect entities such as PII, PHI or PCI in a base64-encoded file using Private AI's entity detection engine. This is only doing the detection of entities, no redacted file is created.
- [Ner Files Uri](https://docs.getlimina.ai/latest/ner-files-uri.md): Detect entities such as PII, PHI or PCI in the file located at the provided URI using Private AI's entity detection engine. This is only doing the detection of entities, no redacted file is created.
- [Bleep](https://docs.getlimina.ai/latest/bleep.md): Bleep an audio given the timestamps to bleep.
- [Get Version](https://docs.getlimina.ai/latest/get-version.md): Return the version of the container application code
- [Healthz](https://docs.getlimina.ai/latest/healthz.md): Check the health of the container.
- [Metrics](https://docs.getlimina.ai/latest/metrics.md): This endpoint serves Prometheus metrics via a HTTP-based interface that provides access to metrics data in a format suitable for scraping by Prometheus servers. The endpoint provides real-time insights into how the system is functioning. The endpoint exposed the metrics in a time-series format, allo…
- [Diagnostics](https://docs.getlimina.ai/latest/diagnostics.md): Get diagnostic information for the container.

## OpenAPI Specs

- [privateai_4.4.1](https://docs.getlimina.ai/openapi/privateai_4.4.1.json)
- [privateai_4.4.0](https://docs.getlimina.ai/openapi/privateai_4.4.0.json)
- [privateai_4.3.1.1](https://docs.getlimina.ai/openapi/privateai_4.3.1.1.json)
- [privateai_4.3.1](https://docs.getlimina.ai/openapi/privateai_4.3.1.json)
- [privateai_4.3.0](https://docs.getlimina.ai/openapi/privateai_4.3.0.json)
- [privateai_4.2.2](https://docs.getlimina.ai/openapi/privateai_4.2.2.json)
- [privateai_4.2.1](https://docs.getlimina.ai/openapi/privateai_4.2.1.json)
- [privateai_4.2.0](https://docs.getlimina.ai/openapi/privateai_4.2.0.json)
- [privateai_4.1.0](https://docs.getlimina.ai/openapi/privateai_4.1.0.json)
- [privateai_4.0.1](https://docs.getlimina.ai/openapi/privateai_4.0.1.json)
- [privateai_4.0.0](https://docs.getlimina.ai/openapi/privateai_4.0.0.json)
- [privateai_3.9.0](https://docs.getlimina.ai/openapi/privateai_3.9.0.json)
- [privateai_3.8.2](https://docs.getlimina.ai/openapi/privateai_3.8.2.json)
- [privateai_3.8.1](https://docs.getlimina.ai/openapi/privateai_3.8.1.json)
- [privateai_3.8.0](https://docs.getlimina.ai/openapi/privateai_3.8.0.json)
- [privateai_3.7.0](https://docs.getlimina.ai/openapi/privateai_3.7.0.json)
- [privateai_3.6.3](https://docs.getlimina.ai/openapi/privateai_3.6.3.json)
- [privateai_3.6.0](https://docs.getlimina.ai/openapi/privateai_3.6.0.json)
- [privateai_3.5.0](https://docs.getlimina.ai/openapi/privateai_3.5.0.json)
- [privateai_3.4.2](https://docs.getlimina.ai/openapi/privateai_3.4.2.json)
- [privateai_3.3.3](https://docs.getlimina.ai/openapi/privateai_3.3.3.json)
- [privateai_3.3.0](https://docs.getlimina.ai/openapi/privateai_3.3.0.json)
- [privateai_3.2.0](https://docs.getlimina.ai/openapi/privateai_3.2.0.json)
- [privateai_3.1.0](https://docs.getlimina.ai/openapi/privateai_3.1.0.json)
- [privateai_3.0.0](https://docs.getlimina.ai/openapi/privateai_3.0.0.json)