# Lucidworks documentation

## SaaS Platform

### Get Started

- [Introduction](https://doc.lucidworks.com/docs/lw-platform/index.md): Discover how to deploy, customize, and scale Lucidworks products for AI-powered search and insights across B2B, B2C, knowledge management, customer support, and more.
- [Latest changes](https://doc.lucidworks.com/docs/lw-platform/latest-changes.md): Lucidworks products are constantly evolving to deliver new features, improvements, and fixes. This page highlights the latest changes to help you stay current with product updates and enhancements.

### Lucidworks Platform

- [Platform Features](https://doc.lucidworks.com/docs/lw-platform/lw-platform/overview.md): Lucidworks Platform
- [Indexes](https://doc.lucidworks.com/docs/lw-platform/lw-platform/indexes.md)
- [Authentication API](https://doc.lucidworks.com/docs/lw-platform/lw-platform/authentication-api.md)
- [Rate limiting](https://doc.lucidworks.com/docs/lw-platform/lw-platform/rate-limiting.md)

#### Settings

- [Settings](https://doc.lucidworks.com/docs/lw-platform/lw-platform/settings/overview.md)

##### Users and Provisioning

- [Users and Provisioning](https://doc.lucidworks.com/docs/lw-platform/lw-platform/settings/lw-users/overview.md)
- [Single sign-on authentication](https://doc.lucidworks.com/docs/lw-platform/lw-platform/settings/lw-users/sso.md)

##### Fusion integrations

- [Fusion Integrations](https://doc.lucidworks.com/docs/lw-platform/lw-platform/settings/fusion-integrations/overview.md)
- [Commerce Studio integration with Fusion](https://doc.lucidworks.com/docs/lw-platform/lw-platform/settings/fusion-integrations/commerce-studio-integration.md)
- [Configuration Promotion tool integration with Fusion](https://doc.lucidworks.com/docs/lw-platform/lw-platform/settings/fusion-integrations/configuration-promotion-integration.md)

### Lucidworks AI

- [Quickstart](https://doc.lucidworks.com/docs/lw-platform/lw-ai/quickstart-lucidworks-ai-nhs-rag.md): Lucidworks AI Neural Hybrid Search and RAG
- [Lucidworks AI](https://doc.lucidworks.com/docs/lw-platform/lw-ai/overview.md)
- [Lucidworks AI Gateway](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-gateway.md)
- [Image Data Enrichment](https://doc.lucidworks.com/docs/lw-platform/lw-ai/data-enrichment.md)
- [Pre-trained embedding models](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-pre-trained-embedding-models.md)
- [Integrations](https://doc.lucidworks.com/docs/lw-platform/lw-ai/integrations.md)
- [AI Model Usage](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-ai-model-usage.md)
- [Generative AI](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-generative-ai.md)
- [Generative AI using Lucidworks-managed keys](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-generative-ai-using-lw-keys.md)
- [Data Handling and Security FAQ](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-security-faq.md): Lucidworks AI

#### Fusion Stages for AI

- [Fusion stages for AI](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-stages/overview.md): Lucidworks AI
- [LWAI Chunker Index Stage](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-stages/lucidworks-ai-chunker-index-stage.md): Lucidworks AI
- [Chunking RAG Bridge Query Stage](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-stages/chunking-rag-bridge.md): Lucidworks AI
- [Lucidworks AI Prediction index stage](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-stages/lucidworks-ai-prediction-index-stage.md): Lucidworks AI
- [Lucidworks AI Prediction query stage](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-stages/lucidworks-ai-prediction-query-stage.md)
- [Lucidworks AI Vectorize Field](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-stages/vectorize-field-via-lucidworks-ai-index-stage.md): Lucidworks AI
- [LWAI Batch Vectorize Index Stage](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-stages/batch-vectorize-field-via-lucidworks-ai-index-stage.md): Lucidworks AI
- [Lucidworks AI Vectorize Query](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-stages/vectorize-query-via-lucidworks-ai-query-stage.md): Lucidworks AI

#### Custom embedding model training

- [Custom embedding model training](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-custom-embedding-model-training/overview.md)
- [Use case training data](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-custom-embedding-model-training/custom-embedding-model-training-data.md): Lucidworks AI custom embedding model training
- [RNN models](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-custom-embedding-model-training/custom-embedding-rnn-models.md): Lucidworks AI custom embedding model training
- [Transformer RNN models](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-custom-embedding-model-training/custom-embedding-transformer-rnn-models.md): Lucidworks AI custom embedding model training
- [Custom model training user interface](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-custom-embedding-model-training/custom-model-training-user-interface.md)
- [Create and deploy custom models](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-custom-embedding-model-training/create-and-deploy-custom-models.md)

#### Lucidworks AI APIs

- [Lucidworks AI APIs](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/overview.md)
- [Use Case API](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-use-case-api.md)
- [Prompting Preview API](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-prompting-preview-api.md): Lucidworks AI Prediction API
- [Tokenization API](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-tokenization-api.md): Lucidworks AI Prediction API
- [Models API](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-models-api.md)
- [Async Chunking API](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-async-chunking-api.md): Lucidworks AI

##### Prediction API

- [Prediction API](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-prediction-api/overview.md)
- [Embedding use cases](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-prediction-api/embedding-prediction.md)
- [Classification use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-prediction-api/classification-prediction.md): Lucidworks AI Prediction API
- [FAQ enrichment use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-prediction-api/faq-enrichment.md)
- [Image metadata enrichment use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-prediction-api/image-metadata-enrichment.md)
- [Part Number Detection use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-prediction-api/part-number-detection-use-case.md): Lucidworks AI Prediction API
- [Pass-through use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-prediction-api/passthrough-prediction.md): Lucidworks AI Prediction API
- [Retrieval-augmented generation (RAG) use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-prediction-api/rag-prediction.md): Lucidworks AI Prediction API
- [Standalone query rewriter use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-prediction-api/standalone-query-rewriter-prediction.md)
- [Summarization use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-prediction-api/summarization-prediction.md): Lucidworks AI Prediction API
- [Keyword extraction use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-prediction-api/keyword-extraction-prediction.md)
- [Named entity recognition (NER) use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-prediction-api/ner-prediction.md): Lucidworks AI Prediction API

##### Async Prediction API

- [Async Prediction API](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-async-prediction-api/overview.md)
- [FAQ enrichment use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-async-prediction-api/faq-enrichment-async.md)
- [Image metadata enrichment use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-async-prediction-api/image-metadata-enrichment.md)
- [Pass-through use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-async-prediction-api/passthrough-async.md): Lucidworks AI Async Prediction API
- [Retrieval-augmented generation (RAG) use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-async-prediction-api/rag-async.md): Lucidworks AI Async Prediction API
- [Standalone query rewriter use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-async-prediction-api/standalone-query-rewriter-async.md)
- [Summarization use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-async-prediction-api/summarization-async.md): Lucidworks AI Async Prediction API
- [Keyword extraction use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-async-prediction-api/keyword-extraction-async.md)
- [Named entity recognition (NER) use case](https://doc.lucidworks.com/docs/lw-platform/lw-ai/lw-ai-apis/lw-ai-async-prediction-api/ner-async.md): Lucidworks AI Async Prediction API

### Core Settings

- [Quickstart](https://doc.lucidworks.com/docs/lw-platform/lw-core/quickstart.md): Build intuitive and configurable searches in 3 steps.
- [Core Settings](https://doc.lucidworks.com/docs/lw-platform/lw-core/overview.md)
- [Relevance](https://doc.lucidworks.com/docs/lw-platform/lw-core/sites-relevance.md): Core Settings
- [Boost](https://doc.lucidworks.com/docs/lw-platform/lw-core/sites-boost.md): Core Settings

#### Typeahead

- [Typeahead](https://doc.lucidworks.com/docs/lw-platform/lw-core/sites-typeahead.md): Core Settings
- [Typeahead Service API](https://doc.lucidworks.com/docs/lw-platform/lw-core/typeahead-api.md)

### UI Studio

- [Quickstart](https://doc.lucidworks.com/docs/lw-platform/lw-ui-studio/quickstart.md): Build a basic search interface in UI Studio Builder with Search Bar, Results, and Facets components.
- [UI Studio](https://doc.lucidworks.com/docs/lw-platform/lw-ui-studio/overview.md): Build interactive search experience pages with drag-and-drop canvas sections, pre-built components, and no-code configuration.
- [Compositions](https://doc.lucidworks.com/docs/lw-platform/lw-ui-studio/compositions.md): A composition is the top-level container you build, version, and publish in UI Studio.

#### Components

- [Button](https://doc.lucidworks.com/docs/lw-platform/lw-ui-studio/components/button.md): Interactive or static button component for navigation or actions in UI Studio applications
- [Facets](https://doc.lucidworks.com/docs/lw-platform/lw-ui-studio/components/facets.md): Interactive filtering component for refining search results by categories and attributes in UI Studio applications
- [Image](https://doc.lucidworks.com/docs/lw-platform/lw-ui-studio/components/image.md): Display images with optional links and views in UI Studio applications
- [Results](https://doc.lucidworks.com/docs/lw-platform/lw-ui-studio/components/results.md): Display search results with sorting, pagination, conditional row coloring, and dynamic row linking
- [Search Bar](https://doc.lucidworks.com/docs/lw-platform/lw-ui-studio/components/search-bar.md): Interactive search input with typeahead autocomplete suggestions in UI Studio applications
- [Text](https://doc.lucidworks.com/docs/lw-platform/lw-ui-studio/components/text.md): Display and format text content with rich styling options in UI Studio applications

### Agent Studio

- [Quickstart](https://doc.lucidworks.com/docs/lw-platform/lw-agent-studio/quickstart.md)
- [Agent Studio](https://doc.lucidworks.com/docs/lw-platform/lw-agent-studio/overview.md)

### Commerce Studio

- [Commerce Studio](https://doc.lucidworks.com/docs/lw-platform/lw-cs/overview.md)
- [Editor](https://doc.lucidworks.com/docs/lw-platform/lw-cs/cstudio-editor.md)
- [Rules](https://doc.lucidworks.com/docs/lw-platform/lw-cs/cstudio-rules.md)
- [Rewrites](https://doc.lucidworks.com/docs/lw-platform/lw-cs/cstudio-query-rewrite.md)
- [Settings](https://doc.lucidworks.com/docs/lw-platform/lw-cs/cstudio-settings.md)
- [AI Ranking Insights](https://doc.lucidworks.com/docs/lw-platform/lw-cs/cs-ai-ranking-insights.md)
- [Rules and Rewrites API](https://doc.lucidworks.com/docs/lw-platform/lw-cs/cs-rules-rewrites-api.md)
- [Commerce Studio versus Predictive Merchandiser](https://doc.lucidworks.com/docs/lw-platform/lw-cs/cstudio-versus-pm.md)
- [Migration guide](https://doc.lucidworks.com/docs/lw-platform/lw-cs/cs-migrate.md)

### Analytics Studio

- [Quickstart](https://doc.lucidworks.com/docs/lw-platform/lw-analytics/quickstart.md): Start collecting user insights in 3 steps.
- [Analytics Studio](https://doc.lucidworks.com/docs/lw-platform/lw-analytics/overview.md)
- [Metrics](https://doc.lucidworks.com/docs/lw-platform/lw-analytics/analytics-screen.md)
- [Analytics Studio and Commerce Studio](https://doc.lucidworks.com/docs/lw-platform/lw-analytics/analytics-and-commerce-studio.md)

#### Signals

- [Signals](https://doc.lucidworks.com/docs/lw-platform/lw-analytics/signals/overview.md)
- [Signals Store](https://doc.lucidworks.com/docs/lw-platform/lw-analytics/signals/signals-store.md)
- [Signal Usage Metrics](https://doc.lucidworks.com/docs/lw-platform/lw-analytics/signals/signal-usage.md)
- [Signals Beacon](https://doc.lucidworks.com/docs/lw-platform/lw-analytics/signals/signals-beacon.md)
- [Beacon configuration interface](https://doc.lucidworks.com/docs/lw-platform/lw-analytics/signals/beacon-configuration-interface.md)
- [Platform Signals API](https://doc.lucidworks.com/docs/lw-platform/lw-analytics/signals/signals-api.md)
- [Signals Beacon FAQ](https://doc.lucidworks.com/docs/lw-platform/lw-analytics/signals/faq.md)

## Platform APIs

### Authentication

#### Request Access Token

- [Request Access Token](https://doc.lucidworks.com/api-reference/request-access-token/request-access-token.md): Use this API to generate an access token.

### Async Chunking

#### Split content into chunks

- [Chunk text using the specified chunker](https://doc.lucidworks.com/api-reference/split-content-into-chunks/chunk-text-using-the-specified-chunker.md): This is an all-purpose chunking endpoint you can use by specifying the `chunker` and `modelId` to use.
- [Split text on newlines](https://doc.lucidworks.com/api-reference/split-content-into-chunks/split-text-on-newlines.md): The dynamic-newline chunker (chunking strategy) splits the provided text on all new line characters. Then all of the split chunks under the `maxChunkSize` limit will be merged.
- [Chunk using dynamic-sentence](https://doc.lucidworks.com/api-reference/split-content-into-chunks/chunk-using-dynamic-sentence.md): The dynamic-sentence chunker (chunking strategy) splits the provided text into sentences. Sentences are joined until they reach the `maxChunkSize`. If `overlapSize` is provided, adjacent chunks will both have overlapping sentences on the sides.
- [Split text on a regex](https://doc.lucidworks.com/api-reference/split-content-into-chunks/split-text-on-a-regex.md): The regex-splitter chunker (chunking strategy) splits the submitted text based on the specified regex (regular expression), according to the conventions employed by the `re` python package. For more information about the `re` operations, see https://docs.python.org/3/library/re.html.
- [Chunk using semantic chunker](https://doc.lucidworks.com/api-reference/split-content-into-chunks/chunk-using-semantic-chunker.md): The semantic chunker (chunking strategy) creates chunks based on semantic similarity.
- [Split text on sentences](https://doc.lucidworks.com/api-reference/split-content-into-chunks/split-text-on-sentences.md): The sentence chunker (chunking strategy) splits text on sentences.

#### Request chunked content

- [Get results by chunkingId](https://doc.lucidworks.com/api-reference/request-chunked-content/get-results-by-chunkingid.md): Fetch chunked content by chunking ID. The ID is returned in the response of the `POST` operation you used to trigger the chunking operation.

### Async Prediction

#### Create predictions

- [Model predictions by use case](https://doc.lucidworks.com/api-reference/create-predictions/model-predictions-by-use-case.md): This is an all-purpose prediction endpoint you can use by specifying a `USE_CASE` and `MODEL_ID`. Upon submission, the API responds with a unique `predictionId` and a `status`. The `predictionId` can be used later in the GET request to retrieve the results.
- [FAQ Enrichment use case](https://doc.lucidworks.com/api-reference/create-predictions/faq-enrichment-use-case.md): The FAQ enrichment use case uses a large language model (LLM) to ingest input text and return a JSON response that contains a list of question and answer pairs.
- [Image metadata enrichment use case](https://doc.lucidworks.com/api-reference/create-predictions/image-metadata-enrichment-use-case.md): In the image metadata enrichment use case, the LLM ingests a text containing either a base64-encoded image or a public HTTP/HTTPS or Google Cloud Storage (`gs://`) image link and routes the image to a multimodal model. A JSON response is returned that contains an `imageMetadata` dictionary with a li…
- [Passthrough use case](https://doc.lucidworks.com/api-reference/create-predictions/passthrough-use-case.md): The passthrough use case lets you use the service as a proxy to the large language model (LLM). The service sends text (no additional prompts or other information) to the LLM.
- [RAG use case](https://doc.lucidworks.com/api-reference/create-predictions/rag-use-case.md): The rag use case uses candidate documents that are inserted into a LLM’s context to ground the generated response to those documents instead of generating an answer from details stored in the LLM’s trained weights. This type of search adds guardrails so the LLM can search private data collections.
- [Standalone query rewriter](https://doc.lucidworks.com/api-reference/create-predictions/standalone-query-rewriter.md): The standalone query rewriter use case rewrites the text in reference to the context based on the memoryUuid.
- [Summarization use case](https://doc.lucidworks.com/api-reference/create-predictions/summarization-use-case.md): In the summarization use case, the LLM ingests text and returns a summary of the text as a response.
- [Keyword extraction use case](https://doc.lucidworks.com/api-reference/create-predictions/keyword-extraction-use-case.md): In the keyword-extraction use case, the LLM ingests text and returns a JSON response that contains a list of keywords extracted from the text. No options can be configured.
- [Named Entity Recognition (NER) use case](https://doc.lucidworks.com/api-reference/create-predictions/named-entity-recognition-ner-use-case.md): In the Named Entity Recognition (NER) use case, the LLM ingests text and entities to extract and return a JSON response that contains a list of entities extracted from the text. No options can be configured.

#### Fetch predictions

- [Get prediction results](https://doc.lucidworks.com/api-reference/fetch-predictions/get-prediction-results.md): Fetch the results of a prediction task by its ID.

### Commerce Studio Rules & Rewrites

#### Rule Management

- [List rules](https://doc.lucidworks.com/api-reference/rule-management/list-rules.md): List all rules with optional filtering and pagination. Note that sorting applies to the rule's staging content only. Filtering applies OR logic, matching if either the staging or live content matches the filter. Use `textSearchRelevance` sort to sort by search relevance (cannot be combined with othe…
- [Create a rule](https://doc.lucidworks.com/api-reference/rule-management/create-a-rule.md): Create a rule in Commerce Studio.
- [Get a rule](https://doc.lucidworks.com/api-reference/rule-management/get-a-rule.md): Retrieve a rule.
- [Update a rule](https://doc.lucidworks.com/api-reference/rule-management/update-a-rule.md): Update a rule.
- [Delete a rule](https://doc.lucidworks.com/api-reference/rule-management/delete-a-rule.md): Delete a rule.

#### Query Rewrite Management

- [List query rewrites](https://doc.lucidworks.com/api-reference/query-rewrite-management/list-query-rewrites.md): Note that sorting applies to the rule's staging content only. Filtering applies OR logic, so it matches if either the staging or live content matches the filter. Use `textSearchRelevance` sort to sort by search relevance (cannot be combined with other sort parameters).
- [Create a query rewrite](https://doc.lucidworks.com/api-reference/query-rewrite-management/create-a-query-rewrite.md): Create a query rewrite in Commerce Studio.
- [Get a query rewrite](https://doc.lucidworks.com/api-reference/query-rewrite-management/get-a-query-rewrite.md): Retrieve a query rewrite.
- [Update a query rewrite](https://doc.lucidworks.com/api-reference/query-rewrite-management/update-a-query-rewrite.md): Update a query rewrite.
- [Delete a query rewrite](https://doc.lucidworks.com/api-reference/query-rewrite-management/delete-a-query-rewrite.md): Delete a query rewrite.

#### Bulk Operations

- [List bulk operations](https://doc.lucidworks.com/api-reference/bulk-operations/list-bulk-operations.md): List all bulk operations with optional filtering and pagination. Returns operations of all types including publish, unpublish, edit, delete, and migrate.
- [Create bulk operation](https://doc.lucidworks.com/api-reference/bulk-operations/create-bulk-operation.md): Create a new bulk operation to perform actions on multiple rules. Supports publish, unpublish, edit, delete, and migrate operation types. Operations execute asynchronously.
- [Get bulk operation](https://doc.lucidworks.com/api-reference/bulk-operations/get-bulk-operation.md): Retrieve details of a specific bulk operation including current status, individual rule statuses, and error messages for failed rules.
- [Update bulk operation](https://doc.lucidworks.com/api-reference/bulk-operations/update-bulk-operation.md): Update an existing bulk operation. Used to modify operation parameters or retry failed rules.
- [Delete bulk operation](https://doc.lucidworks.com/api-reference/bulk-operations/delete-bulk-operation.md): Delete a bulk operation record. This removes the operation from the system but does not reverse changes already applied to rules.

### Models

#### Manage models

- [List all models](https://doc.lucidworks.com/api-reference/manage-models/list-all-models.md): Fetch the list of pre-trained and custom models.
- [Create a model](https://doc.lucidworks.com/api-reference/manage-models/create-a-model.md): Create a custom model and start a training job. The custom model cannot be modified after it is created.
- [Get a model](https://doc.lucidworks.com/api-reference/manage-models/get-a-model.md): Get the details about a specific model.

#### Manage deployments

- [List custom model deployments](https://doc.lucidworks.com/api-reference/manage-deployments/list-custom-model-deployments.md): Fetch the list of custom model deployments. Pre-trained models are not returned in the response because they are deployed in all available regions.
- [Deploy a custom model](https://doc.lucidworks.com/api-reference/manage-deployments/deploy-a-custom-model.md): Deploy a custom model.
- [Delete a custom model deployment](https://doc.lucidworks.com/api-reference/manage-deployments/delete-a-custom-model-deployment.md): Delete the specified custom model deployment.
- [List a model's deployments](https://doc.lucidworks.com/api-reference/manage-deployments/list-a-models-deployments.md): Fetch the list of deployments for the specified model.

### Platform Signals

#### Get signals

- [Query signals](https://doc.lucidworks.com/api-reference/get-signals/query-signals.md): When a user enters text to search your site, a query request is generated and the information is contained in a query signal.
- [Click signals](https://doc.lucidworks.com/api-reference/get-signals/click-signals.md): When a user clicks on an item displayed from your site, including results returned from a query, the information is contained in a click signal.
- [Cartadd signals](https://doc.lucidworks.com/api-reference/get-signals/cartadd-signals.md): When a user adds an item to the cart for a potential sale, the information is contained in the cartadd signal.
- [Purchase complete signals](https://doc.lucidworks.com/api-reference/get-signals/purchase-complete-signals.md): When a user completes a purchase and is taken to the order confirmation page, a signal is recorded.

### Prediction

#### Get predictions

- [Model predictions by use case](https://doc.lucidworks.com/api-reference/get-predictions/model-predictions-by-use-case.md): This is an all-purpose prediction endpoint you can use by specifying a `USE_CASE` and `MODEL_ID`.
- [English language model text encoder](https://doc.lucidworks.com/api-reference/get-predictions/english-language-model-text-encoder.md): The English language encoder is an embedding use that takes in plain English text and returns a 768-dimensional vector encoding of that text. This model powers this semantic search.
- [Custom model prediction](https://doc.lucidworks.com/api-reference/get-predictions/custom-model-prediction.md): The custom model prediction is an embedding use case. If a custom model is trained and deployed using the Lucidworks AI Models API, the `DEPLOYMENT_ID` in the Models API is the same value as the `MODEL_ID` you enter in the custom model to return a prediction.
- [Classification use case](https://doc.lucidworks.com/api-reference/get-predictions/classification-use-case.md): The classification use case lets you use embedding models to compute similarity scores between the incoming text and the labels. It returns the labels ranked in order of most similar to least similar.
- [FAQ Enrichment use case](https://doc.lucidworks.com/api-reference/get-predictions/faq-enrichment-use-case.md): The FAQ enrichment use case uses a large language model (LLM) to ingest input text and return a JSON response that contains a list of question and answer pairs.
- [Image metadata enrichment use case](https://doc.lucidworks.com/api-reference/get-predictions/image-metadata-enrichment-use-case.md): In the image metadata enrichment use case, the LLM ingests a text containing either a base64-encoded image or a public HTTP/HTTPS or Google Cloud Storage (`gs://`) image link and routes the image to a multimodal model. A JSON response is returned that contains an `imageMetadata` dictionary with a li…
- [Part Number Detection use case](https://doc.lucidworks.com/api-reference/get-predictions/part-number-detection-use-case.md): The Part Number Detection use case of the LWAI Prediction API detects part numbers in order to help with query routing and classification, and uses the embedding model to ingest text and return a JSON response of `true` if the input is a part number, or `false` if the input is not a part number.
- [Passthrough use case](https://doc.lucidworks.com/api-reference/get-predictions/passthrough-use-case.md): The passthrough use case lets you use the service as a proxy to the large language model (LLM). The service sends text (no additional prompts or other information) to the LLM and returns a response.
- [RAG use case](https://doc.lucidworks.com/api-reference/get-predictions/rag-use-case.md): The rag use case uses candidate documents that are inserted into a LLM’s context to ground the generated response to those documents instead of generating an answer from details stored in the LLM’s trained weights. This type of search adds guardrails so the LLM can search private data collections.
- [Standalone query rewriter](https://doc.lucidworks.com/api-reference/get-predictions/standalone-query-rewriter.md): The standalone query rewriter use case rewrites the text in reference to the context based on the memoryUuid.
- [Summarization use case](https://doc.lucidworks.com/api-reference/get-predictions/summarization-use-case.md): In the summarization use case, the LLM ingests text and returns a summary of the text as a response.
- [Keyword extraction use case](https://doc.lucidworks.com/api-reference/get-predictions/keyword-extraction-use-case.md): In the keyword-extraction use case, the LLM ingests text and returns a JSON response that contains a list of keywords extracted from the text. No options can be configured.
- [Named Entity Recognition (NER) use case](https://doc.lucidworks.com/api-reference/get-predictions/named-entity-recognition-ner-use-case.md): In the Named Entity Recognition (NER) use case, the LLM ingests text and entities to extract and return a JSON response that contains a list of entities extracted from the text. No options can be configured.

### Prompt Preview

#### Passthrough prompt

- [Passthrough prompt](https://doc.lucidworks.com/api-reference/passthrough-prompt/passthrough-prompt.md): The prompt request for the passthrough use case and specified generative AI (GenAI) `modelId` (model name) sends text to return results in formats supported by generative AI (GenAI) models.

### Tokenization

#### Get tokens

- [Tokenization by MODEL_ID](https://doc.lucidworks.com/api-reference/get-tokens/tokenization-by-model_id.md): The tokenization request for the pre-trained and custom embedding use cases and specified embedding `modelId` (model name) sends text to return results in formats supported by embedding models.

### Use Case

#### Use Cases

- [Get use cases](https://doc.lucidworks.com/api-reference/use-cases/get-use-cases.md): Fetch the list of supported use cases with related models.

### Typeahead

#### API Reference

- [Get typeahead suggestions](https://doc.lucidworks.com/api-reference/get-typeahead-suggestions.md): The `GET /typeahead/suggestions` request retrieves a list of typeahead suggestions.

- [Self-hosted Fusion (1539 pages)](https://doc.lucidworks.com/_llms/self-hosted-fusion.md): Documentation for Self-hosted Fusion.
- [Lucidworks Search (310 pages)](https://doc.lucidworks.com/_llms/lucidworks-search.md): Documentation for Lucidworks Search.
- [Fusion APIs (997 pages)](https://doc.lucidworks.com/_llms/fusion-apis.md): Documentation for Fusion APIs.

## Connectors

###  

- [Connectors](https://doc.lucidworks.com/docs/fusion-connectors/overview.md)
- [Latest changes](https://doc.lucidworks.com/docs/fusion-connectors/latest-changes.md): Fusion Connectors
- [Deprecations and Removals](https://doc.lucidworks.com/docs/fusion-connectors/deprecations-and-removals.md): Fusion Connectors

#### Migrate to V2

- [General V2/Pro migration guide](https://doc.lucidworks.com/docs/fusion-connectors/migration-guide.md)
- [Solr Pro migration guide](https://doc.lucidworks.com/docs/fusion-connectors/migration-solr-pro.md): This guide provides instructions on migrating from the Solr V1 connector to the Solr Pro connector.
- [FTP Pro migration guide](https://doc.lucidworks.com/docs/fusion-connectors/migration-ftp-pro.md): This guide provides instructions on migrating from the FTP V1 connector to the FTP Pro connector.

### Concepts

- [Concepts](https://doc.lucidworks.com/docs/fusion-connectors/concepts/overview.md)
- [Datasources](https://doc.lucidworks.com/docs/fusion-connectors/concepts/datasources.md)
- [V1 and V2 Connectors](https://doc.lucidworks.com/docs/fusion-connectors/concepts/v1-v2-connectors.md)
- [Active Directory Connector for ACLs](https://doc.lucidworks.com/docs/fusion-connectors/concepts/ad-acl.md)
- [ServiceNow V1 Connector](https://doc.lucidworks.com/docs/fusion-connectors/concepts/servicenow.md)
- [SharePoint and SharePoint Online Connectors](https://doc.lucidworks.com/docs/fusion-connectors/concepts/sharepoint.md)
- [Windows Share SMB 2/3 Connector](https://doc.lucidworks.com/docs/fusion-connectors/concepts/windows-share-smb-2-3.md)

### Connectors

- [Configuration Reference](https://doc.lucidworks.com/docs/fusion-connectors/connectors/overview.md)
- [AEM V2](https://doc.lucidworks.com/docs/fusion-connectors/connectors/aem.md): The AEM V2 connector retrieves data from an Adobe Experience Manager (AEM) repository and is compatible with AEM version 6.5.
- [AWS S3 Pro](https://doc.lucidworks.com/docs/fusion-connectors/connectors/amazon-aws-s3-pro.md): The AWS S3 Pro connector enables Fusion to crawl and index content stored in Amazon S3 buckets.
- [Box.com V2](https://doc.lucidworks.com/docs/fusion-connectors/connectors/box.com-v2.md): The Box V2 connector retrieves data from a Box.com cloud-based data repository.
- [Couchbase V2](https://doc.lucidworks.com/docs/fusion-connectors/connectors/couchbase-v2.md): The Couchbase V2 connector uses the Couchbase Java client to retrieve data stored in Couchbase.
- [File Upload Pro](https://doc.lucidworks.com/docs/fusion-connectors/connectors/fileupload-pro.md): The File Upload Pro connector provides a convenient way to quickly ingest data from your local filesystem.
- [FTP Pro](https://doc.lucidworks.com/docs/fusion-connectors/connectors/ftp-pro.md): The FTP Pro connector retrieves documents using the File Transfer Protocol (FTP), FTPS, and SFTP.
- [Google Cloud Storage (GCS) V2](https://doc.lucidworks.com/docs/fusion-connectors/connectors/google-cloud-storage.md): The Fusion Google Cloud Storage (GCS) V2 connector enables indexing datasets from GCS buckets into Fusion 5. The connector leverages the Google Cloud API for authentication and fetching content and metadata.
- [JDBC V2](https://doc.lucidworks.com/docs/fusion-connectors/connectors/jdbc-v2.md): The JDBC V2 connector fetches rows from any JDBC-compliant relational database and indexes them as documents in Fusion. Each row returned by the SQL `SELECT` statements entered in Fusion becomes a document in the content collection, enabling the querying of relational data.
- [Kaltura V2](https://doc.lucidworks.com/docs/fusion-connectors/connectors/kaltura.md): The Kaltura V2 connector uses the Kaltura Java API client to retrieve data stored in Kaltura.
- [LDAP ACLs V2](https://doc.lucidworks.com/docs/fusion-connectors/connectors/ad-acl-ldap.md): The LDAP ACLs V2 connector indexes access control lists (ACLs) from an LDAP directory. It is used by other content connectors to enable security trimming so users can only search and access content they're authorized to see.
- [Local Filesystem V2](https://doc.lucidworks.com/docs/fusion-connectors/connectors/local-filesystem-v2.md): The Local Filesystem V2 connector traverses a network file system (NFS), where a shared drive is mounted to the same location on all hosts in the cluster that are running this connector.
- [OneDrive Datasource V2](https://doc.lucidworks.com/docs/fusion-connectors/connectors/onedrive.md): The Fusion OneDrive connector crawls a OneDrive for Business instance and retrieves data from it for indexing within Fusion.
- [SharePoint Optimized V2](https://doc.lucidworks.com/docs/fusion-connectors/connectors/sharepoint-v2-optimized.md): The SharePoint Optimized V2 connector indexes content and metadata from SharePoint Online and on-premises environments, making it searchable in Fusion.
- [SharePoint V2](https://doc.lucidworks.com/docs/fusion-connectors/connectors/sharepoint-v2.md): The SharePoint connector retrieves content and metadata from an on-premises SharePoint repository.
- [Sitecore V2](https://doc.lucidworks.com/docs/fusion-connectors/connectors/sitecore.md): The Sitecore V2 connector provides full crawl and incremental crawl support for Sitecore versions 8.x and 9.x. It indexes document content and all metadata.
- [Slack V2](https://doc.lucidworks.com/docs/fusion-connectors/connectors/slack-v2.md): The Slack V2 connector allows you to index Slack channels and messages.
- [Solr Pro](https://doc.lucidworks.com/docs/fusion-connectors/connectors/solr-pro.md): The Solr Pro connector pulls documents from an external standalone Apache Solr instance or Apache SolrCloud cluster using Solr's javabin response type and streaming response parser.
- [Solr Push Endpoint V2](https://doc.lucidworks.com/docs/fusion-connectors/connectors/solr-push.md): The Solr Push Endpoint accepts documents and pushes them to Solr using the Fusion index pipelines.
- [Web V2](https://doc.lucidworks.com/docs/fusion-connectors/connectors/web-v2.md): The Web V2 connector retrieves data from a website using HTTP and starting from a specified URL.
- [Windows Share SMB 2/3 V2](https://doc.lucidworks.com/docs/fusion-connectors/connectors/windows-share-smb-2-3-v2.md): The Windows Share connector can access content in a Windows Share or Server Message Block (SMB 2 and 3 protocols)/Common Internet File System (CIFS) filesystem.

#### REST V2

- [REST V2](https://doc.lucidworks.com/docs/fusion-connectors/connectors/rest-v2/overview.md): The REST V2 connector is a way to use one connector for multiple datasources. It works with recipes, which are premade JSON configurations.
- [Use OAuth](https://doc.lucidworks.com/docs/fusion-connectors/connectors/rest-v2/rest-v2-oauth.md): REST V2 connector
- [FAQ](https://doc.lucidworks.com/docs/fusion-connectors/connectors/rest-v2/rest-v2-faq.md): REST V2 connector
- [Troubleshooting](https://doc.lucidworks.com/docs/fusion-connectors/connectors/rest-v2/rest-v2-troubleshooting.md): REST V2 connector

##### Recipes

- [Recipes](https://doc.lucidworks.com/docs/fusion-connectors/connectors/rest-v2/recipes/overview.md): REST V2 connector
- [Alfresco](https://doc.lucidworks.com/docs/fusion-connectors/connectors/rest-v2/recipes/rest-alfresco.md): REST V2 connector
- [Confluence](https://doc.lucidworks.com/docs/fusion-connectors/connectors/rest-v2/recipes/rest-confluence.md): REST V2 connector
- [GitHub](https://doc.lucidworks.com/docs/fusion-connectors/connectors/rest-v2/recipes/rest-github.md): REST V2 connector
- [Jira](https://doc.lucidworks.com/docs/fusion-connectors/connectors/rest-v2/recipes/rest-jira.md): REST V2 connector

#### V1 connectors

- [AWS S3 V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/s3.md): The AWS S3 V1 Connector can access AWS S3 buckets in native format.
- [Active Directory for ACLs V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/ad-acl.md): The Active Directory Connector for ACLs indexes Access Control List (ACL) information so that it can be used by other connectors.
- [Alfresco V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/alfresco.md): The Alfresco V1 connector allows Fusion to crawl and index content stored in an Alfresco Community repository that adheres to the Content Management Interoperability Services (CMIS) standard.
- [Apache Hadoop 2 V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/hadoop-apache2.md): The Apache Hadoop 2 Connector is a MapReduce-enabled crawler that is compatible with Apache Hadoop
- [Azure V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/azure.md): The Azure V1 connector is used to crawl an Azure instance.
- [Box.com V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/box.com.md): The Box connector retrieves data from a Box.com cloud-based data repository.
- [Cloudera V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/hadoop-cloudera.md): The Cloudera Connector is a MapReduce-enabled crawler that is compatible with Cloudera CDH v4.x and v5.x
- [Confluence V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/confluence.md): The connector retrieves data from the Atlassian Confluence Wiki CMS by connecting to Confluence Cloud or Confluence Server/Data Center.
- [Couchbase V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/couchbase.md): The Couchbase V1 connector uses the Cross-Datacenter Replication (XDCR) feature of Couchbase to retrieve data stored in Couchbase continuously in real-time.
- [Dropbox V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/dropbox.md): The Dropbox connector retrieves data from a Dropbox cloud-based data repository.
- [Drupal 7.x V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/drupal-7.x.md): The Drupal connector requires Drupal’s Services 7.x3.11 Module REST API
- [FTP V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/ftp.md): The FTP V1 connector retrieves documents using the File Transfer Protocol (FTP).
- [File Upload V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/fileupload.md): The File Upload V1 connector provides a convenient way to quickly ingest data from a single uploaded file. It can crawl exactly one file from Fusion's Blob Store and feed it through an index pipeline.
- [GitHub V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/github.md): The GitHub connector retrieves data from GitHub repositories using the GitHub REST API.
- [Google Drive V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/googledrive.md): The Google Drive connector is used to index the documents in a Google Drive account.
- [HDFS V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/hdfs.md): The HDFS V1 connector traverses the Hadoop Distributed File System (HDFS) as it would a regular Unix filesystem.
- [Hortonworks V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/hadoop-hortonworks.md): The Hortonworks Connector is a MapReduce-enabled crawler that is compatible with Hortonworks Data Platform v2.x.
- [JDBC V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/jdbc.md): The JDBC connector fetches documents from a relational database via SQL queries.
- [Jira V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/jira.md): The Jira V1 connector retrieves data from an instance of Atlassian’s Jira issue tracking system.
- [Jive V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/jive.md): The Jive V1 connector retrieves content from a Jive instance.
- [Local Filesystem V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/local-filesystem-v1.md): This connector traverses a network file system (NFS), where a shared drive is mounted to the same location on all hosts in the cluster that are running this connector.
- [MapR V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/hadoop-mapr.md): The MapR Connector is a MapReduce-enabled crawler that is compatible with MapR 4.x and 5.x.
- [MongoDB V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/mongodb.md): The MongoDB V1 connector ingests documents from a MongoDB database into Fusion for indexing and search.
- [Salesforce V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/salesforce.md): The Salesforce V1 connector uses the Salesforce REST API to ingest and index data from a Salesforce Connected App in a Salesforce repository.
- [ServiceNow V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/servicenow.md): The ServiceNow V1 connector ingests records, knowledge articles, incidents, tasks, and other content from your ServiceNow instance into Fusion for search and analysis.
- [SharePoint Online V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/sharepoint-online.md): The SharePoint Online V1 connector retrieves data from cloud-based SharePoint repositories.
- [SharePoint Online V1 Optimized](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/sharepoint-online-v1-optimized.md): The SharePoint Online V1 Optimized connector retrieves data from cloud-based SharePoint repositories.
- [SharePoint V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/sharepoint.md): The SharePoint connector retrieves content and metadata from an on-premises SharePoint repository.
- [SharePoint V1 Optimized](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/sharepoint-v1-optimized.md): The SharePoint connector retrieves content and metadata from an on-premises SharePoint repository.
- [Solr V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/solr.md): The Solr V1 connector pulls documents from an external standalone Apache Solr instance or Apache SolrCloud cluster using Solr's javabin response type and streaming response parser.
- [SolrXML V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/solrxml.md): The SolrXML connector indexes XML files formatted according to Solr’s XML structure.
- [Twitter Search V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/twitter-search.md): The Twitter Search connector uses Twitter’s search API to query Twitter for tweets that match specific parameters. It allows querying for any keyword, location or other query terms.
- [Twitter Stream V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/twitter-stream.md): The Twitter Stream connector uses Twitter’s streaming API to continually index Twitter.
- [Web V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/web.md): The Web V1 connector retrieves data from a website using HTTP and starting from a specified URL.
- [Windows Share SMB 2/3 V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/windows-share-smb-2-3.md): The Windows Share connector can access content in a Windows Share or Server Message Block (SMB 2 and 3 protocols)/Common Internet File System (CIFS) filesystem. Available in Fusion 5.x.x releases.
- [Windows Share V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/windows-share.md): The Windows Share connector can access content in a Windows Share or Server Message Block (SMB)/Common Internet File System (CIFS) filesystem.
- [Zendesk V1](https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/zendesk.md): The Zendesk connector uses the Zendesk REST API to retrieve tickets and their associated comments and attachments from a Zendesk repository.

### Developers

- [Lucid.anda Connector Framework](https://doc.lucidworks.com/docs/fusion-connectors/developers/lucid.anda-connector-framework.md)
- [Lucid.fs Connector Framework](https://doc.lucidworks.com/docs/fusion-connectors/developers/lucid.fs-connector-framework.md)
- [Connectors SDK](https://doc.lucidworks.com/docs/fusion-connectors/developers/connectors-sdk-4x.md)
- [Java Connector Development](https://doc.lucidworks.com/docs/fusion-connectors/developers/java-sdk.md)
- [Remote Connectors](https://doc.lucidworks.com/docs/fusion-connectors/developers/remote-connectors.md)
- [Remote V2 Connectors](https://doc.lucidworks.com/docs/fusion-connectors/developers/remote-v2-connectors.md)

### Downloads

- [V2 and Pro connector downloads](https://doc.lucidworks.com/docs/fusion-connectors/downloads/v2-connectors-downloads.md)
- [V1 connector downloads](https://doc.lucidworks.com/docs/fusion-connectors/downloads/fusion-4-x-connector-downloads.md)

## Policies

###  

- [Policies](https://doc.lucidworks.com/docs/policies/overview.md)

### Support tiers

- [Lucidworks Enterprise Technical Support Policy](https://doc.lucidworks.com/docs/policies/enterprise-technical-support.md)
- [Lucidworks Managed Services Technical Support Policy](https://doc.lucidworks.com/docs/policies/managed-technical-support.md)
- [Lucidworks Modern Technical Support Policy](https://doc.lucidworks.com/docs/policies/modern-technical-support.md)
- [Technical Support](https://doc.lucidworks.com/docs/policies/technical-support.md)

### Support lifecycle policies

- [Lucidworks Semantic Version Support Lifecycle](https://doc.lucidworks.com/docs/policies/lifecycle-policies/lw-semantic-version-support-lifecycle.md)
- [Lucidworks Version Support Lifecycle](https://doc.lucidworks.com/docs/policies/lifecycle-policies/lw-version-support-lifecycle.md)
- [Lucidworks Fusion Product Lifecycle](https://doc.lucidworks.com/docs/policies/lifecycle-policies/lw-fusion-product-lifecycle.md)

### Technology support

- [Lucidworks Apache Solr Support Policy](https://doc.lucidworks.com/docs/policies/apache-solr-support-policy.md)
- [Lucidworks Certified vs. Supported Policy](https://doc.lucidworks.com/docs/policies/certified-vs-supported-policy.md)

### Product features

- [Lucidworks Feature Limited Availability](https://doc.lucidworks.com/docs/policies/feature-availability.md)

### Privacy and compliance

- [GDPR Compliance Policy](https://doc.lucidworks.com/docs/policies/lw-signals-beacon-gdpr-compliance.md)
- [Lucidworks Signals Beacon Privacy and Security Policies](https://doc.lucidworks.com/docs/policies/lw-signals-beacon.md)

## OpenAPI Specs

- [authentication](/api-reference/saas/authentication.json)
- [machine-learning-platform-async-chunking](/api-reference/saas/machine-learning-platform-async-chunking.json)
- [machine-learning-platform-async-prediction](/api-reference/saas/machine-learning-platform-async-prediction.json)
- [cs-rules-rewrites](/api-reference/saas/cs-rules-rewrites.json)
- [machine-learning-models](/api-reference/saas/machine-learning-models.json)
- [lw-platform-signals](/api-reference/saas/lw-platform-signals.json)
- [machine-learning-platform-predict](/api-reference/saas/machine-learning-platform-predict.json)
- [machine-learning-platform-prompt-passthrough](/api-reference/saas/machine-learning-platform-prompt-passthrough.json)
- [machine-learning-platform-tokenization](/api-reference/saas/machine-learning-platform-tokenization.json)
- [machine-learning-platform-use-case](/api-reference/saas/machine-learning-platform-use-case.json)
- [lw-platform-typeahead](/api-reference/saas/lw-platform-typeahead.json)
- [fusion-api-swagger](/api-reference/5.9/fusion-api-swagger.json)
- [fusion-api-apps-manager](/api-reference/5.9/fusion-api-apps-manager.json)
- [fusion-api-apps-manager](/api-reference/5.18/fusion-api-apps-manager.json)
- [fusion-api-indexing](/api-reference/5.9/fusion-api-indexing.json)
- [fusion-api-async-parsing](/api-reference/5.9/fusion-api-async-parsing.json)
- [fusion-api-connectors](/api-reference/5.9/fusion-api-connectors.json)
- [fusion-api-job-config](/api-reference/5.9/fusion-api-job-config.json)
- [fusion-api-job-launcher](/api-reference/5.9/fusion-api-job-launcher.json)
- [fusion-api-job-rest-server](/api-reference/5.9/fusion-api-job-rest-server.json)
- [fusion-api-ml-model-service](/api-reference/5.9/fusion-api-ml-model-service.json)
- [fusion-api-api-docs](/api-reference/5.9/fusion-api-api-docs.json)
- [fusion-api-api-docs](/api-reference/5.18/fusion-api-api-docs.json)
- [fusion-api-query](/api-reference/5.9/fusion-api-query.json)
- [fusion-api-templating](/api-reference/5.9/fusion-api-templating.json)
- [service-apps](/api-reference/4.2/service-apps.json)
- [service-archive](/api-reference/4.2/service-archive.json)
- [service-blobs](/api-reference/4.2/service-blobs.json)
- [service-catalog](/api-reference/4.2/service-catalog.json)
- [service-collections](/api-reference/4.2/service-collections.json)
- [service-configurations](/api-reference/4.2/service-configurations.json)
- [service-connectors-datasources](/api-reference/4.2/service-connectors-datasources.json)
- [service-connectors-history](/api-reference/4.2/service-connectors-history.json)
- [service-connectors-jobs](/api-reference/4.2/service-connectors-jobs.json)
- [service-connectors-plugins](/api-reference/4.2/service-connectors-plugins.json)
- [service-connectors-status](/api-reference/4.2/service-connectors-status.json)
- [service-custom-rule-type-crud](/api-reference/4.2/service-custom-rule-type-crud.json)
- [service-experiments](/api-reference/4.2/service-experiments.json)
- [service-features](/api-reference/4.2/service-features.json)
- [service-groups](/api-reference/4.2/service-groups.json)
- [service-history-id](/api-reference/4.2/service-history-id.json)
- [service-history](/api-reference/4.2/service-history.json)
- [service-index-pipeline-templates](/api-reference/4.2/service-index-pipeline-templates.json)
- [service-index-pipelines](/api-reference/4.2/service-index-pipelines.json)
- [service-index-profiles-crud](/api-reference/4.2/service-index-profiles-crud.json)
- [service-index-profiles](/api-reference/4.2/service-index-profiles.json)
- [service-index-stages](/api-reference/4.2/service-index-stages.json)
- [service-introspect](/api-reference/4.2/service-introspect.json)
- [service-jobs](/api-reference/4.2/service-jobs.json)
- [service-license](/api-reference/4.2/service-license.json)
- [service-links](/api-reference/4.2/service-links.json)
- [service-messaging](/api-reference/4.2/service-messaging.json)
- [service-nodes](/api-reference/4.2/service-nodes.json)
- [service-objects](/api-reference/4.2/service-objects.json)
- [service-parser-templates](/api-reference/4.2/service-parser-templates.json)
- [service-parsers](/api-reference/4.2/service-parsers.json)
- [service-partitions](/api-reference/4.2/service-partitions.json)
- [service-query-pipeline-templates](/api-reference/4.2/service-query-pipeline-templates.json)
- [service-query-pipelines](/api-reference/4.2/service-query-pipelines.json)
- [service-query-profile-backcompat](/api-reference/4.2/service-query-profile-backcompat.json)
- [service-query-profiles-crud](/api-reference/4.2/service-query-profiles-crud.json)
- [service-query-profiles](/api-reference/4.2/service-query-profiles.json)
- [service-query-rewrite](/api-reference/4.2/service-query-rewrite.json)
- [service-query-stages](/api-reference/4.2/service-query-stages.json)
- [service-recommend](/api-reference/4.2/service-recommend.json)
- [service-registration](/api-reference/4.2/service-registration.json)
- [service-scheduler](/api-reference/4.2/service-scheduler.json)
- [service-schema](/api-reference/4.2/service-schema.json)
- [service-searchCluster](/api-reference/4.2/service-searchCluster.json)
- [service-searchLogs](/api-reference/4.2/service-searchLogs.json)
- [service-signals](/api-reference/4.2/service-signals.json)
- [service-solr](/api-reference/4.2/service-solr.json)
- [service-solrAdmin](/api-reference/4.2/service-solrAdmin.json)
- [service-solrconfig](/api-reference/4.2/service-solrconfig.json)
- [service-spark](/api-reference/4.2/service-spark.json)
- [service-suggestions-datasources](/api-reference/4.2/service-suggestions-datasources.json)
- [service-swagger](/api-reference/4.2/service-swagger.json)
- [service-synonyms-editor](/api-reference/4.2/service-synonyms-editor.json)
- [service-system-autocomplete](/api-reference/4.2/service-system-autocomplete.json)
- [service-system](/api-reference/4.2/service-system.json)
- [service-tasks](/api-reference/4.2/service-tasks.json)
- [service-taxonomy](/api-reference/4.2/service-taxonomy.json)
- [service-usage](/api-reference/4.2/service-usage.json)
- [service-webapps-admin](/api-reference/4.2/service-webapps-admin.json)
- [service-webapps-appkit](/api-reference/4.2/service-webapps-appkit.json)
- [service-webapps](/api-reference/4.2/service-webapps.json)
- [service-zk-import-export](/api-reference/4.2/service-zk-import-export.json)
- [fusion-api-api-docs](/api-reference/5.17/fusion-api-api-docs.json)
- [fusion-api-apps-manager](/api-reference/5.17/fusion-api-apps-manager.json)
- [fusion-api-async-parsing](/api-reference/5.17/fusion-api-async-parsing.json)
- [fusion-api-connectors](/api-reference/5.17/fusion-api-connectors.json)
- [fusion-api-indexing](/api-reference/5.17/fusion-api-indexing.json)
- [fusion-api-job-config](/api-reference/5.17/fusion-api-job-config.json)
- [fusion-api-job-launcher](/api-reference/5.17/fusion-api-job-launcher.json)
- [fusion-api-job-rest-server](/api-reference/5.17/fusion-api-job-rest-server.json)
- [fusion-api-ml-model-service](/api-reference/5.17/fusion-api-ml-model-service.json)
- [fusion-api-query](/api-reference/5.17/fusion-api-query.json)
- [fusion-api-swagger](/api-reference/5.17/fusion-api-swagger.json)
- [fusion-api-templating](/api-reference/5.17/fusion-api-templating.json)
- [fusion-api-async-parsing](/api-reference/5.18/fusion-api-async-parsing.json)
- [fusion-api-connectors](/api-reference/5.18/fusion-api-connectors.json)
- [fusion-api-indexing](/api-reference/5.18/fusion-api-indexing.json)
- [fusion-api-job-config](/api-reference/5.18/fusion-api-job-config.json)
- [fusion-api-job-launcher](/api-reference/5.18/fusion-api-job-launcher.json)
- [fusion-api-job-rest-server](/api-reference/5.18/fusion-api-job-rest-server.json)
- [fusion-api-ml-model-service](/api-reference/5.18/fusion-api-ml-model-service.json)
- [fusion-api-query](/api-reference/5.18/fusion-api-query.json)
- [fusion-api-swagger](/api-reference/5.18/fusion-api-swagger.json)
- [fusion-api-templating](/api-reference/5.18/fusion-api-templating.json)
- [authentication-csrch](/api-reference/saas/authentication-csrch.json)
- [push](/api-reference/saas/push.json)
- [query-conf](/api-reference/saas/query-conf.json)
- [signals](/api-reference/saas/signals.json)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [Self-hosted Fusion (1539 pages)](https://doc.lucidworks.com/_llms/self-hosted-fusion.md): Documentation for Self-hosted Fusion.
- [Self-hosted Fusion / Fusion 5 (764 pages)](https://doc.lucidworks.com/_llms/self-hosted-fusion/fusion-5.md): Documentation for Self-hosted Fusion / Fusion 5.
- [Self-hosted Fusion / Fusion 4 (775 pages)](https://doc.lucidworks.com/_llms/self-hosted-fusion/fusion-4.md): Documentation for Self-hosted Fusion / Fusion 4.
- [Lucidworks Search (310 pages)](https://doc.lucidworks.com/_llms/lucidworks-search.md): Documentation for Lucidworks Search.
- [Fusion APIs (997 pages)](https://doc.lucidworks.com/_llms/fusion-apis.md): Documentation for Fusion APIs.
- [Fusion APIs / v5.18 (476 pages)](https://doc.lucidworks.com/_llms/fusion-apis/v5-18.md): Documentation for Fusion APIs / v5.18.
- [Fusion APIs / v5.17 (468 pages)](https://doc.lucidworks.com/_llms/fusion-apis/v5-17.md): Documentation for Fusion APIs / v5.17.
- [Fusion APIs / v5.9 (468 pages)](https://doc.lucidworks.com/_llms/fusion-apis/v5-9.md): Documentation for Fusion APIs / v5.9.
- [Fusion APIs / v4.2 (521 pages)](https://doc.lucidworks.com/_llms/fusion-apis/v4-2.md): Documentation for Fusion APIs / v4.2.