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