# Prompting > Prompting - The following endpoints outline how to manage prompts. This Markdown file sits beside the HTML page at the same path (with a `.md` suffix). It summarizes the topic and lists links for tools and LLM context. Companion generated at `2026-05-06T18:17:09.791461+00:00` (UTC). ## Primary page - [Prompting](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html): Full documentation for this topic (HTML). ## Sections on this page - [List chat prompts](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#list-chat-prompts): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#list_chat_prompts_chatprompts__get-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses): In-page section heading. - [Create chat prompt](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#create-chat-prompt): In-page section heading. - [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#body-parameter): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#create_chat_prompt_chatprompts__post-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_1): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_1): In-page section heading. - [Delete chat prompt by chat prompt ID](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#delete-chat-prompt-by-chat-prompt-id): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#delete_chat_prompt_chatprompts__chatpromptid___delete-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_2): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_2): In-page section heading. - [Retrieve chat prompt by chat prompt ID](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#retrieve-chat-prompt-by-chat-prompt-id): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#get_chat_prompt_chatprompts__chatpromptid___get-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_3): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_3): In-page section heading. - [Edit chat prompt by chat prompt ID](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#edit-chat-prompt-by-chat-prompt-id): In-page section heading. - [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#body-parameter_1): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#update_chat_prompt_data_chatprompts__chatpromptid___patch-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_4): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_4): In-page section heading. - [List chats](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#list-chats): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#list_chats_chats__get-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_5): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_5): In-page section heading. - [Create chat](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#create-chat): In-page section heading. - [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#body-parameter_2): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#create_chat_chats__post-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_6): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_6): In-page section heading. - [Delete chat by chat ID](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#delete-chat-by-chat-id): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#delete_chat_chats__chatid___delete-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_7): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_7): In-page section heading. - [Retrieve chat by chat ID](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#retrieve-chat-by-chat-id): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#get_chat_chats__chatid___get-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_8): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_8): In-page section heading. - [Edit chat by chat ID](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#edit-chat-by-chat-id): In-page section heading. - [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#body-parameter_3): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#edit_chat_chats__chatid___patch-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_9): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_9): In-page section heading. - [List comparison chats](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#list-comparison-chats): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#list_comparison_chats_comparisonchats__get-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_10): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_10): In-page section heading. - [Create comparison chat](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#create-comparison-chat): In-page section heading. - [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#body-parameter_4): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#create_comparison_chat_comparisonchats__post-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_11): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_11): In-page section heading. - [Delete comparison chat by comparison chat ID](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#delete-comparison-chat-by-comparison-chat-id): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#delete_comparison_chat_comparisonchats__comparisonchatid___delete-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_12): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_12): In-page section heading. - [Retrieve comparison chat by comparison chat ID](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#retrieve-comparison-chat-by-comparison-chat-id): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#get_comparison_chat_comparisonchats__comparisonchatid___get-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_13): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_13): In-page section heading. - [Edit comparison chat by comparison chat ID](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#edit-comparison-chat-by-comparison-chat-id): In-page section heading. - [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#body-parameter_5): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#edit_comparison_chat_comparisonchats__comparisonchatid___patch-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_14): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_14): In-page section heading. - [List comparison prompts](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#list-comparison-prompts): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#list_comparison_prompts_comparisonprompts__get-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_15): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_15): In-page section heading. - [Create comparison prompt](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#create-comparison-prompt): In-page section heading. - [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#body-parameter_6): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#create_comparison_prompt_comparisonprompts__post-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_16): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_16): In-page section heading. - [Delete comparison prompt by comparison prompt ID](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#delete-comparison-prompt-by-comparison-prompt-id): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#delete_comparison_prompt_comparisonprompts__comparisonpromptid___delete-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_17): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_17): In-page section heading. - [Retrieve comparison prompt by comparison prompt ID](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#retrieve-comparison-prompt-by-comparison-prompt-id): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#get_comparison_prompt_comparisonprompts__comparisonpromptid___get-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_18): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_18): In-page section heading. - [Edit comparison prompt by comparison prompt ID](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#edit-comparison-prompt-by-comparison-prompt-id): In-page section heading. - [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#body-parameter_7): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#update_comparison_prompt_comparisonprompts__comparisonpromptid___patch-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_19): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_19): In-page section heading. - [List prompt templates](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#list-prompt-templates): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#list_prompt_templates_prompttemplates__get-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_20): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_20): In-page section heading. - [Create prompt template](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#create-prompt-template): In-page section heading. - [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#body-parameter_8): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#create_prompt_template_prompttemplates__post-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_21): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_21): In-page section heading. - [List prompt templates versions](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#list-prompt-templates-versions): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#list_prompt_templates_versions_prompttemplates_versions__get-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_22): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_22): In-page section heading. - [Get prompt template by prompt template ID](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#get-prompt-template-by-prompt-template-id): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#get_prompt_template_prompttemplates__prompttemplateid___get-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_23): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_23): In-page section heading. - [List prompt template versions by prompt template ID](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#list-prompt-template-versions-by-prompt-template-id): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#list_prompt_template_versions_prompttemplates__prompttemplateid__versions__get-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_24): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_24): In-page section heading. - [Create prompt template version by prompt template ID](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#create-prompt-template-version-by-prompt-template-id): In-page section heading. - [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#body-parameter_9): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#create_prompt_template_version_prompttemplates__prompttemplateid__versions__post-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_25): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_25): In-page section heading. - [Get prompt template version by prompt template ID](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#get-prompt-template-version-by-prompt-template-id): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#get_prompt_template_version_prompttemplates__prompttemplateid__versions__prompttemplateversionid___get-parameters): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#example-responses_26): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#responses_26): In-page section heading. - [ChatPromptResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ChatPromptResponse): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties): In-page section heading. - [ChatResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ChatResponse): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_1): In-page section heading. - [ChatsSortQueryParam](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ChatsSortQueryParam): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_2): In-page section heading. - [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#enumerated-values): In-page section heading. - [Citation](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_Citation): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_3): In-page section heading. - [CommonLLMSettings](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_CommonLLMSettings): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_4): In-page section heading. - [ComparisonChatResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ComparisonChatResponse): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_5): In-page section heading. - [ComparisonChatsSortQueryParam](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ComparisonChatsSortQueryParam): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_6): In-page section heading. - [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#enumerated-values_1): In-page section heading. - [ComparisonPromptFeedbackResult](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ComparisonPromptFeedbackResult): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_7): In-page section heading. - [ComparisonPromptResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ComparisonPromptResponse): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_8): In-page section heading. - [ComparisonPromptResult](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ComparisonPromptResult): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_9): In-page section heading. - [ConfidenceScores](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ConfidenceScores): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_10): In-page section heading. - [CreateChatPromptRequest](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_CreateChatPromptRequest): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_11): In-page section heading. - [CreateChatRequest](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_CreateChatRequest): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_12): In-page section heading. - [CreateComparisonChatRequest](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_CreateComparisonChatRequest): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_13): In-page section heading. - [CreateComparisonPromptRequest](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_CreateComparisonPromptRequest): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_14): In-page section heading. - [CreatePromptTemplateRequest](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_CreatePromptTemplateRequest): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_15): In-page section heading. - [CreatePromptTemplateVersionRequest](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_CreatePromptTemplateVersionRequest): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_16): In-page section heading. - [CustomModelChatLLMSettings](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_CustomModelChatLLMSettings): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_17): In-page section heading. - [CustomModelLLMSettings](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_CustomModelLLMSettings): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_18): In-page section heading. - [EditChatPromptRequest](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_EditChatPromptRequest): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_19): In-page section heading. - [EditChatRequest](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_EditChatRequest): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_20): In-page section heading. - [EditComparisonChatRequest](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_EditComparisonChatRequest): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_21): In-page section heading. - [EditComparisonPromptRequest](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_EditComparisonPromptRequest): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_22): In-page section heading. - [ExecutionStatus](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ExecutionStatus): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_23): In-page section heading. - [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#enumerated-values_2): In-page section heading. - [FeedbackMetadata](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_FeedbackMetadata): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_24): In-page section heading. - [FeedbackResult](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_FeedbackResult): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_25): In-page section heading. - [FeedbackSentiment](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_FeedbackSentiment): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_26): In-page section heading. - [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#enumerated-values_3): In-page section heading. - [HTTPValidationErrorResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_HTTPValidationErrorResponse): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_27): In-page section heading. - [ListChatPromptsResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ListChatPromptsResponse): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_28): In-page section heading. - [ListChatsResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ListChatsResponse): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_29): In-page section heading. - [ListComparisonChatsResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ListComparisonChatsResponse): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_30): In-page section heading. - [ListComparisonPromptsResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ListComparisonPromptsResponse): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_31): In-page section heading. - [ListPromptTemplateVersionsResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ListPromptTemplateVersionsResponse): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_32): In-page section heading. - [ListPromptTemplatesResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ListPromptTemplatesResponse): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_33): In-page section heading. - [MetricMetadata](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_MetricMetadata): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_34): In-page section heading. - [PipelineStage](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_PipelineStage): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_35): In-page section heading. - [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#enumerated-values_4): In-page section heading. - [PromptTemplateResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_PromptTemplateResponse): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_36): In-page section heading. - [PromptTemplateVersionResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_PromptTemplateVersionResponse): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_37): In-page section heading. - [PromptTemplatesSortQueryParam](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_PromptTemplatesSortQueryParam): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_38): In-page section heading. - [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#enumerated-values_5): In-page section heading. - [ProviderGuardStage](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ProviderGuardStage): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_39): In-page section heading. - [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#enumerated-values_6): In-page section heading. - [ProviderGuardsMetadata](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ProviderGuardsMetadata): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_40): In-page section heading. - [ResultMetadata](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ResultMetadata): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_41): In-page section heading. - [RetrievalMode](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_RetrievalMode): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_42): In-page section heading. - [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#enumerated-values_7): In-page section heading. - [ValidationError](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_ValidationError): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_43): In-page section heading. - [Variable](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_Variable): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_44): In-page section heading. - [VectorDatabaseRetrievers](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_VectorDatabaseRetrievers): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_45): In-page section heading. - [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#enumerated-values_8): In-page section heading. - [VectorDatabaseSettings](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#tocS_VectorDatabaseSettings): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/prompting.html#properties_46): In-page section heading. ## Related documentation - [Developer documentation](https://docs.datarobot.com/en/docs/api/index.html): Linked from this page. - [API reference](https://docs.datarobot.com/en/docs/api/reference/index.html): Linked from this page. - [REST API](https://docs.datarobot.com/en/docs/api/reference/public-api/index.html): Linked from this page. - [Generative AI](https://docs.datarobot.com/en/docs/api/reference/public-api/tag-genai.html): Linked from this page. ## Documentation content The following endpoints outline how to manage prompts. ## List chat prompts Operation path: `GET /api/v2/genai/chatPrompts/` Authentication requirements: `BearerAuth` List chat prompts. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | playgroundId | query | any | false | Only retrieve the chat prompts associated with this playground ID. | | llmBlueprintId | query | any | false | Only retrieve the chat prompts associated with this LLM blueprint ID. If specified, will retrieve the chat prompts for the oldest chat in this LLM blueprint. | | chatId | query | any | false | Only retrieve the chat prompts associated with this chat ID. | | offset | query | integer | false | Skip the specified number of values. | | limit | query | integer | false | Retrieve only the specified number of values. | ### Example responses > 200 Response ``` { "description": "Paginated list of chat prompts.", "properties": { "count": { "description": "The number of records on this page.", "title": "count", "type": "integer" }, "data": { "description": "The list of records.", "items": { "description": "API response object for a single chat prompt.", "properties": { "chatContextId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat context for this prompt.", "title": "chatContextId" }, "chatId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat this chat prompt belongs to.", "title": "chatId" }, "chatPromptIdsIncludedInHistory": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The list of IDs of the chat prompts included in this prompt's history.", "title": "chatPromptIdsIncludedInHistory" }, "citations": { "description": "The list of relevant vector database citations (in case of using a vector database).", "items": { "description": "API response object for a single vector database citation.", "properties": { "chunkId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the chunk in the vector database index.", "title": "chunkId" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "LangChain Document metadata information holder.", "title": "metadata" }, "page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The source page number where the citation was found.", "title": "page" }, "similarityScore": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The similarity score between the citation and the user prompt.", "title": "similarityScore" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source of the citation (e.g., a filename in the original dataset).", "title": "source" }, "startIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The chunk's start character index in the source document.", "title": "startIndex" }, "text": { "description": "The text of the citation.", "title": "text", "type": "string" } }, "required": [ "text", "source" ], "title": "Citation", "type": "object" }, "title": "citations", "type": "array" }, "confidenceScores": { "anyOf": [ { "description": "API response object for confidence scores.", "properties": { "bleu": { "description": "BLEU score.", "title": "bleu", "type": "number" }, "meteor": { "description": "METEOR score.", "title": "meteor", "type": "number" }, "rouge": { "description": "ROUGE score.", "title": "rouge", "type": "number" } }, "required": [ "rouge", "meteor", "bleu" ], "title": "ConfidenceScores", "type": "object" }, { "type": "null" } ], "description": "The confidence scores that measure the similarity between the prompt context and the prompt completion." }, "creationDate": { "description": "The creation date of the chat prompt (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the chat prompt.", "title": "creationUserId", "type": "string" }, "executionStatus": { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, "id": { "description": "The ID of the chat prompt.", "title": "id", "type": "string" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint the chat prompt belongs to.", "title": "llmBlueprintId", "type": "string" }, "llmId": { "description": "The ID of the LLM used by the chat prompt.", "title": "llmId", "type": "string" }, "llmSettings": { "anyOf": [ { "additionalProperties": true, "description": "The settings that are available for all non-custom LLMs.", "properties": { "maxCompletionLength": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum number of tokens allowed in the chat completion. Use this value to, for example, control costs on token-based charges or manage response length for chat text limits.", "title": "maxCompletionLength" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "title": "CommonLLMSettings", "type": "object" }, { "additionalProperties": false, "description": "The settings that are available for custom model LLMs.", "properties": { "externalLlmContextSize": { "anyOf": [ { "maximum": 128000, "minimum": 128, "type": "integer" }, { "type": "null" } ], "default": 4096, "description": "The external LLM's context size, in tokens. This value is only used for pruning documents supplied to the LLM when a vector database is associated with the LLM blueprint. It does not affect the external LLM's actual context size in any way and is not supplied to the LLM.", "title": "externalLlmContextSize" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" }, "validationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the custom model LLM.", "title": "validationId" } }, "title": "CustomModelLLMSettings", "type": "object" }, { "additionalProperties": false, "description": "The settings that are available for custom model LLMs used via chat completion interface.", "properties": { "customModelId": { "description": "The ID of the custom model used via chat completion interface.", "title": "customModelId", "type": "string" }, "customModelVersionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model version used via chat completion interface.", "title": "customModelVersionId" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "required": [ "customModelId" ], "title": "CustomModelChatLLMSettings", "type": "object" }, { "type": "null" } ], "description": "A key/value dictionary of LLM settings.", "title": "llmSettings" }, "metadataFilter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The metadata dictionary defining the filters that documents must match in order to be retrieved.", "title": "metadataFilter" }, "resultMetadata": { "anyOf": [ { "description": "The additional information about prompt execution results.", "properties": { "blockedResultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The message to replace the result text if it is non empty, which represents a blocked response.", "title": "blockedResultText" }, "cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The estimated cost of executing the prompt.", "title": "cost" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message for the prompt (in case of an errored prompt).", "title": "errorMessage" }, "estimatedDocsTokenCount": { "default": 0, "description": "The estimated number of tokens in the documents retrieved from the vector database.", "title": "estimatedDocsTokenCount", "type": "integer" }, "feedbackResult": { "description": "Prompt feedback included in the result metadata.", "properties": { "negativeUserIds": { "default": [], "description": "The list of user IDs whose feedback is negative.", "items": { "type": "string" }, "title": "negativeUserIds", "type": "array" }, "positiveUserIds": { "default": [], "description": "The list of user IDs whose feedback is positive.", "items": { "type": "string" }, "title": "positiveUserIds", "type": "array" } }, "title": "FeedbackResult", "type": "object" }, "finalPrompt": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ] }, "type": "object" }, "type": "array" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } ] }, "type": "object" }, "type": "array" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "description": "The final representation of the prompt that was submitted to the LLM.", "title": "finalPrompt" }, "inputTokenCount": { "default": 0, "description": "The number of tokens in the LLM input. This number includes the tokens in the system prompt, the user prompt, the chat history (for history-aware chats) and the documents retrieved from the vector database (in case of using a vector database).", "title": "inputTokenCount", "type": "integer" }, "latencyMilliseconds": { "description": "The latency of the LLM response (in milliseconds).", "title": "latencyMilliseconds", "type": "integer" }, "metrics": { "default": [], "description": "The evaluation metrics for the prompt.", "items": { "description": "Prompt metric metadata.", "properties": { "costConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the cost configuration.", "title": "costConfigurationId" }, "customModelGuardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the custom model guard.", "title": "customModelGuardId" }, "customModelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model used for the metric.", "title": "customModelId" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message associated with the metric computation.", "title": "errorMessage" }, "evaluationDatasetConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the evaluation dataset configuration.", "title": "evaluationDatasetConfigurationId" }, "executionStatus": { "anyOf": [ { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, { "type": "null" } ], "description": "The computation status of the metric." }, "formattedName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted name of the metric.", "title": "formattedName" }, "formattedValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted value of the metric.", "title": "formattedValue" }, "llmIsDeprecated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the LLM is deprecated and will be removed in a future release.", "title": "llmIsDeprecated" }, "name": { "description": "The name of the metric.", "title": "name", "type": "string" }, "nemoMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the NeMo Pipeline configuration.", "title": "nemoMetricId" }, "ootbMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the OOTB metric configuration.", "title": "ootbMetricId" }, "sidecarModelMetricValidationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric).", "title": "sidecarModelMetricValidationId" }, "stage": { "anyOf": [ { "description": "Enum that describes at which stage the metric may be calculated.", "enum": [ "prompt_pipeline", "response_pipeline" ], "title": "PipelineStage", "type": "string" }, { "type": "null" } ], "description": "The stage (prompt or response) that the metric applies to." }, "value": { "description": "The value of the metric.", "title": "value" } }, "required": [ "name", "value" ], "title": "MetricMetadata", "type": "object" }, "title": "metrics", "type": "array" }, "outputTokenCount": { "default": 0, "description": "The number of tokens in the LLM output.", "title": "outputTokenCount", "type": "integer" }, "providerLLMGuards": { "anyOf": [ { "items": { "description": "Info on the provider guard metrics.", "properties": { "name": { "description": "The name of the provider guard metric.", "title": "name", "type": "string" }, "satisfyCriteria": { "description": "Whether the configured provider guard metric satisfied its hidden internal guard criteria.", "title": "satisfyCriteria", "type": "boolean" }, "stage": { "description": "The data stage where the provider guard metric is acting upon.", "enum": [ "prompt", "response" ], "title": "ProviderGuardStage", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The value of the provider guard metric.", "title": "value" } }, "required": [ "satisfyCriteria", "name", "value", "stage" ], "title": "ProviderGuardsMetadata", "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "The provider llm guards metadata.", "title": "providerLLMGuards" }, "totalTokenCount": { "default": 0, "description": "The combined number of tokens in the LLM input and output.", "title": "totalTokenCount", "type": "integer" } }, "required": [ "latencyMilliseconds" ], "title": "ResultMetadata", "type": "object" }, { "type": "null" } ], "description": "The additional information about the chat prompt results." }, "resultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The text of the prompt completion.", "title": "resultText" }, "text": { "description": "The text of the user prompt.", "title": "text", "type": "string" }, "userName": { "description": "The name of the user that created the chat prompt.", "title": "userName", "type": "string" }, "vectorDatabaseFamilyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the vector database family this chat prompt belongs to.", "title": "vectorDatabaseFamilyId" }, "vectorDatabaseId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the vector database linked to this LLM blueprint.", "title": "vectorDatabaseId" }, "vectorDatabaseSettings": { "anyOf": [ { "description": "Vector database retrieval settings.", "properties": { "addNeighborChunks": { "default": false, "description": "Add neighboring chunks to those that the similarity search retrieves, such that when selected, search returns i, i-1, and i+1.", "title": "addNeighborChunks", "type": "boolean" }, "maxDocumentsRetrievedPerPrompt": { "anyOf": [ { "maximum": 10, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of chunks to retrieve from the vector database.", "title": "maxDocumentsRetrievedPerPrompt" }, "maxTokens": { "anyOf": [ { "maximum": 51200, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of tokens to retrieve from the vector database.", "title": "maxTokens" }, "maximalMarginalRelevanceLambda": { "default": 0.5, "description": "Adjust the retrieval of chunks when using maximal marginal relevance to favor diversity (0.0) or similarity (1.0).", "maximum": 1, "minimum": 0, "title": "maximalMarginalRelevanceLambda", "type": "number" }, "retrievalMode": { "description": "Retrieval modes for vector databases.", "enum": [ "similarity", "maximal_marginal_relevance" ], "title": "RetrievalMode", "type": "string" }, "retriever": { "description": "The method used to retrieve relevant chunks from the vector database.", "enum": [ "SINGLE_LOOKUP_RETRIEVER", "CONVERSATIONAL_RETRIEVER", "MULTI_STEP_RETRIEVER" ], "title": "VectorDatabaseRetrievers", "type": "string" } }, "title": "VectorDatabaseSettings", "type": "object" }, { "type": "null" } ], "description": "A key/value dictionary of vector database settings." } }, "required": [ "llmId", "id", "text", "llmBlueprintId", "creationDate", "creationUserId", "userName", "resultMetadata", "resultText", "confidenceScores", "citations", "executionStatus" ], "title": "ChatPromptResponse", "type": "object" }, "title": "data", "type": "array" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the next page, or `null` if there is no such page.", "title": "next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the previous page, or `null` if there is no such page.", "title": "previous" }, "totalCount": { "description": "The total number of records.", "title": "totalCount", "type": "integer" } }, "required": [ "totalCount", "count", "next", "previous", "data" ], "title": "ListChatPromptsResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | Successful Response | ListChatPromptsResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Create chat prompt Operation path: `POST /api/v2/genai/chatPrompts/` Authentication requirements: `BearerAuth` Request the execution of a new prompt within a chat or an LLM blueprint. ### Body parameter ``` { "description": "The body of the \"Create chat prompt\" request.", "properties": { "chatId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat this prompt belongs to. If LLM and vector database settings are not specified in the request, then the prompt will use the current settings of the chat.", "title": "chatId" }, "llmBlueprintId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the LLM blueprint this prompt belongs to. If LLM and vector database settings are not specified in the request, then the prompt will use the current settings of the LLM blueprint.", "title": "llmBlueprintId" }, "llmId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "If specified, uses this LLM ID for the prompt and updates the settings of the corresponding chat or LLM blueprint to use this LLM ID.", "title": "llmId" }, "llmSettings": { "anyOf": [ { "additionalProperties": true, "description": "The settings that are available for all non-custom LLMs.", "properties": { "maxCompletionLength": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum number of tokens allowed in the chat completion. Use this value to, for example, control costs on token-based charges or manage response length for chat text limits.", "title": "maxCompletionLength" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "title": "CommonLLMSettings", "type": "object" }, { "additionalProperties": false, "description": "The settings that are available for custom model LLMs.", "properties": { "externalLlmContextSize": { "anyOf": [ { "maximum": 128000, "minimum": 128, "type": "integer" }, { "type": "null" } ], "default": 4096, "description": "The external LLM's context size, in tokens. This value is only used for pruning documents supplied to the LLM when a vector database is associated with the LLM blueprint. It does not affect the external LLM's actual context size in any way and is not supplied to the LLM.", "title": "externalLlmContextSize" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" }, "validationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the custom model LLM.", "title": "validationId" } }, "title": "CustomModelLLMSettings", "type": "object" }, { "additionalProperties": false, "description": "The settings that are available for custom model LLMs used via chat completion interface.", "properties": { "customModelId": { "description": "The ID of the custom model used via chat completion interface.", "title": "customModelId", "type": "string" }, "customModelVersionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model version used via chat completion interface.", "title": "customModelVersionId" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "required": [ "customModelId" ], "title": "CustomModelChatLLMSettings", "type": "object" }, { "type": "null" } ], "description": "If specified, uses these LLM settings for the prompt and updates the settings of the corresponding chat or LLM blueprint to use these LLM settings.", "title": "llmSettings" }, "metadataFilter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The metadata fields to add to the chat prompt.", "title": "metadataFilter" }, "text": { "description": "The text of the user prompt.", "maxLength": 5000000, "title": "text", "type": "string" }, "vectorDatabaseId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "If specified, uses this vector database ID for the prompt and updates the settings of the corresponding chat or LLM blueprint to use this vector database ID.", "title": "vectorDatabaseId" }, "vectorDatabaseSettings": { "anyOf": [ { "description": "Vector database retrieval settings.", "properties": { "addNeighborChunks": { "default": false, "description": "Add neighboring chunks to those that the similarity search retrieves, such that when selected, search returns i, i-1, and i+1.", "title": "addNeighborChunks", "type": "boolean" }, "maxDocumentsRetrievedPerPrompt": { "anyOf": [ { "maximum": 10, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of chunks to retrieve from the vector database.", "title": "maxDocumentsRetrievedPerPrompt" }, "maxTokens": { "anyOf": [ { "maximum": 51200, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of tokens to retrieve from the vector database.", "title": "maxTokens" }, "maximalMarginalRelevanceLambda": { "default": 0.5, "description": "Adjust the retrieval of chunks when using maximal marginal relevance to favor diversity (0.0) or similarity (1.0).", "maximum": 1, "minimum": 0, "title": "maximalMarginalRelevanceLambda", "type": "number" }, "retrievalMode": { "description": "Retrieval modes for vector databases.", "enum": [ "similarity", "maximal_marginal_relevance" ], "title": "RetrievalMode", "type": "string" }, "retriever": { "description": "The method used to retrieve relevant chunks from the vector database.", "enum": [ "SINGLE_LOOKUP_RETRIEVER", "CONVERSATIONAL_RETRIEVER", "MULTI_STEP_RETRIEVER" ], "title": "VectorDatabaseRetrievers", "type": "string" } }, "title": "VectorDatabaseSettings", "type": "object" }, { "type": "null" } ], "description": "If specified, uses these vector database settings for the prompt and updates the settings of the corresponding chat or LLM blueprint to use these vector database settings." } }, "required": [ "text" ], "title": "CreateChatPromptRequest", "type": "object" } ``` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | body | body | CreateChatPromptRequest | true | none | ### Example responses > 202 Response ``` { "description": "API response object for a single chat prompt.", "properties": { "chatContextId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat context for this prompt.", "title": "chatContextId" }, "chatId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat this chat prompt belongs to.", "title": "chatId" }, "chatPromptIdsIncludedInHistory": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The list of IDs of the chat prompts included in this prompt's history.", "title": "chatPromptIdsIncludedInHistory" }, "citations": { "description": "The list of relevant vector database citations (in case of using a vector database).", "items": { "description": "API response object for a single vector database citation.", "properties": { "chunkId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the chunk in the vector database index.", "title": "chunkId" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "LangChain Document metadata information holder.", "title": "metadata" }, "page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The source page number where the citation was found.", "title": "page" }, "similarityScore": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The similarity score between the citation and the user prompt.", "title": "similarityScore" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source of the citation (e.g., a filename in the original dataset).", "title": "source" }, "startIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The chunk's start character index in the source document.", "title": "startIndex" }, "text": { "description": "The text of the citation.", "title": "text", "type": "string" } }, "required": [ "text", "source" ], "title": "Citation", "type": "object" }, "title": "citations", "type": "array" }, "confidenceScores": { "anyOf": [ { "description": "API response object for confidence scores.", "properties": { "bleu": { "description": "BLEU score.", "title": "bleu", "type": "number" }, "meteor": { "description": "METEOR score.", "title": "meteor", "type": "number" }, "rouge": { "description": "ROUGE score.", "title": "rouge", "type": "number" } }, "required": [ "rouge", "meteor", "bleu" ], "title": "ConfidenceScores", "type": "object" }, { "type": "null" } ], "description": "The confidence scores that measure the similarity between the prompt context and the prompt completion." }, "creationDate": { "description": "The creation date of the chat prompt (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the chat prompt.", "title": "creationUserId", "type": "string" }, "executionStatus": { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, "id": { "description": "The ID of the chat prompt.", "title": "id", "type": "string" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint the chat prompt belongs to.", "title": "llmBlueprintId", "type": "string" }, "llmId": { "description": "The ID of the LLM used by the chat prompt.", "title": "llmId", "type": "string" }, "llmSettings": { "anyOf": [ { "additionalProperties": true, "description": "The settings that are available for all non-custom LLMs.", "properties": { "maxCompletionLength": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum number of tokens allowed in the chat completion. Use this value to, for example, control costs on token-based charges or manage response length for chat text limits.", "title": "maxCompletionLength" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "title": "CommonLLMSettings", "type": "object" }, { "additionalProperties": false, "description": "The settings that are available for custom model LLMs.", "properties": { "externalLlmContextSize": { "anyOf": [ { "maximum": 128000, "minimum": 128, "type": "integer" }, { "type": "null" } ], "default": 4096, "description": "The external LLM's context size, in tokens. This value is only used for pruning documents supplied to the LLM when a vector database is associated with the LLM blueprint. It does not affect the external LLM's actual context size in any way and is not supplied to the LLM.", "title": "externalLlmContextSize" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" }, "validationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the custom model LLM.", "title": "validationId" } }, "title": "CustomModelLLMSettings", "type": "object" }, { "additionalProperties": false, "description": "The settings that are available for custom model LLMs used via chat completion interface.", "properties": { "customModelId": { "description": "The ID of the custom model used via chat completion interface.", "title": "customModelId", "type": "string" }, "customModelVersionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model version used via chat completion interface.", "title": "customModelVersionId" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "required": [ "customModelId" ], "title": "CustomModelChatLLMSettings", "type": "object" }, { "type": "null" } ], "description": "A key/value dictionary of LLM settings.", "title": "llmSettings" }, "metadataFilter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The metadata dictionary defining the filters that documents must match in order to be retrieved.", "title": "metadataFilter" }, "resultMetadata": { "anyOf": [ { "description": "The additional information about prompt execution results.", "properties": { "blockedResultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The message to replace the result text if it is non empty, which represents a blocked response.", "title": "blockedResultText" }, "cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The estimated cost of executing the prompt.", "title": "cost" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message for the prompt (in case of an errored prompt).", "title": "errorMessage" }, "estimatedDocsTokenCount": { "default": 0, "description": "The estimated number of tokens in the documents retrieved from the vector database.", "title": "estimatedDocsTokenCount", "type": "integer" }, "feedbackResult": { "description": "Prompt feedback included in the result metadata.", "properties": { "negativeUserIds": { "default": [], "description": "The list of user IDs whose feedback is negative.", "items": { "type": "string" }, "title": "negativeUserIds", "type": "array" }, "positiveUserIds": { "default": [], "description": "The list of user IDs whose feedback is positive.", "items": { "type": "string" }, "title": "positiveUserIds", "type": "array" } }, "title": "FeedbackResult", "type": "object" }, "finalPrompt": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ] }, "type": "object" }, "type": "array" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } ] }, "type": "object" }, "type": "array" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "description": "The final representation of the prompt that was submitted to the LLM.", "title": "finalPrompt" }, "inputTokenCount": { "default": 0, "description": "The number of tokens in the LLM input. This number includes the tokens in the system prompt, the user prompt, the chat history (for history-aware chats) and the documents retrieved from the vector database (in case of using a vector database).", "title": "inputTokenCount", "type": "integer" }, "latencyMilliseconds": { "description": "The latency of the LLM response (in milliseconds).", "title": "latencyMilliseconds", "type": "integer" }, "metrics": { "default": [], "description": "The evaluation metrics for the prompt.", "items": { "description": "Prompt metric metadata.", "properties": { "costConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the cost configuration.", "title": "costConfigurationId" }, "customModelGuardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the custom model guard.", "title": "customModelGuardId" }, "customModelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model used for the metric.", "title": "customModelId" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message associated with the metric computation.", "title": "errorMessage" }, "evaluationDatasetConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the evaluation dataset configuration.", "title": "evaluationDatasetConfigurationId" }, "executionStatus": { "anyOf": [ { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, { "type": "null" } ], "description": "The computation status of the metric." }, "formattedName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted name of the metric.", "title": "formattedName" }, "formattedValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted value of the metric.", "title": "formattedValue" }, "llmIsDeprecated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the LLM is deprecated and will be removed in a future release.", "title": "llmIsDeprecated" }, "name": { "description": "The name of the metric.", "title": "name", "type": "string" }, "nemoMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the NeMo Pipeline configuration.", "title": "nemoMetricId" }, "ootbMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the OOTB metric configuration.", "title": "ootbMetricId" }, "sidecarModelMetricValidationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric).", "title": "sidecarModelMetricValidationId" }, "stage": { "anyOf": [ { "description": "Enum that describes at which stage the metric may be calculated.", "enum": [ "prompt_pipeline", "response_pipeline" ], "title": "PipelineStage", "type": "string" }, { "type": "null" } ], "description": "The stage (prompt or response) that the metric applies to." }, "value": { "description": "The value of the metric.", "title": "value" } }, "required": [ "name", "value" ], "title": "MetricMetadata", "type": "object" }, "title": "metrics", "type": "array" }, "outputTokenCount": { "default": 0, "description": "The number of tokens in the LLM output.", "title": "outputTokenCount", "type": "integer" }, "providerLLMGuards": { "anyOf": [ { "items": { "description": "Info on the provider guard metrics.", "properties": { "name": { "description": "The name of the provider guard metric.", "title": "name", "type": "string" }, "satisfyCriteria": { "description": "Whether the configured provider guard metric satisfied its hidden internal guard criteria.", "title": "satisfyCriteria", "type": "boolean" }, "stage": { "description": "The data stage where the provider guard metric is acting upon.", "enum": [ "prompt", "response" ], "title": "ProviderGuardStage", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The value of the provider guard metric.", "title": "value" } }, "required": [ "satisfyCriteria", "name", "value", "stage" ], "title": "ProviderGuardsMetadata", "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "The provider llm guards metadata.", "title": "providerLLMGuards" }, "totalTokenCount": { "default": 0, "description": "The combined number of tokens in the LLM input and output.", "title": "totalTokenCount", "type": "integer" } }, "required": [ "latencyMilliseconds" ], "title": "ResultMetadata", "type": "object" }, { "type": "null" } ], "description": "The additional information about the chat prompt results." }, "resultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The text of the prompt completion.", "title": "resultText" }, "text": { "description": "The text of the user prompt.", "title": "text", "type": "string" }, "userName": { "description": "The name of the user that created the chat prompt.", "title": "userName", "type": "string" }, "vectorDatabaseFamilyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the vector database family this chat prompt belongs to.", "title": "vectorDatabaseFamilyId" }, "vectorDatabaseId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the vector database linked to this LLM blueprint.", "title": "vectorDatabaseId" }, "vectorDatabaseSettings": { "anyOf": [ { "description": "Vector database retrieval settings.", "properties": { "addNeighborChunks": { "default": false, "description": "Add neighboring chunks to those that the similarity search retrieves, such that when selected, search returns i, i-1, and i+1.", "title": "addNeighborChunks", "type": "boolean" }, "maxDocumentsRetrievedPerPrompt": { "anyOf": [ { "maximum": 10, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of chunks to retrieve from the vector database.", "title": "maxDocumentsRetrievedPerPrompt" }, "maxTokens": { "anyOf": [ { "maximum": 51200, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of tokens to retrieve from the vector database.", "title": "maxTokens" }, "maximalMarginalRelevanceLambda": { "default": 0.5, "description": "Adjust the retrieval of chunks when using maximal marginal relevance to favor diversity (0.0) or similarity (1.0).", "maximum": 1, "minimum": 0, "title": "maximalMarginalRelevanceLambda", "type": "number" }, "retrievalMode": { "description": "Retrieval modes for vector databases.", "enum": [ "similarity", "maximal_marginal_relevance" ], "title": "RetrievalMode", "type": "string" }, "retriever": { "description": "The method used to retrieve relevant chunks from the vector database.", "enum": [ "SINGLE_LOOKUP_RETRIEVER", "CONVERSATIONAL_RETRIEVER", "MULTI_STEP_RETRIEVER" ], "title": "VectorDatabaseRetrievers", "type": "string" } }, "title": "VectorDatabaseSettings", "type": "object" }, { "type": "null" } ], "description": "A key/value dictionary of vector database settings." } }, "required": [ "llmId", "id", "text", "llmBlueprintId", "creationDate", "creationUserId", "userName", "resultMetadata", "resultText", "confidenceScores", "citations", "executionStatus" ], "title": "ChatPromptResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 202 | Accepted | Successful Response | ChatPromptResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Delete chat prompt by chat prompt ID Operation path: `DELETE /api/v2/genai/chatPrompts/{chatPromptId}/` Authentication requirements: `BearerAuth` Delete an existing chat prompt. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | chatPromptId | path | string | true | The ID of the chat prompt to delete. | ### Example responses > 422 Response ``` { "properties": { "detail": { "items": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "loc", "type": "array" }, "msg": { "title": "msg", "type": "string" }, "type": { "title": "type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" }, "title": "detail", "type": "array" } }, "title": "HTTPValidationErrorResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 204 | No Content | Successful Response | None | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Retrieve chat prompt by chat prompt ID Operation path: `GET /api/v2/genai/chatPrompts/{chatPromptId}/` Authentication requirements: `BearerAuth` Retrieve an existing chat prompt. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | chatPromptId | path | string | true | The ID of the chat prompt to retrieve. | ### Example responses > 200 Response ``` { "description": "API response object for a single chat prompt.", "properties": { "chatContextId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat context for this prompt.", "title": "chatContextId" }, "chatId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat this chat prompt belongs to.", "title": "chatId" }, "chatPromptIdsIncludedInHistory": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The list of IDs of the chat prompts included in this prompt's history.", "title": "chatPromptIdsIncludedInHistory" }, "citations": { "description": "The list of relevant vector database citations (in case of using a vector database).", "items": { "description": "API response object for a single vector database citation.", "properties": { "chunkId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the chunk in the vector database index.", "title": "chunkId" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "LangChain Document metadata information holder.", "title": "metadata" }, "page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The source page number where the citation was found.", "title": "page" }, "similarityScore": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The similarity score between the citation and the user prompt.", "title": "similarityScore" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source of the citation (e.g., a filename in the original dataset).", "title": "source" }, "startIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The chunk's start character index in the source document.", "title": "startIndex" }, "text": { "description": "The text of the citation.", "title": "text", "type": "string" } }, "required": [ "text", "source" ], "title": "Citation", "type": "object" }, "title": "citations", "type": "array" }, "confidenceScores": { "anyOf": [ { "description": "API response object for confidence scores.", "properties": { "bleu": { "description": "BLEU score.", "title": "bleu", "type": "number" }, "meteor": { "description": "METEOR score.", "title": "meteor", "type": "number" }, "rouge": { "description": "ROUGE score.", "title": "rouge", "type": "number" } }, "required": [ "rouge", "meteor", "bleu" ], "title": "ConfidenceScores", "type": "object" }, { "type": "null" } ], "description": "The confidence scores that measure the similarity between the prompt context and the prompt completion." }, "creationDate": { "description": "The creation date of the chat prompt (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the chat prompt.", "title": "creationUserId", "type": "string" }, "executionStatus": { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, "id": { "description": "The ID of the chat prompt.", "title": "id", "type": "string" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint the chat prompt belongs to.", "title": "llmBlueprintId", "type": "string" }, "llmId": { "description": "The ID of the LLM used by the chat prompt.", "title": "llmId", "type": "string" }, "llmSettings": { "anyOf": [ { "additionalProperties": true, "description": "The settings that are available for all non-custom LLMs.", "properties": { "maxCompletionLength": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum number of tokens allowed in the chat completion. Use this value to, for example, control costs on token-based charges or manage response length for chat text limits.", "title": "maxCompletionLength" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "title": "CommonLLMSettings", "type": "object" }, { "additionalProperties": false, "description": "The settings that are available for custom model LLMs.", "properties": { "externalLlmContextSize": { "anyOf": [ { "maximum": 128000, "minimum": 128, "type": "integer" }, { "type": "null" } ], "default": 4096, "description": "The external LLM's context size, in tokens. This value is only used for pruning documents supplied to the LLM when a vector database is associated with the LLM blueprint. It does not affect the external LLM's actual context size in any way and is not supplied to the LLM.", "title": "externalLlmContextSize" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" }, "validationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the custom model LLM.", "title": "validationId" } }, "title": "CustomModelLLMSettings", "type": "object" }, { "additionalProperties": false, "description": "The settings that are available for custom model LLMs used via chat completion interface.", "properties": { "customModelId": { "description": "The ID of the custom model used via chat completion interface.", "title": "customModelId", "type": "string" }, "customModelVersionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model version used via chat completion interface.", "title": "customModelVersionId" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "required": [ "customModelId" ], "title": "CustomModelChatLLMSettings", "type": "object" }, { "type": "null" } ], "description": "A key/value dictionary of LLM settings.", "title": "llmSettings" }, "metadataFilter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The metadata dictionary defining the filters that documents must match in order to be retrieved.", "title": "metadataFilter" }, "resultMetadata": { "anyOf": [ { "description": "The additional information about prompt execution results.", "properties": { "blockedResultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The message to replace the result text if it is non empty, which represents a blocked response.", "title": "blockedResultText" }, "cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The estimated cost of executing the prompt.", "title": "cost" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message for the prompt (in case of an errored prompt).", "title": "errorMessage" }, "estimatedDocsTokenCount": { "default": 0, "description": "The estimated number of tokens in the documents retrieved from the vector database.", "title": "estimatedDocsTokenCount", "type": "integer" }, "feedbackResult": { "description": "Prompt feedback included in the result metadata.", "properties": { "negativeUserIds": { "default": [], "description": "The list of user IDs whose feedback is negative.", "items": { "type": "string" }, "title": "negativeUserIds", "type": "array" }, "positiveUserIds": { "default": [], "description": "The list of user IDs whose feedback is positive.", "items": { "type": "string" }, "title": "positiveUserIds", "type": "array" } }, "title": "FeedbackResult", "type": "object" }, "finalPrompt": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ] }, "type": "object" }, "type": "array" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } ] }, "type": "object" }, "type": "array" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "description": "The final representation of the prompt that was submitted to the LLM.", "title": "finalPrompt" }, "inputTokenCount": { "default": 0, "description": "The number of tokens in the LLM input. This number includes the tokens in the system prompt, the user prompt, the chat history (for history-aware chats) and the documents retrieved from the vector database (in case of using a vector database).", "title": "inputTokenCount", "type": "integer" }, "latencyMilliseconds": { "description": "The latency of the LLM response (in milliseconds).", "title": "latencyMilliseconds", "type": "integer" }, "metrics": { "default": [], "description": "The evaluation metrics for the prompt.", "items": { "description": "Prompt metric metadata.", "properties": { "costConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the cost configuration.", "title": "costConfigurationId" }, "customModelGuardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the custom model guard.", "title": "customModelGuardId" }, "customModelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model used for the metric.", "title": "customModelId" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message associated with the metric computation.", "title": "errorMessage" }, "evaluationDatasetConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the evaluation dataset configuration.", "title": "evaluationDatasetConfigurationId" }, "executionStatus": { "anyOf": [ { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, { "type": "null" } ], "description": "The computation status of the metric." }, "formattedName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted name of the metric.", "title": "formattedName" }, "formattedValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted value of the metric.", "title": "formattedValue" }, "llmIsDeprecated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the LLM is deprecated and will be removed in a future release.", "title": "llmIsDeprecated" }, "name": { "description": "The name of the metric.", "title": "name", "type": "string" }, "nemoMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the NeMo Pipeline configuration.", "title": "nemoMetricId" }, "ootbMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the OOTB metric configuration.", "title": "ootbMetricId" }, "sidecarModelMetricValidationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric).", "title": "sidecarModelMetricValidationId" }, "stage": { "anyOf": [ { "description": "Enum that describes at which stage the metric may be calculated.", "enum": [ "prompt_pipeline", "response_pipeline" ], "title": "PipelineStage", "type": "string" }, { "type": "null" } ], "description": "The stage (prompt or response) that the metric applies to." }, "value": { "description": "The value of the metric.", "title": "value" } }, "required": [ "name", "value" ], "title": "MetricMetadata", "type": "object" }, "title": "metrics", "type": "array" }, "outputTokenCount": { "default": 0, "description": "The number of tokens in the LLM output.", "title": "outputTokenCount", "type": "integer" }, "providerLLMGuards": { "anyOf": [ { "items": { "description": "Info on the provider guard metrics.", "properties": { "name": { "description": "The name of the provider guard metric.", "title": "name", "type": "string" }, "satisfyCriteria": { "description": "Whether the configured provider guard metric satisfied its hidden internal guard criteria.", "title": "satisfyCriteria", "type": "boolean" }, "stage": { "description": "The data stage where the provider guard metric is acting upon.", "enum": [ "prompt", "response" ], "title": "ProviderGuardStage", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The value of the provider guard metric.", "title": "value" } }, "required": [ "satisfyCriteria", "name", "value", "stage" ], "title": "ProviderGuardsMetadata", "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "The provider llm guards metadata.", "title": "providerLLMGuards" }, "totalTokenCount": { "default": 0, "description": "The combined number of tokens in the LLM input and output.", "title": "totalTokenCount", "type": "integer" } }, "required": [ "latencyMilliseconds" ], "title": "ResultMetadata", "type": "object" }, { "type": "null" } ], "description": "The additional information about the chat prompt results." }, "resultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The text of the prompt completion.", "title": "resultText" }, "text": { "description": "The text of the user prompt.", "title": "text", "type": "string" }, "userName": { "description": "The name of the user that created the chat prompt.", "title": "userName", "type": "string" }, "vectorDatabaseFamilyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the vector database family this chat prompt belongs to.", "title": "vectorDatabaseFamilyId" }, "vectorDatabaseId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the vector database linked to this LLM blueprint.", "title": "vectorDatabaseId" }, "vectorDatabaseSettings": { "anyOf": [ { "description": "Vector database retrieval settings.", "properties": { "addNeighborChunks": { "default": false, "description": "Add neighboring chunks to those that the similarity search retrieves, such that when selected, search returns i, i-1, and i+1.", "title": "addNeighborChunks", "type": "boolean" }, "maxDocumentsRetrievedPerPrompt": { "anyOf": [ { "maximum": 10, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of chunks to retrieve from the vector database.", "title": "maxDocumentsRetrievedPerPrompt" }, "maxTokens": { "anyOf": [ { "maximum": 51200, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of tokens to retrieve from the vector database.", "title": "maxTokens" }, "maximalMarginalRelevanceLambda": { "default": 0.5, "description": "Adjust the retrieval of chunks when using maximal marginal relevance to favor diversity (0.0) or similarity (1.0).", "maximum": 1, "minimum": 0, "title": "maximalMarginalRelevanceLambda", "type": "number" }, "retrievalMode": { "description": "Retrieval modes for vector databases.", "enum": [ "similarity", "maximal_marginal_relevance" ], "title": "RetrievalMode", "type": "string" }, "retriever": { "description": "The method used to retrieve relevant chunks from the vector database.", "enum": [ "SINGLE_LOOKUP_RETRIEVER", "CONVERSATIONAL_RETRIEVER", "MULTI_STEP_RETRIEVER" ], "title": "VectorDatabaseRetrievers", "type": "string" } }, "title": "VectorDatabaseSettings", "type": "object" }, { "type": "null" } ], "description": "A key/value dictionary of vector database settings." } }, "required": [ "llmId", "id", "text", "llmBlueprintId", "creationDate", "creationUserId", "userName", "resultMetadata", "resultText", "confidenceScores", "citations", "executionStatus" ], "title": "ChatPromptResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | Successful Response | ChatPromptResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Edit chat prompt by chat prompt ID Operation path: `PATCH /api/v2/genai/chatPrompts/{chatPromptId}/` Authentication requirements: `BearerAuth` Edit an existing chat prompt. ### Body parameter ``` { "description": "The body of the \"Update chat prompt\" request.", "properties": { "customMetrics": { "anyOf": [ { "items": { "description": "Prompt metric metadata.", "properties": { "costConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the cost configuration.", "title": "costConfigurationId" }, "customModelGuardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the custom model guard.", "title": "customModelGuardId" }, "customModelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model used for the metric.", "title": "customModelId" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message associated with the metric computation.", "title": "errorMessage" }, "evaluationDatasetConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the evaluation dataset configuration.", "title": "evaluationDatasetConfigurationId" }, "executionStatus": { "anyOf": [ { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, { "type": "null" } ], "description": "The computation status of the metric." }, "formattedName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted name of the metric.", "title": "formattedName" }, "formattedValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted value of the metric.", "title": "formattedValue" }, "llmIsDeprecated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the LLM is deprecated and will be removed in a future release.", "title": "llmIsDeprecated" }, "name": { "description": "The name of the metric.", "title": "name", "type": "string" }, "nemoMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the NeMo Pipeline configuration.", "title": "nemoMetricId" }, "ootbMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the OOTB metric configuration.", "title": "ootbMetricId" }, "sidecarModelMetricValidationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric).", "title": "sidecarModelMetricValidationId" }, "stage": { "anyOf": [ { "description": "Enum that describes at which stage the metric may be calculated.", "enum": [ "prompt_pipeline", "response_pipeline" ], "title": "PipelineStage", "type": "string" }, { "type": "null" } ], "description": "The stage (prompt or response) that the metric applies to." }, "value": { "description": "The value of the metric.", "title": "value" } }, "required": [ "name", "value" ], "title": "MetricMetadata", "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "The list of metric results to add to the chat prompt.", "title": "customMetrics" }, "feedbackMetadata": { "anyOf": [ { "description": "Prompt feedback metadata.", "properties": { "feedback": { "anyOf": [ { "description": "The sentiment of the feedback.", "enum": [ "1", "0" ], "title": "FeedbackSentiment", "type": "string" }, { "type": "null" } ], "description": "The sentiment of the feedback." } }, "required": [ "feedback" ], "title": "FeedbackMetadata", "type": "object" }, { "type": "null" } ], "description": "The feedback metadata to add to the chat prompt." } }, "title": "EditChatPromptRequest", "type": "object" } ``` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | chatPromptId | path | string | true | The ID of the chat prompt to edit. | | body | body | EditChatPromptRequest | true | none | ### Example responses > 200 Response ``` { "description": "API response object for a single chat prompt.", "properties": { "chatContextId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat context for this prompt.", "title": "chatContextId" }, "chatId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat this chat prompt belongs to.", "title": "chatId" }, "chatPromptIdsIncludedInHistory": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The list of IDs of the chat prompts included in this prompt's history.", "title": "chatPromptIdsIncludedInHistory" }, "citations": { "description": "The list of relevant vector database citations (in case of using a vector database).", "items": { "description": "API response object for a single vector database citation.", "properties": { "chunkId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the chunk in the vector database index.", "title": "chunkId" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "LangChain Document metadata information holder.", "title": "metadata" }, "page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The source page number where the citation was found.", "title": "page" }, "similarityScore": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The similarity score between the citation and the user prompt.", "title": "similarityScore" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source of the citation (e.g., a filename in the original dataset).", "title": "source" }, "startIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The chunk's start character index in the source document.", "title": "startIndex" }, "text": { "description": "The text of the citation.", "title": "text", "type": "string" } }, "required": [ "text", "source" ], "title": "Citation", "type": "object" }, "title": "citations", "type": "array" }, "confidenceScores": { "anyOf": [ { "description": "API response object for confidence scores.", "properties": { "bleu": { "description": "BLEU score.", "title": "bleu", "type": "number" }, "meteor": { "description": "METEOR score.", "title": "meteor", "type": "number" }, "rouge": { "description": "ROUGE score.", "title": "rouge", "type": "number" } }, "required": [ "rouge", "meteor", "bleu" ], "title": "ConfidenceScores", "type": "object" }, { "type": "null" } ], "description": "The confidence scores that measure the similarity between the prompt context and the prompt completion." }, "creationDate": { "description": "The creation date of the chat prompt (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the chat prompt.", "title": "creationUserId", "type": "string" }, "executionStatus": { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, "id": { "description": "The ID of the chat prompt.", "title": "id", "type": "string" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint the chat prompt belongs to.", "title": "llmBlueprintId", "type": "string" }, "llmId": { "description": "The ID of the LLM used by the chat prompt.", "title": "llmId", "type": "string" }, "llmSettings": { "anyOf": [ { "additionalProperties": true, "description": "The settings that are available for all non-custom LLMs.", "properties": { "maxCompletionLength": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum number of tokens allowed in the chat completion. Use this value to, for example, control costs on token-based charges or manage response length for chat text limits.", "title": "maxCompletionLength" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "title": "CommonLLMSettings", "type": "object" }, { "additionalProperties": false, "description": "The settings that are available for custom model LLMs.", "properties": { "externalLlmContextSize": { "anyOf": [ { "maximum": 128000, "minimum": 128, "type": "integer" }, { "type": "null" } ], "default": 4096, "description": "The external LLM's context size, in tokens. This value is only used for pruning documents supplied to the LLM when a vector database is associated with the LLM blueprint. It does not affect the external LLM's actual context size in any way and is not supplied to the LLM.", "title": "externalLlmContextSize" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" }, "validationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the custom model LLM.", "title": "validationId" } }, "title": "CustomModelLLMSettings", "type": "object" }, { "additionalProperties": false, "description": "The settings that are available for custom model LLMs used via chat completion interface.", "properties": { "customModelId": { "description": "The ID of the custom model used via chat completion interface.", "title": "customModelId", "type": "string" }, "customModelVersionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model version used via chat completion interface.", "title": "customModelVersionId" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "required": [ "customModelId" ], "title": "CustomModelChatLLMSettings", "type": "object" }, { "type": "null" } ], "description": "A key/value dictionary of LLM settings.", "title": "llmSettings" }, "metadataFilter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The metadata dictionary defining the filters that documents must match in order to be retrieved.", "title": "metadataFilter" }, "resultMetadata": { "anyOf": [ { "description": "The additional information about prompt execution results.", "properties": { "blockedResultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The message to replace the result text if it is non empty, which represents a blocked response.", "title": "blockedResultText" }, "cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The estimated cost of executing the prompt.", "title": "cost" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message for the prompt (in case of an errored prompt).", "title": "errorMessage" }, "estimatedDocsTokenCount": { "default": 0, "description": "The estimated number of tokens in the documents retrieved from the vector database.", "title": "estimatedDocsTokenCount", "type": "integer" }, "feedbackResult": { "description": "Prompt feedback included in the result metadata.", "properties": { "negativeUserIds": { "default": [], "description": "The list of user IDs whose feedback is negative.", "items": { "type": "string" }, "title": "negativeUserIds", "type": "array" }, "positiveUserIds": { "default": [], "description": "The list of user IDs whose feedback is positive.", "items": { "type": "string" }, "title": "positiveUserIds", "type": "array" } }, "title": "FeedbackResult", "type": "object" }, "finalPrompt": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ] }, "type": "object" }, "type": "array" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } ] }, "type": "object" }, "type": "array" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "description": "The final representation of the prompt that was submitted to the LLM.", "title": "finalPrompt" }, "inputTokenCount": { "default": 0, "description": "The number of tokens in the LLM input. This number includes the tokens in the system prompt, the user prompt, the chat history (for history-aware chats) and the documents retrieved from the vector database (in case of using a vector database).", "title": "inputTokenCount", "type": "integer" }, "latencyMilliseconds": { "description": "The latency of the LLM response (in milliseconds).", "title": "latencyMilliseconds", "type": "integer" }, "metrics": { "default": [], "description": "The evaluation metrics for the prompt.", "items": { "description": "Prompt metric metadata.", "properties": { "costConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the cost configuration.", "title": "costConfigurationId" }, "customModelGuardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the custom model guard.", "title": "customModelGuardId" }, "customModelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model used for the metric.", "title": "customModelId" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message associated with the metric computation.", "title": "errorMessage" }, "evaluationDatasetConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the evaluation dataset configuration.", "title": "evaluationDatasetConfigurationId" }, "executionStatus": { "anyOf": [ { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, { "type": "null" } ], "description": "The computation status of the metric." }, "formattedName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted name of the metric.", "title": "formattedName" }, "formattedValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted value of the metric.", "title": "formattedValue" }, "llmIsDeprecated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the LLM is deprecated and will be removed in a future release.", "title": "llmIsDeprecated" }, "name": { "description": "The name of the metric.", "title": "name", "type": "string" }, "nemoMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the NeMo Pipeline configuration.", "title": "nemoMetricId" }, "ootbMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the OOTB metric configuration.", "title": "ootbMetricId" }, "sidecarModelMetricValidationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric).", "title": "sidecarModelMetricValidationId" }, "stage": { "anyOf": [ { "description": "Enum that describes at which stage the metric may be calculated.", "enum": [ "prompt_pipeline", "response_pipeline" ], "title": "PipelineStage", "type": "string" }, { "type": "null" } ], "description": "The stage (prompt or response) that the metric applies to." }, "value": { "description": "The value of the metric.", "title": "value" } }, "required": [ "name", "value" ], "title": "MetricMetadata", "type": "object" }, "title": "metrics", "type": "array" }, "outputTokenCount": { "default": 0, "description": "The number of tokens in the LLM output.", "title": "outputTokenCount", "type": "integer" }, "providerLLMGuards": { "anyOf": [ { "items": { "description": "Info on the provider guard metrics.", "properties": { "name": { "description": "The name of the provider guard metric.", "title": "name", "type": "string" }, "satisfyCriteria": { "description": "Whether the configured provider guard metric satisfied its hidden internal guard criteria.", "title": "satisfyCriteria", "type": "boolean" }, "stage": { "description": "The data stage where the provider guard metric is acting upon.", "enum": [ "prompt", "response" ], "title": "ProviderGuardStage", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The value of the provider guard metric.", "title": "value" } }, "required": [ "satisfyCriteria", "name", "value", "stage" ], "title": "ProviderGuardsMetadata", "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "The provider llm guards metadata.", "title": "providerLLMGuards" }, "totalTokenCount": { "default": 0, "description": "The combined number of tokens in the LLM input and output.", "title": "totalTokenCount", "type": "integer" } }, "required": [ "latencyMilliseconds" ], "title": "ResultMetadata", "type": "object" }, { "type": "null" } ], "description": "The additional information about the chat prompt results." }, "resultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The text of the prompt completion.", "title": "resultText" }, "text": { "description": "The text of the user prompt.", "title": "text", "type": "string" }, "userName": { "description": "The name of the user that created the chat prompt.", "title": "userName", "type": "string" }, "vectorDatabaseFamilyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the vector database family this chat prompt belongs to.", "title": "vectorDatabaseFamilyId" }, "vectorDatabaseId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the vector database linked to this LLM blueprint.", "title": "vectorDatabaseId" }, "vectorDatabaseSettings": { "anyOf": [ { "description": "Vector database retrieval settings.", "properties": { "addNeighborChunks": { "default": false, "description": "Add neighboring chunks to those that the similarity search retrieves, such that when selected, search returns i, i-1, and i+1.", "title": "addNeighborChunks", "type": "boolean" }, "maxDocumentsRetrievedPerPrompt": { "anyOf": [ { "maximum": 10, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of chunks to retrieve from the vector database.", "title": "maxDocumentsRetrievedPerPrompt" }, "maxTokens": { "anyOf": [ { "maximum": 51200, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of tokens to retrieve from the vector database.", "title": "maxTokens" }, "maximalMarginalRelevanceLambda": { "default": 0.5, "description": "Adjust the retrieval of chunks when using maximal marginal relevance to favor diversity (0.0) or similarity (1.0).", "maximum": 1, "minimum": 0, "title": "maximalMarginalRelevanceLambda", "type": "number" }, "retrievalMode": { "description": "Retrieval modes for vector databases.", "enum": [ "similarity", "maximal_marginal_relevance" ], "title": "RetrievalMode", "type": "string" }, "retriever": { "description": "The method used to retrieve relevant chunks from the vector database.", "enum": [ "SINGLE_LOOKUP_RETRIEVER", "CONVERSATIONAL_RETRIEVER", "MULTI_STEP_RETRIEVER" ], "title": "VectorDatabaseRetrievers", "type": "string" } }, "title": "VectorDatabaseSettings", "type": "object" }, { "type": "null" } ], "description": "A key/value dictionary of vector database settings." } }, "required": [ "llmId", "id", "text", "llmBlueprintId", "creationDate", "creationUserId", "userName", "resultMetadata", "resultText", "confidenceScores", "citations", "executionStatus" ], "title": "ChatPromptResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | Successful Response | ChatPromptResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## List chats Operation path: `GET /api/v2/genai/chats/` Authentication requirements: `BearerAuth` List chats. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | llmBlueprintId | query | any | false | Only retrieve the chats associated with this LLM blueprint ID. | | offset | query | integer | false | Skip the specified number of values. | | limit | query | integer | false | Retrieve only the specified number of values. | | sort | query | any | false | Apply this sort order to the results. Valid options are "name" and "creationDate". Prefix the attribute name with a dash to sort in descending order, e.g., sort=-creationDate. | ### Example responses > 200 Response ``` { "description": "Paginated list of chats.", "properties": { "count": { "description": "The number of records on this page.", "title": "count", "type": "integer" }, "data": { "description": "The list of records.", "items": { "description": "Chat object formatted for API output.", "properties": { "creationDate": { "description": "The creation date of the chat (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the chat.", "title": "creationUserId", "type": "string" }, "id": { "description": "The ID of the chat.", "title": "id", "type": "string" }, "isFrozen": { "description": "Whether the chat is frozen (e.g., an evaluation chat). If the chat is frozen, it does not accept new prompts.", "title": "isFrozen", "type": "boolean" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint associated with the chat.", "title": "llmBlueprintId", "type": "string" }, "name": { "description": "The name of the chat.", "title": "name", "type": "string" }, "promptsCount": { "description": "The number of chat prompts in the chat.", "title": "promptsCount", "type": "integer" }, "warning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Warning about the contents of the chat.", "title": "warning" } }, "required": [ "id", "name", "llmBlueprintId", "isFrozen", "warning", "creationDate", "creationUserId", "promptsCount" ], "title": "ChatResponse", "type": "object" }, "title": "data", "type": "array" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the next page, or `null` if there is no such page.", "title": "next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the previous page, or `null` if there is no such page.", "title": "previous" }, "totalCount": { "description": "The total number of records.", "title": "totalCount", "type": "integer" } }, "required": [ "totalCount", "count", "next", "previous", "data" ], "title": "ListChatsResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | Successful Response | ListChatsResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Create chat Operation path: `POST /api/v2/genai/chats/` Authentication requirements: `BearerAuth` Create a new chat. ### Body parameter ``` { "description": "The body of the \"Create chat\" request.", "properties": { "llmBlueprintId": { "description": "The ID of the LLM blueprint to associate with the chat.", "title": "llmBlueprintId", "type": "string" }, "name": { "description": "The name of the chat.", "maxLength": 5000, "minLength": 1, "title": "name", "type": "string" } }, "required": [ "name", "llmBlueprintId" ], "title": "CreateChatRequest", "type": "object" } ``` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | body | body | CreateChatRequest | true | none | ### Example responses > 201 Response ``` { "description": "Chat object formatted for API output.", "properties": { "creationDate": { "description": "The creation date of the chat (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the chat.", "title": "creationUserId", "type": "string" }, "id": { "description": "The ID of the chat.", "title": "id", "type": "string" }, "isFrozen": { "description": "Whether the chat is frozen (e.g., an evaluation chat). If the chat is frozen, it does not accept new prompts.", "title": "isFrozen", "type": "boolean" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint associated with the chat.", "title": "llmBlueprintId", "type": "string" }, "name": { "description": "The name of the chat.", "title": "name", "type": "string" }, "promptsCount": { "description": "The number of chat prompts in the chat.", "title": "promptsCount", "type": "integer" }, "warning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Warning about the contents of the chat.", "title": "warning" } }, "required": [ "id", "name", "llmBlueprintId", "isFrozen", "warning", "creationDate", "creationUserId", "promptsCount" ], "title": "ChatResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 201 | Created | Successful Response | ChatResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Delete chat by chat ID Operation path: `DELETE /api/v2/genai/chats/{chatId}/` Authentication requirements: `BearerAuth` Delete an existing chat. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | chatId | path | string | true | The ID of the chat to delete. | ### Example responses > 422 Response ``` { "properties": { "detail": { "items": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "loc", "type": "array" }, "msg": { "title": "msg", "type": "string" }, "type": { "title": "type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" }, "title": "detail", "type": "array" } }, "title": "HTTPValidationErrorResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 204 | No Content | Successful Response | None | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Retrieve chat by chat ID Operation path: `GET /api/v2/genai/chats/{chatId}/` Authentication requirements: `BearerAuth` Retrieve an existing chat. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | chatId | path | string | true | The ID of the chat to retrieve. | ### Example responses > 200 Response ``` { "description": "Chat object formatted for API output.", "properties": { "creationDate": { "description": "The creation date of the chat (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the chat.", "title": "creationUserId", "type": "string" }, "id": { "description": "The ID of the chat.", "title": "id", "type": "string" }, "isFrozen": { "description": "Whether the chat is frozen (e.g., an evaluation chat). If the chat is frozen, it does not accept new prompts.", "title": "isFrozen", "type": "boolean" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint associated with the chat.", "title": "llmBlueprintId", "type": "string" }, "name": { "description": "The name of the chat.", "title": "name", "type": "string" }, "promptsCount": { "description": "The number of chat prompts in the chat.", "title": "promptsCount", "type": "integer" }, "warning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Warning about the contents of the chat.", "title": "warning" } }, "required": [ "id", "name", "llmBlueprintId", "isFrozen", "warning", "creationDate", "creationUserId", "promptsCount" ], "title": "ChatResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | Successful Response | ChatResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Edit chat by chat ID Operation path: `PATCH /api/v2/genai/chats/{chatId}/` Authentication requirements: `BearerAuth` Edit an existing chat. ### Body parameter ``` { "description": "The body of the \"Edit chat\" request.", "properties": { "name": { "description": "The new name of the chat.", "maxLength": 5000, "minLength": 1, "title": "name", "type": "string" } }, "required": [ "name" ], "title": "EditChatRequest", "type": "object" } ``` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | chatId | path | string | true | The ID of the chat to edit. | | body | body | EditChatRequest | true | none | ### Example responses > 200 Response ``` { "description": "Chat object formatted for API output.", "properties": { "creationDate": { "description": "The creation date of the chat (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the chat.", "title": "creationUserId", "type": "string" }, "id": { "description": "The ID of the chat.", "title": "id", "type": "string" }, "isFrozen": { "description": "Whether the chat is frozen (e.g., an evaluation chat). If the chat is frozen, it does not accept new prompts.", "title": "isFrozen", "type": "boolean" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint associated with the chat.", "title": "llmBlueprintId", "type": "string" }, "name": { "description": "The name of the chat.", "title": "name", "type": "string" }, "promptsCount": { "description": "The number of chat prompts in the chat.", "title": "promptsCount", "type": "integer" }, "warning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Warning about the contents of the chat.", "title": "warning" } }, "required": [ "id", "name", "llmBlueprintId", "isFrozen", "warning", "creationDate", "creationUserId", "promptsCount" ], "title": "ChatResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | Successful Response | ChatResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## List comparison chats Operation path: `GET /api/v2/genai/comparisonChats/` Authentication requirements: `BearerAuth` List comparison chats. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | playgroundId | query | any | false | Only retrieve the comparison chats associated with this playground ID. | | offset | query | integer | false | Skip the specified number of values. | | limit | query | integer | false | Retrieve only the specified number of values. | | sort | query | any | false | Apply this sort order to the results. Valid options are "name" and "creationDate". Prefix the attribute name with a dash to sort in descending order, e.g., sort=-creationDate. | ### Example responses > 200 Response ``` { "description": "Paginated list of comparison chats.", "properties": { "count": { "description": "The number of records on this page.", "title": "count", "type": "integer" }, "data": { "description": "The list of records.", "items": { "description": "Comparison chat object formatted for API output.", "properties": { "creationDate": { "description": "The creation date of the comparison chat (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the comparison chat.", "title": "creationUserId", "type": "string" }, "id": { "description": "The ID of the comparison chat.", "title": "id", "type": "string" }, "name": { "description": "The name of the comparison chat.", "title": "name", "type": "string" }, "playgroundId": { "description": "The ID of the playground associated with the comparison chat.", "title": "playgroundId", "type": "string" }, "promptsCount": { "description": "The number of comparison prompts in the comparison chat.", "title": "promptsCount", "type": "integer" } }, "required": [ "id", "name", "playgroundId", "creationDate", "creationUserId", "promptsCount" ], "title": "ComparisonChatResponse", "type": "object" }, "title": "data", "type": "array" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the next page, or `null` if there is no such page.", "title": "next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the previous page, or `null` if there is no such page.", "title": "previous" }, "totalCount": { "description": "The total number of records.", "title": "totalCount", "type": "integer" } }, "required": [ "totalCount", "count", "next", "previous", "data" ], "title": "ListComparisonChatsResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | Successful Response | ListComparisonChatsResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Create comparison chat Operation path: `POST /api/v2/genai/comparisonChats/` Authentication requirements: `BearerAuth` Create a new comparison chat. ### Body parameter ``` { "description": "The body of the \"Create comparison chat\" request.", "properties": { "name": { "description": "The name of the comparison chat.", "maxLength": 5000, "minLength": 1, "title": "name", "type": "string" }, "playgroundId": { "description": "The ID of the playground to associate with the comparison chat.", "title": "playgroundId", "type": "string" } }, "required": [ "name", "playgroundId" ], "title": "CreateComparisonChatRequest", "type": "object" } ``` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | body | body | CreateComparisonChatRequest | true | none | ### Example responses > 201 Response ``` { "description": "Comparison chat object formatted for API output.", "properties": { "creationDate": { "description": "The creation date of the comparison chat (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the comparison chat.", "title": "creationUserId", "type": "string" }, "id": { "description": "The ID of the comparison chat.", "title": "id", "type": "string" }, "name": { "description": "The name of the comparison chat.", "title": "name", "type": "string" }, "playgroundId": { "description": "The ID of the playground associated with the comparison chat.", "title": "playgroundId", "type": "string" }, "promptsCount": { "description": "The number of comparison prompts in the comparison chat.", "title": "promptsCount", "type": "integer" } }, "required": [ "id", "name", "playgroundId", "creationDate", "creationUserId", "promptsCount" ], "title": "ComparisonChatResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 201 | Created | Successful Response | ComparisonChatResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Delete comparison chat by comparison chat ID Operation path: `DELETE /api/v2/genai/comparisonChats/{comparisonChatId}/` Authentication requirements: `BearerAuth` Delete an existing comparison chat. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | comparisonChatId | path | string | true | The ID of the comparison chat to delete. | ### Example responses > 422 Response ``` { "properties": { "detail": { "items": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "loc", "type": "array" }, "msg": { "title": "msg", "type": "string" }, "type": { "title": "type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" }, "title": "detail", "type": "array" } }, "title": "HTTPValidationErrorResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 204 | No Content | Successful Response | None | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Retrieve comparison chat by comparison chat ID Operation path: `GET /api/v2/genai/comparisonChats/{comparisonChatId}/` Authentication requirements: `BearerAuth` Retrieve an existing comparison chat. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | comparisonChatId | path | string | true | The ID of the comparison chat to retrieve. | ### Example responses > 200 Response ``` { "description": "Comparison chat object formatted for API output.", "properties": { "creationDate": { "description": "The creation date of the comparison chat (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the comparison chat.", "title": "creationUserId", "type": "string" }, "id": { "description": "The ID of the comparison chat.", "title": "id", "type": "string" }, "name": { "description": "The name of the comparison chat.", "title": "name", "type": "string" }, "playgroundId": { "description": "The ID of the playground associated with the comparison chat.", "title": "playgroundId", "type": "string" }, "promptsCount": { "description": "The number of comparison prompts in the comparison chat.", "title": "promptsCount", "type": "integer" } }, "required": [ "id", "name", "playgroundId", "creationDate", "creationUserId", "promptsCount" ], "title": "ComparisonChatResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | Successful Response | ComparisonChatResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Edit comparison chat by comparison chat ID Operation path: `PATCH /api/v2/genai/comparisonChats/{comparisonChatId}/` Authentication requirements: `BearerAuth` Edit an existing comparison chat. ### Body parameter ``` { "description": "The body of the \"Edit comparison chat\" request.", "properties": { "name": { "description": "The new name of the comparison chat.", "maxLength": 5000, "minLength": 1, "title": "name", "type": "string" } }, "required": [ "name" ], "title": "EditComparisonChatRequest", "type": "object" } ``` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | comparisonChatId | path | string | true | The ID of the comparison chat to edit. | | body | body | EditComparisonChatRequest | true | none | ### Example responses > 200 Response ``` { "description": "Comparison chat object formatted for API output.", "properties": { "creationDate": { "description": "The creation date of the comparison chat (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the comparison chat.", "title": "creationUserId", "type": "string" }, "id": { "description": "The ID of the comparison chat.", "title": "id", "type": "string" }, "name": { "description": "The name of the comparison chat.", "title": "name", "type": "string" }, "playgroundId": { "description": "The ID of the playground associated with the comparison chat.", "title": "playgroundId", "type": "string" }, "promptsCount": { "description": "The number of comparison prompts in the comparison chat.", "title": "promptsCount", "type": "integer" } }, "required": [ "id", "name", "playgroundId", "creationDate", "creationUserId", "promptsCount" ], "title": "ComparisonChatResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | Successful Response | ComparisonChatResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## List comparison prompts Operation path: `GET /api/v2/genai/comparisonPrompts/` Authentication requirements: `BearerAuth` List the comparison prompts associated with a comparison chat or a set of LLM blueprints. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | llmBlueprintIds | query | any | false | Only retrieve the comparison prompts associated with the specified LLM blueprint IDs. Either this parameter or comparisonChatId must be specified, but not both. | | comparisonChatId | query | any | false | Only retrieve the comparison prompts associated with the specified comparison chat ID. Either this parameter or llmBlueprintIds must be specified, but not both. | | offset | query | integer | false | Skip the specified number of values. | | limit | query | integer | false | Retrieve only the specified number of values. | ### Example responses > 200 Response ``` { "description": "Paginated list of comparison prompts.", "properties": { "count": { "description": "The number of records on this page.", "title": "count", "type": "integer" }, "data": { "description": "The list of records.", "items": { "description": "ComparisonPrompt object formatted for API output.", "properties": { "comparisonChatId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the comparison chat associated with the comparison prompt.", "title": "comparisonChatId" }, "creationDate": { "description": "The creation date of the comparison prompt (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the comparison prompt.", "title": "creationUserId", "type": "string" }, "executionStatus": { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, "id": { "description": "The ID of the comparison prompt.", "title": "id", "type": "string" }, "metadataFilter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The metadata filters applied to the comparison prompt.", "title": "metadataFilter" }, "results": { "description": "The list of comparison prompt results.", "items": { "description": "API response object for a single comparison prompt result.", "properties": { "chatContextId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat context for this prompt.", "title": "chatContextId" }, "citations": { "description": "The list of relevant vector database citations (in case of using a vector database).", "items": { "description": "API response object for a single vector database citation.", "properties": { "chunkId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the chunk in the vector database index.", "title": "chunkId" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "LangChain Document metadata information holder.", "title": "metadata" }, "page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The source page number where the citation was found.", "title": "page" }, "similarityScore": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The similarity score between the citation and the user prompt.", "title": "similarityScore" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source of the citation (e.g., a filename in the original dataset).", "title": "source" }, "startIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The chunk's start character index in the source document.", "title": "startIndex" }, "text": { "description": "The text of the citation.", "title": "text", "type": "string" } }, "required": [ "text", "source" ], "title": "Citation", "type": "object" }, "title": "citations", "type": "array" }, "comparisonPromptResultIdsIncludedInHistory": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The list of IDs of the comparison prompt results included in this prompt's history.", "title": "comparisonPromptResultIdsIncludedInHistory" }, "confidenceScores": { "anyOf": [ { "description": "API response object for confidence scores.", "properties": { "bleu": { "description": "BLEU score.", "title": "bleu", "type": "number" }, "meteor": { "description": "METEOR score.", "title": "meteor", "type": "number" }, "rouge": { "description": "ROUGE score.", "title": "rouge", "type": "number" } }, "required": [ "rouge", "meteor", "bleu" ], "title": "ConfidenceScores", "type": "object" }, { "type": "null" } ], "description": "The confidence scores that measure the similarity between the prompt context and the prompt completion." }, "executionStatus": { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, "id": { "description": "The ID of the comparison prompt result.", "title": "id", "type": "string" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint that produced the result.", "title": "llmBlueprintId", "type": "string" }, "resultMetadata": { "anyOf": [ { "description": "The additional information about prompt execution results.", "properties": { "blockedResultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The message to replace the result text if it is non empty, which represents a blocked response.", "title": "blockedResultText" }, "cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The estimated cost of executing the prompt.", "title": "cost" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message for the prompt (in case of an errored prompt).", "title": "errorMessage" }, "estimatedDocsTokenCount": { "default": 0, "description": "The estimated number of tokens in the documents retrieved from the vector database.", "title": "estimatedDocsTokenCount", "type": "integer" }, "feedbackResult": { "description": "Prompt feedback included in the result metadata.", "properties": { "negativeUserIds": { "default": [], "description": "The list of user IDs whose feedback is negative.", "items": { "type": "string" }, "title": "negativeUserIds", "type": "array" }, "positiveUserIds": { "default": [], "description": "The list of user IDs whose feedback is positive.", "items": { "type": "string" }, "title": "positiveUserIds", "type": "array" } }, "title": "FeedbackResult", "type": "object" }, "finalPrompt": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ] }, "type": "object" }, "type": "array" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } ] }, "type": "object" }, "type": "array" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "description": "The final representation of the prompt that was submitted to the LLM.", "title": "finalPrompt" }, "inputTokenCount": { "default": 0, "description": "The number of tokens in the LLM input. This number includes the tokens in the system prompt, the user prompt, the chat history (for history-aware chats) and the documents retrieved from the vector database (in case of using a vector database).", "title": "inputTokenCount", "type": "integer" }, "latencyMilliseconds": { "description": "The latency of the LLM response (in milliseconds).", "title": "latencyMilliseconds", "type": "integer" }, "metrics": { "default": [], "description": "The evaluation metrics for the prompt.", "items": { "description": "Prompt metric metadata.", "properties": { "costConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the cost configuration.", "title": "costConfigurationId" }, "customModelGuardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the custom model guard.", "title": "customModelGuardId" }, "customModelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model used for the metric.", "title": "customModelId" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message associated with the metric computation.", "title": "errorMessage" }, "evaluationDatasetConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the evaluation dataset configuration.", "title": "evaluationDatasetConfigurationId" }, "executionStatus": { "anyOf": [ { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, { "type": "null" } ], "description": "The computation status of the metric." }, "formattedName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted name of the metric.", "title": "formattedName" }, "formattedValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted value of the metric.", "title": "formattedValue" }, "llmIsDeprecated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the LLM is deprecated and will be removed in a future release.", "title": "llmIsDeprecated" }, "name": { "description": "The name of the metric.", "title": "name", "type": "string" }, "nemoMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the NeMo Pipeline configuration.", "title": "nemoMetricId" }, "ootbMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the OOTB metric configuration.", "title": "ootbMetricId" }, "sidecarModelMetricValidationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric).", "title": "sidecarModelMetricValidationId" }, "stage": { "anyOf": [ { "description": "Enum that describes at which stage the metric may be calculated.", "enum": [ "prompt_pipeline", "response_pipeline" ], "title": "PipelineStage", "type": "string" }, { "type": "null" } ], "description": "The stage (prompt or response) that the metric applies to." }, "value": { "description": "The value of the metric.", "title": "value" } }, "required": [ "name", "value" ], "title": "MetricMetadata", "type": "object" }, "title": "metrics", "type": "array" }, "outputTokenCount": { "default": 0, "description": "The number of tokens in the LLM output.", "title": "outputTokenCount", "type": "integer" }, "providerLLMGuards": { "anyOf": [ { "items": { "description": "Info on the provider guard metrics.", "properties": { "name": { "description": "The name of the provider guard metric.", "title": "name", "type": "string" }, "satisfyCriteria": { "description": "Whether the configured provider guard metric satisfied its hidden internal guard criteria.", "title": "satisfyCriteria", "type": "boolean" }, "stage": { "description": "The data stage where the provider guard metric is acting upon.", "enum": [ "prompt", "response" ], "title": "ProviderGuardStage", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The value of the provider guard metric.", "title": "value" } }, "required": [ "satisfyCriteria", "name", "value", "stage" ], "title": "ProviderGuardsMetadata", "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "The provider llm guards metadata.", "title": "providerLLMGuards" }, "totalTokenCount": { "default": 0, "description": "The combined number of tokens in the LLM input and output.", "title": "totalTokenCount", "type": "integer" } }, "required": [ "latencyMilliseconds" ], "title": "ResultMetadata", "type": "object" }, { "type": "null" } ], "description": "The additional information about the prompt result." }, "resultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The text of the prompt completion.", "title": "resultText" } }, "required": [ "id", "llmBlueprintId", "resultText", "confidenceScores", "citations", "executionStatus" ], "title": "ComparisonPromptResult", "type": "object" }, "title": "results", "type": "array" }, "text": { "description": "The text of the user prompt.", "title": "text", "type": "string" }, "userName": { "description": "The name of the user that created the comparison prompt.", "title": "userName", "type": "string" } }, "required": [ "id", "text", "results", "creationDate", "creationUserId", "userName", "executionStatus" ], "title": "ComparisonPromptResponse", "type": "object" }, "title": "data", "type": "array" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the next page, or `null` if there is no such page.", "title": "next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the previous page, or `null` if there is no such page.", "title": "previous" }, "totalCount": { "description": "The total number of records.", "title": "totalCount", "type": "integer" } }, "required": [ "totalCount", "count", "next", "previous", "data" ], "title": "ListComparisonPromptsResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | Successful Response | ListComparisonPromptsResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Create comparison prompt Operation path: `POST /api/v2/genai/comparisonPrompts/` Authentication requirements: `BearerAuth` Request the execution of a new comparison prompt. ### Body parameter ``` { "description": "The body of the \"Create comparison prompt\" request.", "properties": { "comparisonChatId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the comparison chat to associate the comparison prompt with.", "title": "comparisonChatId" }, "llmBlueprintIds": { "description": "The list of LLM blueprint IDs that should execute the comparison prompt.", "items": { "type": "string" }, "maxItems": 10, "title": "llmBlueprintIds", "type": "array" }, "metadataFilter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The metadata dict that defines filters that the retrieved documents need to match.", "title": "metadataFilter" }, "text": { "description": "The text of the user prompt.", "maxLength": 5000000, "title": "text", "type": "string" } }, "required": [ "llmBlueprintIds", "text" ], "title": "CreateComparisonPromptRequest", "type": "object" } ``` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | body | body | CreateComparisonPromptRequest | true | none | ### Example responses > 202 Response ``` { "description": "ComparisonPrompt object formatted for API output.", "properties": { "comparisonChatId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the comparison chat associated with the comparison prompt.", "title": "comparisonChatId" }, "creationDate": { "description": "The creation date of the comparison prompt (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the comparison prompt.", "title": "creationUserId", "type": "string" }, "executionStatus": { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, "id": { "description": "The ID of the comparison prompt.", "title": "id", "type": "string" }, "metadataFilter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The metadata filters applied to the comparison prompt.", "title": "metadataFilter" }, "results": { "description": "The list of comparison prompt results.", "items": { "description": "API response object for a single comparison prompt result.", "properties": { "chatContextId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat context for this prompt.", "title": "chatContextId" }, "citations": { "description": "The list of relevant vector database citations (in case of using a vector database).", "items": { "description": "API response object for a single vector database citation.", "properties": { "chunkId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the chunk in the vector database index.", "title": "chunkId" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "LangChain Document metadata information holder.", "title": "metadata" }, "page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The source page number where the citation was found.", "title": "page" }, "similarityScore": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The similarity score between the citation and the user prompt.", "title": "similarityScore" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source of the citation (e.g., a filename in the original dataset).", "title": "source" }, "startIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The chunk's start character index in the source document.", "title": "startIndex" }, "text": { "description": "The text of the citation.", "title": "text", "type": "string" } }, "required": [ "text", "source" ], "title": "Citation", "type": "object" }, "title": "citations", "type": "array" }, "comparisonPromptResultIdsIncludedInHistory": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The list of IDs of the comparison prompt results included in this prompt's history.", "title": "comparisonPromptResultIdsIncludedInHistory" }, "confidenceScores": { "anyOf": [ { "description": "API response object for confidence scores.", "properties": { "bleu": { "description": "BLEU score.", "title": "bleu", "type": "number" }, "meteor": { "description": "METEOR score.", "title": "meteor", "type": "number" }, "rouge": { "description": "ROUGE score.", "title": "rouge", "type": "number" } }, "required": [ "rouge", "meteor", "bleu" ], "title": "ConfidenceScores", "type": "object" }, { "type": "null" } ], "description": "The confidence scores that measure the similarity between the prompt context and the prompt completion." }, "executionStatus": { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, "id": { "description": "The ID of the comparison prompt result.", "title": "id", "type": "string" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint that produced the result.", "title": "llmBlueprintId", "type": "string" }, "resultMetadata": { "anyOf": [ { "description": "The additional information about prompt execution results.", "properties": { "blockedResultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The message to replace the result text if it is non empty, which represents a blocked response.", "title": "blockedResultText" }, "cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The estimated cost of executing the prompt.", "title": "cost" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message for the prompt (in case of an errored prompt).", "title": "errorMessage" }, "estimatedDocsTokenCount": { "default": 0, "description": "The estimated number of tokens in the documents retrieved from the vector database.", "title": "estimatedDocsTokenCount", "type": "integer" }, "feedbackResult": { "description": "Prompt feedback included in the result metadata.", "properties": { "negativeUserIds": { "default": [], "description": "The list of user IDs whose feedback is negative.", "items": { "type": "string" }, "title": "negativeUserIds", "type": "array" }, "positiveUserIds": { "default": [], "description": "The list of user IDs whose feedback is positive.", "items": { "type": "string" }, "title": "positiveUserIds", "type": "array" } }, "title": "FeedbackResult", "type": "object" }, "finalPrompt": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ] }, "type": "object" }, "type": "array" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } ] }, "type": "object" }, "type": "array" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "description": "The final representation of the prompt that was submitted to the LLM.", "title": "finalPrompt" }, "inputTokenCount": { "default": 0, "description": "The number of tokens in the LLM input. This number includes the tokens in the system prompt, the user prompt, the chat history (for history-aware chats) and the documents retrieved from the vector database (in case of using a vector database).", "title": "inputTokenCount", "type": "integer" }, "latencyMilliseconds": { "description": "The latency of the LLM response (in milliseconds).", "title": "latencyMilliseconds", "type": "integer" }, "metrics": { "default": [], "description": "The evaluation metrics for the prompt.", "items": { "description": "Prompt metric metadata.", "properties": { "costConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the cost configuration.", "title": "costConfigurationId" }, "customModelGuardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the custom model guard.", "title": "customModelGuardId" }, "customModelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model used for the metric.", "title": "customModelId" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message associated with the metric computation.", "title": "errorMessage" }, "evaluationDatasetConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the evaluation dataset configuration.", "title": "evaluationDatasetConfigurationId" }, "executionStatus": { "anyOf": [ { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, { "type": "null" } ], "description": "The computation status of the metric." }, "formattedName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted name of the metric.", "title": "formattedName" }, "formattedValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted value of the metric.", "title": "formattedValue" }, "llmIsDeprecated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the LLM is deprecated and will be removed in a future release.", "title": "llmIsDeprecated" }, "name": { "description": "The name of the metric.", "title": "name", "type": "string" }, "nemoMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the NeMo Pipeline configuration.", "title": "nemoMetricId" }, "ootbMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the OOTB metric configuration.", "title": "ootbMetricId" }, "sidecarModelMetricValidationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric).", "title": "sidecarModelMetricValidationId" }, "stage": { "anyOf": [ { "description": "Enum that describes at which stage the metric may be calculated.", "enum": [ "prompt_pipeline", "response_pipeline" ], "title": "PipelineStage", "type": "string" }, { "type": "null" } ], "description": "The stage (prompt or response) that the metric applies to." }, "value": { "description": "The value of the metric.", "title": "value" } }, "required": [ "name", "value" ], "title": "MetricMetadata", "type": "object" }, "title": "metrics", "type": "array" }, "outputTokenCount": { "default": 0, "description": "The number of tokens in the LLM output.", "title": "outputTokenCount", "type": "integer" }, "providerLLMGuards": { "anyOf": [ { "items": { "description": "Info on the provider guard metrics.", "properties": { "name": { "description": "The name of the provider guard metric.", "title": "name", "type": "string" }, "satisfyCriteria": { "description": "Whether the configured provider guard metric satisfied its hidden internal guard criteria.", "title": "satisfyCriteria", "type": "boolean" }, "stage": { "description": "The data stage where the provider guard metric is acting upon.", "enum": [ "prompt", "response" ], "title": "ProviderGuardStage", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The value of the provider guard metric.", "title": "value" } }, "required": [ "satisfyCriteria", "name", "value", "stage" ], "title": "ProviderGuardsMetadata", "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "The provider llm guards metadata.", "title": "providerLLMGuards" }, "totalTokenCount": { "default": 0, "description": "The combined number of tokens in the LLM input and output.", "title": "totalTokenCount", "type": "integer" } }, "required": [ "latencyMilliseconds" ], "title": "ResultMetadata", "type": "object" }, { "type": "null" } ], "description": "The additional information about the prompt result." }, "resultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The text of the prompt completion.", "title": "resultText" } }, "required": [ "id", "llmBlueprintId", "resultText", "confidenceScores", "citations", "executionStatus" ], "title": "ComparisonPromptResult", "type": "object" }, "title": "results", "type": "array" }, "text": { "description": "The text of the user prompt.", "title": "text", "type": "string" }, "userName": { "description": "The name of the user that created the comparison prompt.", "title": "userName", "type": "string" } }, "required": [ "id", "text", "results", "creationDate", "creationUserId", "userName", "executionStatus" ], "title": "ComparisonPromptResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 202 | Accepted | Successful Response | ComparisonPromptResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Delete comparison prompt by comparison prompt ID Operation path: `DELETE /api/v2/genai/comparisonPrompts/{comparisonPromptId}/` Authentication requirements: `BearerAuth` Delete an existing comparison prompt. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | comparisonPromptId | path | string | true | The ID of the comparison prompt to delete. | ### Example responses > 422 Response ``` { "properties": { "detail": { "items": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "loc", "type": "array" }, "msg": { "title": "msg", "type": "string" }, "type": { "title": "type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" }, "title": "detail", "type": "array" } }, "title": "HTTPValidationErrorResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 204 | No Content | Successful Response | None | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Retrieve comparison prompt by comparison prompt ID Operation path: `GET /api/v2/genai/comparisonPrompts/{comparisonPromptId}/` Authentication requirements: `BearerAuth` Retrieve an existing comparison prompt. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | comparisonPromptId | path | string | true | The ID of the comparison prompt to retrieve. | ### Example responses > 200 Response ``` { "description": "ComparisonPrompt object formatted for API output.", "properties": { "comparisonChatId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the comparison chat associated with the comparison prompt.", "title": "comparisonChatId" }, "creationDate": { "description": "The creation date of the comparison prompt (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the comparison prompt.", "title": "creationUserId", "type": "string" }, "executionStatus": { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, "id": { "description": "The ID of the comparison prompt.", "title": "id", "type": "string" }, "metadataFilter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The metadata filters applied to the comparison prompt.", "title": "metadataFilter" }, "results": { "description": "The list of comparison prompt results.", "items": { "description": "API response object for a single comparison prompt result.", "properties": { "chatContextId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat context for this prompt.", "title": "chatContextId" }, "citations": { "description": "The list of relevant vector database citations (in case of using a vector database).", "items": { "description": "API response object for a single vector database citation.", "properties": { "chunkId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the chunk in the vector database index.", "title": "chunkId" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "LangChain Document metadata information holder.", "title": "metadata" }, "page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The source page number where the citation was found.", "title": "page" }, "similarityScore": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The similarity score between the citation and the user prompt.", "title": "similarityScore" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source of the citation (e.g., a filename in the original dataset).", "title": "source" }, "startIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The chunk's start character index in the source document.", "title": "startIndex" }, "text": { "description": "The text of the citation.", "title": "text", "type": "string" } }, "required": [ "text", "source" ], "title": "Citation", "type": "object" }, "title": "citations", "type": "array" }, "comparisonPromptResultIdsIncludedInHistory": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The list of IDs of the comparison prompt results included in this prompt's history.", "title": "comparisonPromptResultIdsIncludedInHistory" }, "confidenceScores": { "anyOf": [ { "description": "API response object for confidence scores.", "properties": { "bleu": { "description": "BLEU score.", "title": "bleu", "type": "number" }, "meteor": { "description": "METEOR score.", "title": "meteor", "type": "number" }, "rouge": { "description": "ROUGE score.", "title": "rouge", "type": "number" } }, "required": [ "rouge", "meteor", "bleu" ], "title": "ConfidenceScores", "type": "object" }, { "type": "null" } ], "description": "The confidence scores that measure the similarity between the prompt context and the prompt completion." }, "executionStatus": { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, "id": { "description": "The ID of the comparison prompt result.", "title": "id", "type": "string" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint that produced the result.", "title": "llmBlueprintId", "type": "string" }, "resultMetadata": { "anyOf": [ { "description": "The additional information about prompt execution results.", "properties": { "blockedResultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The message to replace the result text if it is non empty, which represents a blocked response.", "title": "blockedResultText" }, "cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The estimated cost of executing the prompt.", "title": "cost" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message for the prompt (in case of an errored prompt).", "title": "errorMessage" }, "estimatedDocsTokenCount": { "default": 0, "description": "The estimated number of tokens in the documents retrieved from the vector database.", "title": "estimatedDocsTokenCount", "type": "integer" }, "feedbackResult": { "description": "Prompt feedback included in the result metadata.", "properties": { "negativeUserIds": { "default": [], "description": "The list of user IDs whose feedback is negative.", "items": { "type": "string" }, "title": "negativeUserIds", "type": "array" }, "positiveUserIds": { "default": [], "description": "The list of user IDs whose feedback is positive.", "items": { "type": "string" }, "title": "positiveUserIds", "type": "array" } }, "title": "FeedbackResult", "type": "object" }, "finalPrompt": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ] }, "type": "object" }, "type": "array" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } ] }, "type": "object" }, "type": "array" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "description": "The final representation of the prompt that was submitted to the LLM.", "title": "finalPrompt" }, "inputTokenCount": { "default": 0, "description": "The number of tokens in the LLM input. This number includes the tokens in the system prompt, the user prompt, the chat history (for history-aware chats) and the documents retrieved from the vector database (in case of using a vector database).", "title": "inputTokenCount", "type": "integer" }, "latencyMilliseconds": { "description": "The latency of the LLM response (in milliseconds).", "title": "latencyMilliseconds", "type": "integer" }, "metrics": { "default": [], "description": "The evaluation metrics for the prompt.", "items": { "description": "Prompt metric metadata.", "properties": { "costConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the cost configuration.", "title": "costConfigurationId" }, "customModelGuardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the custom model guard.", "title": "customModelGuardId" }, "customModelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model used for the metric.", "title": "customModelId" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message associated with the metric computation.", "title": "errorMessage" }, "evaluationDatasetConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the evaluation dataset configuration.", "title": "evaluationDatasetConfigurationId" }, "executionStatus": { "anyOf": [ { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, { "type": "null" } ], "description": "The computation status of the metric." }, "formattedName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted name of the metric.", "title": "formattedName" }, "formattedValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted value of the metric.", "title": "formattedValue" }, "llmIsDeprecated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the LLM is deprecated and will be removed in a future release.", "title": "llmIsDeprecated" }, "name": { "description": "The name of the metric.", "title": "name", "type": "string" }, "nemoMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the NeMo Pipeline configuration.", "title": "nemoMetricId" }, "ootbMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the OOTB metric configuration.", "title": "ootbMetricId" }, "sidecarModelMetricValidationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric).", "title": "sidecarModelMetricValidationId" }, "stage": { "anyOf": [ { "description": "Enum that describes at which stage the metric may be calculated.", "enum": [ "prompt_pipeline", "response_pipeline" ], "title": "PipelineStage", "type": "string" }, { "type": "null" } ], "description": "The stage (prompt or response) that the metric applies to." }, "value": { "description": "The value of the metric.", "title": "value" } }, "required": [ "name", "value" ], "title": "MetricMetadata", "type": "object" }, "title": "metrics", "type": "array" }, "outputTokenCount": { "default": 0, "description": "The number of tokens in the LLM output.", "title": "outputTokenCount", "type": "integer" }, "providerLLMGuards": { "anyOf": [ { "items": { "description": "Info on the provider guard metrics.", "properties": { "name": { "description": "The name of the provider guard metric.", "title": "name", "type": "string" }, "satisfyCriteria": { "description": "Whether the configured provider guard metric satisfied its hidden internal guard criteria.", "title": "satisfyCriteria", "type": "boolean" }, "stage": { "description": "The data stage where the provider guard metric is acting upon.", "enum": [ "prompt", "response" ], "title": "ProviderGuardStage", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The value of the provider guard metric.", "title": "value" } }, "required": [ "satisfyCriteria", "name", "value", "stage" ], "title": "ProviderGuardsMetadata", "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "The provider llm guards metadata.", "title": "providerLLMGuards" }, "totalTokenCount": { "default": 0, "description": "The combined number of tokens in the LLM input and output.", "title": "totalTokenCount", "type": "integer" } }, "required": [ "latencyMilliseconds" ], "title": "ResultMetadata", "type": "object" }, { "type": "null" } ], "description": "The additional information about the prompt result." }, "resultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The text of the prompt completion.", "title": "resultText" } }, "required": [ "id", "llmBlueprintId", "resultText", "confidenceScores", "citations", "executionStatus" ], "title": "ComparisonPromptResult", "type": "object" }, "title": "results", "type": "array" }, "text": { "description": "The text of the user prompt.", "title": "text", "type": "string" }, "userName": { "description": "The name of the user that created the comparison prompt.", "title": "userName", "type": "string" } }, "required": [ "id", "text", "results", "creationDate", "creationUserId", "userName", "executionStatus" ], "title": "ComparisonPromptResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | Successful Response | ComparisonPromptResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Edit comparison prompt by comparison prompt ID Operation path: `PATCH /api/v2/genai/comparisonPrompts/{comparisonPromptId}/` Authentication requirements: `BearerAuth` Edit an existing comparison prompt. Editing may involve adding new prompt result metadata or executing this comparison prompt on new LLM blueprints. ### Body parameter ``` { "description": "The body of the \"Edit comparison prompt\" request.", "properties": { "additionalLLMBlueprintIds": { "default": [], "description": "The list of additional LLM blueprint IDs that should execute this comparison prompt.", "items": { "type": "string" }, "maxItems": 10, "title": "additionalLLMBlueprintIds", "type": "array" }, "feedbackResult": { "anyOf": [ { "description": "Feedback metadata for a comparison prompt result.", "properties": { "comparisonPromptResultId": { "description": "The ID of the comparison prompt result associated with this feedback.", "title": "comparisonPromptResultId", "type": "string" }, "feedbackMetadata": { "description": "Prompt feedback metadata.", "properties": { "feedback": { "anyOf": [ { "description": "The sentiment of the feedback.", "enum": [ "1", "0" ], "title": "FeedbackSentiment", "type": "string" }, { "type": "null" } ], "description": "The sentiment of the feedback." } }, "required": [ "feedback" ], "title": "FeedbackMetadata", "type": "object" } }, "required": [ "comparisonPromptResultId", "feedbackMetadata" ], "title": "ComparisonPromptFeedbackResult", "type": "object" }, { "type": "null" } ], "description": "The feedback information to add to the comparison prompt." } }, "title": "EditComparisonPromptRequest", "type": "object" } ``` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | comparisonPromptId | path | string | true | The ID of the comparison prompt to edit. | | body | body | EditComparisonPromptRequest | true | none | ### Example responses > 202 Response ``` { "title": "Response Update Comparison Prompt Comparisonprompts Comparisonpromptid Patch", "type": "string" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 202 | Accepted | Successful Response | string | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## List prompt templates Operation path: `GET /api/v2/genai/promptTemplates/` Authentication requirements: `BearerAuth` List prompt templates for the user with optional filtering and sorting. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | offset | query | integer | false | Skip the specified number of values. | | limit | query | integer | false | Retrieve only the specified number of values. | | sort | query | any | false | Apply this sort order to the results. Valid options are "name", "description", "creationDate", "lastUpdateDate". Prefix the attribute name with a dash to sort in descending order, e.g., sort=-creationDate. | | search | query | any | false | Only retrieve prompt templates with names matching the search query. | | creationUserIds | query | any | false | Retrieve only the prompt templates created by these users. | ### Example responses > 200 Response ``` { "description": "Paginated list of prompt templates.", "properties": { "count": { "description": "The number of records on this page.", "title": "count", "type": "integer" }, "data": { "description": "The list of records.", "items": { "description": "API response object for a single prompt template.", "properties": { "creationDate": { "description": "Prompt template creation date (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "ID of the user who created this prompt template.", "title": "creationUserId", "type": "string" }, "description": { "description": "Prompt template description.", "title": "description", "type": "string" }, "id": { "description": "Prompt template ID.", "title": "id", "type": "string" }, "lastUpdateDate": { "description": "Date of the most recent update of this prompt template (ISO 8601 formatted).", "format": "date-time", "title": "lastUpdateDate", "type": "string" }, "lastUpdateUserId": { "description": "ID of the user that made the most recent update to this prompt template.", "title": "lastUpdateUserId", "type": "string" }, "name": { "description": "Prompt template name.", "title": "name", "type": "string" }, "userName": { "description": "Name of the user who created this prompt template.", "title": "userName", "type": "string" }, "versionCount": { "description": "The number of versions associated with this prompt template.", "title": "versionCount", "type": "integer" } }, "required": [ "id", "name", "description", "creationDate", "creationUserId", "lastUpdateDate", "lastUpdateUserId", "userName", "versionCount" ], "title": "PromptTemplateResponse", "type": "object" }, "title": "data", "type": "array" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the next page, or `null` if there is no such page.", "title": "next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the previous page, or `null` if there is no such page.", "title": "previous" }, "totalCount": { "description": "The total number of records.", "title": "totalCount", "type": "integer" } }, "required": [ "totalCount", "count", "next", "previous", "data" ], "title": "ListPromptTemplatesResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | Successful Response | ListPromptTemplatesResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Create prompt template Operation path: `POST /api/v2/genai/promptTemplates/` Authentication requirements: `BearerAuth` Create a new prompt template. ### Body parameter ``` { "description": "The body of the Create PromptTemplate request.", "properties": { "description": { "description": "New prompt template description.", "maxLength": 5000, "title": "description", "type": "string" }, "name": { "description": "New prompt template name.", "maxLength": 5000, "title": "name", "type": "string" } }, "required": [ "name", "description" ], "title": "CreatePromptTemplateRequest", "type": "object" } ``` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | body | body | CreatePromptTemplateRequest | true | none | ### Example responses > 201 Response ``` { "description": "API response object for a single prompt template.", "properties": { "creationDate": { "description": "Prompt template creation date (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "ID of the user who created this prompt template.", "title": "creationUserId", "type": "string" }, "description": { "description": "Prompt template description.", "title": "description", "type": "string" }, "id": { "description": "Prompt template ID.", "title": "id", "type": "string" }, "lastUpdateDate": { "description": "Date of the most recent update of this prompt template (ISO 8601 formatted).", "format": "date-time", "title": "lastUpdateDate", "type": "string" }, "lastUpdateUserId": { "description": "ID of the user that made the most recent update to this prompt template.", "title": "lastUpdateUserId", "type": "string" }, "name": { "description": "Prompt template name.", "title": "name", "type": "string" }, "userName": { "description": "Name of the user who created this prompt template.", "title": "userName", "type": "string" }, "versionCount": { "description": "The number of versions associated with this prompt template.", "title": "versionCount", "type": "integer" } }, "required": [ "id", "name", "description", "creationDate", "creationUserId", "lastUpdateDate", "lastUpdateUserId", "userName", "versionCount" ], "title": "PromptTemplateResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 201 | Created | Successful Response | PromptTemplateResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## List prompt templates versions Operation path: `GET /api/v2/genai/promptTemplates/versions/` Authentication requirements: `BearerAuth` List prompt templates versions for the user with optional filtering. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | offset | query | integer | false | Skip the specified number of values. | | limit | query | integer | false | Retrieve only the specified number of values. | | promptTemplatesIds | query | any | false | Retrieve only versions with matching prompt templates ids. | ### Example responses > 200 Response ``` { "description": "Paginated list of prompt template versions.", "properties": { "count": { "description": "The number of records on this page.", "title": "count", "type": "integer" }, "data": { "description": "The list of records.", "items": { "description": "API response object for a single prompt template version.", "properties": { "commitComment": { "description": "Description of changes for this prompt template version.", "title": "commitComment", "type": "string" }, "creationDate": { "description": "Prompt template version creation date (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "ID of the user who created this prompt template version.", "title": "creationUserId", "type": "string" }, "id": { "description": "Prompt template version ID.", "title": "id", "type": "string" }, "promptTemplateId": { "description": "Prompt template ID.", "title": "promptTemplateId", "type": "string" }, "promptText": { "description": "The text of the prompt with variables enclosed in double curly brackets.", "title": "promptText", "type": "string" }, "userName": { "description": "Name of the user who created this prompt template version.", "title": "userName", "type": "string" }, "variables": { "description": "List of variables associated with this prompt template version.", "items": { "description": "Variable used in prompt template version.", "properties": { "description": { "description": "Description of the variable. This is exposed to MCP clients.", "title": "description", "type": "string" }, "name": { "description": "Name of the variable.", "title": "name", "type": "string" }, "type": { "default": "str", "description": "Type of the variable.", "title": "type", "type": "string" } }, "required": [ "name", "description" ], "title": "Variable", "type": "object" }, "title": "variables", "type": "array" }, "version": { "description": "Version of this prompt template version.", "title": "version", "type": "integer" } }, "required": [ "id", "promptTemplateId", "promptText", "commitComment", "version", "variables", "creationDate", "creationUserId", "userName" ], "title": "PromptTemplateVersionResponse", "type": "object" }, "title": "data", "type": "array" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the next page, or `null` if there is no such page.", "title": "next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the previous page, or `null` if there is no such page.", "title": "previous" }, "totalCount": { "description": "The total number of records.", "title": "totalCount", "type": "integer" } }, "required": [ "totalCount", "count", "next", "previous", "data" ], "title": "ListPromptTemplateVersionsResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | Successful Response | ListPromptTemplateVersionsResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Get prompt template by prompt template ID Operation path: `GET /api/v2/genai/promptTemplates/{promptTemplateId}/` Authentication requirements: `BearerAuth` Get prompt template by ID. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | promptTemplateId | path | string | true | The ID of the prompt template to retrieve. | ### Example responses > 200 Response ``` { "description": "API response object for a single prompt template.", "properties": { "creationDate": { "description": "Prompt template creation date (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "ID of the user who created this prompt template.", "title": "creationUserId", "type": "string" }, "description": { "description": "Prompt template description.", "title": "description", "type": "string" }, "id": { "description": "Prompt template ID.", "title": "id", "type": "string" }, "lastUpdateDate": { "description": "Date of the most recent update of this prompt template (ISO 8601 formatted).", "format": "date-time", "title": "lastUpdateDate", "type": "string" }, "lastUpdateUserId": { "description": "ID of the user that made the most recent update to this prompt template.", "title": "lastUpdateUserId", "type": "string" }, "name": { "description": "Prompt template name.", "title": "name", "type": "string" }, "userName": { "description": "Name of the user who created this prompt template.", "title": "userName", "type": "string" }, "versionCount": { "description": "The number of versions associated with this prompt template.", "title": "versionCount", "type": "integer" } }, "required": [ "id", "name", "description", "creationDate", "creationUserId", "lastUpdateDate", "lastUpdateUserId", "userName", "versionCount" ], "title": "PromptTemplateResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | Successful Response | PromptTemplateResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## List prompt template versions by prompt template ID Operation path: `GET /api/v2/genai/promptTemplates/{promptTemplateId}/versions/` Authentication requirements: `BearerAuth` List versions for a prompt template with pagination. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | promptTemplateId | path | string | true | The ID of the prompt template to retrieve. | | offset | query | integer | false | Skip the specified number of values. | | limit | query | integer | false | Retrieve only the specified number of values. | ### Example responses > 200 Response ``` { "description": "Paginated list of prompt template versions.", "properties": { "count": { "description": "The number of records on this page.", "title": "count", "type": "integer" }, "data": { "description": "The list of records.", "items": { "description": "API response object for a single prompt template version.", "properties": { "commitComment": { "description": "Description of changes for this prompt template version.", "title": "commitComment", "type": "string" }, "creationDate": { "description": "Prompt template version creation date (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "ID of the user who created this prompt template version.", "title": "creationUserId", "type": "string" }, "id": { "description": "Prompt template version ID.", "title": "id", "type": "string" }, "promptTemplateId": { "description": "Prompt template ID.", "title": "promptTemplateId", "type": "string" }, "promptText": { "description": "The text of the prompt with variables enclosed in double curly brackets.", "title": "promptText", "type": "string" }, "userName": { "description": "Name of the user who created this prompt template version.", "title": "userName", "type": "string" }, "variables": { "description": "List of variables associated with this prompt template version.", "items": { "description": "Variable used in prompt template version.", "properties": { "description": { "description": "Description of the variable. This is exposed to MCP clients.", "title": "description", "type": "string" }, "name": { "description": "Name of the variable.", "title": "name", "type": "string" }, "type": { "default": "str", "description": "Type of the variable.", "title": "type", "type": "string" } }, "required": [ "name", "description" ], "title": "Variable", "type": "object" }, "title": "variables", "type": "array" }, "version": { "description": "Version of this prompt template version.", "title": "version", "type": "integer" } }, "required": [ "id", "promptTemplateId", "promptText", "commitComment", "version", "variables", "creationDate", "creationUserId", "userName" ], "title": "PromptTemplateVersionResponse", "type": "object" }, "title": "data", "type": "array" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the next page, or `null` if there is no such page.", "title": "next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the previous page, or `null` if there is no such page.", "title": "previous" }, "totalCount": { "description": "The total number of records.", "title": "totalCount", "type": "integer" } }, "required": [ "totalCount", "count", "next", "previous", "data" ], "title": "ListPromptTemplateVersionsResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | Successful Response | ListPromptTemplateVersionsResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Create prompt template version by prompt template ID Operation path: `POST /api/v2/genai/promptTemplates/{promptTemplateId}/versions/` Authentication requirements: `BearerAuth` Create a new prompt template version. ### Body parameter ``` { "description": "The body of the Create PromptTemplateVersion request.", "properties": { "commitComment": { "description": "Description of changes for this prompt template version.", "maxLength": 5000, "title": "commitComment", "type": "string" }, "promptText": { "description": "The text of the prompt with variables enclosed in double curly brackets.", "maxLength": 5000000, "title": "promptText", "type": "string" }, "variables": { "description": "Variables for this prompt.", "items": { "description": "Variable used in prompt template version.", "properties": { "description": { "description": "Description of the variable. This is exposed to MCP clients.", "title": "description", "type": "string" }, "name": { "description": "Name of the variable.", "title": "name", "type": "string" }, "type": { "default": "str", "description": "Type of the variable.", "title": "type", "type": "string" } }, "required": [ "name", "description" ], "title": "Variable", "type": "object" }, "maxItems": 100, "title": "variables", "type": "array" } }, "required": [ "promptText", "commitComment", "variables" ], "title": "CreatePromptTemplateVersionRequest", "type": "object" } ``` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | promptTemplateId | path | string | true | The ID of the prompt template to create a version for. | | body | body | CreatePromptTemplateVersionRequest | true | none | ### Example responses > 201 Response ``` { "description": "API response object for a single prompt template version.", "properties": { "commitComment": { "description": "Description of changes for this prompt template version.", "title": "commitComment", "type": "string" }, "creationDate": { "description": "Prompt template version creation date (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "ID of the user who created this prompt template version.", "title": "creationUserId", "type": "string" }, "id": { "description": "Prompt template version ID.", "title": "id", "type": "string" }, "promptTemplateId": { "description": "Prompt template ID.", "title": "promptTemplateId", "type": "string" }, "promptText": { "description": "The text of the prompt with variables enclosed in double curly brackets.", "title": "promptText", "type": "string" }, "userName": { "description": "Name of the user who created this prompt template version.", "title": "userName", "type": "string" }, "variables": { "description": "List of variables associated with this prompt template version.", "items": { "description": "Variable used in prompt template version.", "properties": { "description": { "description": "Description of the variable. This is exposed to MCP clients.", "title": "description", "type": "string" }, "name": { "description": "Name of the variable.", "title": "name", "type": "string" }, "type": { "default": "str", "description": "Type of the variable.", "title": "type", "type": "string" } }, "required": [ "name", "description" ], "title": "Variable", "type": "object" }, "title": "variables", "type": "array" }, "version": { "description": "Version of this prompt template version.", "title": "version", "type": "integer" } }, "required": [ "id", "promptTemplateId", "promptText", "commitComment", "version", "variables", "creationDate", "creationUserId", "userName" ], "title": "PromptTemplateVersionResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 201 | Created | Successful Response | PromptTemplateVersionResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | ## Get prompt template version by prompt template ID Operation path: `GET /api/v2/genai/promptTemplates/{promptTemplateId}/versions/{promptTemplateVersionId}/` Authentication requirements: `BearerAuth` Get prompt template version by ID. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | promptTemplateVersionId | path | string | true | The ID of the prompt template version to retrieve. | | promptTemplateId | path | string | true | The ID of the prompt template to retrieve. | ### Example responses > 200 Response ``` { "description": "API response object for a single prompt template version.", "properties": { "commitComment": { "description": "Description of changes for this prompt template version.", "title": "commitComment", "type": "string" }, "creationDate": { "description": "Prompt template version creation date (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "ID of the user who created this prompt template version.", "title": "creationUserId", "type": "string" }, "id": { "description": "Prompt template version ID.", "title": "id", "type": "string" }, "promptTemplateId": { "description": "Prompt template ID.", "title": "promptTemplateId", "type": "string" }, "promptText": { "description": "The text of the prompt with variables enclosed in double curly brackets.", "title": "promptText", "type": "string" }, "userName": { "description": "Name of the user who created this prompt template version.", "title": "userName", "type": "string" }, "variables": { "description": "List of variables associated with this prompt template version.", "items": { "description": "Variable used in prompt template version.", "properties": { "description": { "description": "Description of the variable. This is exposed to MCP clients.", "title": "description", "type": "string" }, "name": { "description": "Name of the variable.", "title": "name", "type": "string" }, "type": { "default": "str", "description": "Type of the variable.", "title": "type", "type": "string" } }, "required": [ "name", "description" ], "title": "Variable", "type": "object" }, "title": "variables", "type": "array" }, "version": { "description": "Version of this prompt template version.", "title": "version", "type": "integer" } }, "required": [ "id", "promptTemplateId", "promptText", "commitComment", "version", "variables", "creationDate", "creationUserId", "userName" ], "title": "PromptTemplateVersionResponse", "type": "object" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | Successful Response | PromptTemplateVersionResponse | | 422 | Unprocessable Entity | Validation Error | HTTPValidationErrorResponse | # Schemas ## ChatPromptResponse ``` { "description": "API response object for a single chat prompt.", "properties": { "chatContextId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat context for this prompt.", "title": "chatContextId" }, "chatId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat this chat prompt belongs to.", "title": "chatId" }, "chatPromptIdsIncludedInHistory": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The list of IDs of the chat prompts included in this prompt's history.", "title": "chatPromptIdsIncludedInHistory" }, "citations": { "description": "The list of relevant vector database citations (in case of using a vector database).", "items": { "description": "API response object for a single vector database citation.", "properties": { "chunkId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the chunk in the vector database index.", "title": "chunkId" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "LangChain Document metadata information holder.", "title": "metadata" }, "page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The source page number where the citation was found.", "title": "page" }, "similarityScore": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The similarity score between the citation and the user prompt.", "title": "similarityScore" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source of the citation (e.g., a filename in the original dataset).", "title": "source" }, "startIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The chunk's start character index in the source document.", "title": "startIndex" }, "text": { "description": "The text of the citation.", "title": "text", "type": "string" } }, "required": [ "text", "source" ], "title": "Citation", "type": "object" }, "title": "citations", "type": "array" }, "confidenceScores": { "anyOf": [ { "description": "API response object for confidence scores.", "properties": { "bleu": { "description": "BLEU score.", "title": "bleu", "type": "number" }, "meteor": { "description": "METEOR score.", "title": "meteor", "type": "number" }, "rouge": { "description": "ROUGE score.", "title": "rouge", "type": "number" } }, "required": [ "rouge", "meteor", "bleu" ], "title": "ConfidenceScores", "type": "object" }, { "type": "null" } ], "description": "The confidence scores that measure the similarity between the prompt context and the prompt completion." }, "creationDate": { "description": "The creation date of the chat prompt (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the chat prompt.", "title": "creationUserId", "type": "string" }, "executionStatus": { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, "id": { "description": "The ID of the chat prompt.", "title": "id", "type": "string" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint the chat prompt belongs to.", "title": "llmBlueprintId", "type": "string" }, "llmId": { "description": "The ID of the LLM used by the chat prompt.", "title": "llmId", "type": "string" }, "llmSettings": { "anyOf": [ { "additionalProperties": true, "description": "The settings that are available for all non-custom LLMs.", "properties": { "maxCompletionLength": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum number of tokens allowed in the chat completion. Use this value to, for example, control costs on token-based charges or manage response length for chat text limits.", "title": "maxCompletionLength" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "title": "CommonLLMSettings", "type": "object" }, { "additionalProperties": false, "description": "The settings that are available for custom model LLMs.", "properties": { "externalLlmContextSize": { "anyOf": [ { "maximum": 128000, "minimum": 128, "type": "integer" }, { "type": "null" } ], "default": 4096, "description": "The external LLM's context size, in tokens. This value is only used for pruning documents supplied to the LLM when a vector database is associated with the LLM blueprint. It does not affect the external LLM's actual context size in any way and is not supplied to the LLM.", "title": "externalLlmContextSize" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" }, "validationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the custom model LLM.", "title": "validationId" } }, "title": "CustomModelLLMSettings", "type": "object" }, { "additionalProperties": false, "description": "The settings that are available for custom model LLMs used via chat completion interface.", "properties": { "customModelId": { "description": "The ID of the custom model used via chat completion interface.", "title": "customModelId", "type": "string" }, "customModelVersionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model version used via chat completion interface.", "title": "customModelVersionId" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "required": [ "customModelId" ], "title": "CustomModelChatLLMSettings", "type": "object" }, { "type": "null" } ], "description": "A key/value dictionary of LLM settings.", "title": "llmSettings" }, "metadataFilter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The metadata dictionary defining the filters that documents must match in order to be retrieved.", "title": "metadataFilter" }, "resultMetadata": { "anyOf": [ { "description": "The additional information about prompt execution results.", "properties": { "blockedResultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The message to replace the result text if it is non empty, which represents a blocked response.", "title": "blockedResultText" }, "cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The estimated cost of executing the prompt.", "title": "cost" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message for the prompt (in case of an errored prompt).", "title": "errorMessage" }, "estimatedDocsTokenCount": { "default": 0, "description": "The estimated number of tokens in the documents retrieved from the vector database.", "title": "estimatedDocsTokenCount", "type": "integer" }, "feedbackResult": { "description": "Prompt feedback included in the result metadata.", "properties": { "negativeUserIds": { "default": [], "description": "The list of user IDs whose feedback is negative.", "items": { "type": "string" }, "title": "negativeUserIds", "type": "array" }, "positiveUserIds": { "default": [], "description": "The list of user IDs whose feedback is positive.", "items": { "type": "string" }, "title": "positiveUserIds", "type": "array" } }, "title": "FeedbackResult", "type": "object" }, "finalPrompt": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ] }, "type": "object" }, "type": "array" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } ] }, "type": "object" }, "type": "array" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "description": "The final representation of the prompt that was submitted to the LLM.", "title": "finalPrompt" }, "inputTokenCount": { "default": 0, "description": "The number of tokens in the LLM input. This number includes the tokens in the system prompt, the user prompt, the chat history (for history-aware chats) and the documents retrieved from the vector database (in case of using a vector database).", "title": "inputTokenCount", "type": "integer" }, "latencyMilliseconds": { "description": "The latency of the LLM response (in milliseconds).", "title": "latencyMilliseconds", "type": "integer" }, "metrics": { "default": [], "description": "The evaluation metrics for the prompt.", "items": { "description": "Prompt metric metadata.", "properties": { "costConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the cost configuration.", "title": "costConfigurationId" }, "customModelGuardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the custom model guard.", "title": "customModelGuardId" }, "customModelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model used for the metric.", "title": "customModelId" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message associated with the metric computation.", "title": "errorMessage" }, "evaluationDatasetConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the evaluation dataset configuration.", "title": "evaluationDatasetConfigurationId" }, "executionStatus": { "anyOf": [ { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, { "type": "null" } ], "description": "The computation status of the metric." }, "formattedName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted name of the metric.", "title": "formattedName" }, "formattedValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted value of the metric.", "title": "formattedValue" }, "llmIsDeprecated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the LLM is deprecated and will be removed in a future release.", "title": "llmIsDeprecated" }, "name": { "description": "The name of the metric.", "title": "name", "type": "string" }, "nemoMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the NeMo Pipeline configuration.", "title": "nemoMetricId" }, "ootbMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the OOTB metric configuration.", "title": "ootbMetricId" }, "sidecarModelMetricValidationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric).", "title": "sidecarModelMetricValidationId" }, "stage": { "anyOf": [ { "description": "Enum that describes at which stage the metric may be calculated.", "enum": [ "prompt_pipeline", "response_pipeline" ], "title": "PipelineStage", "type": "string" }, { "type": "null" } ], "description": "The stage (prompt or response) that the metric applies to." }, "value": { "description": "The value of the metric.", "title": "value" } }, "required": [ "name", "value" ], "title": "MetricMetadata", "type": "object" }, "title": "metrics", "type": "array" }, "outputTokenCount": { "default": 0, "description": "The number of tokens in the LLM output.", "title": "outputTokenCount", "type": "integer" }, "providerLLMGuards": { "anyOf": [ { "items": { "description": "Info on the provider guard metrics.", "properties": { "name": { "description": "The name of the provider guard metric.", "title": "name", "type": "string" }, "satisfyCriteria": { "description": "Whether the configured provider guard metric satisfied its hidden internal guard criteria.", "title": "satisfyCriteria", "type": "boolean" }, "stage": { "description": "The data stage where the provider guard metric is acting upon.", "enum": [ "prompt", "response" ], "title": "ProviderGuardStage", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The value of the provider guard metric.", "title": "value" } }, "required": [ "satisfyCriteria", "name", "value", "stage" ], "title": "ProviderGuardsMetadata", "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "The provider llm guards metadata.", "title": "providerLLMGuards" }, "totalTokenCount": { "default": 0, "description": "The combined number of tokens in the LLM input and output.", "title": "totalTokenCount", "type": "integer" } }, "required": [ "latencyMilliseconds" ], "title": "ResultMetadata", "type": "object" }, { "type": "null" } ], "description": "The additional information about the chat prompt results." }, "resultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The text of the prompt completion.", "title": "resultText" }, "text": { "description": "The text of the user prompt.", "title": "text", "type": "string" }, "userName": { "description": "The name of the user that created the chat prompt.", "title": "userName", "type": "string" }, "vectorDatabaseFamilyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the vector database family this chat prompt belongs to.", "title": "vectorDatabaseFamilyId" }, "vectorDatabaseId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the vector database linked to this LLM blueprint.", "title": "vectorDatabaseId" }, "vectorDatabaseSettings": { "anyOf": [ { "description": "Vector database retrieval settings.", "properties": { "addNeighborChunks": { "default": false, "description": "Add neighboring chunks to those that the similarity search retrieves, such that when selected, search returns i, i-1, and i+1.", "title": "addNeighborChunks", "type": "boolean" }, "maxDocumentsRetrievedPerPrompt": { "anyOf": [ { "maximum": 10, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of chunks to retrieve from the vector database.", "title": "maxDocumentsRetrievedPerPrompt" }, "maxTokens": { "anyOf": [ { "maximum": 51200, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of tokens to retrieve from the vector database.", "title": "maxTokens" }, "maximalMarginalRelevanceLambda": { "default": 0.5, "description": "Adjust the retrieval of chunks when using maximal marginal relevance to favor diversity (0.0) or similarity (1.0).", "maximum": 1, "minimum": 0, "title": "maximalMarginalRelevanceLambda", "type": "number" }, "retrievalMode": { "description": "Retrieval modes for vector databases.", "enum": [ "similarity", "maximal_marginal_relevance" ], "title": "RetrievalMode", "type": "string" }, "retriever": { "description": "The method used to retrieve relevant chunks from the vector database.", "enum": [ "SINGLE_LOOKUP_RETRIEVER", "CONVERSATIONAL_RETRIEVER", "MULTI_STEP_RETRIEVER" ], "title": "VectorDatabaseRetrievers", "type": "string" } }, "title": "VectorDatabaseSettings", "type": "object" }, { "type": "null" } ], "description": "A key/value dictionary of vector database settings." } }, "required": [ "llmId", "id", "text", "llmBlueprintId", "creationDate", "creationUserId", "userName", "resultMetadata", "resultText", "confidenceScores", "citations", "executionStatus" ], "title": "ChatPromptResponse", "type": "object" } ``` ChatPromptResponse ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | chatContextId | any | false | | The ID of the chat context for this prompt. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | chatId | any | false | | The ID of the chat this chat prompt belongs to. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | chatPromptIdsIncludedInHistory | any | false | | The list of IDs of the chat prompts included in this prompt's history. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | [string] | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | citations | [Citation] | true | | The list of relevant vector database citations (in case of using a vector database). | | confidenceScores | any | true | | The confidence scores that measure the similarity between the prompt context and the prompt completion. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | ConfidenceScores | false | | API response object for confidence scores. | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | creationDate | string(date-time) | true | | The creation date of the chat prompt (ISO 8601 formatted). | | creationUserId | string | true | | The ID of the user that created the chat prompt. | | executionStatus | ExecutionStatus | true | | The execution status of the chat prompt. | | id | string | true | | The ID of the chat prompt. | | llmBlueprintId | string | true | | The ID of the LLM blueprint the chat prompt belongs to. | | llmId | string | true | | The ID of the LLM used by the chat prompt. | | llmSettings | any | false | | A key/value dictionary of LLM settings. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | CommonLLMSettings | false | | The settings that are available for all non-custom LLMs. | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | CustomModelLLMSettings | false | | The settings that are available for custom model LLMs. | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | CustomModelChatLLMSettings | false | | The settings that are available for custom model LLMs used via chat completion interface. | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | metadataFilter | any | false | | The metadata dictionary defining the filters that documents must match in order to be retrieved. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | object | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | resultMetadata | any | true | | The additional information about the chat prompt results. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | ResultMetadata | false | | The additional information about prompt execution results. | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | resultText | any | true | | The text of the prompt completion. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | text | string | true | | The text of the user prompt. | | userName | string | true | | The name of the user that created the chat prompt. | | vectorDatabaseFamilyId | any | false | | The ID of the vector database family this chat prompt belongs to. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | vectorDatabaseId | any | false | | The ID of the vector database linked to this LLM blueprint. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | vectorDatabaseSettings | any | false | | A key/value dictionary of vector database settings. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | VectorDatabaseSettings | false | | Vector database retrieval settings. | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | ## ChatResponse ``` { "description": "Chat object formatted for API output.", "properties": { "creationDate": { "description": "The creation date of the chat (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the chat.", "title": "creationUserId", "type": "string" }, "id": { "description": "The ID of the chat.", "title": "id", "type": "string" }, "isFrozen": { "description": "Whether the chat is frozen (e.g., an evaluation chat). If the chat is frozen, it does not accept new prompts.", "title": "isFrozen", "type": "boolean" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint associated with the chat.", "title": "llmBlueprintId", "type": "string" }, "name": { "description": "The name of the chat.", "title": "name", "type": "string" }, "promptsCount": { "description": "The number of chat prompts in the chat.", "title": "promptsCount", "type": "integer" }, "warning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Warning about the contents of the chat.", "title": "warning" } }, "required": [ "id", "name", "llmBlueprintId", "isFrozen", "warning", "creationDate", "creationUserId", "promptsCount" ], "title": "ChatResponse", "type": "object" } ``` ChatResponse ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | creationDate | string(date-time) | true | | The creation date of the chat (ISO 8601 formatted). | | creationUserId | string | true | | The ID of the user that created the chat. | | id | string | true | | The ID of the chat. | | isFrozen | boolean | true | | Whether the chat is frozen (e.g., an evaluation chat). If the chat is frozen, it does not accept new prompts. | | llmBlueprintId | string | true | | The ID of the LLM blueprint associated with the chat. | | name | string | true | | The name of the chat. | | promptsCount | integer | true | | The number of chat prompts in the chat. | | warning | any | true | | Warning about the contents of the chat. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | ## ChatsSortQueryParam ``` { "description": "Sort order values for listing chats.", "enum": [ "name", "-name", "creationDate", "-creationDate" ], "title": "ChatsSortQueryParam", "type": "string" } ``` ChatsSortQueryParam ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | ChatsSortQueryParam | string | false | | Sort order values for listing chats. | ### Enumerated Values | Property | Value | | --- | --- | | ChatsSortQueryParam | [name, -name, creationDate, -creationDate] | ## Citation ``` { "description": "API response object for a single vector database citation.", "properties": { "chunkId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the chunk in the vector database index.", "title": "chunkId" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "LangChain Document metadata information holder.", "title": "metadata" }, "page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The source page number where the citation was found.", "title": "page" }, "similarityScore": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The similarity score between the citation and the user prompt.", "title": "similarityScore" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source of the citation (e.g., a filename in the original dataset).", "title": "source" }, "startIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The chunk's start character index in the source document.", "title": "startIndex" }, "text": { "description": "The text of the citation.", "title": "text", "type": "string" } }, "required": [ "text", "source" ], "title": "Citation", "type": "object" } ``` Citation ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | chunkId | any | false | | The ID of the chunk in the vector database index. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | integer | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | metadata | any | false | | LangChain Document metadata information holder. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | object | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | page | any | false | | The source page number where the citation was found. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | integer | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | similarityScore | any | false | | The similarity score between the citation and the user prompt. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | number | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | source | any | true | | The source of the citation (e.g., a filename in the original dataset). | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | startIndex | any | false | | The chunk's start character index in the source document. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | integer | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | text | string | true | | The text of the citation. | ## CommonLLMSettings ``` { "additionalProperties": true, "description": "The settings that are available for all non-custom LLMs.", "properties": { "maxCompletionLength": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum number of tokens allowed in the chat completion. Use this value to, for example, control costs on token-based charges or manage response length for chat text limits.", "title": "maxCompletionLength" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "title": "CommonLLMSettings", "type": "object" } ``` CommonLLMSettings ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | maxCompletionLength | any | false | | Maximum number of tokens allowed in the chat completion. Use this value to, for example, control costs on token-based charges or manage response length for chat text limits. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | integer | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | systemPrompt | any | false | | System prompt guides the style of the LLM response. It is a "universal" prompt, prepended to all individual prompts. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | maxLength: 5000000 | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | ## ComparisonChatResponse ``` { "description": "Comparison chat object formatted for API output.", "properties": { "creationDate": { "description": "The creation date of the comparison chat (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the comparison chat.", "title": "creationUserId", "type": "string" }, "id": { "description": "The ID of the comparison chat.", "title": "id", "type": "string" }, "name": { "description": "The name of the comparison chat.", "title": "name", "type": "string" }, "playgroundId": { "description": "The ID of the playground associated with the comparison chat.", "title": "playgroundId", "type": "string" }, "promptsCount": { "description": "The number of comparison prompts in the comparison chat.", "title": "promptsCount", "type": "integer" } }, "required": [ "id", "name", "playgroundId", "creationDate", "creationUserId", "promptsCount" ], "title": "ComparisonChatResponse", "type": "object" } ``` ComparisonChatResponse ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | creationDate | string(date-time) | true | | The creation date of the comparison chat (ISO 8601 formatted). | | creationUserId | string | true | | The ID of the user that created the comparison chat. | | id | string | true | | The ID of the comparison chat. | | name | string | true | | The name of the comparison chat. | | playgroundId | string | true | | The ID of the playground associated with the comparison chat. | | promptsCount | integer | true | | The number of comparison prompts in the comparison chat. | ## ComparisonChatsSortQueryParam ``` { "description": "Sort order values for listing comparison chats.", "enum": [ "name", "-name", "creationDate", "-creationDate" ], "title": "ComparisonChatsSortQueryParam", "type": "string" } ``` ComparisonChatsSortQueryParam ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | ComparisonChatsSortQueryParam | string | false | | Sort order values for listing comparison chats. | ### Enumerated Values | Property | Value | | --- | --- | | ComparisonChatsSortQueryParam | [name, -name, creationDate, -creationDate] | ## ComparisonPromptFeedbackResult ``` { "description": "Feedback metadata for a comparison prompt result.", "properties": { "comparisonPromptResultId": { "description": "The ID of the comparison prompt result associated with this feedback.", "title": "comparisonPromptResultId", "type": "string" }, "feedbackMetadata": { "description": "Prompt feedback metadata.", "properties": { "feedback": { "anyOf": [ { "description": "The sentiment of the feedback.", "enum": [ "1", "0" ], "title": "FeedbackSentiment", "type": "string" }, { "type": "null" } ], "description": "The sentiment of the feedback." } }, "required": [ "feedback" ], "title": "FeedbackMetadata", "type": "object" } }, "required": [ "comparisonPromptResultId", "feedbackMetadata" ], "title": "ComparisonPromptFeedbackResult", "type": "object" } ``` ComparisonPromptFeedbackResult ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | comparisonPromptResultId | string | true | | The ID of the comparison prompt result associated with this feedback. | | feedbackMetadata | FeedbackMetadata | true | | The feedback metadata for the comparison prompt result. | ## ComparisonPromptResponse ``` { "description": "ComparisonPrompt object formatted for API output.", "properties": { "comparisonChatId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the comparison chat associated with the comparison prompt.", "title": "comparisonChatId" }, "creationDate": { "description": "The creation date of the comparison prompt (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the comparison prompt.", "title": "creationUserId", "type": "string" }, "executionStatus": { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, "id": { "description": "The ID of the comparison prompt.", "title": "id", "type": "string" }, "metadataFilter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The metadata filters applied to the comparison prompt.", "title": "metadataFilter" }, "results": { "description": "The list of comparison prompt results.", "items": { "description": "API response object for a single comparison prompt result.", "properties": { "chatContextId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat context for this prompt.", "title": "chatContextId" }, "citations": { "description": "The list of relevant vector database citations (in case of using a vector database).", "items": { "description": "API response object for a single vector database citation.", "properties": { "chunkId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the chunk in the vector database index.", "title": "chunkId" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "LangChain Document metadata information holder.", "title": "metadata" }, "page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The source page number where the citation was found.", "title": "page" }, "similarityScore": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The similarity score between the citation and the user prompt.", "title": "similarityScore" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source of the citation (e.g., a filename in the original dataset).", "title": "source" }, "startIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The chunk's start character index in the source document.", "title": "startIndex" }, "text": { "description": "The text of the citation.", "title": "text", "type": "string" } }, "required": [ "text", "source" ], "title": "Citation", "type": "object" }, "title": "citations", "type": "array" }, "comparisonPromptResultIdsIncludedInHistory": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The list of IDs of the comparison prompt results included in this prompt's history.", "title": "comparisonPromptResultIdsIncludedInHistory" }, "confidenceScores": { "anyOf": [ { "description": "API response object for confidence scores.", "properties": { "bleu": { "description": "BLEU score.", "title": "bleu", "type": "number" }, "meteor": { "description": "METEOR score.", "title": "meteor", "type": "number" }, "rouge": { "description": "ROUGE score.", "title": "rouge", "type": "number" } }, "required": [ "rouge", "meteor", "bleu" ], "title": "ConfidenceScores", "type": "object" }, { "type": "null" } ], "description": "The confidence scores that measure the similarity between the prompt context and the prompt completion." }, "executionStatus": { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, "id": { "description": "The ID of the comparison prompt result.", "title": "id", "type": "string" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint that produced the result.", "title": "llmBlueprintId", "type": "string" }, "resultMetadata": { "anyOf": [ { "description": "The additional information about prompt execution results.", "properties": { "blockedResultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The message to replace the result text if it is non empty, which represents a blocked response.", "title": "blockedResultText" }, "cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The estimated cost of executing the prompt.", "title": "cost" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message for the prompt (in case of an errored prompt).", "title": "errorMessage" }, "estimatedDocsTokenCount": { "default": 0, "description": "The estimated number of tokens in the documents retrieved from the vector database.", "title": "estimatedDocsTokenCount", "type": "integer" }, "feedbackResult": { "description": "Prompt feedback included in the result metadata.", "properties": { "negativeUserIds": { "default": [], "description": "The list of user IDs whose feedback is negative.", "items": { "type": "string" }, "title": "negativeUserIds", "type": "array" }, "positiveUserIds": { "default": [], "description": "The list of user IDs whose feedback is positive.", "items": { "type": "string" }, "title": "positiveUserIds", "type": "array" } }, "title": "FeedbackResult", "type": "object" }, "finalPrompt": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ] }, "type": "object" }, "type": "array" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } ] }, "type": "object" }, "type": "array" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "description": "The final representation of the prompt that was submitted to the LLM.", "title": "finalPrompt" }, "inputTokenCount": { "default": 0, "description": "The number of tokens in the LLM input. This number includes the tokens in the system prompt, the user prompt, the chat history (for history-aware chats) and the documents retrieved from the vector database (in case of using a vector database).", "title": "inputTokenCount", "type": "integer" }, "latencyMilliseconds": { "description": "The latency of the LLM response (in milliseconds).", "title": "latencyMilliseconds", "type": "integer" }, "metrics": { "default": [], "description": "The evaluation metrics for the prompt.", "items": { "description": "Prompt metric metadata.", "properties": { "costConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the cost configuration.", "title": "costConfigurationId" }, "customModelGuardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the custom model guard.", "title": "customModelGuardId" }, "customModelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model used for the metric.", "title": "customModelId" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message associated with the metric computation.", "title": "errorMessage" }, "evaluationDatasetConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the evaluation dataset configuration.", "title": "evaluationDatasetConfigurationId" }, "executionStatus": { "anyOf": [ { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, { "type": "null" } ], "description": "The computation status of the metric." }, "formattedName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted name of the metric.", "title": "formattedName" }, "formattedValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted value of the metric.", "title": "formattedValue" }, "llmIsDeprecated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the LLM is deprecated and will be removed in a future release.", "title": "llmIsDeprecated" }, "name": { "description": "The name of the metric.", "title": "name", "type": "string" }, "nemoMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the NeMo Pipeline configuration.", "title": "nemoMetricId" }, "ootbMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the OOTB metric configuration.", "title": "ootbMetricId" }, "sidecarModelMetricValidationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric).", "title": "sidecarModelMetricValidationId" }, "stage": { "anyOf": [ { "description": "Enum that describes at which stage the metric may be calculated.", "enum": [ "prompt_pipeline", "response_pipeline" ], "title": "PipelineStage", "type": "string" }, { "type": "null" } ], "description": "The stage (prompt or response) that the metric applies to." }, "value": { "description": "The value of the metric.", "title": "value" } }, "required": [ "name", "value" ], "title": "MetricMetadata", "type": "object" }, "title": "metrics", "type": "array" }, "outputTokenCount": { "default": 0, "description": "The number of tokens in the LLM output.", "title": "outputTokenCount", "type": "integer" }, "providerLLMGuards": { "anyOf": [ { "items": { "description": "Info on the provider guard metrics.", "properties": { "name": { "description": "The name of the provider guard metric.", "title": "name", "type": "string" }, "satisfyCriteria": { "description": "Whether the configured provider guard metric satisfied its hidden internal guard criteria.", "title": "satisfyCriteria", "type": "boolean" }, "stage": { "description": "The data stage where the provider guard metric is acting upon.", "enum": [ "prompt", "response" ], "title": "ProviderGuardStage", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The value of the provider guard metric.", "title": "value" } }, "required": [ "satisfyCriteria", "name", "value", "stage" ], "title": "ProviderGuardsMetadata", "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "The provider llm guards metadata.", "title": "providerLLMGuards" }, "totalTokenCount": { "default": 0, "description": "The combined number of tokens in the LLM input and output.", "title": "totalTokenCount", "type": "integer" } }, "required": [ "latencyMilliseconds" ], "title": "ResultMetadata", "type": "object" }, { "type": "null" } ], "description": "The additional information about the prompt result." }, "resultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The text of the prompt completion.", "title": "resultText" } }, "required": [ "id", "llmBlueprintId", "resultText", "confidenceScores", "citations", "executionStatus" ], "title": "ComparisonPromptResult", "type": "object" }, "title": "results", "type": "array" }, "text": { "description": "The text of the user prompt.", "title": "text", "type": "string" }, "userName": { "description": "The name of the user that created the comparison prompt.", "title": "userName", "type": "string" } }, "required": [ "id", "text", "results", "creationDate", "creationUserId", "userName", "executionStatus" ], "title": "ComparisonPromptResponse", "type": "object" } ``` ComparisonPromptResponse ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | comparisonChatId | any | false | | The ID of the comparison chat associated with the comparison prompt. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | creationDate | string(date-time) | true | | The creation date of the comparison prompt (ISO 8601 formatted). | | creationUserId | string | true | | The ID of the user that created the comparison prompt. | | executionStatus | ExecutionStatus | true | | The execution status of the entire comparison prompt. | | id | string | true | | The ID of the comparison prompt. | | metadataFilter | any | false | | The metadata filters applied to the comparison prompt. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | object | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | results | [ComparisonPromptResult] | true | | The list of comparison prompt results. | | text | string | true | | The text of the user prompt. | | userName | string | true | | The name of the user that created the comparison prompt. | ## ComparisonPromptResult ``` { "description": "API response object for a single comparison prompt result.", "properties": { "chatContextId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat context for this prompt.", "title": "chatContextId" }, "citations": { "description": "The list of relevant vector database citations (in case of using a vector database).", "items": { "description": "API response object for a single vector database citation.", "properties": { "chunkId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the chunk in the vector database index.", "title": "chunkId" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "LangChain Document metadata information holder.", "title": "metadata" }, "page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The source page number where the citation was found.", "title": "page" }, "similarityScore": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The similarity score between the citation and the user prompt.", "title": "similarityScore" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source of the citation (e.g., a filename in the original dataset).", "title": "source" }, "startIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The chunk's start character index in the source document.", "title": "startIndex" }, "text": { "description": "The text of the citation.", "title": "text", "type": "string" } }, "required": [ "text", "source" ], "title": "Citation", "type": "object" }, "title": "citations", "type": "array" }, "comparisonPromptResultIdsIncludedInHistory": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The list of IDs of the comparison prompt results included in this prompt's history.", "title": "comparisonPromptResultIdsIncludedInHistory" }, "confidenceScores": { "anyOf": [ { "description": "API response object for confidence scores.", "properties": { "bleu": { "description": "BLEU score.", "title": "bleu", "type": "number" }, "meteor": { "description": "METEOR score.", "title": "meteor", "type": "number" }, "rouge": { "description": "ROUGE score.", "title": "rouge", "type": "number" } }, "required": [ "rouge", "meteor", "bleu" ], "title": "ConfidenceScores", "type": "object" }, { "type": "null" } ], "description": "The confidence scores that measure the similarity between the prompt context and the prompt completion." }, "executionStatus": { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, "id": { "description": "The ID of the comparison prompt result.", "title": "id", "type": "string" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint that produced the result.", "title": "llmBlueprintId", "type": "string" }, "resultMetadata": { "anyOf": [ { "description": "The additional information about prompt execution results.", "properties": { "blockedResultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The message to replace the result text if it is non empty, which represents a blocked response.", "title": "blockedResultText" }, "cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The estimated cost of executing the prompt.", "title": "cost" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message for the prompt (in case of an errored prompt).", "title": "errorMessage" }, "estimatedDocsTokenCount": { "default": 0, "description": "The estimated number of tokens in the documents retrieved from the vector database.", "title": "estimatedDocsTokenCount", "type": "integer" }, "feedbackResult": { "description": "Prompt feedback included in the result metadata.", "properties": { "negativeUserIds": { "default": [], "description": "The list of user IDs whose feedback is negative.", "items": { "type": "string" }, "title": "negativeUserIds", "type": "array" }, "positiveUserIds": { "default": [], "description": "The list of user IDs whose feedback is positive.", "items": { "type": "string" }, "title": "positiveUserIds", "type": "array" } }, "title": "FeedbackResult", "type": "object" }, "finalPrompt": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ] }, "type": "object" }, "type": "array" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } ] }, "type": "object" }, "type": "array" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "description": "The final representation of the prompt that was submitted to the LLM.", "title": "finalPrompt" }, "inputTokenCount": { "default": 0, "description": "The number of tokens in the LLM input. This number includes the tokens in the system prompt, the user prompt, the chat history (for history-aware chats) and the documents retrieved from the vector database (in case of using a vector database).", "title": "inputTokenCount", "type": "integer" }, "latencyMilliseconds": { "description": "The latency of the LLM response (in milliseconds).", "title": "latencyMilliseconds", "type": "integer" }, "metrics": { "default": [], "description": "The evaluation metrics for the prompt.", "items": { "description": "Prompt metric metadata.", "properties": { "costConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the cost configuration.", "title": "costConfigurationId" }, "customModelGuardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the custom model guard.", "title": "customModelGuardId" }, "customModelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model used for the metric.", "title": "customModelId" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message associated with the metric computation.", "title": "errorMessage" }, "evaluationDatasetConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the evaluation dataset configuration.", "title": "evaluationDatasetConfigurationId" }, "executionStatus": { "anyOf": [ { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, { "type": "null" } ], "description": "The computation status of the metric." }, "formattedName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted name of the metric.", "title": "formattedName" }, "formattedValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted value of the metric.", "title": "formattedValue" }, "llmIsDeprecated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the LLM is deprecated and will be removed in a future release.", "title": "llmIsDeprecated" }, "name": { "description": "The name of the metric.", "title": "name", "type": "string" }, "nemoMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the NeMo Pipeline configuration.", "title": "nemoMetricId" }, "ootbMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the OOTB metric configuration.", "title": "ootbMetricId" }, "sidecarModelMetricValidationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric).", "title": "sidecarModelMetricValidationId" }, "stage": { "anyOf": [ { "description": "Enum that describes at which stage the metric may be calculated.", "enum": [ "prompt_pipeline", "response_pipeline" ], "title": "PipelineStage", "type": "string" }, { "type": "null" } ], "description": "The stage (prompt or response) that the metric applies to." }, "value": { "description": "The value of the metric.", "title": "value" } }, "required": [ "name", "value" ], "title": "MetricMetadata", "type": "object" }, "title": "metrics", "type": "array" }, "outputTokenCount": { "default": 0, "description": "The number of tokens in the LLM output.", "title": "outputTokenCount", "type": "integer" }, "providerLLMGuards": { "anyOf": [ { "items": { "description": "Info on the provider guard metrics.", "properties": { "name": { "description": "The name of the provider guard metric.", "title": "name", "type": "string" }, "satisfyCriteria": { "description": "Whether the configured provider guard metric satisfied its hidden internal guard criteria.", "title": "satisfyCriteria", "type": "boolean" }, "stage": { "description": "The data stage where the provider guard metric is acting upon.", "enum": [ "prompt", "response" ], "title": "ProviderGuardStage", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The value of the provider guard metric.", "title": "value" } }, "required": [ "satisfyCriteria", "name", "value", "stage" ], "title": "ProviderGuardsMetadata", "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "The provider llm guards metadata.", "title": "providerLLMGuards" }, "totalTokenCount": { "default": 0, "description": "The combined number of tokens in the LLM input and output.", "title": "totalTokenCount", "type": "integer" } }, "required": [ "latencyMilliseconds" ], "title": "ResultMetadata", "type": "object" }, { "type": "null" } ], "description": "The additional information about the prompt result." }, "resultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The text of the prompt completion.", "title": "resultText" } }, "required": [ "id", "llmBlueprintId", "resultText", "confidenceScores", "citations", "executionStatus" ], "title": "ComparisonPromptResult", "type": "object" } ``` ComparisonPromptResult ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | chatContextId | any | false | | The ID of the chat context for this prompt. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | citations | [Citation] | true | | The list of relevant vector database citations (in case of using a vector database). | | comparisonPromptResultIdsIncludedInHistory | any | false | | The list of IDs of the comparison prompt results included in this prompt's history. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | [string] | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | confidenceScores | any | true | | The confidence scores that measure the similarity between the prompt context and the prompt completion. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | ConfidenceScores | false | | API response object for confidence scores. | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | executionStatus | ExecutionStatus | true | | The execution status of the comparison prompt by this LLM blueprint. | | id | string | true | | The ID of the comparison prompt result. | | llmBlueprintId | string | true | | The ID of the LLM blueprint that produced the result. | | resultMetadata | any | false | | The additional information about the prompt result. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | ResultMetadata | false | | The additional information about prompt execution results. | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | resultText | any | true | | The text of the prompt completion. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | ## ConfidenceScores ``` { "description": "API response object for confidence scores.", "properties": { "bleu": { "description": "BLEU score.", "title": "bleu", "type": "number" }, "meteor": { "description": "METEOR score.", "title": "meteor", "type": "number" }, "rouge": { "description": "ROUGE score.", "title": "rouge", "type": "number" } }, "required": [ "rouge", "meteor", "bleu" ], "title": "ConfidenceScores", "type": "object" } ``` ConfidenceScores ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | bleu | number | true | | BLEU score. | | meteor | number | true | | METEOR score. | | rouge | number | true | | ROUGE score. | ## CreateChatPromptRequest ``` { "description": "The body of the \"Create chat prompt\" request.", "properties": { "chatId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat this prompt belongs to. If LLM and vector database settings are not specified in the request, then the prompt will use the current settings of the chat.", "title": "chatId" }, "llmBlueprintId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the LLM blueprint this prompt belongs to. If LLM and vector database settings are not specified in the request, then the prompt will use the current settings of the LLM blueprint.", "title": "llmBlueprintId" }, "llmId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "If specified, uses this LLM ID for the prompt and updates the settings of the corresponding chat or LLM blueprint to use this LLM ID.", "title": "llmId" }, "llmSettings": { "anyOf": [ { "additionalProperties": true, "description": "The settings that are available for all non-custom LLMs.", "properties": { "maxCompletionLength": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum number of tokens allowed in the chat completion. Use this value to, for example, control costs on token-based charges or manage response length for chat text limits.", "title": "maxCompletionLength" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "title": "CommonLLMSettings", "type": "object" }, { "additionalProperties": false, "description": "The settings that are available for custom model LLMs.", "properties": { "externalLlmContextSize": { "anyOf": [ { "maximum": 128000, "minimum": 128, "type": "integer" }, { "type": "null" } ], "default": 4096, "description": "The external LLM's context size, in tokens. This value is only used for pruning documents supplied to the LLM when a vector database is associated with the LLM blueprint. It does not affect the external LLM's actual context size in any way and is not supplied to the LLM.", "title": "externalLlmContextSize" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" }, "validationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the custom model LLM.", "title": "validationId" } }, "title": "CustomModelLLMSettings", "type": "object" }, { "additionalProperties": false, "description": "The settings that are available for custom model LLMs used via chat completion interface.", "properties": { "customModelId": { "description": "The ID of the custom model used via chat completion interface.", "title": "customModelId", "type": "string" }, "customModelVersionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model version used via chat completion interface.", "title": "customModelVersionId" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "required": [ "customModelId" ], "title": "CustomModelChatLLMSettings", "type": "object" }, { "type": "null" } ], "description": "If specified, uses these LLM settings for the prompt and updates the settings of the corresponding chat or LLM blueprint to use these LLM settings.", "title": "llmSettings" }, "metadataFilter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The metadata fields to add to the chat prompt.", "title": "metadataFilter" }, "text": { "description": "The text of the user prompt.", "maxLength": 5000000, "title": "text", "type": "string" }, "vectorDatabaseId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "If specified, uses this vector database ID for the prompt and updates the settings of the corresponding chat or LLM blueprint to use this vector database ID.", "title": "vectorDatabaseId" }, "vectorDatabaseSettings": { "anyOf": [ { "description": "Vector database retrieval settings.", "properties": { "addNeighborChunks": { "default": false, "description": "Add neighboring chunks to those that the similarity search retrieves, such that when selected, search returns i, i-1, and i+1.", "title": "addNeighborChunks", "type": "boolean" }, "maxDocumentsRetrievedPerPrompt": { "anyOf": [ { "maximum": 10, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of chunks to retrieve from the vector database.", "title": "maxDocumentsRetrievedPerPrompt" }, "maxTokens": { "anyOf": [ { "maximum": 51200, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of tokens to retrieve from the vector database.", "title": "maxTokens" }, "maximalMarginalRelevanceLambda": { "default": 0.5, "description": "Adjust the retrieval of chunks when using maximal marginal relevance to favor diversity (0.0) or similarity (1.0).", "maximum": 1, "minimum": 0, "title": "maximalMarginalRelevanceLambda", "type": "number" }, "retrievalMode": { "description": "Retrieval modes for vector databases.", "enum": [ "similarity", "maximal_marginal_relevance" ], "title": "RetrievalMode", "type": "string" }, "retriever": { "description": "The method used to retrieve relevant chunks from the vector database.", "enum": [ "SINGLE_LOOKUP_RETRIEVER", "CONVERSATIONAL_RETRIEVER", "MULTI_STEP_RETRIEVER" ], "title": "VectorDatabaseRetrievers", "type": "string" } }, "title": "VectorDatabaseSettings", "type": "object" }, { "type": "null" } ], "description": "If specified, uses these vector database settings for the prompt and updates the settings of the corresponding chat or LLM blueprint to use these vector database settings." } }, "required": [ "text" ], "title": "CreateChatPromptRequest", "type": "object" } ``` CreateChatPromptRequest ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | chatId | any | false | | The ID of the chat this prompt belongs to. If LLM and vector database settings are not specified in the request, then the prompt will use the current settings of the chat. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | llmBlueprintId | any | false | | The ID of the LLM blueprint this prompt belongs to. If LLM and vector database settings are not specified in the request, then the prompt will use the current settings of the LLM blueprint. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | llmId | any | false | | If specified, uses this LLM ID for the prompt and updates the settings of the corresponding chat or LLM blueprint to use this LLM ID. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | llmSettings | any | false | | If specified, uses these LLM settings for the prompt and updates the settings of the corresponding chat or LLM blueprint to use these LLM settings. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | CommonLLMSettings | false | | The settings that are available for all non-custom LLMs. | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | CustomModelLLMSettings | false | | The settings that are available for custom model LLMs. | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | CustomModelChatLLMSettings | false | | The settings that are available for custom model LLMs used via chat completion interface. | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | metadataFilter | any | false | | The metadata fields to add to the chat prompt. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | object | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | text | string | true | maxLength: 5000000 | The text of the user prompt. | | vectorDatabaseId | any | false | | If specified, uses this vector database ID for the prompt and updates the settings of the corresponding chat or LLM blueprint to use this vector database ID. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | vectorDatabaseSettings | any | false | | If specified, uses these vector database settings for the prompt and updates the settings of the corresponding chat or LLM blueprint to use these vector database settings. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | VectorDatabaseSettings | false | | Vector database retrieval settings. | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | ## CreateChatRequest ``` { "description": "The body of the \"Create chat\" request.", "properties": { "llmBlueprintId": { "description": "The ID of the LLM blueprint to associate with the chat.", "title": "llmBlueprintId", "type": "string" }, "name": { "description": "The name of the chat.", "maxLength": 5000, "minLength": 1, "title": "name", "type": "string" } }, "required": [ "name", "llmBlueprintId" ], "title": "CreateChatRequest", "type": "object" } ``` CreateChatRequest ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | llmBlueprintId | string | true | | The ID of the LLM blueprint to associate with the chat. | | name | string | true | maxLength: 5000minLength: 1minLength: 1 | The name of the chat. | ## CreateComparisonChatRequest ``` { "description": "The body of the \"Create comparison chat\" request.", "properties": { "name": { "description": "The name of the comparison chat.", "maxLength": 5000, "minLength": 1, "title": "name", "type": "string" }, "playgroundId": { "description": "The ID of the playground to associate with the comparison chat.", "title": "playgroundId", "type": "string" } }, "required": [ "name", "playgroundId" ], "title": "CreateComparisonChatRequest", "type": "object" } ``` CreateComparisonChatRequest ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | name | string | true | maxLength: 5000minLength: 1minLength: 1 | The name of the comparison chat. | | playgroundId | string | true | | The ID of the playground to associate with the comparison chat. | ## CreateComparisonPromptRequest ``` { "description": "The body of the \"Create comparison prompt\" request.", "properties": { "comparisonChatId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the comparison chat to associate the comparison prompt with.", "title": "comparisonChatId" }, "llmBlueprintIds": { "description": "The list of LLM blueprint IDs that should execute the comparison prompt.", "items": { "type": "string" }, "maxItems": 10, "title": "llmBlueprintIds", "type": "array" }, "metadataFilter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The metadata dict that defines filters that the retrieved documents need to match.", "title": "metadataFilter" }, "text": { "description": "The text of the user prompt.", "maxLength": 5000000, "title": "text", "type": "string" } }, "required": [ "llmBlueprintIds", "text" ], "title": "CreateComparisonPromptRequest", "type": "object" } ``` CreateComparisonPromptRequest ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | comparisonChatId | any | false | | The ID of the comparison chat to associate the comparison prompt with. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | llmBlueprintIds | [string] | true | maxItems: 10 | The list of LLM blueprint IDs that should execute the comparison prompt. | | metadataFilter | any | false | | The metadata dict that defines filters that the retrieved documents need to match. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | object | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | text | string | true | maxLength: 5000000 | The text of the user prompt. | ## CreatePromptTemplateRequest ``` { "description": "The body of the Create PromptTemplate request.", "properties": { "description": { "description": "New prompt template description.", "maxLength": 5000, "title": "description", "type": "string" }, "name": { "description": "New prompt template name.", "maxLength": 5000, "title": "name", "type": "string" } }, "required": [ "name", "description" ], "title": "CreatePromptTemplateRequest", "type": "object" } ``` CreatePromptTemplateRequest ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | description | string | true | maxLength: 5000 | New prompt template description. | | name | string | true | maxLength: 5000 | New prompt template name. | ## CreatePromptTemplateVersionRequest ``` { "description": "The body of the Create PromptTemplateVersion request.", "properties": { "commitComment": { "description": "Description of changes for this prompt template version.", "maxLength": 5000, "title": "commitComment", "type": "string" }, "promptText": { "description": "The text of the prompt with variables enclosed in double curly brackets.", "maxLength": 5000000, "title": "promptText", "type": "string" }, "variables": { "description": "Variables for this prompt.", "items": { "description": "Variable used in prompt template version.", "properties": { "description": { "description": "Description of the variable. This is exposed to MCP clients.", "title": "description", "type": "string" }, "name": { "description": "Name of the variable.", "title": "name", "type": "string" }, "type": { "default": "str", "description": "Type of the variable.", "title": "type", "type": "string" } }, "required": [ "name", "description" ], "title": "Variable", "type": "object" }, "maxItems": 100, "title": "variables", "type": "array" } }, "required": [ "promptText", "commitComment", "variables" ], "title": "CreatePromptTemplateVersionRequest", "type": "object" } ``` CreatePromptTemplateVersionRequest ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | commitComment | string | true | maxLength: 5000 | Description of changes for this prompt template version. | | promptText | string | true | maxLength: 5000000 | The text of the prompt with variables enclosed in double curly brackets. | | variables | [Variable] | true | maxItems: 100 | Variables for this prompt. | ## CustomModelChatLLMSettings ``` { "additionalProperties": false, "description": "The settings that are available for custom model LLMs used via chat completion interface.", "properties": { "customModelId": { "description": "The ID of the custom model used via chat completion interface.", "title": "customModelId", "type": "string" }, "customModelVersionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model version used via chat completion interface.", "title": "customModelVersionId" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "required": [ "customModelId" ], "title": "CustomModelChatLLMSettings", "type": "object" } ``` CustomModelChatLLMSettings ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | customModelId | string | true | | The ID of the custom model used via chat completion interface. | | customModelVersionId | any | false | | The ID of the custom model version used via chat completion interface. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | systemPrompt | any | false | | System prompt guides the style of the LLM response. It is a "universal" prompt, prepended to all individual prompts. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | maxLength: 5000000 | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | ## CustomModelLLMSettings ``` { "additionalProperties": false, "description": "The settings that are available for custom model LLMs.", "properties": { "externalLlmContextSize": { "anyOf": [ { "maximum": 128000, "minimum": 128, "type": "integer" }, { "type": "null" } ], "default": 4096, "description": "The external LLM's context size, in tokens. This value is only used for pruning documents supplied to the LLM when a vector database is associated with the LLM blueprint. It does not affect the external LLM's actual context size in any way and is not supplied to the LLM.", "title": "externalLlmContextSize" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" }, "validationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the custom model LLM.", "title": "validationId" } }, "title": "CustomModelLLMSettings", "type": "object" } ``` CustomModelLLMSettings ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | externalLlmContextSize | any | false | | The external LLM's context size, in tokens. This value is only used for pruning documents supplied to the LLM when a vector database is associated with the LLM blueprint. It does not affect the external LLM's actual context size in any way and is not supplied to the LLM. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | integer | false | maximum: 128000minimum: 128 | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | systemPrompt | any | false | | System prompt guides the style of the LLM response. It is a "universal" prompt, prepended to all individual prompts. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | maxLength: 5000000 | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | validationId | any | false | | The validation ID of the custom model LLM. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | ## EditChatPromptRequest ``` { "description": "The body of the \"Update chat prompt\" request.", "properties": { "customMetrics": { "anyOf": [ { "items": { "description": "Prompt metric metadata.", "properties": { "costConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the cost configuration.", "title": "costConfigurationId" }, "customModelGuardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the custom model guard.", "title": "customModelGuardId" }, "customModelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model used for the metric.", "title": "customModelId" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message associated with the metric computation.", "title": "errorMessage" }, "evaluationDatasetConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the evaluation dataset configuration.", "title": "evaluationDatasetConfigurationId" }, "executionStatus": { "anyOf": [ { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, { "type": "null" } ], "description": "The computation status of the metric." }, "formattedName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted name of the metric.", "title": "formattedName" }, "formattedValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted value of the metric.", "title": "formattedValue" }, "llmIsDeprecated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the LLM is deprecated and will be removed in a future release.", "title": "llmIsDeprecated" }, "name": { "description": "The name of the metric.", "title": "name", "type": "string" }, "nemoMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the NeMo Pipeline configuration.", "title": "nemoMetricId" }, "ootbMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the OOTB metric configuration.", "title": "ootbMetricId" }, "sidecarModelMetricValidationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric).", "title": "sidecarModelMetricValidationId" }, "stage": { "anyOf": [ { "description": "Enum that describes at which stage the metric may be calculated.", "enum": [ "prompt_pipeline", "response_pipeline" ], "title": "PipelineStage", "type": "string" }, { "type": "null" } ], "description": "The stage (prompt or response) that the metric applies to." }, "value": { "description": "The value of the metric.", "title": "value" } }, "required": [ "name", "value" ], "title": "MetricMetadata", "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "The list of metric results to add to the chat prompt.", "title": "customMetrics" }, "feedbackMetadata": { "anyOf": [ { "description": "Prompt feedback metadata.", "properties": { "feedback": { "anyOf": [ { "description": "The sentiment of the feedback.", "enum": [ "1", "0" ], "title": "FeedbackSentiment", "type": "string" }, { "type": "null" } ], "description": "The sentiment of the feedback." } }, "required": [ "feedback" ], "title": "FeedbackMetadata", "type": "object" }, { "type": "null" } ], "description": "The feedback metadata to add to the chat prompt." } }, "title": "EditChatPromptRequest", "type": "object" } ``` EditChatPromptRequest ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | customMetrics | any | false | | The list of metric results to add to the chat prompt. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | [MetricMetadata] | false | | [Prompt metric metadata.] | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | feedbackMetadata | any | false | | The feedback metadata to add to the chat prompt. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | FeedbackMetadata | false | | Prompt feedback metadata. | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | ## EditChatRequest ``` { "description": "The body of the \"Edit chat\" request.", "properties": { "name": { "description": "The new name of the chat.", "maxLength": 5000, "minLength": 1, "title": "name", "type": "string" } }, "required": [ "name" ], "title": "EditChatRequest", "type": "object" } ``` EditChatRequest ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | name | string | true | maxLength: 5000minLength: 1minLength: 1 | The new name of the chat. | ## EditComparisonChatRequest ``` { "description": "The body of the \"Edit comparison chat\" request.", "properties": { "name": { "description": "The new name of the comparison chat.", "maxLength": 5000, "minLength": 1, "title": "name", "type": "string" } }, "required": [ "name" ], "title": "EditComparisonChatRequest", "type": "object" } ``` EditComparisonChatRequest ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | name | string | true | maxLength: 5000minLength: 1minLength: 1 | The new name of the comparison chat. | ## EditComparisonPromptRequest ``` { "description": "The body of the \"Edit comparison prompt\" request.", "properties": { "additionalLLMBlueprintIds": { "default": [], "description": "The list of additional LLM blueprint IDs that should execute this comparison prompt.", "items": { "type": "string" }, "maxItems": 10, "title": "additionalLLMBlueprintIds", "type": "array" }, "feedbackResult": { "anyOf": [ { "description": "Feedback metadata for a comparison prompt result.", "properties": { "comparisonPromptResultId": { "description": "The ID of the comparison prompt result associated with this feedback.", "title": "comparisonPromptResultId", "type": "string" }, "feedbackMetadata": { "description": "Prompt feedback metadata.", "properties": { "feedback": { "anyOf": [ { "description": "The sentiment of the feedback.", "enum": [ "1", "0" ], "title": "FeedbackSentiment", "type": "string" }, { "type": "null" } ], "description": "The sentiment of the feedback." } }, "required": [ "feedback" ], "title": "FeedbackMetadata", "type": "object" } }, "required": [ "comparisonPromptResultId", "feedbackMetadata" ], "title": "ComparisonPromptFeedbackResult", "type": "object" }, { "type": "null" } ], "description": "The feedback information to add to the comparison prompt." } }, "title": "EditComparisonPromptRequest", "type": "object" } ``` EditComparisonPromptRequest ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | additionalLLMBlueprintIds | [string] | false | maxItems: 10 | The list of additional LLM blueprint IDs that should execute this comparison prompt. | | feedbackResult | any | false | | The feedback information to add to the comparison prompt. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | ComparisonPromptFeedbackResult | false | | Feedback metadata for a comparison prompt result. | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | ## ExecutionStatus ``` { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" } ``` ExecutionStatus ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | ExecutionStatus | string | false | | Job and entity execution status. | ### Enumerated Values | Property | Value | | --- | --- | | ExecutionStatus | [NEW, RUNNING, COMPLETED, REQUIRES_USER_INPUT, SKIPPED, ERROR] | ## FeedbackMetadata ``` { "description": "Prompt feedback metadata.", "properties": { "feedback": { "anyOf": [ { "description": "The sentiment of the feedback.", "enum": [ "1", "0" ], "title": "FeedbackSentiment", "type": "string" }, { "type": "null" } ], "description": "The sentiment of the feedback." } }, "required": [ "feedback" ], "title": "FeedbackMetadata", "type": "object" } ``` FeedbackMetadata ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | feedback | any | true | | The sentiment of the feedback. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | FeedbackSentiment | false | | The sentiment of the feedback. | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | ## FeedbackResult ``` { "description": "Prompt feedback included in the result metadata.", "properties": { "negativeUserIds": { "default": [], "description": "The list of user IDs whose feedback is negative.", "items": { "type": "string" }, "title": "negativeUserIds", "type": "array" }, "positiveUserIds": { "default": [], "description": "The list of user IDs whose feedback is positive.", "items": { "type": "string" }, "title": "positiveUserIds", "type": "array" } }, "title": "FeedbackResult", "type": "object" } ``` FeedbackResult ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | negativeUserIds | [string] | false | | The list of user IDs whose feedback is negative. | | positiveUserIds | [string] | false | | The list of user IDs whose feedback is positive. | ## FeedbackSentiment ``` { "description": "The sentiment of the feedback.", "enum": [ "1", "0" ], "title": "FeedbackSentiment", "type": "string" } ``` FeedbackSentiment ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | FeedbackSentiment | string | false | | The sentiment of the feedback. | ### Enumerated Values | Property | Value | | --- | --- | | FeedbackSentiment | [1, 0] | ## HTTPValidationErrorResponse ``` { "properties": { "detail": { "items": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "loc", "type": "array" }, "msg": { "title": "msg", "type": "string" }, "type": { "title": "type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" }, "title": "detail", "type": "array" } }, "title": "HTTPValidationErrorResponse", "type": "object" } ``` HTTPValidationErrorResponse ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | detail | [ValidationError] | false | | none | ## ListChatPromptsResponse ``` { "description": "Paginated list of chat prompts.", "properties": { "count": { "description": "The number of records on this page.", "title": "count", "type": "integer" }, "data": { "description": "The list of records.", "items": { "description": "API response object for a single chat prompt.", "properties": { "chatContextId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat context for this prompt.", "title": "chatContextId" }, "chatId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat this chat prompt belongs to.", "title": "chatId" }, "chatPromptIdsIncludedInHistory": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The list of IDs of the chat prompts included in this prompt's history.", "title": "chatPromptIdsIncludedInHistory" }, "citations": { "description": "The list of relevant vector database citations (in case of using a vector database).", "items": { "description": "API response object for a single vector database citation.", "properties": { "chunkId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the chunk in the vector database index.", "title": "chunkId" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "LangChain Document metadata information holder.", "title": "metadata" }, "page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The source page number where the citation was found.", "title": "page" }, "similarityScore": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The similarity score between the citation and the user prompt.", "title": "similarityScore" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source of the citation (e.g., a filename in the original dataset).", "title": "source" }, "startIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The chunk's start character index in the source document.", "title": "startIndex" }, "text": { "description": "The text of the citation.", "title": "text", "type": "string" } }, "required": [ "text", "source" ], "title": "Citation", "type": "object" }, "title": "citations", "type": "array" }, "confidenceScores": { "anyOf": [ { "description": "API response object for confidence scores.", "properties": { "bleu": { "description": "BLEU score.", "title": "bleu", "type": "number" }, "meteor": { "description": "METEOR score.", "title": "meteor", "type": "number" }, "rouge": { "description": "ROUGE score.", "title": "rouge", "type": "number" } }, "required": [ "rouge", "meteor", "bleu" ], "title": "ConfidenceScores", "type": "object" }, { "type": "null" } ], "description": "The confidence scores that measure the similarity between the prompt context and the prompt completion." }, "creationDate": { "description": "The creation date of the chat prompt (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the chat prompt.", "title": "creationUserId", "type": "string" }, "executionStatus": { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, "id": { "description": "The ID of the chat prompt.", "title": "id", "type": "string" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint the chat prompt belongs to.", "title": "llmBlueprintId", "type": "string" }, "llmId": { "description": "The ID of the LLM used by the chat prompt.", "title": "llmId", "type": "string" }, "llmSettings": { "anyOf": [ { "additionalProperties": true, "description": "The settings that are available for all non-custom LLMs.", "properties": { "maxCompletionLength": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum number of tokens allowed in the chat completion. Use this value to, for example, control costs on token-based charges or manage response length for chat text limits.", "title": "maxCompletionLength" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "title": "CommonLLMSettings", "type": "object" }, { "additionalProperties": false, "description": "The settings that are available for custom model LLMs.", "properties": { "externalLlmContextSize": { "anyOf": [ { "maximum": 128000, "minimum": 128, "type": "integer" }, { "type": "null" } ], "default": 4096, "description": "The external LLM's context size, in tokens. This value is only used for pruning documents supplied to the LLM when a vector database is associated with the LLM blueprint. It does not affect the external LLM's actual context size in any way and is not supplied to the LLM.", "title": "externalLlmContextSize" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" }, "validationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the custom model LLM.", "title": "validationId" } }, "title": "CustomModelLLMSettings", "type": "object" }, { "additionalProperties": false, "description": "The settings that are available for custom model LLMs used via chat completion interface.", "properties": { "customModelId": { "description": "The ID of the custom model used via chat completion interface.", "title": "customModelId", "type": "string" }, "customModelVersionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model version used via chat completion interface.", "title": "customModelVersionId" }, "systemPrompt": { "anyOf": [ { "maxLength": 5000000, "type": "string" }, { "type": "null" } ], "description": "System prompt guides the style of the LLM response. It is a \"universal\" prompt, prepended to all individual prompts.", "title": "systemPrompt" } }, "required": [ "customModelId" ], "title": "CustomModelChatLLMSettings", "type": "object" }, { "type": "null" } ], "description": "A key/value dictionary of LLM settings.", "title": "llmSettings" }, "metadataFilter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The metadata dictionary defining the filters that documents must match in order to be retrieved.", "title": "metadataFilter" }, "resultMetadata": { "anyOf": [ { "description": "The additional information about prompt execution results.", "properties": { "blockedResultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The message to replace the result text if it is non empty, which represents a blocked response.", "title": "blockedResultText" }, "cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The estimated cost of executing the prompt.", "title": "cost" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message for the prompt (in case of an errored prompt).", "title": "errorMessage" }, "estimatedDocsTokenCount": { "default": 0, "description": "The estimated number of tokens in the documents retrieved from the vector database.", "title": "estimatedDocsTokenCount", "type": "integer" }, "feedbackResult": { "description": "Prompt feedback included in the result metadata.", "properties": { "negativeUserIds": { "default": [], "description": "The list of user IDs whose feedback is negative.", "items": { "type": "string" }, "title": "negativeUserIds", "type": "array" }, "positiveUserIds": { "default": [], "description": "The list of user IDs whose feedback is positive.", "items": { "type": "string" }, "title": "positiveUserIds", "type": "array" } }, "title": "FeedbackResult", "type": "object" }, "finalPrompt": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ] }, "type": "object" }, "type": "array" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } ] }, "type": "object" }, "type": "array" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "description": "The final representation of the prompt that was submitted to the LLM.", "title": "finalPrompt" }, "inputTokenCount": { "default": 0, "description": "The number of tokens in the LLM input. This number includes the tokens in the system prompt, the user prompt, the chat history (for history-aware chats) and the documents retrieved from the vector database (in case of using a vector database).", "title": "inputTokenCount", "type": "integer" }, "latencyMilliseconds": { "description": "The latency of the LLM response (in milliseconds).", "title": "latencyMilliseconds", "type": "integer" }, "metrics": { "default": [], "description": "The evaluation metrics for the prompt.", "items": { "description": "Prompt metric metadata.", "properties": { "costConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the cost configuration.", "title": "costConfigurationId" }, "customModelGuardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the custom model guard.", "title": "customModelGuardId" }, "customModelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model used for the metric.", "title": "customModelId" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message associated with the metric computation.", "title": "errorMessage" }, "evaluationDatasetConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the evaluation dataset configuration.", "title": "evaluationDatasetConfigurationId" }, "executionStatus": { "anyOf": [ { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, { "type": "null" } ], "description": "The computation status of the metric." }, "formattedName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted name of the metric.", "title": "formattedName" }, "formattedValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted value of the metric.", "title": "formattedValue" }, "llmIsDeprecated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the LLM is deprecated and will be removed in a future release.", "title": "llmIsDeprecated" }, "name": { "description": "The name of the metric.", "title": "name", "type": "string" }, "nemoMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the NeMo Pipeline configuration.", "title": "nemoMetricId" }, "ootbMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the OOTB metric configuration.", "title": "ootbMetricId" }, "sidecarModelMetricValidationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric).", "title": "sidecarModelMetricValidationId" }, "stage": { "anyOf": [ { "description": "Enum that describes at which stage the metric may be calculated.", "enum": [ "prompt_pipeline", "response_pipeline" ], "title": "PipelineStage", "type": "string" }, { "type": "null" } ], "description": "The stage (prompt or response) that the metric applies to." }, "value": { "description": "The value of the metric.", "title": "value" } }, "required": [ "name", "value" ], "title": "MetricMetadata", "type": "object" }, "title": "metrics", "type": "array" }, "outputTokenCount": { "default": 0, "description": "The number of tokens in the LLM output.", "title": "outputTokenCount", "type": "integer" }, "providerLLMGuards": { "anyOf": [ { "items": { "description": "Info on the provider guard metrics.", "properties": { "name": { "description": "The name of the provider guard metric.", "title": "name", "type": "string" }, "satisfyCriteria": { "description": "Whether the configured provider guard metric satisfied its hidden internal guard criteria.", "title": "satisfyCriteria", "type": "boolean" }, "stage": { "description": "The data stage where the provider guard metric is acting upon.", "enum": [ "prompt", "response" ], "title": "ProviderGuardStage", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The value of the provider guard metric.", "title": "value" } }, "required": [ "satisfyCriteria", "name", "value", "stage" ], "title": "ProviderGuardsMetadata", "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "The provider llm guards metadata.", "title": "providerLLMGuards" }, "totalTokenCount": { "default": 0, "description": "The combined number of tokens in the LLM input and output.", "title": "totalTokenCount", "type": "integer" } }, "required": [ "latencyMilliseconds" ], "title": "ResultMetadata", "type": "object" }, { "type": "null" } ], "description": "The additional information about the chat prompt results." }, "resultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The text of the prompt completion.", "title": "resultText" }, "text": { "description": "The text of the user prompt.", "title": "text", "type": "string" }, "userName": { "description": "The name of the user that created the chat prompt.", "title": "userName", "type": "string" }, "vectorDatabaseFamilyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the vector database family this chat prompt belongs to.", "title": "vectorDatabaseFamilyId" }, "vectorDatabaseId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the vector database linked to this LLM blueprint.", "title": "vectorDatabaseId" }, "vectorDatabaseSettings": { "anyOf": [ { "description": "Vector database retrieval settings.", "properties": { "addNeighborChunks": { "default": false, "description": "Add neighboring chunks to those that the similarity search retrieves, such that when selected, search returns i, i-1, and i+1.", "title": "addNeighborChunks", "type": "boolean" }, "maxDocumentsRetrievedPerPrompt": { "anyOf": [ { "maximum": 10, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of chunks to retrieve from the vector database.", "title": "maxDocumentsRetrievedPerPrompt" }, "maxTokens": { "anyOf": [ { "maximum": 51200, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of tokens to retrieve from the vector database.", "title": "maxTokens" }, "maximalMarginalRelevanceLambda": { "default": 0.5, "description": "Adjust the retrieval of chunks when using maximal marginal relevance to favor diversity (0.0) or similarity (1.0).", "maximum": 1, "minimum": 0, "title": "maximalMarginalRelevanceLambda", "type": "number" }, "retrievalMode": { "description": "Retrieval modes for vector databases.", "enum": [ "similarity", "maximal_marginal_relevance" ], "title": "RetrievalMode", "type": "string" }, "retriever": { "description": "The method used to retrieve relevant chunks from the vector database.", "enum": [ "SINGLE_LOOKUP_RETRIEVER", "CONVERSATIONAL_RETRIEVER", "MULTI_STEP_RETRIEVER" ], "title": "VectorDatabaseRetrievers", "type": "string" } }, "title": "VectorDatabaseSettings", "type": "object" }, { "type": "null" } ], "description": "A key/value dictionary of vector database settings." } }, "required": [ "llmId", "id", "text", "llmBlueprintId", "creationDate", "creationUserId", "userName", "resultMetadata", "resultText", "confidenceScores", "citations", "executionStatus" ], "title": "ChatPromptResponse", "type": "object" }, "title": "data", "type": "array" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the next page, or `null` if there is no such page.", "title": "next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the previous page, or `null` if there is no such page.", "title": "previous" }, "totalCount": { "description": "The total number of records.", "title": "totalCount", "type": "integer" } }, "required": [ "totalCount", "count", "next", "previous", "data" ], "title": "ListChatPromptsResponse", "type": "object" } ``` ListChatPromptsResponse ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | count | integer | true | | The number of records on this page. | | data | [ChatPromptResponse] | true | | The list of records. | | next | any | true | | The URL to the next page, or null if there is no such page. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | previous | any | true | | The URL to the previous page, or null if there is no such page. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | totalCount | integer | true | | The total number of records. | ## ListChatsResponse ``` { "description": "Paginated list of chats.", "properties": { "count": { "description": "The number of records on this page.", "title": "count", "type": "integer" }, "data": { "description": "The list of records.", "items": { "description": "Chat object formatted for API output.", "properties": { "creationDate": { "description": "The creation date of the chat (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the chat.", "title": "creationUserId", "type": "string" }, "id": { "description": "The ID of the chat.", "title": "id", "type": "string" }, "isFrozen": { "description": "Whether the chat is frozen (e.g., an evaluation chat). If the chat is frozen, it does not accept new prompts.", "title": "isFrozen", "type": "boolean" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint associated with the chat.", "title": "llmBlueprintId", "type": "string" }, "name": { "description": "The name of the chat.", "title": "name", "type": "string" }, "promptsCount": { "description": "The number of chat prompts in the chat.", "title": "promptsCount", "type": "integer" }, "warning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Warning about the contents of the chat.", "title": "warning" } }, "required": [ "id", "name", "llmBlueprintId", "isFrozen", "warning", "creationDate", "creationUserId", "promptsCount" ], "title": "ChatResponse", "type": "object" }, "title": "data", "type": "array" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the next page, or `null` if there is no such page.", "title": "next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the previous page, or `null` if there is no such page.", "title": "previous" }, "totalCount": { "description": "The total number of records.", "title": "totalCount", "type": "integer" } }, "required": [ "totalCount", "count", "next", "previous", "data" ], "title": "ListChatsResponse", "type": "object" } ``` ListChatsResponse ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | count | integer | true | | The number of records on this page. | | data | [ChatResponse] | true | | The list of records. | | next | any | true | | The URL to the next page, or null if there is no such page. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | previous | any | true | | The URL to the previous page, or null if there is no such page. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | totalCount | integer | true | | The total number of records. | ## ListComparisonChatsResponse ``` { "description": "Paginated list of comparison chats.", "properties": { "count": { "description": "The number of records on this page.", "title": "count", "type": "integer" }, "data": { "description": "The list of records.", "items": { "description": "Comparison chat object formatted for API output.", "properties": { "creationDate": { "description": "The creation date of the comparison chat (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the comparison chat.", "title": "creationUserId", "type": "string" }, "id": { "description": "The ID of the comparison chat.", "title": "id", "type": "string" }, "name": { "description": "The name of the comparison chat.", "title": "name", "type": "string" }, "playgroundId": { "description": "The ID of the playground associated with the comparison chat.", "title": "playgroundId", "type": "string" }, "promptsCount": { "description": "The number of comparison prompts in the comparison chat.", "title": "promptsCount", "type": "integer" } }, "required": [ "id", "name", "playgroundId", "creationDate", "creationUserId", "promptsCount" ], "title": "ComparisonChatResponse", "type": "object" }, "title": "data", "type": "array" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the next page, or `null` if there is no such page.", "title": "next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the previous page, or `null` if there is no such page.", "title": "previous" }, "totalCount": { "description": "The total number of records.", "title": "totalCount", "type": "integer" } }, "required": [ "totalCount", "count", "next", "previous", "data" ], "title": "ListComparisonChatsResponse", "type": "object" } ``` ListComparisonChatsResponse ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | count | integer | true | | The number of records on this page. | | data | [ComparisonChatResponse] | true | | The list of records. | | next | any | true | | The URL to the next page, or null if there is no such page. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | previous | any | true | | The URL to the previous page, or null if there is no such page. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | totalCount | integer | true | | The total number of records. | ## ListComparisonPromptsResponse ``` { "description": "Paginated list of comparison prompts.", "properties": { "count": { "description": "The number of records on this page.", "title": "count", "type": "integer" }, "data": { "description": "The list of records.", "items": { "description": "ComparisonPrompt object formatted for API output.", "properties": { "comparisonChatId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the comparison chat associated with the comparison prompt.", "title": "comparisonChatId" }, "creationDate": { "description": "The creation date of the comparison prompt (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "The ID of the user that created the comparison prompt.", "title": "creationUserId", "type": "string" }, "executionStatus": { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, "id": { "description": "The ID of the comparison prompt.", "title": "id", "type": "string" }, "metadataFilter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The metadata filters applied to the comparison prompt.", "title": "metadataFilter" }, "results": { "description": "The list of comparison prompt results.", "items": { "description": "API response object for a single comparison prompt result.", "properties": { "chatContextId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the chat context for this prompt.", "title": "chatContextId" }, "citations": { "description": "The list of relevant vector database citations (in case of using a vector database).", "items": { "description": "API response object for a single vector database citation.", "properties": { "chunkId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the chunk in the vector database index.", "title": "chunkId" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "LangChain Document metadata information holder.", "title": "metadata" }, "page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The source page number where the citation was found.", "title": "page" }, "similarityScore": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The similarity score between the citation and the user prompt.", "title": "similarityScore" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source of the citation (e.g., a filename in the original dataset).", "title": "source" }, "startIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The chunk's start character index in the source document.", "title": "startIndex" }, "text": { "description": "The text of the citation.", "title": "text", "type": "string" } }, "required": [ "text", "source" ], "title": "Citation", "type": "object" }, "title": "citations", "type": "array" }, "comparisonPromptResultIdsIncludedInHistory": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The list of IDs of the comparison prompt results included in this prompt's history.", "title": "comparisonPromptResultIdsIncludedInHistory" }, "confidenceScores": { "anyOf": [ { "description": "API response object for confidence scores.", "properties": { "bleu": { "description": "BLEU score.", "title": "bleu", "type": "number" }, "meteor": { "description": "METEOR score.", "title": "meteor", "type": "number" }, "rouge": { "description": "ROUGE score.", "title": "rouge", "type": "number" } }, "required": [ "rouge", "meteor", "bleu" ], "title": "ConfidenceScores", "type": "object" }, { "type": "null" } ], "description": "The confidence scores that measure the similarity between the prompt context and the prompt completion." }, "executionStatus": { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, "id": { "description": "The ID of the comparison prompt result.", "title": "id", "type": "string" }, "llmBlueprintId": { "description": "The ID of the LLM blueprint that produced the result.", "title": "llmBlueprintId", "type": "string" }, "resultMetadata": { "anyOf": [ { "description": "The additional information about prompt execution results.", "properties": { "blockedResultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The message to replace the result text if it is non empty, which represents a blocked response.", "title": "blockedResultText" }, "cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The estimated cost of executing the prompt.", "title": "cost" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message for the prompt (in case of an errored prompt).", "title": "errorMessage" }, "estimatedDocsTokenCount": { "default": 0, "description": "The estimated number of tokens in the documents retrieved from the vector database.", "title": "estimatedDocsTokenCount", "type": "integer" }, "feedbackResult": { "description": "Prompt feedback included in the result metadata.", "properties": { "negativeUserIds": { "default": [], "description": "The list of user IDs whose feedback is negative.", "items": { "type": "string" }, "title": "negativeUserIds", "type": "array" }, "positiveUserIds": { "default": [], "description": "The list of user IDs whose feedback is positive.", "items": { "type": "string" }, "title": "positiveUserIds", "type": "array" } }, "title": "FeedbackResult", "type": "object" }, "finalPrompt": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ] }, "type": "object" }, "type": "array" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } ] }, "type": "object" }, "type": "array" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "description": "The final representation of the prompt that was submitted to the LLM.", "title": "finalPrompt" }, "inputTokenCount": { "default": 0, "description": "The number of tokens in the LLM input. This number includes the tokens in the system prompt, the user prompt, the chat history (for history-aware chats) and the documents retrieved from the vector database (in case of using a vector database).", "title": "inputTokenCount", "type": "integer" }, "latencyMilliseconds": { "description": "The latency of the LLM response (in milliseconds).", "title": "latencyMilliseconds", "type": "integer" }, "metrics": { "default": [], "description": "The evaluation metrics for the prompt.", "items": { "description": "Prompt metric metadata.", "properties": { "costConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the cost configuration.", "title": "costConfigurationId" }, "customModelGuardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the custom model guard.", "title": "customModelGuardId" }, "customModelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model used for the metric.", "title": "customModelId" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message associated with the metric computation.", "title": "errorMessage" }, "evaluationDatasetConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the evaluation dataset configuration.", "title": "evaluationDatasetConfigurationId" }, "executionStatus": { "anyOf": [ { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, { "type": "null" } ], "description": "The computation status of the metric." }, "formattedName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted name of the metric.", "title": "formattedName" }, "formattedValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted value of the metric.", "title": "formattedValue" }, "llmIsDeprecated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the LLM is deprecated and will be removed in a future release.", "title": "llmIsDeprecated" }, "name": { "description": "The name of the metric.", "title": "name", "type": "string" }, "nemoMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the NeMo Pipeline configuration.", "title": "nemoMetricId" }, "ootbMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the OOTB metric configuration.", "title": "ootbMetricId" }, "sidecarModelMetricValidationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric).", "title": "sidecarModelMetricValidationId" }, "stage": { "anyOf": [ { "description": "Enum that describes at which stage the metric may be calculated.", "enum": [ "prompt_pipeline", "response_pipeline" ], "title": "PipelineStage", "type": "string" }, { "type": "null" } ], "description": "The stage (prompt or response) that the metric applies to." }, "value": { "description": "The value of the metric.", "title": "value" } }, "required": [ "name", "value" ], "title": "MetricMetadata", "type": "object" }, "title": "metrics", "type": "array" }, "outputTokenCount": { "default": 0, "description": "The number of tokens in the LLM output.", "title": "outputTokenCount", "type": "integer" }, "providerLLMGuards": { "anyOf": [ { "items": { "description": "Info on the provider guard metrics.", "properties": { "name": { "description": "The name of the provider guard metric.", "title": "name", "type": "string" }, "satisfyCriteria": { "description": "Whether the configured provider guard metric satisfied its hidden internal guard criteria.", "title": "satisfyCriteria", "type": "boolean" }, "stage": { "description": "The data stage where the provider guard metric is acting upon.", "enum": [ "prompt", "response" ], "title": "ProviderGuardStage", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The value of the provider guard metric.", "title": "value" } }, "required": [ "satisfyCriteria", "name", "value", "stage" ], "title": "ProviderGuardsMetadata", "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "The provider llm guards metadata.", "title": "providerLLMGuards" }, "totalTokenCount": { "default": 0, "description": "The combined number of tokens in the LLM input and output.", "title": "totalTokenCount", "type": "integer" } }, "required": [ "latencyMilliseconds" ], "title": "ResultMetadata", "type": "object" }, { "type": "null" } ], "description": "The additional information about the prompt result." }, "resultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The text of the prompt completion.", "title": "resultText" } }, "required": [ "id", "llmBlueprintId", "resultText", "confidenceScores", "citations", "executionStatus" ], "title": "ComparisonPromptResult", "type": "object" }, "title": "results", "type": "array" }, "text": { "description": "The text of the user prompt.", "title": "text", "type": "string" }, "userName": { "description": "The name of the user that created the comparison prompt.", "title": "userName", "type": "string" } }, "required": [ "id", "text", "results", "creationDate", "creationUserId", "userName", "executionStatus" ], "title": "ComparisonPromptResponse", "type": "object" }, "title": "data", "type": "array" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the next page, or `null` if there is no such page.", "title": "next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the previous page, or `null` if there is no such page.", "title": "previous" }, "totalCount": { "description": "The total number of records.", "title": "totalCount", "type": "integer" } }, "required": [ "totalCount", "count", "next", "previous", "data" ], "title": "ListComparisonPromptsResponse", "type": "object" } ``` ListComparisonPromptsResponse ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | count | integer | true | | The number of records on this page. | | data | [ComparisonPromptResponse] | true | | The list of records. | | next | any | true | | The URL to the next page, or null if there is no such page. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | previous | any | true | | The URL to the previous page, or null if there is no such page. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | totalCount | integer | true | | The total number of records. | ## ListPromptTemplateVersionsResponse ``` { "description": "Paginated list of prompt template versions.", "properties": { "count": { "description": "The number of records on this page.", "title": "count", "type": "integer" }, "data": { "description": "The list of records.", "items": { "description": "API response object for a single prompt template version.", "properties": { "commitComment": { "description": "Description of changes for this prompt template version.", "title": "commitComment", "type": "string" }, "creationDate": { "description": "Prompt template version creation date (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "ID of the user who created this prompt template version.", "title": "creationUserId", "type": "string" }, "id": { "description": "Prompt template version ID.", "title": "id", "type": "string" }, "promptTemplateId": { "description": "Prompt template ID.", "title": "promptTemplateId", "type": "string" }, "promptText": { "description": "The text of the prompt with variables enclosed in double curly brackets.", "title": "promptText", "type": "string" }, "userName": { "description": "Name of the user who created this prompt template version.", "title": "userName", "type": "string" }, "variables": { "description": "List of variables associated with this prompt template version.", "items": { "description": "Variable used in prompt template version.", "properties": { "description": { "description": "Description of the variable. This is exposed to MCP clients.", "title": "description", "type": "string" }, "name": { "description": "Name of the variable.", "title": "name", "type": "string" }, "type": { "default": "str", "description": "Type of the variable.", "title": "type", "type": "string" } }, "required": [ "name", "description" ], "title": "Variable", "type": "object" }, "title": "variables", "type": "array" }, "version": { "description": "Version of this prompt template version.", "title": "version", "type": "integer" } }, "required": [ "id", "promptTemplateId", "promptText", "commitComment", "version", "variables", "creationDate", "creationUserId", "userName" ], "title": "PromptTemplateVersionResponse", "type": "object" }, "title": "data", "type": "array" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the next page, or `null` if there is no such page.", "title": "next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the previous page, or `null` if there is no such page.", "title": "previous" }, "totalCount": { "description": "The total number of records.", "title": "totalCount", "type": "integer" } }, "required": [ "totalCount", "count", "next", "previous", "data" ], "title": "ListPromptTemplateVersionsResponse", "type": "object" } ``` ListPromptTemplateVersionsResponse ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | count | integer | true | | The number of records on this page. | | data | [PromptTemplateVersionResponse] | true | | The list of records. | | next | any | true | | The URL to the next page, or null if there is no such page. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | previous | any | true | | The URL to the previous page, or null if there is no such page. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | totalCount | integer | true | | The total number of records. | ## ListPromptTemplatesResponse ``` { "description": "Paginated list of prompt templates.", "properties": { "count": { "description": "The number of records on this page.", "title": "count", "type": "integer" }, "data": { "description": "The list of records.", "items": { "description": "API response object for a single prompt template.", "properties": { "creationDate": { "description": "Prompt template creation date (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "ID of the user who created this prompt template.", "title": "creationUserId", "type": "string" }, "description": { "description": "Prompt template description.", "title": "description", "type": "string" }, "id": { "description": "Prompt template ID.", "title": "id", "type": "string" }, "lastUpdateDate": { "description": "Date of the most recent update of this prompt template (ISO 8601 formatted).", "format": "date-time", "title": "lastUpdateDate", "type": "string" }, "lastUpdateUserId": { "description": "ID of the user that made the most recent update to this prompt template.", "title": "lastUpdateUserId", "type": "string" }, "name": { "description": "Prompt template name.", "title": "name", "type": "string" }, "userName": { "description": "Name of the user who created this prompt template.", "title": "userName", "type": "string" }, "versionCount": { "description": "The number of versions associated with this prompt template.", "title": "versionCount", "type": "integer" } }, "required": [ "id", "name", "description", "creationDate", "creationUserId", "lastUpdateDate", "lastUpdateUserId", "userName", "versionCount" ], "title": "PromptTemplateResponse", "type": "object" }, "title": "data", "type": "array" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the next page, or `null` if there is no such page.", "title": "next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL to the previous page, or `null` if there is no such page.", "title": "previous" }, "totalCount": { "description": "The total number of records.", "title": "totalCount", "type": "integer" } }, "required": [ "totalCount", "count", "next", "previous", "data" ], "title": "ListPromptTemplatesResponse", "type": "object" } ``` ListPromptTemplatesResponse ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | count | integer | true | | The number of records on this page. | | data | [PromptTemplateResponse] | true | | The list of records. | | next | any | true | | The URL to the next page, or null if there is no such page. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | previous | any | true | | The URL to the previous page, or null if there is no such page. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | totalCount | integer | true | | The total number of records. | ## MetricMetadata ``` { "description": "Prompt metric metadata.", "properties": { "costConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the cost configuration.", "title": "costConfigurationId" }, "customModelGuardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the custom model guard.", "title": "customModelGuardId" }, "customModelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model used for the metric.", "title": "customModelId" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message associated with the metric computation.", "title": "errorMessage" }, "evaluationDatasetConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the evaluation dataset configuration.", "title": "evaluationDatasetConfigurationId" }, "executionStatus": { "anyOf": [ { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, { "type": "null" } ], "description": "The computation status of the metric." }, "formattedName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted name of the metric.", "title": "formattedName" }, "formattedValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted value of the metric.", "title": "formattedValue" }, "llmIsDeprecated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the LLM is deprecated and will be removed in a future release.", "title": "llmIsDeprecated" }, "name": { "description": "The name of the metric.", "title": "name", "type": "string" }, "nemoMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the NeMo Pipeline configuration.", "title": "nemoMetricId" }, "ootbMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the OOTB metric configuration.", "title": "ootbMetricId" }, "sidecarModelMetricValidationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric).", "title": "sidecarModelMetricValidationId" }, "stage": { "anyOf": [ { "description": "Enum that describes at which stage the metric may be calculated.", "enum": [ "prompt_pipeline", "response_pipeline" ], "title": "PipelineStage", "type": "string" }, { "type": "null" } ], "description": "The stage (prompt or response) that the metric applies to." }, "value": { "description": "The value of the metric.", "title": "value" } }, "required": [ "name", "value" ], "title": "MetricMetadata", "type": "object" } ``` MetricMetadata ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | costConfigurationId | any | false | | The ID of the cost configuration. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | customModelGuardId | any | false | | Id of the custom model guard. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | customModelId | any | false | | The ID of the custom model used for the metric. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | errorMessage | any | false | | The error message associated with the metric computation. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | evaluationDatasetConfigurationId | any | false | | The ID of the evaluation dataset configuration. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | executionStatus | any | false | | The computation status of the metric. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | ExecutionStatus | false | | Job and entity execution status. | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | formattedName | any | false | | The formatted name of the metric. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | formattedValue | any | false | | The formatted value of the metric. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | llmIsDeprecated | any | false | | Whether the LLM is deprecated and will be removed in a future release. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | boolean | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | name | string | true | | The name of the metric. | | nemoMetricId | any | false | | The id of the NeMo Pipeline configuration. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | ootbMetricId | any | false | | The id of the OOTB metric configuration. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | sidecarModelMetricValidationId | any | false | | The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric). | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | stage | any | false | | The stage (prompt or response) that the metric applies to. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | PipelineStage | false | | Enum that describes at which stage the metric may be calculated. | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | value | any | true | | The value of the metric. | ## PipelineStage ``` { "description": "Enum that describes at which stage the metric may be calculated.", "enum": [ "prompt_pipeline", "response_pipeline" ], "title": "PipelineStage", "type": "string" } ``` PipelineStage ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | PipelineStage | string | false | | Enum that describes at which stage the metric may be calculated. | ### Enumerated Values | Property | Value | | --- | --- | | PipelineStage | [prompt_pipeline, response_pipeline] | ## PromptTemplateResponse ``` { "description": "API response object for a single prompt template.", "properties": { "creationDate": { "description": "Prompt template creation date (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "ID of the user who created this prompt template.", "title": "creationUserId", "type": "string" }, "description": { "description": "Prompt template description.", "title": "description", "type": "string" }, "id": { "description": "Prompt template ID.", "title": "id", "type": "string" }, "lastUpdateDate": { "description": "Date of the most recent update of this prompt template (ISO 8601 formatted).", "format": "date-time", "title": "lastUpdateDate", "type": "string" }, "lastUpdateUserId": { "description": "ID of the user that made the most recent update to this prompt template.", "title": "lastUpdateUserId", "type": "string" }, "name": { "description": "Prompt template name.", "title": "name", "type": "string" }, "userName": { "description": "Name of the user who created this prompt template.", "title": "userName", "type": "string" }, "versionCount": { "description": "The number of versions associated with this prompt template.", "title": "versionCount", "type": "integer" } }, "required": [ "id", "name", "description", "creationDate", "creationUserId", "lastUpdateDate", "lastUpdateUserId", "userName", "versionCount" ], "title": "PromptTemplateResponse", "type": "object" } ``` PromptTemplateResponse ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | creationDate | string(date-time) | true | | Prompt template creation date (ISO 8601 formatted). | | creationUserId | string | true | | ID of the user who created this prompt template. | | description | string | true | | Prompt template description. | | id | string | true | | Prompt template ID. | | lastUpdateDate | string(date-time) | true | | Date of the most recent update of this prompt template (ISO 8601 formatted). | | lastUpdateUserId | string | true | | ID of the user that made the most recent update to this prompt template. | | name | string | true | | Prompt template name. | | userName | string | true | | Name of the user who created this prompt template. | | versionCount | integer | true | | The number of versions associated with this prompt template. | ## PromptTemplateVersionResponse ``` { "description": "API response object for a single prompt template version.", "properties": { "commitComment": { "description": "Description of changes for this prompt template version.", "title": "commitComment", "type": "string" }, "creationDate": { "description": "Prompt template version creation date (ISO 8601 formatted).", "format": "date-time", "title": "creationDate", "type": "string" }, "creationUserId": { "description": "ID of the user who created this prompt template version.", "title": "creationUserId", "type": "string" }, "id": { "description": "Prompt template version ID.", "title": "id", "type": "string" }, "promptTemplateId": { "description": "Prompt template ID.", "title": "promptTemplateId", "type": "string" }, "promptText": { "description": "The text of the prompt with variables enclosed in double curly brackets.", "title": "promptText", "type": "string" }, "userName": { "description": "Name of the user who created this prompt template version.", "title": "userName", "type": "string" }, "variables": { "description": "List of variables associated with this prompt template version.", "items": { "description": "Variable used in prompt template version.", "properties": { "description": { "description": "Description of the variable. This is exposed to MCP clients.", "title": "description", "type": "string" }, "name": { "description": "Name of the variable.", "title": "name", "type": "string" }, "type": { "default": "str", "description": "Type of the variable.", "title": "type", "type": "string" } }, "required": [ "name", "description" ], "title": "Variable", "type": "object" }, "title": "variables", "type": "array" }, "version": { "description": "Version of this prompt template version.", "title": "version", "type": "integer" } }, "required": [ "id", "promptTemplateId", "promptText", "commitComment", "version", "variables", "creationDate", "creationUserId", "userName" ], "title": "PromptTemplateVersionResponse", "type": "object" } ``` PromptTemplateVersionResponse ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | commitComment | string | true | | Description of changes for this prompt template version. | | creationDate | string(date-time) | true | | Prompt template version creation date (ISO 8601 formatted). | | creationUserId | string | true | | ID of the user who created this prompt template version. | | id | string | true | | Prompt template version ID. | | promptTemplateId | string | true | | Prompt template ID. | | promptText | string | true | | The text of the prompt with variables enclosed in double curly brackets. | | userName | string | true | | Name of the user who created this prompt template version. | | variables | [Variable] | true | | List of variables associated with this prompt template version. | | version | integer | true | | Version of this prompt template version. | ## PromptTemplatesSortQueryParam ``` { "description": "Sort order values for listing prompt templates.", "enum": [ "name", "-name", "description", "-description", "creationDate", "-creationDate", "lastUpdateDate", "-lastUpdateDate" ], "title": "PromptTemplatesSortQueryParam", "type": "string" } ``` PromptTemplatesSortQueryParam ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | PromptTemplatesSortQueryParam | string | false | | Sort order values for listing prompt templates. | ### Enumerated Values | Property | Value | | --- | --- | | PromptTemplatesSortQueryParam | [name, -name, description, -description, creationDate, -creationDate, lastUpdateDate, -lastUpdateDate] | ## ProviderGuardStage ``` { "description": "The data stage where the provider guard metric is acting upon.", "enum": [ "prompt", "response" ], "title": "ProviderGuardStage", "type": "string" } ``` ProviderGuardStage ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | ProviderGuardStage | string | false | | The data stage where the provider guard metric is acting upon. | ### Enumerated Values | Property | Value | | --- | --- | | ProviderGuardStage | [prompt, response] | ## ProviderGuardsMetadata ``` { "description": "Info on the provider guard metrics.", "properties": { "name": { "description": "The name of the provider guard metric.", "title": "name", "type": "string" }, "satisfyCriteria": { "description": "Whether the configured provider guard metric satisfied its hidden internal guard criteria.", "title": "satisfyCriteria", "type": "boolean" }, "stage": { "description": "The data stage where the provider guard metric is acting upon.", "enum": [ "prompt", "response" ], "title": "ProviderGuardStage", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The value of the provider guard metric.", "title": "value" } }, "required": [ "satisfyCriteria", "name", "value", "stage" ], "title": "ProviderGuardsMetadata", "type": "object" } ``` ProviderGuardsMetadata ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | name | string | true | | The name of the provider guard metric. | | satisfyCriteria | boolean | true | | Whether the configured provider guard metric satisfied its hidden internal guard criteria. | | stage | ProviderGuardStage | true | | The data stage where the provider guard metric is acting upon. | | value | any | true | | The value of the provider guard metric. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | number | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | integer | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | ## ResultMetadata ``` { "description": "The additional information about prompt execution results.", "properties": { "blockedResultText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The message to replace the result text if it is non empty, which represents a blocked response.", "title": "blockedResultText" }, "cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The estimated cost of executing the prompt.", "title": "cost" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message for the prompt (in case of an errored prompt).", "title": "errorMessage" }, "estimatedDocsTokenCount": { "default": 0, "description": "The estimated number of tokens in the documents retrieved from the vector database.", "title": "estimatedDocsTokenCount", "type": "integer" }, "feedbackResult": { "description": "Prompt feedback included in the result metadata.", "properties": { "negativeUserIds": { "default": [], "description": "The list of user IDs whose feedback is negative.", "items": { "type": "string" }, "title": "negativeUserIds", "type": "array" }, "positiveUserIds": { "default": [], "description": "The list of user IDs whose feedback is positive.", "items": { "type": "string" }, "title": "positiveUserIds", "type": "array" } }, "title": "FeedbackResult", "type": "object" }, "finalPrompt": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ] }, "type": "object" }, "type": "array" }, { "items": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } ] }, "type": "object" }, "type": "array" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "description": "The final representation of the prompt that was submitted to the LLM.", "title": "finalPrompt" }, "inputTokenCount": { "default": 0, "description": "The number of tokens in the LLM input. This number includes the tokens in the system prompt, the user prompt, the chat history (for history-aware chats) and the documents retrieved from the vector database (in case of using a vector database).", "title": "inputTokenCount", "type": "integer" }, "latencyMilliseconds": { "description": "The latency of the LLM response (in milliseconds).", "title": "latencyMilliseconds", "type": "integer" }, "metrics": { "default": [], "description": "The evaluation metrics for the prompt.", "items": { "description": "Prompt metric metadata.", "properties": { "costConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the cost configuration.", "title": "costConfigurationId" }, "customModelGuardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the custom model guard.", "title": "customModelGuardId" }, "customModelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the custom model used for the metric.", "title": "customModelId" }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message associated with the metric computation.", "title": "errorMessage" }, "evaluationDatasetConfigurationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the evaluation dataset configuration.", "title": "evaluationDatasetConfigurationId" }, "executionStatus": { "anyOf": [ { "description": "Job and entity execution status.", "enum": [ "NEW", "RUNNING", "COMPLETED", "REQUIRES_USER_INPUT", "SKIPPED", "ERROR" ], "title": "ExecutionStatus", "type": "string" }, { "type": "null" } ], "description": "The computation status of the metric." }, "formattedName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted name of the metric.", "title": "formattedName" }, "formattedValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The formatted value of the metric.", "title": "formattedValue" }, "llmIsDeprecated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the LLM is deprecated and will be removed in a future release.", "title": "llmIsDeprecated" }, "name": { "description": "The name of the metric.", "title": "name", "type": "string" }, "nemoMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the NeMo Pipeline configuration.", "title": "nemoMetricId" }, "ootbMetricId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the OOTB metric configuration.", "title": "ootbMetricId" }, "sidecarModelMetricValidationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The validation ID of the sidecar model validation(in case of using a sidecar model deployment for the metric).", "title": "sidecarModelMetricValidationId" }, "stage": { "anyOf": [ { "description": "Enum that describes at which stage the metric may be calculated.", "enum": [ "prompt_pipeline", "response_pipeline" ], "title": "PipelineStage", "type": "string" }, { "type": "null" } ], "description": "The stage (prompt or response) that the metric applies to." }, "value": { "description": "The value of the metric.", "title": "value" } }, "required": [ "name", "value" ], "title": "MetricMetadata", "type": "object" }, "title": "metrics", "type": "array" }, "outputTokenCount": { "default": 0, "description": "The number of tokens in the LLM output.", "title": "outputTokenCount", "type": "integer" }, "providerLLMGuards": { "anyOf": [ { "items": { "description": "Info on the provider guard metrics.", "properties": { "name": { "description": "The name of the provider guard metric.", "title": "name", "type": "string" }, "satisfyCriteria": { "description": "Whether the configured provider guard metric satisfied its hidden internal guard criteria.", "title": "satisfyCriteria", "type": "boolean" }, "stage": { "description": "The data stage where the provider guard metric is acting upon.", "enum": [ "prompt", "response" ], "title": "ProviderGuardStage", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The value of the provider guard metric.", "title": "value" } }, "required": [ "satisfyCriteria", "name", "value", "stage" ], "title": "ProviderGuardsMetadata", "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "The provider llm guards metadata.", "title": "providerLLMGuards" }, "totalTokenCount": { "default": 0, "description": "The combined number of tokens in the LLM input and output.", "title": "totalTokenCount", "type": "integer" } }, "required": [ "latencyMilliseconds" ], "title": "ResultMetadata", "type": "object" } ``` ResultMetadata ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | blockedResultText | any | false | | The message to replace the result text if it is non empty, which represents a blocked response. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | cost | any | false | | The estimated cost of executing the prompt. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | number | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | errorMessage | any | false | | The error message for the prompt (in case of an errored prompt). | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | estimatedDocsTokenCount | integer | false | | The estimated number of tokens in the documents retrieved from the vector database. | | feedbackResult | FeedbackResult | false | | The user feedback associated with the prompt. | | finalPrompt | any | false | | The final representation of the prompt that was submitted to the LLM. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | [object] | false | | none | | »» additionalProperties | any | false | | none | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | »»» anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | »»» anonymous | [object] | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | »»» anonymous | null | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | [object] | false | | none | | »» additionalProperties | any | false | | none | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | »»» anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | »»» anonymous | [object] | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | object | false | | none | | »» additionalProperties | any | false | | none | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | »»» anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | »»» anonymous | [object] | false | | none | | »»»» additionalProperties | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | inputTokenCount | integer | false | | The number of tokens in the LLM input. This number includes the tokens in the system prompt, the user prompt, the chat history (for history-aware chats) and the documents retrieved from the vector database (in case of using a vector database). | | latencyMilliseconds | integer | true | | The latency of the LLM response (in milliseconds). | | metrics | [MetricMetadata] | false | | The evaluation metrics for the prompt. | | outputTokenCount | integer | false | | The number of tokens in the LLM output. | | providerLLMGuards | any | false | | The provider llm guards metadata. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | [ProviderGuardsMetadata] | false | | [Info on the provider guard metrics.] | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | totalTokenCount | integer | false | | The combined number of tokens in the LLM input and output. | ## RetrievalMode ``` { "description": "Retrieval modes for vector databases.", "enum": [ "similarity", "maximal_marginal_relevance" ], "title": "RetrievalMode", "type": "string" } ``` RetrievalMode ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | RetrievalMode | string | false | | Retrieval modes for vector databases. | ### Enumerated Values | Property | Value | | --- | --- | | RetrievalMode | [similarity, maximal_marginal_relevance] | ## ValidationError ``` { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "loc", "type": "array" }, "msg": { "title": "msg", "type": "string" }, "type": { "title": "type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" } ``` ValidationError ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | loc | [anyOf] | true | | none | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | string | false | | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | integer | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | msg | string | true | | none | | type | string | true | | none | ## Variable ``` { "description": "Variable used in prompt template version.", "properties": { "description": { "description": "Description of the variable. This is exposed to MCP clients.", "title": "description", "type": "string" }, "name": { "description": "Name of the variable.", "title": "name", "type": "string" }, "type": { "default": "str", "description": "Type of the variable.", "title": "type", "type": "string" } }, "required": [ "name", "description" ], "title": "Variable", "type": "object" } ``` Variable ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | description | string | true | | Description of the variable. This is exposed to MCP clients. | | name | string | true | | Name of the variable. | | type | string | false | | Type of the variable. | ## VectorDatabaseRetrievers ``` { "description": "The method used to retrieve relevant chunks from the vector database.", "enum": [ "SINGLE_LOOKUP_RETRIEVER", "CONVERSATIONAL_RETRIEVER", "MULTI_STEP_RETRIEVER" ], "title": "VectorDatabaseRetrievers", "type": "string" } ``` VectorDatabaseRetrievers ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | VectorDatabaseRetrievers | string | false | | The method used to retrieve relevant chunks from the vector database. | ### Enumerated Values | Property | Value | | --- | --- | | VectorDatabaseRetrievers | [SINGLE_LOOKUP_RETRIEVER, CONVERSATIONAL_RETRIEVER, MULTI_STEP_RETRIEVER] | ## VectorDatabaseSettings ``` { "description": "Vector database retrieval settings.", "properties": { "addNeighborChunks": { "default": false, "description": "Add neighboring chunks to those that the similarity search retrieves, such that when selected, search returns i, i-1, and i+1.", "title": "addNeighborChunks", "type": "boolean" }, "maxDocumentsRetrievedPerPrompt": { "anyOf": [ { "maximum": 10, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of chunks to retrieve from the vector database.", "title": "maxDocumentsRetrievedPerPrompt" }, "maxTokens": { "anyOf": [ { "maximum": 51200, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The maximum number of tokens to retrieve from the vector database.", "title": "maxTokens" }, "maximalMarginalRelevanceLambda": { "default": 0.5, "description": "Adjust the retrieval of chunks when using maximal marginal relevance to favor diversity (0.0) or similarity (1.0).", "maximum": 1, "minimum": 0, "title": "maximalMarginalRelevanceLambda", "type": "number" }, "retrievalMode": { "description": "Retrieval modes for vector databases.", "enum": [ "similarity", "maximal_marginal_relevance" ], "title": "RetrievalMode", "type": "string" }, "retriever": { "description": "The method used to retrieve relevant chunks from the vector database.", "enum": [ "SINGLE_LOOKUP_RETRIEVER", "CONVERSATIONAL_RETRIEVER", "MULTI_STEP_RETRIEVER" ], "title": "VectorDatabaseRetrievers", "type": "string" } }, "title": "VectorDatabaseSettings", "type": "object" } ``` VectorDatabaseSettings ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | addNeighborChunks | boolean | false | | Add neighboring chunks to those that the similarity search retrieves, such that when selected, search returns i, i-1, and i+1. | | maxDocumentsRetrievedPerPrompt | any | false | | The maximum number of chunks to retrieve from the vector database. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | integer | false | maximum: 10minimum: 1 | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | maxTokens | any | false | | The maximum number of tokens to retrieve from the vector database. | anyOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | integer | false | maximum: 51200minimum: 1 | none | or | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » anonymous | null | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | maximalMarginalRelevanceLambda | number | false | maximum: 1minimum: 0 | Adjust the retrieval of chunks when using maximal marginal relevance to favor diversity (0.0) or similarity (1.0). | | retrievalMode | RetrievalMode | false | | The retrieval mode to use. Similarity search or maximal marginal relevance. | | retriever | VectorDatabaseRetrievers | false | | The method used to retrieve relevant chunks from the vector database. |