mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
1004 lines
No EOL
32 KiB
JSON
1004 lines
No EOL
32 KiB
JSON
{
|
|
"id": "inference",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-public.httpResponseIntoObservable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "httpResponseIntoObservable",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
"OperatorFunction",
|
|
"<",
|
|
"StreamedHttpResponse",
|
|
", T>"
|
|
],
|
|
"path": "x-pack/plugins/inference/public/util/http_response_into_observable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "inference",
|
|
"id": "def-public.InferencePublicSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "InferencePublicSetup",
|
|
"description": [],
|
|
"path": "x-pack/plugins/inference/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "inference",
|
|
"id": "def-public.InferencePublicStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "InferencePublicStart",
|
|
"description": [],
|
|
"path": "x-pack/plugins/inference/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-public.InferencePublicStart.chatComplete",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "chatComplete",
|
|
"description": [],
|
|
"signature": [
|
|
"<TToolOptions extends ",
|
|
"ToolOptions",
|
|
"<string> = ",
|
|
"ToolOptions",
|
|
"<string>>(options: { connectorId: string; system?: string | undefined; messages: ",
|
|
{
|
|
"pluginId": "inference",
|
|
"scope": "common",
|
|
"docId": "kibInferencePluginApi",
|
|
"section": "def-common.Message",
|
|
"text": "Message"
|
|
},
|
|
"[]; } & TToolOptions) => ",
|
|
"ChatCompletionResponse",
|
|
"<TToolOptions>"
|
|
],
|
|
"path": "x-pack/plugins/inference/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-public.InferencePublicStart.chatComplete.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"{ connectorId: string; system?: string | undefined; messages: ",
|
|
{
|
|
"pluginId": "inference",
|
|
"scope": "common",
|
|
"docId": "kibInferencePluginApi",
|
|
"section": "def-common.Message",
|
|
"text": "Message"
|
|
},
|
|
"[]; } & TToolOptions"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/chat_complete/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-public.InferencePublicStart.output",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "output",
|
|
"description": [],
|
|
"signature": [
|
|
"<TId extends string = string, TOutputSchema extends ToolSchemaTypeObject | undefined = ToolSchemaTypeObject | undefined>(id: TId, options: { connectorId: string; system?: string | undefined; input: string; schema?: TOutputSchema | undefined; previousMessages?: ",
|
|
{
|
|
"pluginId": "inference",
|
|
"scope": "common",
|
|
"docId": "kibInferencePluginApi",
|
|
"section": "def-common.Message",
|
|
"text": "Message"
|
|
},
|
|
"[] | undefined; }) => ",
|
|
"Observable",
|
|
"<",
|
|
"OutputEvent",
|
|
"<TId, TOutputSchema extends ToolSchemaTypeObject ? ",
|
|
"FromToolSchema",
|
|
"<TOutputSchema> : undefined>>"
|
|
],
|
|
"path": "x-pack/plugins/inference/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-public.InferencePublicStart.output.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"TId"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/output/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-public.InferencePublicStart.output.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"{ connectorId: string; system?: string | undefined; input: string; schema?: TOutputSchema | undefined; previousMessages?: ",
|
|
{
|
|
"pluginId": "inference",
|
|
"scope": "common",
|
|
"docId": "kibInferencePluginApi",
|
|
"section": "def-common.Message",
|
|
"text": "Message"
|
|
},
|
|
"[] | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/output/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-public.InferencePublicStart.getConnectors",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConnectors",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
"InferenceConnector",
|
|
"[]>"
|
|
],
|
|
"path": "x-pack/plugins/inference/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-server.naturalLanguageToEsql",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "naturalLanguageToEsql",
|
|
"description": [],
|
|
"signature": [
|
|
"({\n client,\n connectorId,\n tools,\n toolChoice,\n logger,\n ...rest\n}: ",
|
|
"NlToEsqlTaskParams",
|
|
"<TToolOptions>) => ",
|
|
"Observable",
|
|
"<",
|
|
"NlToEsqlTaskEvent",
|
|
"<TToolOptions>>"
|
|
],
|
|
"path": "x-pack/plugins/inference/server/tasks/nl_to_esql/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-server.naturalLanguageToEsql.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{\n client,\n connectorId,\n tools,\n toolChoice,\n logger,\n ...rest\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"NlToEsqlTaskParams",
|
|
"<TToolOptions>"
|
|
],
|
|
"path": "x-pack/plugins/inference/server/tasks/nl_to_esql/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-server.withoutChunkEvents",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "withoutChunkEvents",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
"OperatorFunction",
|
|
"<T, Exclude<T, ",
|
|
"ChatCompletionChunkEvent",
|
|
">>"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/chat_complete/without_chunk_events.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-server.withoutOutputUpdateEvents",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "withoutOutputUpdateEvents",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
"OperatorFunction",
|
|
"<T, Exclude<T, { id: string; content: string; } & { type: ",
|
|
"OutputEventType",
|
|
".OutputUpdate; }>>"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/output/without_output_update_events.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-server.withoutTokenCountEvents",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "withoutTokenCountEvents",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
"OperatorFunction",
|
|
"<T, Exclude<T, ",
|
|
"ChatCompletionTokenCountEvent",
|
|
">>"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/chat_complete/without_token_count_events.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-server.InferenceClient",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "InferenceClient",
|
|
"description": [],
|
|
"path": "x-pack/plugins/inference/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-server.InferenceClient.chatComplete",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "chatComplete",
|
|
"description": [
|
|
"\n`chatComplete` requests the LLM to generate a response to\na prompt or conversation, which might be plain text\nor a tool call, or a combination of both."
|
|
],
|
|
"signature": [
|
|
"<TToolOptions extends ",
|
|
"ToolOptions",
|
|
"<string> = ",
|
|
"ToolOptions",
|
|
"<string>>(options: { connectorId: string; system?: string | undefined; messages: ",
|
|
{
|
|
"pluginId": "inference",
|
|
"scope": "common",
|
|
"docId": "kibInferencePluginApi",
|
|
"section": "def-common.Message",
|
|
"text": "Message"
|
|
},
|
|
"[]; } & TToolOptions) => ",
|
|
"ChatCompletionResponse",
|
|
"<TToolOptions>"
|
|
],
|
|
"path": "x-pack/plugins/inference/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-server.InferenceClient.chatComplete.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"{ connectorId: string; system?: string | undefined; messages: ",
|
|
{
|
|
"pluginId": "inference",
|
|
"scope": "common",
|
|
"docId": "kibInferencePluginApi",
|
|
"section": "def-common.Message",
|
|
"text": "Message"
|
|
},
|
|
"[]; } & TToolOptions"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/chat_complete/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-server.InferenceClient.output",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "output",
|
|
"description": [
|
|
"\n`output` asks the LLM to generate a structured (JSON)\nresponse based on a schema and a prompt or conversation."
|
|
],
|
|
"signature": [
|
|
"<TId extends string = string, TOutputSchema extends ToolSchemaTypeObject | undefined = ToolSchemaTypeObject | undefined>(id: TId, options: { connectorId: string; system?: string | undefined; input: string; schema?: TOutputSchema | undefined; previousMessages?: ",
|
|
{
|
|
"pluginId": "inference",
|
|
"scope": "common",
|
|
"docId": "kibInferencePluginApi",
|
|
"section": "def-common.Message",
|
|
"text": "Message"
|
|
},
|
|
"[] | undefined; }) => ",
|
|
"Observable",
|
|
"<",
|
|
"OutputEvent",
|
|
"<TId, TOutputSchema extends ToolSchemaTypeObject ? ",
|
|
"FromToolSchema",
|
|
"<TOutputSchema> : undefined>>"
|
|
],
|
|
"path": "x-pack/plugins/inference/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-server.InferenceClient.output.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"TId"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/output/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-server.InferenceClient.output.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"{ connectorId: string; system?: string | undefined; input: string; schema?: TOutputSchema | undefined; previousMessages?: ",
|
|
{
|
|
"pluginId": "inference",
|
|
"scope": "common",
|
|
"docId": "kibInferencePluginApi",
|
|
"section": "def-common.Message",
|
|
"text": "Message"
|
|
},
|
|
"[] | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/output/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-server.InferenceClient.getConnectorById",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConnectorById",
|
|
"description": [
|
|
"\n`getConnectorById` returns an inference connector by id.\nNon-inference connectors will throw an error."
|
|
],
|
|
"signature": [
|
|
"(id: string) => Promise<",
|
|
"InferenceConnector",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/inference/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-server.InferenceClient.getConnectorById.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/inference/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "inference",
|
|
"id": "def-server.InferenceServerSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "InferenceServerSetup",
|
|
"description": [],
|
|
"path": "x-pack/plugins/inference/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "inference",
|
|
"id": "def-server.InferenceServerStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "InferenceServerStart",
|
|
"description": [],
|
|
"path": "x-pack/plugins/inference/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-server.InferenceServerStart.getClient",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getClient",
|
|
"description": [
|
|
"\nCreates an inference client, scoped to a request.\n"
|
|
],
|
|
"signature": [
|
|
"(options: InferenceClientCreateOptions) => ",
|
|
{
|
|
"pluginId": "inference",
|
|
"scope": "server",
|
|
"docId": "kibInferencePluginApi",
|
|
"section": "def-server.InferenceClient",
|
|
"text": "InferenceClient"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/inference/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-server.InferenceServerStart.getClient.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"{@link InferenceClientCreateOptions }"
|
|
],
|
|
"signature": [
|
|
"InferenceClientCreateOptions"
|
|
],
|
|
"path": "x-pack/plugins/inference/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.correctCommonEsqlMistakes",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "correctCommonEsqlMistakes",
|
|
"description": [],
|
|
"signature": [
|
|
"(query: string) => { isCorrection: boolean; input: string; output: string; }"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/tasks/nl_to_esql/correct_common_esql_mistakes.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.correctCommonEsqlMistakes.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/tasks/nl_to_esql/correct_common_esql_mistakes.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.generateFakeToolCallId",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "generateFakeToolCallId",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/chat_complete/generate_fake_tool_call_id.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.isChatCompletionChunkEvent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isChatCompletionChunkEvent",
|
|
"description": [],
|
|
"signature": [
|
|
"(event: ",
|
|
"ChatCompletionEvent",
|
|
"<",
|
|
"ToolOptions",
|
|
"<string>>) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/chat_complete/is_chat_completion_chunk_event.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.isChatCompletionChunkEvent.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "event",
|
|
"description": [],
|
|
"signature": [
|
|
"ChatCompletionEvent",
|
|
"<",
|
|
"ToolOptions",
|
|
"<string>>"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/chat_complete/is_chat_completion_chunk_event.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.isChatCompletionEvent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isChatCompletionEvent",
|
|
"description": [],
|
|
"signature": [
|
|
"(event: ",
|
|
"InferenceTaskEvent",
|
|
") => boolean"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/chat_complete/is_chat_completion_event.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.isChatCompletionEvent.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "event",
|
|
"description": [],
|
|
"signature": [
|
|
"InferenceTaskEvent"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/chat_complete/is_chat_completion_event.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.isChatCompletionMessageEvent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isChatCompletionMessageEvent",
|
|
"description": [],
|
|
"signature": [
|
|
"(event: ",
|
|
"ChatCompletionEvent",
|
|
"<T>) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/chat_complete/is_chat_completion_message_event.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.isChatCompletionMessageEvent.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "event",
|
|
"description": [],
|
|
"signature": [
|
|
"ChatCompletionEvent",
|
|
"<T>"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/chat_complete/is_chat_completion_message_event.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.isOutputCompleteEvent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isOutputCompleteEvent",
|
|
"description": [],
|
|
"signature": [
|
|
"(event: TOutputEvent) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/output/is_output_complete_event.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.isOutputCompleteEvent.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "event",
|
|
"description": [],
|
|
"signature": [
|
|
"TOutputEvent"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/output/is_output_complete_event.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.isOutputEvent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isOutputEvent",
|
|
"description": [],
|
|
"signature": [
|
|
"(event: ",
|
|
"InferenceTaskEvent",
|
|
") => boolean"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/output/is_output_event.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.isOutputEvent.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "event",
|
|
"description": [],
|
|
"signature": [
|
|
"InferenceTaskEvent"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/output/is_output_event.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.isOutputUpdateEvent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isOutputUpdateEvent",
|
|
"description": [],
|
|
"signature": [
|
|
"(event: ",
|
|
"OutputEvent",
|
|
"<string, unknown>) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/output/is_output_update_event.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.isOutputUpdateEvent.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "event",
|
|
"description": [],
|
|
"signature": [
|
|
"OutputEvent",
|
|
"<string, unknown>"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/output/is_output_update_event.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.splitIntoCommands",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "splitIntoCommands",
|
|
"description": [],
|
|
"signature": [
|
|
"(query: string) => { name: string | undefined; command: string; }[]"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/tasks/nl_to_esql/correct_common_esql_mistakes.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.splitIntoCommands.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/tasks/nl_to_esql/correct_common_esql_mistakes.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.MessageRole",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "MessageRole",
|
|
"description": [],
|
|
"path": "x-pack/plugins/inference/common/chat_complete/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.AssistantMessage",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AssistantMessage",
|
|
"description": [],
|
|
"signature": [
|
|
"MessageBase<",
|
|
{
|
|
"pluginId": "inference",
|
|
"scope": "common",
|
|
"docId": "kibInferencePluginApi",
|
|
"section": "def-common.MessageRole",
|
|
"text": "MessageRole"
|
|
},
|
|
".Assistant> & { content: string | null; toolCalls?: ",
|
|
"ToolCall",
|
|
"<string, Record<string, any> | undefined>[] | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/chat_complete/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.Message",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "Message",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "inference",
|
|
"scope": "common",
|
|
"docId": "kibInferencePluginApi",
|
|
"section": "def-common.UserMessage",
|
|
"text": "UserMessage"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "inference",
|
|
"scope": "common",
|
|
"docId": "kibInferencePluginApi",
|
|
"section": "def-common.AssistantMessage",
|
|
"text": "AssistantMessage"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "inference",
|
|
"scope": "common",
|
|
"docId": "kibInferencePluginApi",
|
|
"section": "def-common.ToolMessage",
|
|
"text": "ToolMessage"
|
|
},
|
|
"<unknown>"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/chat_complete/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.ToolMessage",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ToolMessage",
|
|
"description": [],
|
|
"signature": [
|
|
"MessageBase<",
|
|
{
|
|
"pluginId": "inference",
|
|
"scope": "common",
|
|
"docId": "kibInferencePluginApi",
|
|
"section": "def-common.MessageRole",
|
|
"text": "MessageRole"
|
|
},
|
|
".Tool> & { toolCallId: string; response: TToolResponse; }"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/chat_complete/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.ToolSchema",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ToolSchema",
|
|
"description": [],
|
|
"signature": [
|
|
"ToolSchemaTypeObject"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/chat_complete/tool_schema.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "inference",
|
|
"id": "def-common.UserMessage",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UserMessage",
|
|
"description": [],
|
|
"signature": [
|
|
"MessageBase<",
|
|
{
|
|
"pluginId": "inference",
|
|
"scope": "common",
|
|
"docId": "kibInferencePluginApi",
|
|
"section": "def-common.MessageRole",
|
|
"text": "MessageRole"
|
|
},
|
|
".User> & { content: string; }"
|
|
],
|
|
"path": "x-pack/plugins/inference/common/chat_complete/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |