Skip to content

Commit 52805fa

Browse files
authored
Merge pull request #2691 from tisnik/lcore-4146-updated-model-doc
LCORE-4146: Updated model doc
2 parents 10ed2a9 + 3f3035a commit 52805fa

8 files changed

Lines changed: 1730 additions & 1681 deletions

File tree

‎docs/models/common.puml‎

Lines changed: 101 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -10,31 +10,31 @@ class "AgentTurnAccumulator" as src.models.common.agents.turn_accumulator.AgentT
1010
seen_docs : set[tuple[str, str]]
1111
text_parts : list[str]
1212
tool_round : int
13-
turn_summary : TurnSummary
13+
turn_summary
1414
vector_store_ids : Final[list[str]]
1515
increment_round_if_pending() -> None
1616
}
1717
class "Attachment" as src.models.common.query.Attachment {
18-
attachment_type : Optional[str]
19-
content : Optional[str]
20-
content_type : Optional[str]
18+
attachment_type : str
19+
content : str
20+
content_type : str
2121
model_config : dict
2222
validate_image_attachment() -> Self
2323
}
2424
class "CatalogModel" as src.models.common.models.CatalogModel {
25-
api_model_type : Optional[str]
26-
identifier : Optional[str]
27-
metadata : Optional[dict[str, Any]]
28-
model_type : Optional[str]
29-
provider_id : Optional[str]
30-
provider_resource_id : Optional[str]
31-
type : Optional[str]
25+
api_model_type : str
26+
identifier : str
27+
metadata : dict[str, Any]
28+
model_type : str
29+
provider_id : str
30+
provider_resource_id : str
31+
type : str
3232
}
3333
class "CatalogShield" as src.models.common.shields.CatalogShield {
34-
config : Optional[dict[str, Any]]
35-
name : Optional[str]
36-
provider_id : Optional[Literal['question_validity', 'redaction']]
37-
type : Optional[Literal['shield']]
34+
config : dict[str, Any]
35+
name : str
36+
provider_id : Literal['question_validity', 'redaction']
37+
type : Literal['shield']
3838
}
3939
class "CatalogTool" as src.models.common.tools.CatalogTool {
4040
description : str
@@ -58,7 +58,7 @@ class "ConversationData" as src.models.common.conversation.ConversationData {
5858
topic_summary : Optional[str]
5959
}
6060
class "ConversationDetails" as src.models.common.conversation.ConversationDetails {
61-
conversation_id : Optional[str]
61+
conversation_id : str
6262
created_at : Optional[str]
6363
last_message_at : Optional[str]
6464
last_used_model : Optional[str]
@@ -67,16 +67,16 @@ class "ConversationDetails" as src.models.common.conversation.ConversationDetail
6767
topic_summary : Optional[str]
6868
}
6969
class "ConversationTurn" as src.models.common.conversation.ConversationTurn {
70-
completed_at : Optional[str]
71-
messages : Optional[list[Message]]
72-
model : Optional[str]
73-
provider : Optional[str]
74-
started_at : Optional[str]
75-
tool_calls : Optional[list[ToolCallSummary]]
76-
tool_results : Optional[list[ToolResultSummary]]
70+
completed_at : str
71+
messages : list[Message]
72+
model : str
73+
provider : str
74+
started_at : str
75+
tool_calls : list[ToolCallSummary]
76+
tool_results : list[ToolResultSummary]
7777
}
7878
class "EndEventData" as src.models.common.agents.stream_payloads.EndEventData {
79-
context_status : Literal
79+
context_status
8080
input_tokens : int
8181
output_tokens : int
8282
referenced_documents : list[ReferencedDocument]
@@ -124,39 +124,39 @@ class "ListedMcpTool" as src.models.common.tools.ListedMcpTool {
124124
name : str
125125
}
126126
class "MCPListToolsSummary" as src.models.common.turn_summary.MCPListToolsSummary {
127-
server_label : Optional[str]
128-
tools : Optional[list[ToolInfoSummary]]
127+
server_label : str
128+
tools : list[ToolInfoSummary]
129129
}
130130
class "MCPServerAuthInfo" as src.models.common.mcp.MCPServerAuthInfo {
131-
client_auth_headers : Optional[list[str]]
132-
name : Optional[str]
131+
client_auth_headers : list[str]
132+
name : str
133133
}
134134
class "MCPServerInfo" as src.models.common.mcp.MCPServerInfo {
135-
name : Optional[str]
136-
provider_id : Optional[str]
137-
source : Optional[str]
138-
url : Optional[str]
135+
name : str
136+
provider_id : str
137+
source : str
138+
url : str
139139
}
140140
class "Message" as src.models.common.conversation.Message {
141-
content : Optional[str]
141+
content : str
142142
referenced_documents : Optional[list[ReferencedDocument]]
143-
type : Optional[Literal['user', 'assistant', 'system', 'developer']]
143+
type : Literal['user', 'assistant', 'system', 'developer']
144144
}
145145
class "ProviderHealthStatus" as src.models.common.health.ProviderHealthStatus {
146146
message : Optional[str]
147-
provider_id : Optional[str]
148-
status : Optional[str]
147+
provider_id : str
148+
status : str
149149
}
150150
class "RAGChunk" as src.models.common.turn_summary.RAGChunk {
151151
attributes : Optional[dict[str, Any]]
152-
content : Optional[str]
152+
content : str
153153
score : Optional[float]
154154
source : Optional[str]
155155
}
156156
class "RAGContext" as src.models.common.turn_summary.RAGContext {
157-
context_text : Optional[str]
158-
rag_chunks : Optional[list[RAGChunk]]
159-
referenced_documents : Optional[list[ReferencedDocument]]
157+
context_text : str
158+
rag_chunks : list[RAGChunk]
159+
referenced_documents : list[ReferencedDocument]
160160
}
161161
class "ReferencedDocument" as src.models.common.turn_summary.ReferencedDocument {
162162
doc_title : Optional[str]
@@ -165,12 +165,12 @@ class "ReferencedDocument" as src.models.common.turn_summary.ReferencedDocument
165165
source : Optional[str]
166166
}
167167
class "ResponseGeneratorContext" as src.models.common.responses.contexts.ResponseGeneratorContext {
168-
client : AsyncOgxClient
168+
client
169169
conversation_id : str
170-
inline_rag_context : RAGContext
170+
inline_rag_context
171171
model_id : str
172172
moderation_result
173-
query_request : QueryRequest
173+
query_request
174174
rag_id_mapping : dict[str, str]
175175
request_id : str
176176
skip_userid_check : bool
@@ -179,24 +179,24 @@ class "ResponseGeneratorContext" as src.models.common.responses.contexts.Respons
179179
vector_store_ids : list[str]
180180
}
181181
class "ResponsesApiParams" as src.models.common.responses.responses_api_params.ResponsesApiParams {
182-
conversation : Optional[str]
182+
conversation : str
183183
extra_headers : Optional[dict[str, str]]
184184
include : Optional[list[IncludeParameter]]
185-
input : Optional[ResponseInput]
185+
input
186186
instructions : Optional[str]
187187
max_infer_iters : Optional[int]
188188
max_output_tokens : Optional[int]
189189
max_tool_calls : Optional[int]
190190
metadata : Optional[dict[str, str]]
191-
model : Optional[str]
192-
omit_conversation : Optional[bool]
191+
model : str
192+
omit_conversation : bool
193193
parallel_tool_calls : Optional[bool]
194194
previous_response_id : Optional[str]
195195
prompt : Optional[Prompt]
196196
reasoning : Optional[Reasoning]
197197
safety_identifier : Optional[str]
198-
store : Optional[bool]
199-
stream : Optional[bool]
198+
store : bool
199+
stream : bool
200200
temperature : Optional[float]
201201
text : Optional[Text]
202202
tool_choice : Optional[ToolChoice]
@@ -205,45 +205,45 @@ class "ResponsesApiParams" as src.models.common.responses.responses_api_params.R
205205
model_dump() -> dict[str, Any]
206206
}
207207
class "ResponsesContext" as src.models.common.responses.contexts.ResponsesContext {
208-
auth : Optional[tuple[str, str, bool, str]]
208+
auth : tuple[str, str, bool, str]
209209
background_tasks : Optional[BackgroundTasks]
210-
client : Optional[AsyncOgxClient]
210+
client
211211
compacted_original_input : Optional[ResponseInput]
212-
endpoint_path : Optional[str]
213-
filter_server_tools : Optional[bool]
214-
generate_topic_summary : Optional[bool]
215-
inline_rag_context : Optional[RAGContext]
216-
input_text : Optional[str]
217-
model_config : ConfigDict
218-
moderation_result : Optional[ShieldModerationResult]
219-
rh_identity_context : Optional[tuple[str, str]]
220-
root_span : Span
221-
started_at : Optional[datetime]
212+
endpoint_path : str
213+
filter_server_tools : bool
214+
generate_topic_summary : bool
215+
inline_rag_context
216+
input_text : str
217+
model_config
218+
moderation_result
219+
rh_identity_context : tuple[str, str]
220+
root_span
221+
started_at : datetime
222222
user_agent : Optional[str]
223223
}
224224
class "ResponsesConversationContext" as src.models.common.responses.responses_conversation_context.ResponsesConversationContext {
225-
conversation : Optional[str]
226-
generate_topic_summary : Optional[bool]
227-
model_config : ConfigDict
225+
conversation : str
226+
generate_topic_summary : bool
227+
model_config
228228
user_conversation : Optional[UserConversation]
229229
}
230230
class "ShieldModerationBlocked" as src.models.common.moderation.ShieldModerationBlocked {
231231
decision : Literal['blocked']
232232
message : str
233233
moderation_id : str
234-
refusal_response : ResponseMessage
234+
refusal_response
235235
}
236236
class "ShieldModerationPassed" as src.models.common.moderation.ShieldModerationPassed {
237237
decision : Literal['passed']
238238
}
239239
class "SkillMetadata" as src.models.common.skills.SkillMetadata {
240-
description : Optional[str]
241-
name : Optional[str]
240+
description : str
241+
name : str
242242
}
243243
class "SolrVectorSearchRequest" as src.models.common.query.SolrVectorSearchRequest {
244244
filters : Optional[dict[str, Any]]
245245
mode : Optional[Literal['semantic', 'hybrid', 'lexical', 'keyword']]
246-
model_config : ConfigDict
246+
model_config
247247
coerce_legacy_plain_dict(data: Any) -> Any
248248
}
249249
class "StartEventData" as src.models.common.agents.stream_payloads.StartEventData {
@@ -256,7 +256,7 @@ class "StartStreamPayload" as src.models.common.agents.stream_payloads.StartStre
256256
create() -> Self
257257
}
258258
class "StreamPayloadBase" as src.models.common.agents.stream_payloads.StreamPayloadBase {
259-
model_config : ConfigDict
259+
model_config
260260
serialize_json() -> str
261261
serialize_text() -> str
262262
}
@@ -271,42 +271,42 @@ class "TokenStreamPayload" as src.models.common.agents.stream_payloads.TokenStre
271271
serialize_text() -> str
272272
}
273273
class "ToolCallStreamPayload" as src.models.common.agents.stream_payloads.ToolCallStreamPayload {
274-
data : ToolCallSummary
274+
data
275275
event : Literal['tool_call']
276276
serialize_text() -> str
277277
}
278278
class "ToolCallSummary" as src.models.common.turn_summary.ToolCallSummary {
279-
args : Optional[dict[str, Any]]
280-
id : Optional[str]
281-
name : Optional[str]
282-
type : Optional[str]
279+
args : dict[str, Any]
280+
id : str
281+
name : str
282+
type : str
283283
}
284284
class "ToolInfoSummary" as src.models.common.turn_summary.ToolInfoSummary {
285285
description : Optional[str]
286286
input_schema : Optional[dict[str, Any]]
287-
name : Optional[str]
287+
name : str
288288
}
289289
class "ToolResultStreamPayload" as src.models.common.agents.stream_payloads.ToolResultStreamPayload {
290-
data : ToolResultSummary
290+
data
291291
event : Literal['tool_result']
292292
serialize_text() -> str
293293
}
294294
class "ToolResultSummary" as src.models.common.turn_summary.ToolResultSummary {
295-
content : Optional[str]
296-
id : Optional[str]
297-
round : Optional[int]
298-
status : Optional[str]
299-
type : Optional[str]
295+
content : str
296+
id : str
297+
round : int
298+
status : str
299+
type : str
300300
}
301301
class "Transcript" as src.models.common.transcripts.Transcript {
302-
attachments : Optional[list[dict[str, Any]]]
302+
attachments : list[dict[str, Any]]
303303
llm_response : str
304304
metadata
305305
query_is_valid : bool
306-
rag_chunks : Optional[list[dict[str, Any]]]
306+
rag_chunks : list[dict[str, Any]]
307307
redacted_query : str
308-
tool_calls : Optional[list[dict[str, Any]]]
309-
tool_results : Optional[list[dict[str, Any]]]
308+
tool_calls : list[dict[str, Any]]
309+
tool_results : list[dict[str, Any]]
310310
truncated : bool
311311
}
312312
class "TranscriptMetadata" as src.models.common.transcripts.TranscriptMetadata {
@@ -324,16 +324,16 @@ class "TurnCompleteStreamPayload" as src.models.common.agents.stream_payloads.Tu
324324
create() -> Self
325325
}
326326
class "TurnSummary" as src.models.common.turn_summary.TurnSummary {
327-
id : Optional[str]
327+
id : str
328328
llm_response : str
329-
next_chunk_id : Optional[int]
330-
output_items : Optional[list[OpenAIResponseOutput]]
331-
partial_tokens : Optional[list[str]]
332-
rag_chunks : Optional[list[RAGChunk]]
333-
referenced_documents : Optional[list[ReferencedDocument]]
334-
token_usage : Optional[TokenCounter]
335-
tool_calls : Optional[list[ToolCallSummary]]
336-
tool_results : Optional[list[ToolResultSummary]]
329+
next_chunk_id : int
330+
output_items : list[OpenAIResponseOutput]
331+
partial_tokens : list[str]
332+
rag_chunks : list[RAGChunk]
333+
referenced_documents : list[ReferencedDocument]
334+
token_usage
335+
tool_calls : list[ToolCallSummary]
336+
tool_results : list[ToolResultSummary]
337337
}
338338
src.models.common.agents.stream_payloads.EndStreamPayload --|> src.models.common.agents.stream_payloads.StreamPayloadBase
339339
src.models.common.agents.stream_payloads.ErrorStreamPayload --|> src.models.common.agents.stream_payloads.StreamPayloadBase
@@ -343,11 +343,11 @@ src.models.common.agents.stream_payloads.TokenStreamPayload --|> src.models.comm
343343
src.models.common.agents.stream_payloads.ToolCallStreamPayload --|> src.models.common.agents.stream_payloads.StreamPayloadBase
344344
src.models.common.agents.stream_payloads.ToolResultStreamPayload --|> src.models.common.agents.stream_payloads.StreamPayloadBase
345345
src.models.common.agents.stream_payloads.TurnCompleteStreamPayload --|> src.models.common.agents.stream_payloads.StreamPayloadBase
346-
src.models.common.agents.stream_payloads.EndStreamPayload --> src.models.common.agents.stream_payloads.EndEventData : data
347-
src.models.common.agents.stream_payloads.ErrorStreamPayload --> src.models.common.agents.stream_payloads.ErrorEventData : data
348-
src.models.common.agents.stream_payloads.InterruptedStreamPayload --> src.models.common.agents.stream_payloads.InterruptedEventData : data
349-
src.models.common.agents.stream_payloads.StartStreamPayload --> src.models.common.agents.stream_payloads.StartEventData : data
350-
src.models.common.agents.stream_payloads.TokenStreamPayload --> src.models.common.agents.stream_payloads.TokenChunkData : data
351-
src.models.common.agents.stream_payloads.TurnCompleteStreamPayload --> src.models.common.agents.stream_payloads.TokenChunkData : data
352-
src.models.common.transcripts.Transcript --> src.models.common.transcripts.TranscriptMetadata : metadata
346+
src.models.common.agents.stream_payloads.EndEventData --* src.models.common.agents.stream_payloads.EndStreamPayload : data
347+
src.models.common.agents.stream_payloads.ErrorEventData --* src.models.common.agents.stream_payloads.ErrorStreamPayload : data
348+
src.models.common.agents.stream_payloads.InterruptedEventData --* src.models.common.agents.stream_payloads.InterruptedStreamPayload : data
349+
src.models.common.agents.stream_payloads.StartEventData --* src.models.common.agents.stream_payloads.StartStreamPayload : data
350+
src.models.common.agents.stream_payloads.TokenChunkData --* src.models.common.agents.stream_payloads.TokenStreamPayload : data
351+
src.models.common.agents.stream_payloads.TokenChunkData --* src.models.common.agents.stream_payloads.TurnCompleteStreamPayload : data
352+
src.models.common.transcripts.TranscriptMetadata --* src.models.common.transcripts.Transcript : metadata
353353
@enduml

0 commit comments

Comments
 (0)