Render Endpoint in Julep

​

Overview

Julep provides a render endpoint that allows you to preview how chat inputs will be processed before actually sending them to the model. This is useful for debugging, testing templates, and understanding how the system processes your messages.

​

Purpose

​

Input Structure

The render endpoint accepts the same input structure as the chat endpoint:

• Messages: An array of input messages representing the conversation so far.
• Tools: (Advanced) Additional tools provided for this specific interaction.
• Tool Choice: Specifies which tool the agent should use.
• Memory Access: Controls how the session accesses history and memories (recall parameter).
• Additional Parameters: Various parameters to control the behavior of the rendering.

Here’s an example of how a typical message object might be structured in a render request:

  """
  Attributes for the Message object:
      role (Literal["user", "assistant", "system", "tool"]): The role of the message sender.
      tool_call_id (str | None): Optional identifier for a tool call associated with this message.
      content (Annotated[str | list[str] | list[Content | ContentModel7 | ContentModel] | None, Field(...)]): The main content of the message, which can be a string, a list of strings, or a list of content models.
      name (str | None): Optional name associated with the message.
      continue_ (Annotated[StrictBool | None, Field(alias="continue")]): Flag to indicate whether to continue the conversation without interruption.
      tool_calls (list[ChosenFunctionCall | ChosenComputer20241022 | ChosenTextEditor20241022 | ChosenBash20241022] | None): List of tool calls generated during the message creation, if any.
  """
  # Example of a simple message structure
  messages = [{"role": "user", "content": "Your query here"}]

​

Additional Parameters

The render endpoint accepts the same parameters as the chat endpoint:

​

Response Structure

The render endpoint returns a RenderResponse object with the following structure:

{
  "messages": [
    // Array of processed messages that would be sent to the model
  ],
  "docs": [
    // Array of document references that would be used for this request
  ],
  "tools": [
    // Array of formatted tools that would be available to the model
  ]
}

​

Usage

Here’s an example of how to use the render endpoint in Julep using the SDKs:

# Create a session with custom recall options
client.sessions.create(
    agent=agent.id,
    user=user.id,
    recall=True,
    recall_options={
        "mode": "hybrid", # or "vector", "text"
        "num_search_messages": 4, # number of messages to search for documents
        "max_query_length": 1000, # maximum query length
        "alpha": 0.7, # weight to apply to BM25 vs Vector search results (ranges from 0 to 1)
        "confidence": 0.6, # confidence cutoff level (ranges from -1 to 1)
        "limit": 10, # limit of documents to return
        "lang": "en-US", # language to be used for text-only search
        "metadata_filter": {}, # metadata filter to apply to the search
        "mmr_strength": 0, # MMR Strength (ranges from 0 to 1)
    }
)

# Render the chat input without sending to the model
render_response = client.sessions.render(
    session_id=session.id,
    messages=[
        {
            "role": "user",
            "content": "Tell me about Julep"
        }
    ],
    recall=True
)
print("Processed messages:", render_response.messages)
print("Retrieved documents:", render_response.docs)
print("Available tools:", render_response.tools)

​

Use Cases

​

Support

If you need help with further questions in Julep:

• Join our Discord community
• Check the GitHub repository
• Contact support at hey@julep.ai