Skip to main content

Class: Portkey

Unified language model interface

Extends​

Constructors​

new Portkey()​

new Portkey(init?): Portkey

Parameters​

• init?: Partial<Portkey>

Returns​

Portkey

Overrides​

BaseLLM.constructor

Defined in​

packages/llamaindex/src/llm/portkey.ts:76

Properties​

apiKey?​

optional apiKey: string = undefined

Defined in​

packages/llamaindex/src/llm/portkey.ts:70

baseURL?​

optional baseURL: string = undefined

Defined in​

packages/llamaindex/src/llm/portkey.ts:71

llms?​

optional llms: null | [LLMOptions] = undefined

Defined in​

packages/llamaindex/src/llm/portkey.ts:73

mode?​

optional mode: string = undefined

Defined in​

packages/llamaindex/src/llm/portkey.ts:72

session​

session: PortkeySession

Defined in​

packages/llamaindex/src/llm/portkey.ts:74

Accessors​

metadata​

get metadata(): LLMMetadata

Returns​

LLMMetadata

Overrides​

BaseLLM.metadata

Defined in​

packages/llamaindex/src/llm/portkey.ts:90

Methods​

chat()​

chat(params)​

chat(params): Promise<AsyncIterable<ChatResponseChunk>>

Get a chat response from the LLM

Parameters​

• params: LLMChatParamsStreaming<object, object>

Returns​

Promise<AsyncIterable<ChatResponseChunk>>

Overrides​

BaseLLM.chat

Defined in​

packages/llamaindex/src/llm/portkey.ts:94

chat(params)​

chat(params): Promise<ChatResponse<object>>

Get a chat response from the LLM

Parameters​

• params: LLMChatParamsNonStreaming<object, object>

Returns​

Promise<ChatResponse<object>>

Overrides​

BaseLLM.chat

Defined in​

packages/llamaindex/src/llm/portkey.ts:97

complete()​

complete(params)​

complete(params): Promise<AsyncIterable<CompletionResponse>>

Get a prompt completion from the LLM

Parameters​

• params: LLMCompletionParamsStreaming

Returns​

Promise<AsyncIterable<CompletionResponse>>

Inherited from​

BaseLLM.complete

Defined in​

packages/core/dist/llms/index.d.ts:168

complete(params)​

complete(params): Promise<CompletionResponse>

Get a prompt completion from the LLM

Parameters​

• params: LLMCompletionParamsNonStreaming

Returns​

Promise<CompletionResponse>

Inherited from​

BaseLLM.complete

Defined in​

packages/core/dist/llms/index.d.ts:169

streamChat()​

streamChat(messages, params?): AsyncIterable<ChatResponseChunk>

Parameters​

• messages: ChatMessage[]

• params?: Record<string, any>

Returns​

AsyncIterable<ChatResponseChunk>

Defined in​

packages/llamaindex/src/llm/portkey.ts:121