-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch '8.x' into backport/8.x/pr-198735
- Loading branch information
Showing
96 changed files
with
1,128 additions
and
545 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# @kbn/inference-common | ||
|
||
Common types and utilities for the inference APIs and features. | ||
|
||
The main purpose of the package is to have a clean line between the inference plugin's | ||
implementation and the underlying types, so that other packages or plugins can leverage the | ||
types without directly depending on the plugin. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License | ||
* 2.0; you may not use this file except in compliance with the Elastic License | ||
* 2.0. | ||
*/ | ||
|
||
export { | ||
MessageRole, | ||
ChatCompletionEventType, | ||
ToolChoiceType, | ||
type Message, | ||
type AssistantMessage, | ||
type ToolMessage, | ||
type UserMessage, | ||
type ToolSchemaType, | ||
type FromToolSchema, | ||
type ToolSchema, | ||
type UnvalidatedToolCall, | ||
type ToolCallsOf, | ||
type ToolCall, | ||
type ToolDefinition, | ||
type ToolOptions, | ||
type FunctionCallingMode, | ||
type ToolChoice, | ||
type ChatCompleteAPI, | ||
type ChatCompleteOptions, | ||
type ChatCompletionResponse, | ||
type ChatCompletionTokenCountEvent, | ||
type ChatCompletionEvent, | ||
type ChatCompletionChunkEvent, | ||
type ChatCompletionChunkToolCall, | ||
type ChatCompletionMessageEvent, | ||
withoutTokenCountEvents, | ||
withoutChunkEvents, | ||
isChatCompletionMessageEvent, | ||
isChatCompletionEvent, | ||
isChatCompletionChunkEvent, | ||
isChatCompletionTokenCountEvent, | ||
ChatCompletionErrorCode, | ||
type ChatCompletionToolNotFoundError, | ||
type ChatCompletionToolValidationError, | ||
type ChatCompletionTokenLimitReachedError, | ||
isToolValidationError, | ||
isTokenLimitReachedError, | ||
isToolNotFoundError, | ||
} from './src/chat_complete'; | ||
export { | ||
OutputEventType, | ||
type OutputAPI, | ||
type OutputResponse, | ||
type OutputCompleteEvent, | ||
type OutputUpdateEvent, | ||
type Output, | ||
type OutputEvent, | ||
isOutputCompleteEvent, | ||
isOutputUpdateEvent, | ||
isOutputEvent, | ||
withoutOutputUpdateEvents, | ||
} from './src/output'; | ||
export { | ||
InferenceTaskEventType, | ||
type InferenceTaskEvent, | ||
type InferenceTaskEventBase, | ||
} from './src/inference_task'; | ||
export { | ||
InferenceTaskError, | ||
InferenceTaskErrorCode, | ||
type InferenceTaskErrorEvent, | ||
type InferenceTaskInternalError, | ||
type InferenceTaskRequestError, | ||
createInferenceInternalError, | ||
createInferenceRequestError, | ||
isInferenceError, | ||
isInferenceInternalError, | ||
isInferenceRequestError, | ||
} from './src/errors'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"type": "shared-common", | ||
"id": "@kbn/inference-common", | ||
"owner": "@elastic/appex-ai-infra" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"name": "@kbn/inference-common", | ||
"private": true, | ||
"version": "1.0.0", | ||
"license": "Elastic License 2.0", | ||
"sideEffects": false | ||
} |
69 changes: 69 additions & 0 deletions
69
x-pack/packages/ai-infra/inference-common/src/chat_complete/api.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License | ||
* 2.0; you may not use this file except in compliance with the Elastic License | ||
* 2.0. | ||
*/ | ||
|
||
import type { Observable } from 'rxjs'; | ||
import type { ToolOptions } from './tools'; | ||
import type { Message } from './messages'; | ||
import type { ChatCompletionEvent } from './events'; | ||
|
||
/** | ||
* Request a completion from the LLM based on a prompt or conversation. | ||
* | ||
* @example using the API to get an event observable. | ||
* ```ts | ||
* const events$ = chatComplete({ | ||
* connectorId: 'my-connector', | ||
* system: "You are a helpful assistant", | ||
* messages: [ | ||
* { role: MessageRole.User, content: "First question?"}, | ||
* { role: MessageRole.Assistant, content: "Some answer"}, | ||
* { role: MessageRole.User, content: "Another question?"}, | ||
* ] | ||
* }); | ||
*/ | ||
export type ChatCompleteAPI = <TToolOptions extends ToolOptions = ToolOptions>( | ||
options: ChatCompleteOptions<TToolOptions> | ||
) => ChatCompletionResponse<TToolOptions>; | ||
|
||
/** | ||
* Options used to call the {@link ChatCompleteAPI} | ||
*/ | ||
export type ChatCompleteOptions<TToolOptions extends ToolOptions = ToolOptions> = { | ||
/** | ||
* The ID of the connector to use. | ||
* Must be a genAI compatible connector, or an error will be thrown. | ||
*/ | ||
connectorId: string; | ||
/** | ||
* Optional system message for the LLM. | ||
*/ | ||
system?: string; | ||
/** | ||
* The list of messages for the current conversation | ||
*/ | ||
messages: Message[]; | ||
/** | ||
* Function calling mode, defaults to "native". | ||
*/ | ||
functionCalling?: FunctionCallingMode; | ||
} & TToolOptions; | ||
|
||
/** | ||
* Response from the {@link ChatCompleteAPI}. | ||
* | ||
* Observable of {@link ChatCompletionEvent} | ||
*/ | ||
export type ChatCompletionResponse<TToolOptions extends ToolOptions = ToolOptions> = Observable< | ||
ChatCompletionEvent<TToolOptions> | ||
>; | ||
|
||
/** | ||
* Define the function calling mode when using inference APIs. | ||
* - native will use the LLM's native function calling (requires the LLM to have native support) | ||
* - simulated: will emulate function calling with function calling instructions | ||
*/ | ||
export type FunctionCallingMode = 'native' | 'simulated'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.