Skip to content

Commit 7850c3c

Browse files
authored
Merge pull request #3093 from tisnik/lcore-4686-documentation
LCORE-4923: Updated devel documentation
2 parents a1dc9c7 + d9d8f7b commit 7850c3c

24 files changed

Lines changed: 3255 additions & 1262 deletions

File tree

‎docs/devel_doc/openapi.md‎

Lines changed: 545 additions & 13 deletions
Large diffs are not rendered by default.

‎docs/models/common.puml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,7 @@ class "ResponsesApiParams" as src.models.common.responses.responses_api_params.R
195195
parallel_tool_calls : Optional[bool]
196196
previous_response_id : Optional[str]
197197
prompt : Optional[Prompt]
198+
prompt_cache_key : Optional[str]
198199
reasoning : Optional[Reasoning]
199200
safety_identifier : Optional[str]
200201
store : bool

‎docs/models/common.svg‎

Lines changed: 262 additions & 261 deletions
Loading

‎docs/models/requests.json‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2231,13 +2231,14 @@
22312231
},
22322232
"ResponsesRequest": {
22332233
"additionalProperties": false,
2234-
"description": "Model representing a request for the Responses API following LCORE specification.\n\nAttributes:\n input: Input text or structured input items containing the query.\n model: Model identifier in format \"provider/model\". Auto-selected if not provided.\n conversation: Conversation ID linking to an existing conversation. Accepts both\n OpenAI and LCORE formats. Mutually exclusive with previous_response_id.\n include: Explicitly specify output item types that are excluded by default but\n should be included in the response.\n instructions: System instructions or guidelines provided to the model (acts as\n the system prompt).\n max_infer_iters: Maximum number of inference iterations the model can perform.\n max_output_tokens: Maximum number of tokens allowed in the response.\n max_tool_calls: Maximum number of tool calls allowed in a single response.\n metadata: Custom metadata dictionary with key-value pairs for tracking or logging.\n parallel_tool_calls: Whether the model can make multiple tool calls in parallel.\n previous_response_id: Identifier of the previous response in a multi-turn\n conversation. Mutually exclusive with conversation.\n prompt: Prompt object containing a template with variables for dynamic\n substitution.\n reasoning: Reasoning configuration for the response.\n safety_identifier: Safety identifier for the response.\n store: Whether to store the response in conversation history. Defaults to True.\n stream: Whether to stream the response as it is generated. Defaults to False.\n temperature: Sampling temperature controlling randomness (typically 0.0\u20132.0).\n text: Text response configuration specifying output format constraints (JSON\n schema, JSON object, or plain text).\n tool_choice: Tool selection strategy (\"auto\", \"required\", \"none\", or specific\n tool configuration).\n tools: List of tools available to the model (file search, web search, function\n calls, MCP tools). Defaults to all tools available to the model.\n generate_topic_summary: LCORE-specific flag indicating whether to generate a\n topic summary for new conversations. Defaults to True.\n shield_ids: LCORE-specific list of configured shield names to apply.\n If None, all configured shields are used.\n solr: Optional Solr inline RAG options (mode, filters) or legacy filter-only dict.",
2234+
"description": "Model representing a request for the Responses API following LCORE specification.\n\nAttributes:\n input: Input text or structured input items containing the query.\n model: Model identifier in format \"provider/model\". Auto-selected if not provided.\n conversation: Conversation ID linking to an existing conversation. Accepts both\n OpenAI and LCORE formats. Mutually exclusive with previous_response_id.\n include: Explicitly specify output item types that are excluded by default but\n should be included in the response.\n instructions: System instructions or guidelines provided to the model (acts as\n the system prompt).\n max_infer_iters: Maximum number of inference iterations the model can perform.\n max_output_tokens: Maximum number of tokens allowed in the response.\n max_tool_calls: Maximum number of tool calls allowed in a single response.\n metadata: Custom metadata dictionary with key-value pairs for tracking or logging.\n parallel_tool_calls: Whether the model can make multiple tool calls in parallel.\n previous_response_id: Identifier of the previous response in a multi-turn\n conversation. Mutually exclusive with conversation.\n prompt_cache_key: Prompt cache key used by providers that support prompt\n caching.\n prompt: Prompt object containing a template with variables for dynamic\n substitution.\n reasoning: Reasoning configuration for the response.\n safety_identifier: Safety identifier for the response.\n store: Whether to store the response in conversation history. Defaults to True.\n stream: Whether to stream the response as it is generated. Defaults to False.\n temperature: Sampling temperature controlling randomness (typically 0.0\u20132.0).\n text: Text response configuration specifying output format constraints (JSON\n schema, JSON object, or plain text).\n tool_choice: Tool selection strategy (\"auto\", \"required\", \"none\", or specific\n tool configuration).\n tools: List of tools available to the model (file search, web search, function\n calls, MCP tools). Defaults to all tools available to the model.\n generate_topic_summary: LCORE-specific flag indicating whether to generate a\n topic summary for new conversations. Defaults to True.\n shield_ids: LCORE-specific list of configured shield names to apply.\n If None, all configured shields are used.\n solr: Optional Solr inline RAG options (mode, filters) or legacy filter-only dict.",
22352235
"examples": [
22362236
{
22372237
"generate_topic_summary": true,
22382238
"input": "Hello World!",
22392239
"instructions": "You are a helpful assistant",
22402240
"model": "openai/gpt-5.6-luna",
2241+
"prompt_cache_key": "example-cache-key",
22412242
"store": true,
22422243
"stream": false
22432244
}
@@ -2306,6 +2307,12 @@
23062307
"default": null,
23072308
"title": "Previous Response Id"
23082309
},
2310+
"prompt_cache_key": {
2311+
"type": "string",
2312+
"nullable": true,
2313+
"default": null,
2314+
"title": "Prompt Cache Key"
2315+
},
23092316
"prompt": {
23102317
"anyOf": [
23112318
{

‎docs/models/requests.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -954,6 +954,8 @@ Attributes:
954954
parallel_tool_calls: Whether the model can make multiple tool calls in parallel.
955955
previous_response_id: Identifier of the previous response in a multi-turn
956956
conversation. Mutually exclusive with conversation.
957+
prompt_cache_key: Prompt cache key used by providers that support prompt
958+
caching.
957959
prompt: Prompt object containing a template with variables for dynamic
958960
substitution.
959961
reasoning: Reasoning configuration for the response.
@@ -987,6 +989,7 @@ Attributes:
987989
| metadata | object | |
988990
| parallel_tool_calls | boolean | |
989991
| previous_response_id | string | |
992+
| prompt_cache_key | string | |
990993
| prompt | | |
991994
| reasoning | | |
992995
| safety_identifier | string | |

‎docs/models/requests.puml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ class "ResponsesRequest" as src.models.api.requests.responses_openai.ResponsesRe
8282
parallel_tool_calls : Optional[bool]
8383
previous_response_id : Optional[str]
8484
prompt : Optional[Prompt]
85+
prompt_cache_key : Optional[str]
8586
reasoning : Optional[Reasoning]
8687
safety_identifier : Optional[str]
8788
shield_ids : Optional[list[str]]

0 commit comments

Comments
 (0)