> ## 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.
# Summarization use case
> In the summarization use case, the LLM ingests text and returns a summary of the text as a response.
The context length is 2048 tokens. No options can be configured.
## OpenAPI
````yaml /api-reference/saas/machine-learning-platform-predict.json post /ai/prediction/summarization/{MODEL_ID}
openapi: 3.0.1
info:
title: Lucidworks AI Prediction API
version: v0
description: >-
The Lucidworks AI Prediction API is used to send synchronous API calls that
run predictions from pre-trained models or custom models.
The Use Case API returns a list of all supported models.
The `prediction` endpoints require an authentication token with scope
`machinelearning.predict`.
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: Get predictions
description: Submit prediction tasks to Lucidworks AI.
paths:
/ai/prediction/summarization/{MODEL_ID}:
parameters:
- schema:
type: string
name: MODEL_ID
in: path
required: true
description: Unique identifier for the model.
example: llama-3-8b-instruct
post:
tags:
- Get predictions
summary: Summarization use case
description: >-
In the summarization use case, the LLM ingests text and returns a
summary of the text as a response.
The context length is 2048 tokens. No options can be configured.
operationId: post-ai-prediction-summarization-modelId
parameters:
- in: header
name: Authorization
schema:
type: string
required: true
description: >-
Bearer token used for authentication. Format: `Authorization: Bearer
ACCESS_TOKEN`.
example: Bearer abc123def456
- schema:
type: string
example: application/json
in: header
name: Content-Type
description: application/json
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SummarizationRequest'
example:
batch:
- text: >-
Nearly ten years had passed since the Dursleys had woken up
to find their nephew on the front step, but Privet Drive had
hardly changed at all. The sun rose on the same tidy front
gardens and lit up the brass number four on the Dursleys'
front door; it crept into their living room, which was
almost exactly the same as it had been on the night when Mr.
Dursley had seen that fateful news report about the owls.
Only the photographs on the mantelpiece really showed how
much time had passed. Ten years ago, there had been lots of
pictures of what looked like a large pink beach ball wearing
different-colored bonnets - but Dudley Dursley was no longer
a baby, and now the photographs showed a large blond boy
riding his first bicycle, on a carousel at the fair, playing
a computer game with his father, being hugged and kissed by
his mother. The room held no sign at all that another boy
lived in the house, too.
useCaseConfig:
maxWords: 100
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SummarizationResponse'
example:
predictions:
- tokensUsed:
promptTokens: 255
completionTokens: 99
totalTokens: 354
summary: >-
Ten years have passed since Harry Potter's arrival on
Privet Drive, yet the Dursleys' home remains largely
unchanged. The sun rises on the same tidy gardens, and the
living room appears identical to its state on the night
Harry's presence was first reported. However, the
photographs on the mantelpiece reveal the passage of time,
showcasing Dudley's growth from a baby to a young boy.
Meanwhile, Harry's presence is completely erased from the
room, as if he never existed.
response: >-
Ten years have passed since Harry Potter's arrival on
Privet Drive, yet the Dursleys' home remains largely
unchanged. The sun rises on the same tidy gardens, and the
living room appears identical to its state on the night
Harry's presence was first reported. However, the
photographs on the mantelpiece reveal the passage of time,
showcasing Dudley's growth from a baby to a young boy.
Meanwhile, Harry's presence is completely erased from the
room, as if he never existed.
components:
schemas:
SummarizationRequest:
title: SummarizationRequest
type: object
x-examples: {}
properties:
batch:
type: array
description: >-
The batch of key:value pairs used as inputs in the prediction. Up to
32 inputs per request are allowed.
maxItems: 32
items:
type: object
properties:
text:
type: string
description: The content the model analyzes.
example: >-
Nearly ten years had passed since the Dursleys had woken up to
find their nephew on the front step, but Privet Drive had
hardly changed at all. The sun rose on the same tidy front
gardens and lit up the brass number four on the Dursleys'''
front door; it crept into their living room, which was almost
exactly the same as it had been on the night when Mr. Dursley
had seen that fateful news report about the owls. Only the
photographs on the mantelpiece really showed how much time had
passed. Ten years ago, there had been lots of pictures of what
looked like a large pink beach ball wearing different-colored
bonnets - but Dudley Dursley was no longer a baby, and now the
photographs showed a large blond boy riding his first bicycle,
on a carousel at the fair, playing a computer game with his
father, being hugged and kissed by his mother. The room held
no sign at all that another boy lived in the house, too.
useCaseConfig:
$ref: '#/components/schemas/UseCaseConfigSummarization'
modelConfig:
$ref: '#/components/schemas/ModelConfig'
SummarizationResponse:
type: object
x-examples: {}
properties:
predictions:
type: array
items:
$ref: '#/components/schemas/SummarizationResponseTokens'
UseCaseConfigSummarization:
title: UseCaseConfigSummarization
type: object
properties:
maxWords:
type: integer
example: 100
description: >-
This parameter specifies the maximum number of words returned in the
summary when generated by the model.
ModelConfig:
title: ModelConfig
type: object
description: >-
Provides fields and values that specify ranges for tokens. Fields used
for specific use cases and models are specified. The default values are
used if other values are not specified.
properties:
temperature:
type: number
format: float
example: 0.8
minimum: 0
maximum: 2
description: >-
A sampling temperature between 0 and 2. A higher sampling
temperature such as 0.8, results in more random (creative) output. A
lower value such as 0.2 results in more focused (conservative)
output. A lower value does not guarantee the model returns the same
response for the same input. We recommend staying at or below a
temperature of 1.0. Values above 1.0 might return nonsense unless
the topP value is lowered to be more deterministic.
topP:
type: number
format: float
example: 1
minimum: 0
maximum: 1
description: >-
A floating-point number between 0 and 1 that controls the cumulative
probability of the top tokens to consider, known as the randomness
of the LLM's response. This parameter is also referred to as top
probability. Set `topP` to 1 to consider all tokens. A higher value
specifies a higher probability threshold and selects tokens whose
cumulative probability is greater than the threshold. The higher the
value, the more diverse the output.
topK:
type: integer
example: -1
description: >-
An integer that controls the number of top tokens to consider. Set
topK to -1 to consider all tokens.
presencePenalty:
type: number
format: float
minimum: -2
maximum: 2
description: >-
A floating-point number between -2.0 and 2.0 that penalizes new
tokens based on whether they have already appeared in the text. This
increases the model's use of diverse tokens. A value greater than
zero (0) encourages the model to use new tokens. A value less than
zero (0) encourages the model to repeat existing tokens. This is
applicable for all OpenAI and Llama models.
example: 2
frequencyPenalty:
type: number
format: float
minimum: -2
maximum: 2
example: 1
description: >-
A floating-point number between -2.0 and 2.0 that penalizes new
tokens based on their frequency in the generated text. A value
greater than zero (0) encourages the model to use new tokens. A
value less than zero (0) encourages the model to repeat existing
tokens. This is applicable for all OpenAI and Llama models.
maxTokens:
type: integer
format: int32
example: 1
description: >-
The maximum number of tokens to generate per output sequence. The
value is different for each model. Review individual model
specifications when the value exceeds 2048.
apiKey:
type: string
description: >-
This optional parameter is only required when using the model for
prediction. You can find this value in your model's settings:
* **OpenAI**: Copy and paste the API key found in your
organization's settings. For more information, see OpenAI
Authentication API keys.
* **Azure OpenAI**: Copy and paste the API key found in your Azure
portal. See Authenticate
with API key.
* **Anthropic**: Copy and paste the API key found in your Anthropic
console or by using the Anthropic
API.
* **Google Vertex AI**: Copy and paste the base64-encoded service
account key JSON found in your Google
Cloud console. This service account key must have the Vertex
AI user role enabled. For more information, see generate
service account key.
example: API key specific to use case and model
azureDeployment:
type: string
example: DEPLOYMENT_NAME
description: >-
This optional parameter is the name of the deployed Azure OpenAI
model and is only required when a deployed Azure OpenAI model is
used for prediction.
azureEndpoint:
type: string
description: "\t\nThis optional parameter is the URL endpoint of the deployed Azure OpenAI model and is only required when a deployed Azure OpenAI model is used for prediction."
example: https://azure.endpoint.com
googleProjectId:
type: string
example: '[GOOGLE_PROJECT_ID]'
description: >-
This parameter is optional, and is only required when a Google
Vertex AI model is used for prediction.
googleRegion:
type: string
description: >-
This parameter is optional, and is only required when a Google
Vertex AI model is used for prediction. A value of `global` routes
the query to any available region. Other possible region values are:
* us-central1
* us-west4
* northamerica-northeast1
* us-east4
* us-west1
* asia-northeast3
* asia-southeast1
* asia-northeast
example: '[GOOGLE_PROJECT_REGION_OF_MODEL_ACCESS]'
SummarizationResponseTokens:
type: object
properties:
tokensUsed:
$ref: '#/components/schemas/Token'
response:
type: string
description: The results returned from the request.
example: >-
A decade after the Dursleys found their nephew on their doorstep,
Privet Drive remains largely unchanged. The only noticeable
difference is in the family photographs, which now depict Dudley
Dursley as a large blond boy engaged in various activities,
replacing his baby pictures. There is no indication of another boy
living in the house.
x-examples: {}
Token:
type: object
properties:
promptTokens:
type: integer
format: int32
description: >-
The number of tokens generated to prompt the model to continue
generating results.
example: 148
completionTokens:
type: integer
format: int32
description: The number of tokens used until the model completes.
example: 27
totalTokens:
type: integer
format: int32
description: The sum of the prompt and completion tokens used in the model.
example: 175
````