> ## Documentation Index
> Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get use cases

> Fetch the list of supported use cases with related models.



## OpenAPI

````yaml /api-reference/saas/machine-learning-platform-use-case.json get /ai/usecase
openapi: 3.0.1
info:
  title: Lucidworks AI Use Case API
  version: '1.0'
  description: >-
    The Lucidworks AI Use Case API returns a list of use cases and their
    associated models.


    The `usecase` endpoint requires an authentication token with scope
    `machinelearning.predict`, which is the same scope used in the Prediction
    API.
  contact:
    name: Lucidworks
    url: https://lucidworks.com/
    email: support@lucidworks.com
  termsOfService: https://lucidworks.com/legal/developer-license-agreement/
  license:
    name: Lucidworks
    url: https://lucidworks.com/legal/developer-license-agreement/
servers:
  - url: https://APPLICATION_ID.applications.lucidworks.com
    description: Production
security: []
tags:
  - name: Use Cases
    description: Access the library of available use cases.
paths:
  /ai/usecase:
    parameters: []
    get:
      tags:
        - Use Cases
      summary: Get use cases
      description: Fetch the list of supported use cases with related models.
      operationId: getUseCases
      parameters:
        - in: header
          name: Authorization
          schema:
            type: string
          required: true
          description: >-
            Bearer token used for authentication. Format: `Authorization: Bearer
            ACCESS_TOKEN`.
          example: Bearer abc123def456
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UseCaseResponse'
              example:
                - useCase: embedding
                  models:
                    - id: bge-large
                      name: bge-large
                      modelType: shared
                      vectorSize: 1024
                      modelProvider: Lucidworks
                    - id: multilingual-e5-large
                      name: multilingual-e5-large
                      modelType: shared
                      vectorSize: 1024
                      modelProvider: Lucidworks
                    - id: bge-small
                      name: bge-small
                      modelType: shared
                      vectorSize: 384
                      modelProvider: Lucidworks
                    - id: bge-base
                      name: bge-base
                      modelType: shared
                      vectorSize: 768
                      modelProvider: Lucidworks
                    - id: gte-small
                      name: gte-small
                      modelType: shared
                      vectorSize: 384
                      modelProvider: Lucidworks
                    - id: gte-base
                      name: gte-base
                      modelType: shared
                      vectorSize: 768
                      modelProvider: Lucidworks
                    - id: snowflake-arctic-embed-s
                      name: snowflake-arctic-embed-s
                      modelType: shared
                      vectorSize: 384
                      modelProvider: Lucidworks
                    - id: snowflake-arctic-embed-xs
                      name: snowflake-arctic-embed-xs
                      modelType: shared
                      vectorSize: 384
                      modelProvider: Lucidworks
                    - id: e5-small-v2
                      name: e5-small-v2
                      modelType: shared
                      vectorSize: 384
                      modelProvider: Lucidworks
                    - id: snowflake-arctic-embed-l-v2.0
                      name: snowflake-arctic-embed-l-v2.0
                      modelType: shared
                      vectorSize: 1024
                      modelProvider: Lucidworks
                    - id: gte-large
                      name: gte-large
                      modelType: shared
                      vectorSize: 1024
                      modelProvider: Lucidworks
                    - id: snowflake-arctic-embed-m-v2.0
                      name: snowflake-arctic-embed-m-v2.0
                      modelType: shared
                      vectorSize: 768
                      modelProvider: Lucidworks
                    - id: multilingual-e5-base
                      name: multilingual-e5-base
                      modelType: shared
                      vectorSize: 768
                      modelProvider: Lucidworks
                    - id: e5-base-v2
                      name: e5-base-v2
                      modelType: shared
                      vectorSize: 768
                      modelProvider: Lucidworks
                    - id: e5-large-v2
                      name: e5-large-v2
                      modelType: shared
                      vectorSize: 1024
                      modelProvider: Lucidworks
                    - id: multilingual-e5-small
                      name: multilingual-e5-small
                      modelType: shared
                      vectorSize: 384
                      modelProvider: Lucidworks
                - useCase: classification
                  models:
                    - id: bge-large
                      name: bge-large
                      modelType: shared
                      vectorSize: 1024
                      modelProvider: Lucidworks
                    - id: multilingual-e5-large
                      name: multilingual-e5-large
                      modelType: shared
                      vectorSize: 1024
                      modelProvider: Lucidworks
                    - id: bge-small
                      name: bge-small
                      modelType: shared
                      vectorSize: 384
                      modelProvider: Lucidworks
                    - id: bge-base
                      name: bge-base
                      modelType: shared
                      vectorSize: 768
                      modelProvider: Lucidworks
                    - id: gte-small
                      name: gte-small
                      modelType: shared
                      vectorSize: 384
                      modelProvider: Lucidworks
                    - id: gte-base
                      name: gte-base
                      modelType: shared
                      vectorSize: 768
                      modelProvider: Lucidworks
                    - id: snowflake-arctic-embed-s
                      name: snowflake-arctic-embed-s
                      modelType: shared
                      vectorSize: 384
                      modelProvider: Lucidworks
                    - id: snowflake-arctic-embed-xs
                      name: snowflake-arctic-embed-xs
                      modelType: shared
                      vectorSize: 384
                      modelProvider: Lucidworks
                    - id: e5-small-v2
                      name: e5-small-v2
                      modelType: shared
                      vectorSize: 384
                      modelProvider: Lucidworks
                    - id: snowflake-arctic-embed-l-v2.0
                      name: snowflake-arctic-embed-l-v2.0
                      modelType: shared
                      vectorSize: 1024
                      modelProvider: Lucidworks
                    - id: gte-large
                      name: gte-large
                      modelType: shared
                      vectorSize: 1024
                      modelProvider: Lucidworks
                    - id: snowflake-arctic-embed-m-v2.0
                      name: snowflake-arctic-embed-m-v2.0
                      modelType: shared
                      vectorSize: 768
                      modelProvider: Lucidworks
                    - id: multilingual-e5-base
                      name: multilingual-e5-base
                      modelType: shared
                      vectorSize: 768
                      modelProvider: Lucidworks
                    - id: e5-base-v2
                      name: e5-base-v2
                      modelType: shared
                      vectorSize: 768
                      modelProvider: Lucidworks
                    - id: e5-large-v2
                      name: e5-large-v2
                      modelType: shared
                      vectorSize: 1024
                      modelProvider: Lucidworks
                    - id: multilingual-e5-small
                      name: multilingual-e5-small
                      modelType: shared
                      vectorSize: 384
                      modelProvider: Lucidworks
                - useCase: passthrough
                  models:
                    - id: claude-sonnet-4-20250514
                      name: claude-sonnet-4-20250514
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-sonnet-4-5-20250929
                      name: claude-sonnet-4-5-20250929
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-haiku-4-5-20251001
                      name: claude-haiku-4-5-20251001
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-sonnet-4-6
                      name: claude-sonnet-4-6
                      modelType: shared
                      modelProvider: Anthropic
                    - id: llama-3-8b-instruct
                      name: llama-3-8b-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: llama-3v2-3b-instruct
                      name: llama-3v2-3b-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: phi-4-multimodal-instruct
                      name: phi-4-multimodal-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: gpt-3.5-turbo
                      name: gpt-3.5-turbo
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-3.5-turbo-1106
                      name: gpt-3.5-turbo-1106 (deprecated)
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-3.5-turbo-0125
                      name: gpt-3.5-turbo-0125
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4
                      name: gpt-4
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-0613
                      name: gpt-4-0613
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-turbo
                      name: gpt-4-turbo
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-turbo-2024-04-09
                      name: gpt-4-turbo-2024-04-09
                      modelType: shared
                      modelProvider: OpenAI
                    - id: azure-openai
                      name: azure-openai
                      modelType: shared
                      modelProvider: Azure
                    - id: gpt-4o
                      name: gpt-4o
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4o-2024-05-13
                      name: gpt-4o-2024-05-13
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4o-mini
                      name: gpt-4o-mini
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5-2025-08-07
                      name: gpt-5-2025-08-07
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5-mini-2025-08-07
                      name: gpt-5-mini-2025-08-07
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5.1-2025-11-13
                      name: gpt-5.1-2025-11-13
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gemini-2.5-flash
                      name: gemini-2.5-flash
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-2.5-flash-lite
                      name: gemini-2.5-flash-lite
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-2.5-pro
                      name: gemini-2.5-pro
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-3-pro-preview
                      name: gemini-3-pro-preview
                      modelType: shared
                      modelProvider: Google Vertex AI
                - useCase: standalone-query-rewriter
                  models:
                    - id: claude-sonnet-4-20250514
                      name: claude-sonnet-4-20250514
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-sonnet-4-5-20250929
                      name: claude-sonnet-4-5-20250929
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-haiku-4-5-20251001
                      name: claude-haiku-4-5-20251001
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-sonnet-4-6
                      name: claude-sonnet-4-6
                      modelType: shared
                      modelProvider: Anthropic
                    - id: llama-3-8b-instruct
                      name: llama-3-8b-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: llama-3v2-3b-instruct
                      name: llama-3v2-3b-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: phi-4-multimodal-instruct
                      name: phi-4-multimodal-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: gpt-3.5-turbo
                      name: gpt-3.5-turbo
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-3.5-turbo-1106
                      name: gpt-3.5-turbo-1106 (deprecated)
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-3.5-turbo-0125
                      name: gpt-3.5-turbo-0125
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4
                      name: gpt-4
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-0613
                      name: gpt-4-0613
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-turbo
                      name: gpt-4-turbo
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-turbo-2024-04-09
                      name: gpt-4-turbo-2024-04-09
                      modelType: shared
                      modelProvider: OpenAI
                    - id: azure-openai
                      name: azure-openai
                      modelType: shared
                      modelProvider: Azure
                    - id: gpt-4o
                      name: gpt-4o
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4o-2024-05-13
                      name: gpt-4o-2024-05-13
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4o-mini
                      name: gpt-4o-mini
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5-2025-08-07
                      name: gpt-5-2025-08-07
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5-mini-2025-08-07
                      name: gpt-5-mini-2025-08-07
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5.1-2025-11-13
                      name: gpt-5.1-2025-11-13
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gemini-2.5-flash
                      name: gemini-2.5-flash
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-2.5-flash-lite
                      name: gemini-2.5-flash-lite
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-2.5-pro
                      name: gemini-2.5-pro
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-3-pro-preview
                      name: gemini-3-pro-preview
                      modelType: shared
                      modelProvider: Google Vertex AI
                - useCase: image-metadata-enrichment
                  models:
                    - id: claude-sonnet-4-20250514
                      name: claude-sonnet-4-20250514
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-sonnet-4-5-20250929
                      name: claude-sonnet-4-5-20250929
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-haiku-4-5-20251001
                      name: claude-haiku-4-5-20251001
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-sonnet-4-6
                      name: claude-sonnet-4-6
                      modelType: shared
                      modelProvider: Anthropic
                    - id: gpt-4o
                      name: gpt-4o
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4o-2024-05-13
                      name: gpt-4o-2024-05-13
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4o-mini
                      name: gpt-4o-mini
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5-2025-08-07
                      name: gpt-5-2025-08-07
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5.1-2025-11-13
                      name: gpt-5.1-2025-11-13
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gemini-2.5-flash
                      name: gemini-2.5-flash
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-2.5-flash-lite
                      name: gemini-2.5-flash-lite
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-2.5-pro
                      name: gemini-2.5-pro
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-3-pro-preview
                      name: gemini-3-pro-preview
                      modelType: shared
                      modelProvider: Google Vertex AI
                - useCase: rag
                  models:
                    - id: claude-sonnet-4-20250514
                      name: claude-sonnet-4-20250514
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-sonnet-4-5-20250929
                      name: claude-sonnet-4-5-20250929
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-haiku-4-5-20251001
                      name: claude-haiku-4-5-20251001
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-sonnet-4-6
                      name: claude-sonnet-4-6
                      modelType: shared
                      modelProvider: Anthropic
                    - id: llama-3-8b-instruct
                      name: llama-3-8b-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: llama-3v2-3b-instruct
                      name: llama-3v2-3b-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: phi-4-multimodal-instruct
                      name: phi-4-multimodal-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: gpt-3.5-turbo
                      name: gpt-3.5-turbo
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-3.5-turbo-1106
                      name: gpt-3.5-turbo-1106 (deprecated)
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-3.5-turbo-0125
                      name: gpt-3.5-turbo-0125
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4
                      name: gpt-4
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-0613
                      name: gpt-4-0613
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-turbo
                      name: gpt-4-turbo
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-turbo-2024-04-09
                      name: gpt-4-turbo-2024-04-09
                      modelType: shared
                      modelProvider: OpenAI
                    - id: azure-openai
                      name: azure-openai
                      modelType: shared
                      modelProvider: Azure
                    - id: gpt-4o
                      name: gpt-4o
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4o-2024-05-13
                      name: gpt-4o-2024-05-13
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4o-mini
                      name: gpt-4o-mini
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5-2025-08-07
                      name: gpt-5-2025-08-07
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5-mini-2025-08-07
                      name: gpt-5-mini-2025-08-07
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5.1-2025-11-13
                      name: gpt-5.1-2025-11-13
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gemini-2.5-flash
                      name: gemini-2.5-flash
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-2.5-flash-lite
                      name: gemini-2.5-flash-lite
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-2.5-pro
                      name: gemini-2.5-pro
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-3-pro-preview
                      name: gemini-3-pro-preview
                      modelType: shared
                      modelProvider: Google Vertex AI
                - useCase: summarization
                  models:
                    - id: claude-sonnet-4-20250514
                      name: claude-sonnet-4-20250514
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-sonnet-4-5-20250929
                      name: claude-sonnet-4-5-20250929
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-haiku-4-5-20251001
                      name: claude-haiku-4-5-20251001
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-sonnet-4-6
                      name: claude-sonnet-4-6
                      modelType: shared
                      modelProvider: Anthropic
                    - id: llama-3-8b-instruct
                      name: llama-3-8b-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: llama-3v2-3b-instruct
                      name: llama-3v2-3b-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: phi-4-multimodal-instruct
                      name: phi-4-multimodal-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: gpt-3.5-turbo
                      name: gpt-3.5-turbo
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-3.5-turbo-1106
                      name: gpt-3.5-turbo-1106 (deprecated)
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-3.5-turbo-0125
                      name: gpt-3.5-turbo-0125
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4
                      name: gpt-4
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-0613
                      name: gpt-4-0613
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-turbo
                      name: gpt-4-turbo
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-turbo-2024-04-09
                      name: gpt-4-turbo-2024-04-09
                      modelType: shared
                      modelProvider: OpenAI
                    - id: azure-openai
                      name: azure-openai
                      modelType: shared
                      modelProvider: Azure
                    - id: gpt-4o
                      name: gpt-4o
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4o-2024-05-13
                      name: gpt-4o-2024-05-13
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4o-mini
                      name: gpt-4o-mini
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5-2025-08-07
                      name: gpt-5-2025-08-07
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5-mini-2025-08-07
                      name: gpt-5-mini-2025-08-07
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5.1-2025-11-13
                      name: gpt-5.1-2025-11-13
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gemini-2.5-flash
                      name: gemini-2.5-flash
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-2.5-flash-lite
                      name: gemini-2.5-flash-lite
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-2.5-pro
                      name: gemini-2.5-pro
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-3-pro-preview
                      name: gemini-3-pro-preview
                      modelType: shared
                      modelProvider: Google Vertex AI
                - useCase: ner
                  models:
                    - id: claude-sonnet-4-20250514
                      name: claude-sonnet-4-20250514
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-sonnet-4-5-20250929
                      name: claude-sonnet-4-5-20250929
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-haiku-4-5-20251001
                      name: claude-haiku-4-5-20251001
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-sonnet-4-6
                      name: claude-sonnet-4-6
                      modelType: shared
                      modelProvider: Anthropic
                    - id: llama-3-8b-instruct
                      name: llama-3-8b-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: llama-3v2-3b-instruct
                      name: llama-3v2-3b-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: phi-4-multimodal-instruct
                      name: phi-4-multimodal-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: gpt-3.5-turbo
                      name: gpt-3.5-turbo
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-3.5-turbo-1106
                      name: gpt-3.5-turbo-1106 (deprecated)
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-3.5-turbo-0125
                      name: gpt-3.5-turbo-0125
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4
                      name: gpt-4
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-0613
                      name: gpt-4-0613
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-turbo
                      name: gpt-4-turbo
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-turbo-2024-04-09
                      name: gpt-4-turbo-2024-04-09
                      modelType: shared
                      modelProvider: OpenAI
                    - id: azure-openai
                      name: azure-openai
                      modelType: shared
                      modelProvider: Azure
                    - id: gpt-4o
                      name: gpt-4o
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4o-2024-05-13
                      name: gpt-4o-2024-05-13
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4o-mini
                      name: gpt-4o-mini
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5-2025-08-07
                      name: gpt-5-2025-08-07
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5-mini-2025-08-07
                      name: gpt-5-mini-2025-08-07
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5.1-2025-11-13
                      name: gpt-5.1-2025-11-13
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gemini-2.5-flash
                      name: gemini-2.5-flash
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-2.5-flash-lite
                      name: gemini-2.5-flash-lite
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-2.5-pro
                      name: gemini-2.5-pro
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-3-pro-preview
                      name: gemini-3-pro-preview
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: nu-zero-ner
                      name: nu-zero-ner
                      modelType: shared
                      modelProvider: Lucidworks
                - useCase: keyword-extraction
                  models:
                    - id: claude-sonnet-4-20250514
                      name: claude-sonnet-4-20250514
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-sonnet-4-5-20250929
                      name: claude-sonnet-4-5-20250929
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-haiku-4-5-20251001
                      name: claude-haiku-4-5-20251001
                      modelType: shared
                      modelProvider: Anthropic
                    - id: claude-sonnet-4-6
                      name: claude-sonnet-4-6
                      modelType: shared
                      modelProvider: Anthropic
                    - id: llama-3-8b-instruct
                      name: llama-3-8b-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: llama-3v2-3b-instruct
                      name: llama-3v2-3b-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: phi-4-multimodal-instruct
                      name: phi-4-multimodal-instruct
                      modelType: shared
                      modelProvider: Lucidworks
                    - id: gpt-3.5-turbo
                      name: gpt-3.5-turbo
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-3.5-turbo-1106
                      name: gpt-3.5-turbo-1106 (deprecated)
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-3.5-turbo-0125
                      name: gpt-3.5-turbo-0125
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4
                      name: gpt-4
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-0613
                      name: gpt-4-0613
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-turbo
                      name: gpt-4-turbo
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4-turbo-2024-04-09
                      name: gpt-4-turbo-2024-04-09
                      modelType: shared
                      modelProvider: OpenAI
                    - id: azure-openai
                      name: azure-openai
                      modelType: shared
                      modelProvider: Azure
                    - id: gpt-4o
                      name: gpt-4o
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4o-2024-05-13
                      name: gpt-4o-2024-05-13
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-4o-mini
                      name: gpt-4o-mini
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5-2025-08-07
                      name: gpt-5-2025-08-07
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5-mini-2025-08-07
                      name: gpt-5-mini-2025-08-07
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gpt-5.1-2025-11-13
                      name: gpt-5.1-2025-11-13
                      modelType: shared
                      modelProvider: OpenAI
                    - id: gemini-2.5-flash
                      name: gemini-2.5-flash
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-2.5-flash-lite
                      name: gemini-2.5-flash-lite
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-2.5-pro
                      name: gemini-2.5-pro
                      modelType: shared
                      modelProvider: Google Vertex AI
                    - id: gemini-3-pro-preview
                      name: gemini-3-pro-preview
                      modelType: shared
                      modelProvider: Google Vertex AI
components:
  schemas:
    UseCaseResponse:
      type: object
      properties:
        useCase:
          type: string
          description: The name of the use case to perform an action or function.
          example: embedding
        models:
          type: array
          items:
            $ref: '#/components/schemas/Model'
    Model:
      type: object
      properties:
        id:
          type: string
          description: >-
            The identifier of the model. For:


            * Pre-trained models, the value is pre-defined and cannot be edited.


            * Custom models, the value is the universally unique identified
            (UUID) that is the primary key for the model.
          example: bge-large
        name:
          type: string
          description: |-
            The name of the type of model. For:

            * Pre-trained models, the value is the same as the `id` value. 

            * Custom models, the value is the name of the model.
          example: bge-large
        modelType:
          type: string
          description: >-
            The type of model and whether it is a Lucidworks-hosted model or
            only accessible to users in your workspace. For:


            * Pre-trained models, the value is `shared`. 


            * Custom models, the value is the name of the model.
          example: shared
        vectorSize:
          type: integer
          format: int32
          description: Dimensionality of the embedding vectors used in the model.
          example: 1024
        modelProvider:
          type: string
          description: >-
            The name of the provider of this model, whether Lucidworks or a
            third-party provider.
          example: Lucidworks

````