API
@julep/sdk / Modules / api
Module: api
Table of contents
References
Classes
Type Aliases
Variables
References
JulepApiClient
Re-exports JulepApiClient
Type Aliases
Agent
Ƭ Agent: Object
Type declaration
Defined in
AgentDefaultSettings
Ƭ AgentDefaultSettings: Object
Type declaration
Defined in
src/api/models/AgentDefaultSettings.ts:5
ChatInput
Ƭ ChatInput: ChatInputData
& ChatSettings
& MemoryAccessOptions
Defined in
ChatInputData
Ƭ ChatInputData: Object
Type declaration
Defined in
src/api/models/ChatInputData.ts:9
ChatMLImageContentPart
Ƭ ChatMLImageContentPart: Object
Type declaration
Defined in
src/api/models/ChatMLImageContentPart.ts:5
ChatMLMessage
Ƭ ChatMLMessage: Object
Type declaration
Defined in
src/api/models/ChatMLMessage.ts:5
ChatMLTextContentPart
Ƭ ChatMLTextContentPart: Object
Type declaration
Defined in
src/api/models/ChatMLTextContentPart.ts:5
ChatResponse
Ƭ ChatResponse: Object
Represents a chat completion response returned by model, based on the provided input.
Type declaration
Defined in
src/api/models/ChatResponse.ts:11
ChatSettings
Ƭ ChatSettings: Object
Type declaration
Defined in
src/api/models/ChatSettings.ts:5
CompletionUsage
Ƭ CompletionUsage: Object
Usage statistics for the completion request.
Type declaration
Defined in
src/api/models/CompletionUsage.ts:8
CreateAgentRequest
Ƭ CreateAgentRequest: Object
A valid request payload for creating an agent
Type declaration
Defined in
src/api/models/CreateAgentRequest.ts:11
CreateDoc
Ƭ CreateDoc: Object
Type declaration
Defined in
CreateSessionRequest
Ƭ CreateSessionRequest: Object
A valid request payload for creating a session
Type declaration
Defined in
src/api/models/CreateSessionRequest.ts:8
CreateToolRequest
Ƭ CreateToolRequest: Object
Type declaration
Defined in
src/api/models/CreateToolRequest.ts:6
CreateUserRequest
Ƭ CreateUserRequest: Object
A valid request payload for creating a user
Type declaration
Defined in
src/api/models/CreateUserRequest.ts:9
Doc
Ƭ Doc: Object
Type declaration
Defined in
DocIds
Ƭ DocIds: Object
Type declaration
Defined in
FunctionCallOption
Ƭ FunctionCallOption: Object
Specifying a particular function via {"name": "my_function"}
forces the model to call that function.
Type declaration
Defined in
src/api/models/FunctionCallOption.ts:9
FunctionDef
Ƭ FunctionDef: Object
Type declaration
Defined in
src/api/models/FunctionDef.ts:6
FunctionParameters
Ƭ FunctionParameters: Record
<string
, any
>
The parameters the functions accepts, described as a JSON Schema object.
Defined in
src/api/models/FunctionParameters.ts:8
InputChatMLMessage
Ƭ InputChatMLMessage: Object
Type declaration
Defined in
src/api/models/InputChatMLMessage.ts:5
JobStatus
Ƭ JobStatus: Object
Type declaration
Defined in
Memory
Ƭ Memory: Object
Type declaration
Defined in
MemoryAccessOptions
Ƭ MemoryAccessOptions: Object
Type declaration
Defined in
src/api/models/MemoryAccessOptions.ts:5
NamedToolChoice
Ƭ NamedToolChoice: Object
Specifies a tool the model should use. Use to force the model to call a specific function.
Type declaration
Defined in
src/api/models/NamedToolChoice.ts:8
OpenAPIConfig
Ƭ OpenAPIConfig: Object
Type declaration
Defined in
PartialFunctionDef
Ƭ PartialFunctionDef: Object
Type declaration
Defined in
src/api/models/PartialFunctionDef.ts:6
PatchAgentRequest
Ƭ PatchAgentRequest: Object
A request for patching an agent
Type declaration
Defined in
src/api/models/PatchAgentRequest.ts:9
PatchSessionRequest
Ƭ PatchSessionRequest: Object
A request for patching a session
Type declaration
Defined in
src/api/models/PatchSessionRequest.ts:8
PatchToolRequest
Ƭ PatchToolRequest: Object
Type declaration
Defined in
src/api/models/PatchToolRequest.ts:6
PatchUserRequest
Ƭ PatchUserRequest: Object
A request for patching a user
Type declaration
Defined in
src/api/models/PatchUserRequest.ts:8
ResourceCreatedResponse
Ƭ ResourceCreatedResponse: Object
Type declaration
Defined in
src/api/models/ResourceCreatedResponse.ts:5
ResourceDeletedResponse
Ƭ ResourceDeletedResponse: Object
Type declaration
Defined in
src/api/models/ResourceDeletedResponse.ts:5
ResourceUpdatedResponse
Ƭ ResourceUpdatedResponse: Object
Type declaration
Defined in
src/api/models/ResourceUpdatedResponse.ts:5
Session
Ƭ Session: Object
Type declaration
Defined in
Suggestion
Ƭ Suggestion: Object
Type declaration
Defined in
src/api/models/Suggestion.ts:5
Tool
Ƭ Tool: Object
Type declaration
Defined in
ToolChoiceOption
Ƭ ToolChoiceOption: "none"
| "auto"
| NamedToolChoice
Controls which (if any) function is called by the model. none
means the model will not call a function and instead generates a message. auto
means the model can pick between generating a message or calling a function. Specifying a particular function via {"type: "function", "function": {"name": "my_function"}}
forces the model to call that function.
none
is the default when no functions are present. auto
is the default if functions are present.
Defined in
src/api/models/ToolChoiceOption.ts:15
UpdateAgentRequest
Ƭ UpdateAgentRequest: Object
A valid request payload for updating an agent
Type declaration
Defined in
src/api/models/UpdateAgentRequest.ts:9
UpdateSessionRequest
Ƭ UpdateSessionRequest: Object
A valid request payload for updating a session
Type declaration
Defined in
src/api/models/UpdateSessionRequest.ts:8
UpdateToolRequest
Ƭ UpdateToolRequest: Object
Type declaration
Defined in
src/api/models/UpdateToolRequest.ts:6
UpdateUserRequest
Ƭ UpdateUserRequest: Object
A valid request payload for updating a user
Type declaration
Defined in
src/api/models/UpdateUserRequest.ts:8
User
Ƭ User: Object
Type declaration
Defined in
agent_id
Ƭ agent_id: string
Defined in
doc_id
Ƭ doc_id: string
Defined in
job_id
Ƭ job_id: string
Defined in
memory_id
Ƭ memory_id: string
Defined in
message_id
Ƭ message_id: string
Defined in
src/api/models/message_id.ts:5
session_id
Ƭ session_id: string
Defined in
src/api/models/session_id.ts:5
tool_id
Ƭ tool_id: string
Defined in
user_id
Ƭ user_id: string
Defined in
Variables
$Agent
• Const
$Agent: Object
Type declaration
Defined in
$AgentDefaultSettings
• Const
$AgentDefaultSettings: Object
Type declaration
Defined in
src/api/schemas/$AgentDefaultSettings.ts:5
$ChatInput
• Const
$ChatInput: Object
Type declaration
Defined in
src/api/schemas/$ChatInput.ts:5
$ChatInputData
• Const
$ChatInputData: Object
Type declaration
Defined in
src/api/schemas/$ChatInputData.ts:5
$ChatMLImageContentPart
• Const
$ChatMLImageContentPart: Object
Type declaration
Defined in
src/api/schemas/$ChatMLImageContentPart.ts:5
$ChatMLMessage
• Const
$ChatMLMessage: Object
Type declaration
Defined in
src/api/schemas/$ChatMLMessage.ts:5
$ChatMLTextContentPart
• Const
$ChatMLTextContentPart: Object
Type declaration
Defined in
src/api/schemas/$ChatMLTextContentPart.ts:5
$ChatResponse
• Const
$ChatResponse: Object
Type declaration
Defined in
src/api/schemas/$ChatResponse.ts:5
$ChatSettings
• Const
$ChatSettings: Object
Type declaration
Defined in
src/api/schemas/$ChatSettings.ts:5
$CompletionUsage
• Const
$CompletionUsage: Object
Type declaration
Defined in
src/api/schemas/$CompletionUsage.ts:5
$CreateAgentRequest
• Const
$CreateAgentRequest: Object
Type declaration
Defined in
src/api/schemas/$CreateAgentRequest.ts:5
$CreateDoc
• Const
$CreateDoc: Object
Type declaration
Defined in
src/api/schemas/$CreateDoc.ts:5
$CreateSessionRequest
• Const
$CreateSessionRequest: Object
Type declaration
Defined in
src/api/schemas/$CreateSessionRequest.ts:5
$CreateToolRequest
• Const
$CreateToolRequest: Object
Type declaration
Defined in
src/api/schemas/$CreateToolRequest.ts:5
$CreateUserRequest
• Const
$CreateUserRequest: Object
Type declaration
Defined in
src/api/schemas/$CreateUserRequest.ts:5
$Doc
• Const
$Doc: Object
Type declaration
Defined in
$DocIds
• Const
$DocIds: Object
Type declaration
Defined in
$FunctionCallOption
• Const
$FunctionCallOption: Object
Type declaration
Defined in
src/api/schemas/$FunctionCallOption.ts:5
$FunctionDef
• Const
$FunctionDef: Object
Type declaration
Defined in
src/api/schemas/$FunctionDef.ts:5
$FunctionParameters
• Const
$FunctionParameters: Object
Type declaration
Defined in
src/api/schemas/$FunctionParameters.ts:5
$InputChatMLMessage
• Const
$InputChatMLMessage: Object
Type declaration
Defined in
src/api/schemas/$InputChatMLMessage.ts:5
$JobStatus
• Const
$JobStatus: Object
Type declaration
Defined in
src/api/schemas/$JobStatus.ts:5
$Memory
• Const
$Memory: Object
Type declaration
Defined in
$MemoryAccessOptions
• Const
$MemoryAccessOptions: Object
Type declaration
Defined in
src/api/schemas/$MemoryAccessOptions.ts:5
$NamedToolChoice
• Const
$NamedToolChoice: Object
Type declaration
Defined in
src/api/schemas/$NamedToolChoice.ts:5
$PartialFunctionDef
• Const
$PartialFunctionDef: Object
Type declaration
Defined in
src/api/schemas/$PartialFunctionDef.ts:5
$PatchAgentRequest
• Const
$PatchAgentRequest: Object
Type declaration
Defined in
src/api/schemas/$PatchAgentRequest.ts:5
$PatchSessionRequest
• Const
$PatchSessionRequest: Object
Type declaration
Defined in
src/api/schemas/$PatchSessionRequest.ts:5
$PatchToolRequest
• Const
$PatchToolRequest: Object
Type declaration
Defined in
src/api/schemas/$PatchToolRequest.ts:5
$PatchUserRequest
• Const
$PatchUserRequest: Object
Type declaration
Defined in
src/api/schemas/$PatchUserRequest.ts:5
$ResourceCreatedResponse
• Const
$ResourceCreatedResponse: Object
Type declaration
Defined in
src/api/schemas/$ResourceCreatedResponse.ts:5
$ResourceDeletedResponse
• Const
$ResourceDeletedResponse: Object
Type declaration
Defined in
src/api/schemas/$ResourceDeletedResponse.ts:5
$ResourceUpdatedResponse
• Const
$ResourceUpdatedResponse: Object
Type declaration
Defined in
src/api/schemas/$ResourceUpdatedResponse.ts:5
$Session
• Const
$Session: Object
Type declaration
Defined in
$Suggestion
• Const
$Suggestion: Object
Type declaration
Defined in
src/api/schemas/$Suggestion.ts:5
$Tool
• Const
$Tool: Object
Type declaration
Defined in
$ToolChoiceOption
• Const
$ToolChoiceOption: Object
Type declaration
Defined in
src/api/schemas/$ToolChoiceOption.ts:5
$UpdateAgentRequest
• Const
$UpdateAgentRequest: Object
Type declaration
Defined in
src/api/schemas/$UpdateAgentRequest.ts:5
$UpdateSessionRequest
• Const
$UpdateSessionRequest: Object
Type declaration
Defined in
src/api/schemas/$UpdateSessionRequest.ts:5
$UpdateToolRequest
• Const
$UpdateToolRequest: Object
Type declaration
Defined in
src/api/schemas/$UpdateToolRequest.ts:5
$UpdateUserRequest
• Const
$UpdateUserRequest: Object
Type declaration
Defined in
src/api/schemas/$UpdateUserRequest.ts:5
$User
• Const
$User: Object
Type declaration
Defined in
$agent_id
• Const
$agent_id: Object
Type declaration
Defined in
src/api/schemas/$agent_id.ts:5
$doc_id
• Const
$doc_id: Object
Type declaration
Defined in
$job_id
• Const
$job_id: Object
Type declaration
Defined in
$memory_id
• Const
$memory_id: Object
Type declaration
Defined in
src/api/schemas/$memory_id.ts:5
$message_id
• Const
$message_id: Object
Type declaration
Defined in
src/api/schemas/$message_id.ts:5
$session_id
• Const
$session_id: Object
Type declaration
Defined in
src/api/schemas/$session_id.ts:5
$tool_id
• Const
$tool_id: Object
Type declaration
Defined in
$user_id
• Const
$user_id: Object
Type declaration
Defined in
OpenAPI
• Const
OpenAPI: OpenAPIConfig
Defined in
Last updated