Session

@julep/sdk / Modules / managers/session / SessionsManager

Class: SessionsManager

managers/session.SessionsManager

BaseManager serves as the base class for all manager classes that interact with the Julep API. It provides common functionality needed for API interactions.

Hierarchy

• BaseManager

  ↳ SessionsManager

Table of contents

Constructors

• constructor

Properties

• apiClient

Methods

• chat

• create

• delete

• deleteHistory

• get

• history

• list

• suggestions

• update

Constructors

constructor

• new SessionsManager(apiClient): SessionsManager

Constructs a new instance of BaseManager.

Parameters

Name	Type	Description
apiClient	JulepApiClient	The JulepApiClient instance used for API interactions.

Returns

SessionsManager

Inherited from

BaseManager.constructor

Defined in

src/managers/base.ts:14

Properties

apiClient

• apiClient: JulepApiClient

The JulepApiClient instance used for API interactions.

Inherited from

BaseManager.apiClient

Defined in

src/managers/base.ts:14

Methods

chat

▸ chat(sessionId, input): Promise<ChatResponse>

Parameters

Name	Type
sessionId	string & Format<"uuid">
input	ChatInput

Returns

Promise<ChatResponse>

Defined in

src/managers/session.ts:161

---

create

▸ create(payload): Promise<ResourceCreatedResponse>

Parameters

Name	Type
payload	CreateSessionPayload

Returns

Promise<ResourceCreatedResponse>

Defined in

src/managers/session.ts:39

---

delete

▸ delete(sessionId): Promise<void>

Parameters

Name	Type
sessionId	string & Format<"uuid">

Returns

Promise<void>

Defined in

src/managers/session.ts:109

---

deleteHistory

▸ deleteHistory(sessionId): Promise<void>

Parameters

Name	Type
sessionId	string & Format<"uuid">

Returns

Promise<void>

Defined in

src/managers/session.ts:263

---

get

▸ get(sessionId): Promise<Session>

Retrieves a session by its ID.

Parameters

Name	Type	Description
sessionId	string & Format<"uuid">	The unique identifier of the session.

Returns

Promise<Session>

A promise that resolves with the session object.

Defined in

src/managers/session.ts:33

---

history

▸ history(sessionId, options?): Promise<ChatMLMessage[]>

Parameters

Name	Type
sessionId	string & Format<"uuid">
options	Object
options.limit?	number & Minimum<1> & Maximum<1000>
options.offset?	number & Minimum<0>

Returns

Promise<ChatMLMessage[]>

Defined in

src/managers/session.ts:240

---

list

▸ list(options?): Promise<Session[]>

Parameters

Name	Type
options	Object
options.limit?	number & Type<"uint32"> & Minimum<1> & Maximum<1000>
options.metadataFilter?	Object
options.offset?	number & Minimum<1> & Maximum<1000>

Returns

Promise<Session[]>

Defined in

src/managers/session.ts:75

---

suggestions

▸ suggestions(sessionId, options?): Promise<Suggestion[]>

Parameters

Name	Type
sessionId	string & Format<"uuid">
options	Object
options.limit?	number & Minimum<1> & Maximum<1000>
options.offset?	number & Minimum<0>

Returns

Promise<Suggestion[]>

Defined in

src/managers/session.ts:217

---

update

▸ update(sessionId, options, overwrite?): Promise<ResourceUpdatedResponse>

Parameters

Name	Type	Default value
sessionId	string & Format<"uuid">	undefined
options	Object	undefined
options.contextOverflow?	"truncate" | "adaptive"	undefined
options.metadata?	Record<string, any>	undefined
options.situation	string	undefined
options.tokenBudget?	number & Minimum<1>	undefined
overwrite	boolean	false

Returns

Promise<ResourceUpdatedResponse>

Defined in

src/managers/session.ts:115