H2h2o
Prompt Templates

Finds a prompt template by id.

Returns a single prompt template by its unique identifier.

get/prompt_templates/{prompt_template_id}

Request

Path parameters

prompt_template_idstring required

Id of a prompt template to return

Response

Successful operation

namestring

A name of the prompt template.

descriptionstring

A description of the prompt template.

langstring

A language code.

system_promptstring

A system prompt.

pre_prompt_querystring

A text that is prepended before the contextual document chunks.

prompt_querystring

A text that is appended to the beginning of the user's message.

hyde_no_rag_llm_prompt_extensionstring

An LLM prompt extension.

pre_prompt_summarystring

A prompt that goes before each large piece of text to summarize.

prompt_summarystring

A prompt that goes after each large piece of text to summarize.

system_prompt_reflectionstring

A system prompt for self-reflection.

prompt_reflectionstring

A template for self-reflection, must contain two occurrences of %s for full previous prompt (including system prompt, document related context and prompts if applicable, and user prompts) and answer

auto_gen_description_promptstring

A prompt to create a description of the collection.

auto_gen_document_summary_pre_prompt_summarystring

A pre_prompt_summary for summary of a freshly imported document (if enabled).

auto_gen_document_summary_prompt_summarystring

A prompt_summary for summary of a freshly imported document (if enabled).`

auto_gen_document_sample_questions_promptstring

A prompt to create sample questions for a freshly imported document (if enabled).

default_sample_questionsstring[]

Default sample questions in case there are no auto-generated sample questions.

image_batch_image_promptstring

A prompt for each image batch for vision models.

image_batch_final_promptstring

A prompt for each image batch for vision models.

idstring required

A unique identifier of the prompt template.

is_defaultboolean required

A flag identifying if the prompt template is default or not.

user_countinteger

The number of users who have access to the prompt template.

group_countinteger

The number of groups who have access to the prompt template.

usernamestring

Name of the user owning the prompt template.

user_idstring

The unique identifier of the user owning the prompt template.

created_atstring date-time

The moment when the prompt template was created.

updated_atstring date-time

The Last time when the prompt template was modified.

is_publicboolean required

Whether the prompt template is public or private (only applies to custom templates).

visibleboolean

A flag identifying if a default prompt template is visible to system users.

is_system_defaultboolean

A flag identifying if a default prompt template is the system default.

Changes

No recorded changes to this operation across all 1 revision of this API.