Chat Features in Julep

​

Overview

Julep provides a robust chat system with various features for dynamic interaction with agents. Here’s an overview of the key components and functionalities.

​

Features

​

Input Structure

• 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 chat. You can find more details in the Additional Parameters section.

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

​

Additional Parameters

​

Usage

Here’s an example of how to use the chat API 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)
    }
)

# Chat in the session
response = client.sessions.chat(
    session_id=session.id,
    messages=[
        {
            "role": "user",
            "content": "Tell me about Julep"
        }
    ],
    recall=True
)
print("Agent's response:", response.choices[0].message.content)
print("Searched Documents:", response.docs)

# Chat with metadata for dynamic system prompts
response_with_metadata = client.sessions.chat(
    session_id=session.id,
    messages=[
        {
            "role": "user",
            "content": "Help me with Python"
        }
    ],
    metadata={
        "language": "Spanish",
        "expertise_level": "beginner",
        "custom_instructions": "Use simple examples"
    }
)
# The metadata will be available in the system template as {{metadata.language}}, etc.

To learn more about the Session object, check out the Session page.

​

Response

Both types of responses include the following fields:

• id: The unique identifier for the chat response
• choices: An object of generated message completions containing:
  • role: The role of the message (e.g. “assistant”, “user”, etc.)
  • id: Unique identifier for the message
  • content: list of actual message content
  • created_at: Timestamp when the message was created
  • name: Optional name associated with the message
  • tool_call_id: Optional ID referencing a tool call
  • tool_calls: Optional list of tool calls made during message generation
  • created_at: When this resource was created as UTC date-time
  • docs: List of document references used for this request, intended for citation purposes
  • jobs: List of UUIDs for background jobs that may have been initiated as a result of this interaction
  • usage: Statistics on token usage for the completion request

​

Automatic Tool Calling

Julep supports automatic tool execution during chat interactions. This feature allows tools to be executed seamlessly without manual intervention, making conversations more fluid and responsive.

​

How It Works

1. When auto_run_tools=true:

   • The model identifies when a tool should be used based on the conversation
   • The tool is automatically executed by Julep’s backend
   • Results are fed back to the model to continue the conversation
   • The entire process happens in a single API call

2. When auto_run_tools=false (default):

   • The model returns tool call requests in the response
   • Your application must execute the tools manually
   • Results need to be sent back in a follow-up message

​

Example with Automatic Tool Execution

# Agent with a weather tool
agent = client.agents.create(
    name="Weather Assistant",
    tools=[
        {
            "name": "get_weather",
            "type": "integration",
            "integration": {"provider": "weather"}
        }
    ]
)

# Chat with automatic tool execution
response = client.sessions.chat(
    session_id=session.id,
    messages=[
        {
            "role": "user",
            "content": "What's the weather like in Tokyo and Paris?"
        }
    ],
    auto_run_tools=True  # Tools execute automatically
)

# The response already includes the weather data
print(response.choices[0].message.content)
# Output: "In Tokyo, it's currently 22°C with clear skies. 
#          In Paris, it's 15°C with light rain."

​

Tool History Management

The recall_tools parameter controls whether tool calls and their results are included when recalling conversation history:

• recall_tools=true (default): Tool interactions are preserved in the conversation history
• recall_tools=false: Tool calls and results are excluded from recalled messages

This is useful when you want to maintain a cleaner conversation history without the technical details of tool executions.

​

Finish Reasons

​

Support

If you need help with further questions in Julep:

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