github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_inference_common.devdocs.json

4251 lines
No EOL
154 KiB
JSON
Raw Blame History

{
"id": "@kbn/inference-common",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.Tokenizer",
"type": "Class",
"tags": [],
"label": "Tokenizer",
"description": [],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/utils/tokenizer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.Tokenizer.count",
"type": "Function",
"tags": [],
"label": "count",
"description": [
"\nApproximates the number of tokens in a string,\nassuming 4 characters per token."
],
"signature": [
"(input: string) => number"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/utils/tokenizer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.Tokenizer.count.$1",
"type": "string",
"tags": [],
"label": "input",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/utils/tokenizer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.Tokenizer.truncate",
"type": "Function",
"tags": [],
"label": "truncate",
"description": [
"\nIf the text is longer than the amount of tokens,\ntruncate and mark as truncated."
],
"signature": [
"(input: string, maxTokens: number) => { tokens: number; truncated: boolean; text: string; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/utils/tokenizer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.Tokenizer.truncate.$1",
"type": "string",
"tags": [],
"label": "input",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/utils/tokenizer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.Tokenizer.truncate.$2",
"type": "number",
"tags": [],
"label": "maxTokens",
"description": [],
"signature": [
"number"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/utils/tokenizer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.connectorToInference",
"type": "Function",
"tags": [],
"label": "connectorToInference",
"description": [
"\nConverts an action connector to the internal inference connector format.\n\nThe function will throw if the provided connector is not compatible"
],
"signature": [
"(connector: ",
"RawConnector",
") => ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.InferenceConnector",
"text": "InferenceConnector"
}
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/connector_to_inference.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.connectorToInference.$1",
"type": "Object",
"tags": [],
"label": "connector",
"description": [],
"signature": [
"RawConnector"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/connector_to_inference.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.createInferenceInternalError",
"type": "Function",
"tags": [],
"label": "createInferenceInternalError",
"description": [],
"signature": [
"(message: string, meta: Record<string, any> | undefined) => ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.InferenceTaskInternalError",
"text": "InferenceTaskInternalError"
}
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.createInferenceInternalError.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.createInferenceInternalError.$2",
"type": "Object",
"tags": [],
"label": "meta",
"description": [],
"signature": [
"Record<string, any> | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.createInferenceProviderError",
"type": "Function",
"tags": [],
"label": "createInferenceProviderError",
"description": [],
"signature": [
"(message: string, meta: { status?: number | undefined; } | undefined) => ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.InferenceTaskProviderError",
"text": "InferenceTaskProviderError"
}
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.createInferenceProviderError.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.createInferenceProviderError.$2",
"type": "Object",
"tags": [],
"label": "meta",
"description": [],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.createInferenceProviderError.$2.status",
"type": "number",
"tags": [],
"label": "status",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.createInferenceRequestAbortedError",
"type": "Function",
"tags": [],
"label": "createInferenceRequestAbortedError",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.InferenceTaskAbortedError",
"text": "InferenceTaskAbortedError"
}
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.createInferenceRequestError",
"type": "Function",
"tags": [],
"label": "createInferenceRequestError",
"description": [],
"signature": [
"(message: string, status: number) => ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.InferenceTaskRequestError",
"text": "InferenceTaskRequestError"
}
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.createInferenceRequestError.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.createInferenceRequestError.$2",
"type": "number",
"tags": [],
"label": "status",
"description": [],
"signature": [
"number"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.generateFakeToolCallId",
"type": "Function",
"tags": [],
"label": "generateFakeToolCallId",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/utils/tool_calls.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.getConnectorDefaultModel",
"type": "Function",
"tags": [],
"label": "getConnectorDefaultModel",
"description": [
"\nReturns the default model as defined in the connector's config, if available.\n\nNote: preconfigured connectors only expose their config if their `exposeConfig` flag\nis set to true."
],
"signature": [
"(connector: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.InferenceConnector",
"text": "InferenceConnector"
},
") => string | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/connector_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.getConnectorDefaultModel.$1",
"type": "Object",
"tags": [],
"label": "connector",
"description": [],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.InferenceConnector",
"text": "InferenceConnector"
}
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/connector_config.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.getConnectorModel",
"type": "Function",
"tags": [],
"label": "getConnectorModel",
"description": [
"\nGuesses the model based on the connector type and configuration.\n\nInferred from the type for \"legacy\" connectors,\nand from the provider config field for inference connectors."
],
"signature": [
"(connector: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.InferenceConnector",
"text": "InferenceConnector"
},
") => string | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/get_connector_model.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.getConnectorModel.$1",
"type": "Object",
"tags": [],
"label": "connector",
"description": [],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.InferenceConnector",
"text": "InferenceConnector"
}
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/get_connector_model.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.getConnectorProvider",
"type": "Function",
"tags": [],
"label": "getConnectorProvider",
"description": [
"\nReturns the provider used for the given connector\n\nInferred from the type for \"legacy\" connectors,\nand from the provider config field for inference connectors."
],
"signature": [
"(connector: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.InferenceConnector",
"text": "InferenceConnector"
},
") => string"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/connector_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.getConnectorProvider.$1",
"type": "Object",
"tags": [],
"label": "connector",
"description": [],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.InferenceConnector",
"text": "InferenceConnector"
}
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/connector_config.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isChatCompletionChunkEvent",
"type": "Function",
"tags": [],
"label": "isChatCompletionChunkEvent",
"description": [
"\nCheck if the provided {@link ChatCompletionEvent} is a {@link ChatCompletionChunkEvent}"
],
"signature": [
"(event: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionEvent",
"text": "ChatCompletionEvent"
},
"<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolOptions",
"text": "ToolOptions"
},
"<string>>) => boolean"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/event_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isChatCompletionChunkEvent.$1",
"type": "CompoundType",
"tags": [],
"label": "event",
"description": [],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionEvent",
"text": "ChatCompletionEvent"
},
"<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolOptions",
"text": "ToolOptions"
},
"<string>>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/event_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isChatCompletionEvent",
"type": "Function",
"tags": [],
"label": "isChatCompletionEvent",
"description": [
"\nCheck if the provided {@link InferenceTaskEvent} is a {@link ChatCompletionEvent}"
],
"signature": [
"(event: Record<string, unknown> & { type: string; }) => boolean"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/event_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isChatCompletionEvent.$1",
"type": "CompoundType",
"tags": [],
"label": "event",
"description": [],
"signature": [
"Record<string, unknown> & { type: string; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/event_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isChatCompletionMessageEvent",
"type": "Function",
"tags": [],
"label": "isChatCompletionMessageEvent",
"description": [
"\nCheck if the provided {@link ChatCompletionEvent} is a {@link ChatCompletionMessageEvent}"
],
"signature": [
"(event: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionEvent",
"text": "ChatCompletionEvent"
},
"<T>) => boolean"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/event_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isChatCompletionMessageEvent.$1",
"type": "CompoundType",
"tags": [],
"label": "event",
"description": [],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionEvent",
"text": "ChatCompletionEvent"
},
"<T>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/event_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isChatCompletionTokenCountEvent",
"type": "Function",
"tags": [],
"label": "isChatCompletionTokenCountEvent",
"description": [
"\nCheck if the provided {@link ChatCompletionEvent} is a {@link ChatCompletionMessageEvent}"
],
"signature": [
"(event: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionEvent",
"text": "ChatCompletionEvent"
},
"<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolOptions",
"text": "ToolOptions"
},
"<string>>) => boolean"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/event_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isChatCompletionTokenCountEvent.$1",
"type": "CompoundType",
"tags": [],
"label": "event",
"description": [],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionEvent",
"text": "ChatCompletionEvent"
},
"<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolOptions",
"text": "ToolOptions"
},
"<string>>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/event_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isInferenceError",
"type": "Function",
"tags": [],
"label": "isInferenceError",
"description": [
"\nCheck if the given error is an {@link InferenceTaskError}"
],
"signature": [
"(error: unknown) => boolean"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isInferenceError.$1",
"type": "Unknown",
"tags": [],
"label": "error",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isInferenceInternalError",
"type": "Function",
"tags": [],
"label": "isInferenceInternalError",
"description": [
"\nCheck if the given error is an {@link InferenceTaskInternalError}"
],
"signature": [
"(error: unknown) => boolean"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isInferenceInternalError.$1",
"type": "Unknown",
"tags": [],
"label": "error",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isInferenceProviderError",
"type": "Function",
"tags": [],
"label": "isInferenceProviderError",
"description": [
"\nCheck if the given error is an {@link InferenceTaskProviderError}"
],
"signature": [
"(error: unknown) => boolean"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isInferenceProviderError.$1",
"type": "Unknown",
"tags": [],
"label": "error",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isInferenceRequestAbortedError",
"type": "Function",
"tags": [],
"label": "isInferenceRequestAbortedError",
"description": [
"\nCheck if the given error is an {@link InferenceTaskAbortedError}"
],
"signature": [
"(error: unknown) => boolean"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isInferenceRequestAbortedError.$1",
"type": "Unknown",
"tags": [],
"label": "error",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isInferenceRequestError",
"type": "Function",
"tags": [],
"label": "isInferenceRequestError",
"description": [
"\nCheck if the given error is an {@link InferenceTaskRequestError}"
],
"signature": [
"(error: unknown) => boolean"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isInferenceRequestError.$1",
"type": "Unknown",
"tags": [],
"label": "error",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isOutputCompleteEvent",
"type": "Function",
"tags": [],
"label": "isOutputCompleteEvent",
"description": [
"\nCheck if the provided {@link ChatCompletionEvent} is a {@link ChatCompletionChunkEvent}"
],
"signature": [
"(event: TOutputEvent) => boolean"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/event_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isOutputCompleteEvent.$1",
"type": "Uncategorized",
"tags": [],
"label": "event",
"description": [],
"signature": [
"TOutputEvent"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/event_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isOutputEvent",
"type": "Function",
"tags": [],
"label": "isOutputEvent",
"description": [
"\nCheck if the provided {@link InferenceTaskEvent} is a {@link OutputEvent}"
],
"signature": [
"(event: Record<string, unknown> & { type: string; }) => boolean"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/event_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isOutputEvent.$1",
"type": "CompoundType",
"tags": [],
"label": "event",
"description": [],
"signature": [
"Record<string, unknown> & { type: string; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/event_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isOutputUpdateEvent",
"type": "Function",
"tags": [],
"label": "isOutputUpdateEvent",
"description": [
"\nCheck if the provided {@link OutputEvent} is a {@link OutputUpdateEvent}"
],
"signature": [
"(event: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputEvent",
"text": "OutputEvent"
},
"<string, unknown>) => boolean"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/event_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isOutputUpdateEvent.$1",
"type": "CompoundType",
"tags": [],
"label": "event",
"description": [],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputEvent",
"text": "OutputEvent"
},
"<string, unknown>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/event_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isSupportedConnector",
"type": "Function",
"tags": [],
"label": "isSupportedConnector",
"description": [
"\nChecks if a given connector is compatible for inference.\n\nA connector is compatible if:\n1. its type is in the list of allowed types\n2. for inference connectors, if its taskType is \"chat_completion\""
],
"signature": [
"(connector: ",
"RawConnector",
") => boolean"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/is_supported_connector.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isSupportedConnector.$1",
"type": "Object",
"tags": [],
"label": "connector",
"description": [],
"signature": [
"RawConnector"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/is_supported_connector.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isSupportedConnectorType",
"type": "Function",
"tags": [],
"label": "isSupportedConnectorType",
"description": [
"\nChecks if a given connector type is compatible for inference.\n\nNote: this check is not sufficient to assert if a given connector can be\nused for inference, as `.inference` connectors need additional check logic.\nPlease use `isSupportedConnector` instead when possible."
],
"signature": [
"(id: string) => boolean"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/is_supported_connector.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isSupportedConnectorType.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/is_supported_connector.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isTokenLimitReachedError",
"type": "Function",
"tags": [],
"label": "isTokenLimitReachedError",
"description": [
"\nCheck if an error is a {@link ChatCompletionTokenLimitReachedError}"
],
"signature": [
"(error: Error) => boolean"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isTokenLimitReachedError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isToolNotFoundError",
"type": "Function",
"tags": [],
"label": "isToolNotFoundError",
"description": [
"\nCheck if an error is a {@link ChatCompletionToolNotFoundError}"
],
"signature": [
"(error: Error) => boolean"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isToolNotFoundError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isToolValidationError",
"type": "Function",
"tags": [],
"label": "isToolValidationError",
"description": [
"\nCheck if an error is a {@link ChatCompletionToolValidationError}"
],
"signature": [
"(error: Error | undefined) => boolean"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.isToolValidationError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.truncateList",
"type": "Function",
"tags": [],
"label": "truncateList",
"description": [],
"signature": [
"(values: T[], limit: number) => (string | T)[]"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/truncate_list.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.truncateList.$1",
"type": "Array",
"tags": [],
"label": "values",
"description": [],
"signature": [
"T[]"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/truncate_list.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.truncateList.$2",
"type": "number",
"tags": [],
"label": "limit",
"description": [],
"signature": [
"number"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/truncate_list.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.withoutChunkEvents",
"type": "Function",
"tags": [],
"label": "withoutChunkEvents",
"description": [
"\nOperator filtering out the chunk events from the provided observable."
],
"signature": [
"() => ",
"OperatorFunction",
"<T, Exclude<T, { content: string; tool_calls: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionChunkToolCall",
"text": "ChatCompletionChunkToolCall"
},
"[]; } & { type: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionEventType",
"text": "ChatCompletionEventType"
},
".ChatCompletionChunk; }>>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/event_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.withoutOutputUpdateEvents",
"type": "Function",
"tags": [],
"label": "withoutOutputUpdateEvents",
"description": [
"\nOperator filtering out the update events from the provided observable."
],
"signature": [
"() => ",
"OperatorFunction",
"<T, Exclude<T, { id: string; content: string; } & { type: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputEventType",
"text": "OutputEventType"
},
".OutputUpdate; }>>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/event_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.withoutTokenCountEvents",
"type": "Function",
"tags": [],
"label": "withoutTokenCountEvents",
"description": [
"\nOperator filtering out the token count events from the provided observable."
],
"signature": [
"() => ",
"OperatorFunction",
"<T, Exclude<T, { tokens: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionTokenCount",
"text": "ChatCompletionTokenCount"
},
"; } & { type: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionEventType",
"text": "ChatCompletionEventType"
},
".ChatCompletionTokenCount; }>>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/event_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompleteMetadata",
"type": "Interface",
"tags": [],
"label": "ChatCompleteMetadata",
"description": [
"\nSet of metadata that can be used then calling the inference APIs\n"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/metadata.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompleteMetadata.connectorTelemetry",
"type": "Object",
"tags": [],
"label": "connectorTelemetry",
"description": [],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ConnectorTelemetryMetadata",
"text": "ConnectorTelemetryMetadata"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/metadata.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompleteResponse",
"type": "Interface",
"tags": [],
"label": "ChatCompleteResponse",
"description": [
"\nResponse from the {@link ChatCompleteAPI} when streaming is not enabled."
],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteResponse",
"text": "ChatCompleteResponse"
},
"<TToolOptions>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompleteResponse.content",
"type": "string",
"tags": [],
"label": "content",
"description": [
"\nThe text content of the LLM response."
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompleteResponse.toolCalls",
"type": "Uncategorized",
"tags": [],
"label": "toolCalls",
"description": [
"\nThe eventual tool calls performed by the LLM."
],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolCallsOf",
"text": "ToolCallsOf"
},
"<TToolOptions>[\"toolCalls\"]"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompleteResponse.tokens",
"type": "Object",
"tags": [],
"label": "tokens",
"description": [
"\nToken counts"
],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionTokenCount",
"text": "ChatCompletionTokenCount"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/api.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompleteRetryConfiguration",
"type": "Interface",
"tags": [],
"label": "ChatCompleteRetryConfiguration",
"description": [],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompleteRetryConfiguration.retryOn",
"type": "CompoundType",
"tags": [],
"label": "retryOn",
"description": [
"\nDefines the strategy for error retry\n\nEither one of\n- all: will retry all errors\n- auto: will only retry errors that could be recoverable (e.g rate limit, connectivity)\nOf a custom function to manually handle filtering\n\nDefaults to \"auto\""
],
"signature": [
"\"all\" | \"auto\" | ((err: Error) => boolean) | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompleteRetryConfiguration.initialDelay",
"type": "number",
"tags": [],
"label": "initialDelay",
"description": [
"\nThe initial delay for incremental backoff, in ms.\n\nDefaults to 1000."
],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompleteRetryConfiguration.backoffMultiplier",
"type": "number",
"tags": [],
"label": "backoffMultiplier",
"description": [
"\nThe backoff exponential multiplier.\n\nDefaults to 2."
],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/api.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompletionChunkToolCall",
"type": "Interface",
"tags": [],
"label": "ChatCompletionChunkToolCall",
"description": [
"\nRepresent a partial tool call present in a chunk event.\n\nNote that all properties of the structure, except from the index,\nare partial and must be aggregated."
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompletionChunkToolCall.index",
"type": "number",
"tags": [],
"label": "index",
"description": [
"\nThe tool call index (position in the tool call array)."
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompletionChunkToolCall.toolCallId",
"type": "string",
"tags": [],
"label": "toolCallId",
"description": [
"\nchunk of tool call id."
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompletionChunkToolCall.function",
"type": "Object",
"tags": [],
"label": "function",
"description": [],
"signature": [
"{ name: string; arguments: string; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/events.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompletionTokenCount",
"type": "Interface",
"tags": [],
"label": "ChatCompletionTokenCount",
"description": [
"\nToken count structure for the chatComplete API."
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompletionTokenCount.prompt",
"type": "number",
"tags": [],
"label": "prompt",
"description": [
"\nInput token count"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompletionTokenCount.completion",
"type": "number",
"tags": [],
"label": "completion",
"description": [
"\nOutput token count"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompletionTokenCount.total",
"type": "number",
"tags": [],
"label": "total",
"description": [
"\nTotal token count"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/events.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ConnectorTelemetryMetadata",
"type": "Interface",
"tags": [],
"label": "ConnectorTelemetryMetadata",
"description": [
"\nPass through for the connector telemetry"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/metadata.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ConnectorTelemetryMetadata.pluginId",
"type": "string",
"tags": [],
"label": "pluginId",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/metadata.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ConnectorTelemetryMetadata.aggregateBy",
"type": "string",
"tags": [],
"label": "aggregateBy",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/metadata.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceConnector",
"type": "Interface",
"tags": [],
"label": "InferenceConnector",
"description": [
"\nRepresents a stack connector that can be used for inference."
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/connectors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceConnector.type",
"type": "Enum",
"tags": [],
"label": "type",
"description": [
"the type of the connector, see {@link InferenceConnectorType}"
],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.InferenceConnectorType",
"text": "InferenceConnectorType"
}
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/connectors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceConnector.name",
"type": "string",
"tags": [],
"label": "name",
"description": [
"the name of the connector"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/connectors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceConnector.connectorId",
"type": "string",
"tags": [],
"label": "connectorId",
"description": [
"the id of the connector"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/connectors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceConnector.config",
"type": "Object",
"tags": [],
"label": "config",
"description": [
"\nconfiguration (without secrets) of the connector.\nthe list of properties depends on the connector type (and subtype for inference)"
],
"signature": [
"{ [x: string]: any; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/connectors.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.MessageContentImage",
"type": "Interface",
"tags": [],
"label": "MessageContentImage",
"description": [],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/messages.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.MessageContentImage.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"image\""
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/messages.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.MessageContentImage.source",
"type": "Object",
"tags": [],
"label": "source",
"description": [],
"signature": [
"{ data: string; mimeType: string; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/messages.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.MessageContentText",
"type": "Interface",
"tags": [],
"label": "MessageContentText",
"description": [],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/messages.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.MessageContentText.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"text\""
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/messages.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.MessageContentText.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/messages.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputOptions",
"type": "Interface",
"tags": [],
"label": "OutputOptions",
"description": [
"\nOptions for the {@link OutputAPI}"
],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputOptions",
"text": "OutputOptions"
},
"<TId, TOutputSchema, TStream>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputOptions.id",
"type": "Uncategorized",
"tags": [],
"label": "id",
"description": [
"\nThe id of the operation."
],
"signature": [
"TId"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputOptions.connectorId",
"type": "string",
"tags": [],
"label": "connectorId",
"description": [
"\nThe ID of the connector to use.\nMust be an inference connector, or an error will be thrown."
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputOptions.system",
"type": "string",
"tags": [],
"label": "system",
"description": [
"\nOptional system message for the LLM."
],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputOptions.input",
"type": "string",
"tags": [],
"label": "input",
"description": [
"\nThe prompt for the LLM."
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputOptions.schema",
"type": "Uncategorized",
"tags": [],
"label": "schema",
"description": [
"\nThe schema the response from the LLM should adhere to."
],
"signature": [
"TOutputSchema | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputOptions.previousMessages",
"type": "Array",
"tags": [],
"label": "previousMessages",
"description": [
"\nPrevious messages in the conversation.\nIf provided, will be passed to the LLM in addition to `input`."
],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.Message",
"text": "Message"
},
"[] | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputOptions.modelName",
"type": "string",
"tags": [],
"label": "modelName",
"description": [
"\nThe model name identifier to use. Can be defined to use another model than the\ndefault one, when using connectors / providers exposing multiple models.\n\nDefaults to the default model as defined by the used connector."
],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputOptions.functionCalling",
"type": "CompoundType",
"tags": [],
"label": "functionCalling",
"description": [
"\nFunction calling mode, defaults to \"auto\"."
],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.FunctionCallingMode",
"text": "FunctionCallingMode"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputOptions.stream",
"type": "Uncategorized",
"tags": [],
"label": "stream",
"description": [
"\nSet to true to enable streaming, which will change the API response type from\na single promise to an event observable.\n\nDefaults to false."
],
"signature": [
"TStream | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputOptions.abortSignal",
"type": "Object",
"tags": [],
"label": "abortSignal",
"description": [
"\nOptional signal that can be used to forcefully abort the request."
],
"signature": [
"AbortSignal | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputOptions.maxRetries",
"type": "number",
"tags": [],
"label": "maxRetries",
"description": [
"\nThe maximum amount of times to retry in case of error returned from the provider.\n\nDefaults to 3."
],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputOptions.retryConfiguration",
"type": "Object",
"tags": [],
"label": "retryConfiguration",
"description": [
"\nOptional configuration for the retry mechanism.\n\nNote that defaults are very fine, so only use this if you really have a reason to do so."
],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteRetryConfiguration",
"text": "ChatCompleteRetryConfiguration"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputOptions.retry",
"type": "Object",
"tags": [],
"label": "retry",
"description": [
"\nOptional configuration for retrying the call if output-specific error occurs."
],
"signature": [
"{ onValidationError?: number | boolean | undefined; } | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputOptions.metadata",
"type": "Object",
"tags": [],
"label": "metadata",
"description": [
"\nOptional metadata related to call execution."
],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteMetadata",
"text": "ChatCompleteMetadata"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputResponse",
"type": "Interface",
"tags": [],
"label": "OutputResponse",
"description": [
"\nResponse from the {@link OutputAPI} when streaming is not enabled."
],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputResponse",
"text": "OutputResponse"
},
"<TId, TOutput>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputResponse.id",
"type": "Uncategorized",
"tags": [],
"label": "id",
"description": [
"\nThe id of the operation, as specified when calling the API."
],
"signature": [
"TId"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputResponse.output",
"type": "Uncategorized",
"tags": [],
"label": "output",
"description": [
"\nThe task output, following the schema specified as input."
],
"signature": [
"TOutput"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputResponse.content",
"type": "string",
"tags": [],
"label": "content",
"description": [
"\nPotential text content provided by the LLM, if it was provided in addition to the tool call."
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ToolCall",
"type": "Interface",
"tags": [],
"label": "ToolCall",
"description": [
"\nRepresents a tool call performed by the LLM."
],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolCall",
"text": "ToolCall"
},
"<TName, TArguments>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tools.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ToolCall.toolCallId",
"type": "string",
"tags": [],
"label": "toolCallId",
"description": [
"\nThe id of the tool call, that must be re-used when providing the tool call response"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tools.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ToolCall.function",
"type": "CompoundType",
"tags": [],
"label": "function",
"description": [],
"signature": [
"{ name: TName; } & (TArguments extends Record<string, any> ? { arguments: TArguments; } : {})"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tools.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ToolDefinition",
"type": "Interface",
"tags": [],
"label": "ToolDefinition",
"description": [
"\nThe definition of a tool that will be provided to the LLM for it to eventually call."
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tools.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ToolDefinition.description",
"type": "string",
"tags": [],
"label": "description",
"description": [
"\nA description of what the tool does. Note that this will be exposed to the LLM,\nso the description should be explicit about what the tool does and when to call it."
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tools.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ToolDefinition.schema",
"type": "Object",
"tags": [],
"label": "schema",
"description": [
"\nThe input schema for the tool, representing the shape of the tool's parameters\n\nEven if optional, it is highly recommended to define a schema for all tool definitions, unless\nthe tool is supposed to be called without parameters."
],
"signature": [
"ToolSchemaTypeObject",
" | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tools.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ToolOptions",
"type": "Interface",
"tags": [],
"label": "ToolOptions",
"description": [
"\nTool-related parameters of {@link ChatCompleteAPI}"
],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolOptions",
"text": "ToolOptions"
},
"<TToolNames>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tools.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ToolOptions.toolChoice",
"type": "CompoundType",
"tags": [],
"label": "toolChoice",
"description": [
"\nThe choice of tool execution.\n\nRefer to {@link ToolChoice}"
],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolChoice",
"text": "ToolChoice"
},
"<TToolNames> | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tools.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ToolOptions.tools",
"type": "Object",
"tags": [],
"label": "tools",
"description": [
"\nThe list of tool definitions that will be exposed to the LLM.\n\nRefer to {@link ToolDefinition}."
],
"signature": [
"Record<TToolNames, ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolDefinition",
"text": "ToolDefinition"
},
"> | undefined"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tools.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.UnvalidatedToolCall",
"type": "Interface",
"tags": [],
"label": "UnvalidatedToolCall",
"description": [
"\nRepresents a tool call from the LLM before correctly converted to the schema type.\n\nOnly publicly exposed because referenced by {@link ChatCompletionToolValidationError}"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tools.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.UnvalidatedToolCall.toolCallId",
"type": "string",
"tags": [],
"label": "toolCallId",
"description": [],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tools.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.UnvalidatedToolCall.function",
"type": "Object",
"tags": [],
"label": "function",
"description": [],
"signature": [
"{ name: string; arguments: string; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tools.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompletionErrorCode",
"type": "Enum",
"tags": [],
"label": "ChatCompletionErrorCode",
"description": [
"\nList of code of error that are specific to the {@link ChatCompleteAPI}"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/errors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompletionEventType",
"type": "Enum",
"tags": [],
"label": "ChatCompletionEventType",
"description": [
"\nList possible values of {@link ChatCompletionEvent} types."
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceConnectorType",
"type": "Enum",
"tags": [],
"label": "InferenceConnectorType",
"description": [
"\nThe list of connector types that can be used with the inference APIs"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/connectors/connectors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceEndpointProvider",
"type": "Enum",
"tags": [],
"label": "InferenceEndpointProvider",
"description": [
"\nConstants for relevant inference providers"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/inference_endpoints.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceTaskErrorCode",
"type": "Enum",
"tags": [],
"label": "InferenceTaskErrorCode",
"description": [
"\nEnum for generic inference error codes."
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.MessageRole",
"type": "Enum",
"tags": [],
"label": "MessageRole",
"description": [
"\nEnum for all possible {@link Message} roles."
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/messages.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputEventType",
"type": "Enum",
"tags": [],
"label": "OutputEventType",
"description": [
"\nList possible values of {@link OutputEvent} types."
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ToolChoiceType",
"type": "Enum",
"tags": [],
"label": "ToolChoiceType",
"description": [
"\nTool invocation choice type.\n\nRefer to {@link ToolChoice} for more details."
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tools.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.AssistantMessage",
"type": "Type",
"tags": [],
"label": "AssistantMessage",
"description": [
"\nRepresents a message from the LLM."
],
"signature": [
"MessageBase<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.MessageRole",
"text": "MessageRole"
},
".Assistant> & { content: string | null; toolCalls?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolCall",
"text": "ToolCall"
},
"<string, Record<string, any> | undefined>[] | undefined; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/messages.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.AssistantMessageOf",
"type": "Type",
"tags": [],
"label": "AssistantMessageOf",
"description": [
"\nUtility type to get the Assistant message type of a {@link ToolOptions} type."
],
"signature": [
"Omit<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.AssistantMessage",
"text": "AssistantMessage"
},
", \"toolCalls\"> & ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolCallsOf",
"text": "ToolCallsOf"
},
"<TToolOptions>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/messages.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.BoundChatCompleteAPI",
"type": "Type",
"tags": [],
"label": "BoundChatCompleteAPI",
"description": [
"\nVersion of {@link ChatCompleteAPI} that got pre-bound to a set of static parameters"
],
"signature": [
"<TToolOptions extends ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolOptions",
"text": "ToolOptions"
},
"<string> = ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolOptions",
"text": "ToolOptions"
},
"<string>, TStream extends boolean = false>(options: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.UnboundChatCompleteOptions",
"text": "UnboundChatCompleteOptions"
},
"<TToolOptions, TStream>) => ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteCompositeResponse",
"text": "ChatCompleteCompositeResponse"
},
"<TToolOptions, TStream>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/bound_api.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.BoundChatCompleteAPI.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ [P in \"abortSignal\" | \"metadata\" | \"temperature\" | \"system\" | \"stream\" | \"messages\" | \"modelName\" | \"maxRetries\" | \"retryConfiguration\" | Exclude<keyof TToolOptions, \"connectorId\" | \"functionCalling\">]: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteOptions",
"text": "ChatCompleteOptions"
},
"<TToolOptions, TStream>[P]; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/bound_api.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.BoundChatCompleteOptions",
"type": "Type",
"tags": [],
"label": "BoundChatCompleteOptions",
"description": [
"\nStatic options used to call the {@link BoundChatCompleteAPI}"
],
"signature": [
"{ connectorId: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteOptions",
"text": "ChatCompleteOptions"
},
"<TToolOptions, TStream>[\"connectorId\"]; functionCalling?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteOptions",
"text": "ChatCompleteOptions"
},
"<TToolOptions, TStream>[\"functionCalling\"] | undefined; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/bound_api.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.BoundOutputAPI",
"type": "Type",
"tags": [],
"label": "BoundOutputAPI",
"description": [
"\nVersion of {@link OutputAPI} that got pre-bound to a set of static parameters"
],
"signature": [
"<TId extends string = string, TOutputSchema extends ",
"ToolSchemaTypeObject",
" | undefined = ",
"ToolSchemaTypeObject",
" | undefined, TStream extends boolean = false>(options: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.UnboundOutputOptions",
"text": "UnboundOutputOptions"
},
"<TId, TOutputSchema, TStream>) => ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputCompositeResponse",
"text": "OutputCompositeResponse"
},
"<TId, TOutputSchema, TStream>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/bound_api.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.BoundOutputAPI.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ id: TId; abortSignal?: AbortSignal | undefined; input: string; metadata?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteMetadata",
"text": "ChatCompleteMetadata"
},
" | undefined; schema?: TOutputSchema | undefined; retry?: { onValidationError?: number | boolean | undefined; } | undefined; system?: string | undefined; stream?: TStream | undefined; modelName?: string | undefined; maxRetries?: number | undefined; retryConfiguration?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteRetryConfiguration",
"text": "ChatCompleteRetryConfiguration"
},
" | undefined; previousMessages?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.Message",
"text": "Message"
},
"[] | undefined; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/bound_api.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.BoundOutputOptions",
"type": "Type",
"tags": [],
"label": "BoundOutputOptions",
"description": [
"\nStatic options used to call the {@link BoundOutputAPI}"
],
"signature": [
"{ connectorId: string; functionCalling?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.FunctionCallingMode",
"text": "FunctionCallingMode"
},
" | undefined; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/bound_api.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompleteAPI",
"type": "Type",
"tags": [],
"label": "ChatCompleteAPI",
"description": [
"\nRequest a completion from the LLM based on a prompt or conversation.\n\nBy default, The complete LLM response will be returned as a promise.\n"
],
"signature": [
"<TToolOptions extends ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolOptions",
"text": "ToolOptions"
},
"<string> = ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolOptions",
"text": "ToolOptions"
},
"<string>, TStream extends boolean = false>(options: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteOptions",
"text": "ChatCompleteOptions"
},
"<TToolOptions, TStream>) => ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteCompositeResponse",
"text": "ChatCompleteCompositeResponse"
},
"<TToolOptions, TStream>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/api.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompleteAPI.$1",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ connectorId: string; stream?: TStream | undefined; system?: string | undefined; messages: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.Message",
"text": "Message"
},
"[]; temperature?: number | undefined; modelName?: string | undefined; functionCalling?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.FunctionCallingMode",
"text": "FunctionCallingMode"
},
" | undefined; abortSignal?: AbortSignal | undefined; metadata?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteMetadata",
"text": "ChatCompleteMetadata"
},
" | undefined; maxRetries?: number | undefined; retryConfiguration?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteRetryConfiguration",
"text": "ChatCompleteRetryConfiguration"
},
" | undefined; } & TToolOptions"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/api.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompleteCompositeResponse",
"type": "Type",
"tags": [],
"label": "ChatCompleteCompositeResponse",
"description": [
"\nComposite response type from the {@link ChatCompleteAPI},\nwhich can be either an observable or a promise depending on\nwhether API was called with stream mode enabled or not."
],
"signature": [
"TStream extends true ? ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteStreamResponse",
"text": "ChatCompleteStreamResponse"
},
"<TToolOptions> : Promise<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteResponse",
"text": "ChatCompleteResponse"
},
"<TToolOptions>>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/api.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompleteOptions",
"type": "Type",
"tags": [],
"label": "ChatCompleteOptions",
"description": [
"\nOptions used to call the {@link ChatCompleteAPI}"
],
"signature": [
"{ connectorId: string; stream?: TStream | undefined; system?: string | undefined; messages: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.Message",
"text": "Message"
},
"[]; temperature?: number | undefined; modelName?: string | undefined; functionCalling?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.FunctionCallingMode",
"text": "FunctionCallingMode"
},
" | undefined; abortSignal?: AbortSignal | undefined; metadata?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteMetadata",
"text": "ChatCompleteMetadata"
},
" | undefined; maxRetries?: number | undefined; retryConfiguration?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteRetryConfiguration",
"text": "ChatCompleteRetryConfiguration"
},
" | undefined; } & TToolOptions"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/api.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompleteStreamResponse",
"type": "Type",
"tags": [],
"label": "ChatCompleteStreamResponse",
"description": [
"\nResponse from the {@link ChatCompleteAPI} when streaming is enabled.\n\nObservable of {@link ChatCompletionEvent}"
],
"signature": [
"Observable",
"<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionEvent",
"text": "ChatCompletionEvent"
},
"<TToolOptions>>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/api.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompletionChunkEvent",
"type": "Type",
"tags": [],
"label": "ChatCompletionChunkEvent",
"description": [
"\nChunk event, containing a fragment of the total content,\nand potentially chunks of tool calls."
],
"signature": [
"{ content: string; tool_calls: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionChunkToolCall",
"text": "ChatCompletionChunkToolCall"
},
"[]; } & { type: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionEventType",
"text": "ChatCompletionEventType"
},
".ChatCompletionChunk; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompletionEvent",
"type": "Type",
"tags": [],
"label": "ChatCompletionEvent",
"description": [
"\nEvents emitted from the {@link ChatCompleteResponse} observable\nreturned from the {@link ChatCompleteAPI}.\n\nThe chatComplete API returns 3 type of events:\n- {@link ChatCompletionChunkEvent}: message chunk events\n- {@link ChatCompletionTokenCountEvent}: token count event\n- {@link ChatCompletionMessageEvent}: message event\n\nNote that chunk events can be emitted any amount of times, but token count will be emitted\nat most once (could not be emitted depending on the underlying connector), and message\nevent will be emitted ex\n"
],
"signature": [
"({ content: string; tool_calls: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionChunkToolCall",
"text": "ChatCompletionChunkToolCall"
},
"[]; } & { type: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionEventType",
"text": "ChatCompletionEventType"
},
".ChatCompletionChunk; }) | ({ tokens: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionTokenCount",
"text": "ChatCompletionTokenCount"
},
"; } & { type: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionEventType",
"text": "ChatCompletionEventType"
},
".ChatCompletionTokenCount; }) | ({ content: string; toolCalls: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolCallsOf",
"text": "ToolCallsOf"
},
"<TToolOptions>[\"toolCalls\"]; } & { type: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionEventType",
"text": "ChatCompletionEventType"
},
".ChatCompletionMessage; })"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompletionMessageEvent",
"type": "Type",
"tags": [],
"label": "ChatCompletionMessageEvent",
"description": [
"\nMessage event, sent only once, after all the chunks were emitted, and containing\nthe whole text content and potential tool calls of the response."
],
"signature": [
"{ content: string; toolCalls: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolCallsOf",
"text": "ToolCallsOf"
},
"<TToolOptions>[\"toolCalls\"]; } & { type: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionEventType",
"text": "ChatCompletionEventType"
},
".ChatCompletionMessage; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompletionTokenCountEvent",
"type": "Type",
"tags": [],
"label": "ChatCompletionTokenCountEvent",
"description": [
"\nToken count event, send only once, usually (but not necessarily)\nbefore the message event"
],
"signature": [
"{ tokens: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionTokenCount",
"text": "ChatCompletionTokenCount"
},
"; } & { type: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionEventType",
"text": "ChatCompletionEventType"
},
".ChatCompletionTokenCount; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompletionTokenLimitReachedError",
"type": "Type",
"tags": [],
"label": "ChatCompletionTokenLimitReachedError",
"description": [
"\nError thrown if the completion call fails because of a token limit\nerror, e.g. when the context window is higher than the limit"
],
"signature": [
{
"pluginId": "@kbn/sse-utils",
"scope": "common",
"docId": "kibKbnSseUtilsPluginApi",
"section": "def-common.ServerSentEventError",
"text": "ServerSentEventError"
},
"<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionErrorCode",
"text": "ChatCompletionErrorCode"
},
".TokenLimitReachedError, { tokenLimit?: number | undefined; tokenCount?: number | undefined; }>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/errors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompletionToolNotFoundError",
"type": "Type",
"tags": [],
"label": "ChatCompletionToolNotFoundError",
"description": [
"\nError thrown if the LLM called a tool that was not provided\nin the list of available tools."
],
"signature": [
{
"pluginId": "@kbn/sse-utils",
"scope": "common",
"docId": "kibKbnSseUtilsPluginApi",
"section": "def-common.ServerSentEventError",
"text": "ServerSentEventError"
},
"<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionErrorCode",
"text": "ChatCompletionErrorCode"
},
".ToolNotFoundError, { name: string; }>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/errors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ChatCompletionToolValidationError",
"type": "Type",
"tags": [],
"label": "ChatCompletionToolValidationError",
"description": [
"\nError thrown when the LLM called a tool with parameters that\ndon't match the tool's schema.\n\nThe level of details on the error vary depending on the underlying LLM."
],
"signature": [
{
"pluginId": "@kbn/sse-utils",
"scope": "common",
"docId": "kibKbnSseUtilsPluginApi",
"section": "def-common.ServerSentEventError",
"text": "ServerSentEventError"
},
"<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompletionErrorCode",
"text": "ChatCompletionErrorCode"
},
".ToolValidationError, { name?: string | undefined; arguments?: string | undefined; errorsText?: string | undefined; toolCalls?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.UnvalidatedToolCall",
"text": "UnvalidatedToolCall"
},
"[] | undefined; }>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/errors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.FromToolSchema",
"type": "Type",
"tags": [],
"label": "FromToolSchema",
"description": [
"\nUtility type to infer the shape of a tool call from its schema."
],
"signature": [
"TToolSchema extends ",
"ToolSchemaTypeObject",
" ? FromToolSchemaObject<TToolSchema> : TToolSchema extends ToolSchemaTypeArray ? FromToolSchemaArray<TToolSchema> : TToolSchema extends ToolSchemaTypeBoolean ? boolean : TToolSchema extends ToolSchemaTypeNumber ? number : TToolSchema extends ToolSchemaTypeString ? FromToolSchemaString<TToolSchema> : never"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tool_schema.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.FunctionCallingMode",
"type": "Type",
"tags": [],
"label": "FunctionCallingMode",
"description": [
"\nDefine the function calling mode when using inference APIs.\n- \"native\": will use the LLM's native function calling (requires the LLM to have native support)\n- \"simulated\": will emulate function calling with function calling instructions\n- \"auto\": will use \"native\" for providers we know are supporting native function call, \"simulated\" otherwise"
],
"signature": [
"\"auto\" | \"native\" | \"simulated\""
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/api.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceTaskAbortedError",
"type": "Type",
"tags": [],
"label": "InferenceTaskAbortedError",
"description": [
"\nInference error thrown when the request was aborted.\n\nRequest abortion occurs when providing an abort signal and firing it\nbefore the call to the LLM completes."
],
"signature": [
{
"pluginId": "@kbn/sse-utils",
"scope": "common",
"docId": "kibKbnSseUtilsPluginApi",
"section": "def-common.ServerSentEventError",
"text": "ServerSentEventError"
},
"<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.InferenceTaskErrorCode",
"text": "InferenceTaskErrorCode"
},
".abortedError, { status: number; }>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceTaskError",
"type": "Type",
"tags": [],
"label": "InferenceTaskError",
"description": [],
"signature": [
{
"pluginId": "@kbn/sse-utils",
"scope": "common",
"docId": "kibKbnSseUtilsPluginApi",
"section": "def-common.ServerSentEventError",
"text": "ServerSentEventError"
},
"<TCode, TMeta>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceTaskErrorEvent",
"type": "Type",
"tags": [],
"label": "InferenceTaskErrorEvent",
"description": [],
"signature": [
"{ error: { code: string; message: string; meta?: Record<string, any> | undefined; }; } & { type: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.InferenceTaskEventType",
"text": "InferenceTaskEventType"
},
"; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceTaskEvent",
"type": "Type",
"tags": [],
"label": "InferenceTaskEvent",
"description": [],
"signature": [
"Record<string, unknown> & { type: string; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/inference_task.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceTaskEventBase",
"type": "Type",
"tags": [],
"label": "InferenceTaskEventBase",
"description": [
"\nBase interface for all inference events."
],
"signature": [
"keyof TData extends \"type\" ? never : TData & { type: TEventType; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/inference_task.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceTaskEventType",
"type": "string",
"tags": [],
"label": "InferenceTaskEventType",
"description": [],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/inference_task.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceTaskInternalError",
"type": "Type",
"tags": [],
"label": "InferenceTaskInternalError",
"description": [
"\nInference error thrown when an unexpected internal error occurs while handling the request."
],
"signature": [
{
"pluginId": "@kbn/sse-utils",
"scope": "common",
"docId": "kibKbnSseUtilsPluginApi",
"section": "def-common.ServerSentEventError",
"text": "ServerSentEventError"
},
"<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.InferenceTaskErrorCode",
"text": "InferenceTaskErrorCode"
},
".internalError, Record<string, any>>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceTaskProviderError",
"type": "Type",
"tags": [],
"label": "InferenceTaskProviderError",
"description": [
"\nInference error thrown when calling the provider through its connector returned an error.\n\nIt includes error responses returned from the provider,\nand any potential errors related to connectivity issue."
],
"signature": [
{
"pluginId": "@kbn/sse-utils",
"scope": "common",
"docId": "kibKbnSseUtilsPluginApi",
"section": "def-common.ServerSentEventError",
"text": "ServerSentEventError"
},
"<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.InferenceTaskErrorCode",
"text": "InferenceTaskErrorCode"
},
".providerError, { status?: number | undefined; }>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceTaskRequestError",
"type": "Type",
"tags": [],
"label": "InferenceTaskRequestError",
"description": [
"\nInference error thrown when the request was considered invalid.\n\nSome example of reasons for invalid requests would be:\n- no connector matching the provided connectorId\n- invalid connector type for the provided connectorId"
],
"signature": [
{
"pluginId": "@kbn/sse-utils",
"scope": "common",
"docId": "kibKbnSseUtilsPluginApi",
"section": "def-common.ServerSentEventError",
"text": "ServerSentEventError"
},
"<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.InferenceTaskErrorCode",
"text": "InferenceTaskErrorCode"
},
".requestError, { status: number; }>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.Message",
"type": "Type",
"tags": [],
"label": "Message",
"description": [
"\nMixin composed of all the possible types of messages in a chatComplete discussion.\n\nMessage can be of three types:\n- {@link UserMessage}\n- {@link AssistantMessage}\n- {@link ToolMessage}"
],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.UserMessage",
"text": "UserMessage"
},
" | ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.AssistantMessage",
"text": "AssistantMessage"
},
" | ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolMessage",
"text": "ToolMessage"
},
"<string, unknown, Record<string, any> | undefined>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/messages.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.MessageContent",
"type": "Type",
"tags": [],
"label": "MessageContent",
"description": [],
"signature": [
"string | (",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.MessageContentImage",
"text": "MessageContentImage"
},
" | ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.MessageContentText",
"text": "MessageContentText"
},
")[]"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/messages.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.MessageOf",
"type": "Type",
"tags": [],
"label": "MessageOf",
"description": [
"\nUtility type to get the mixin Message type of a {@link ToolOptions} type."
],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.UserMessage",
"text": "UserMessage"
},
" | ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.AssistantMessageOf",
"text": "AssistantMessageOf"
},
"<TToolOptions> | ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolMessageOf",
"text": "ToolMessageOf"
},
"<TToolOptions>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/messages.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.Output",
"type": "Type",
"tags": [],
"label": "Output",
"description": [
"\nTask output of a {@link OutputCompleteEvent}"
],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputAPI",
"type": "Type",
"tags": [],
"label": "OutputAPI",
"description": [
"\nGenerate a response with the LLM for a prompt, optionally based on a schema.\n"
],
"signature": [
"<TId extends string = string, TOutputSchema extends ",
"ToolSchemaTypeObject",
" | undefined = ",
"ToolSchemaTypeObject",
" | undefined, TStream extends boolean = false>(options: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputOptions",
"text": "OutputOptions"
},
"<TId, TOutputSchema, TStream>) => ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputCompositeResponse",
"text": "OutputCompositeResponse"
},
"<TId, TOutputSchema, TStream>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputAPI.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputOptions",
"text": "OutputOptions"
},
"<TId, TOutputSchema, TStream>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputCompleteEvent",
"type": "Type",
"tags": [],
"label": "OutputCompleteEvent",
"description": [
"\nCompletion (complete message) event for the {@link OutputAPI}"
],
"signature": [
"{ id: TId; output: TOutput; content: string; } & { type: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputEventType",
"text": "OutputEventType"
},
".OutputComplete; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputCompositeResponse",
"type": "Type",
"tags": [],
"label": "OutputCompositeResponse",
"description": [
"\nComposite response type from the {@link OutputAPI},\nwhich can be either an observable or a promise depending on\nwhether API was called with stream mode enabled or not."
],
"signature": [
"TStream extends true ? ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputStreamResponse",
"text": "OutputStreamResponse"
},
"<TId, TOutputSchema> : Promise<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputResponse",
"text": "OutputResponse"
},
"<TId, TOutputSchema extends ",
"ToolSchemaTypeObject",
" ? ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.FromToolSchema",
"text": "FromToolSchema"
},
"<TOutputSchema> : undefined>>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputEvent",
"type": "Type",
"tags": [],
"label": "OutputEvent",
"description": [
"\nEvents emitted from the {@link OutputEvent}."
],
"signature": [
"({ id: TId; content: string; } & { type: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputEventType",
"text": "OutputEventType"
},
".OutputUpdate; }) | ({ id: TId; output: TOutput; content: string; } & { type: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputEventType",
"text": "OutputEventType"
},
".OutputComplete; })"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputStreamResponse",
"type": "Type",
"tags": [],
"label": "OutputStreamResponse",
"description": [
"\nResponse from the {@link OutputAPI} in streaming mode.\n"
],
"signature": [
"Observable",
"<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputEvent",
"text": "OutputEvent"
},
"<TId, TOutputSchema extends ",
"ToolSchemaTypeObject",
" ? ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.FromToolSchema",
"text": "FromToolSchema"
},
"<TOutputSchema> : undefined>>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/api.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.OutputUpdateEvent",
"type": "Type",
"tags": [],
"label": "OutputUpdateEvent",
"description": [
"\nUpdate (chunk) event for the {@link OutputAPI}"
],
"signature": [
"{ id: TId; content: string; } & { type: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.OutputEventType",
"text": "OutputEventType"
},
".OutputUpdate; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ToolCallsOf",
"type": "Type",
"tags": [],
"label": "ToolCallsOf",
"description": [
"\nUtility type to infer the toolCall type of {@link ChatCompletionMessageEvent}."
],
"signature": [
"TToolOptions extends { tools?: Record<string, ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolDefinition",
"text": "ToolDefinition"
},
"> | undefined; } ? TToolOptions extends { toolChoice: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolChoiceType",
"text": "ToolChoiceType"
},
".none; } ? { toolCalls: []; } : { toolCalls: ",
"ToolResponsesOf",
"<ToolsOfChoice<TToolOptions>>; } : { toolCalls: never; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tools.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ToolChoice",
"type": "Type",
"tags": [],
"label": "ToolChoice",
"description": [
"\nDefines the tool invocation for {@link ToolOptions}, either a {@link ToolChoiceType} or {@link CustomToolChoice}.\n- {@link ToolChoiceType.none}: the LLM will never call a tool\n- {@link ToolChoiceType.auto}: the LLM will decide if it should call a tool or provide a text response\n- {@link ToolChoiceType.required}: the LLM will always call a tool, but will decide with one to call\n- {@link CustomToolChoice}: the LLM will always call the specified tool"
],
"signature": [
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ToolChoiceType",
"text": "ToolChoiceType"
},
" | CustomToolChoice<TName>"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tools.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ToolMessage",
"type": "Type",
"tags": [],
"label": "ToolMessage",
"description": [
"\nRepresents a tool invocation result, following a request from the LLM to execute a tool."
],
"signature": [
"MessageBase<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.MessageRole",
"text": "MessageRole"
},
".Tool> & { name: TName; toolCallId: string; response: TToolResponse; } & (TToolData extends undefined ? {} : { data: TToolData; })"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/messages.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ToolMessageOf",
"type": "Type",
"tags": [],
"label": "ToolMessageOf",
"description": [
"\nUtility type to get the Tool message type of a {@link ToolOptions} type."
],
"signature": [
"MessageBase<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.MessageRole",
"text": "MessageRole"
},
".Tool> & { name: ",
"ToolNamesOf",
"<TToolOptions>; toolCallId: string; response: ",
"ToolResponsesOf",
"<TToolOptions[\"tools\"]>; } & ({} | { data: Record<string, any>; })"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/messages.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ToolSchema",
"type": "Type",
"tags": [],
"label": "ToolSchema",
"description": [
"\nDefines the schema for a {@link ToolDefinition}"
],
"signature": [
"ToolSchemaTypeObject"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tool_schema.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.ToolSchemaType",
"type": "Type",
"tags": [],
"label": "ToolSchemaType",
"description": [
"\nA tool schema property's possible types."
],
"signature": [
"ToolSchemaTypeObject",
" | ToolSchemaTypeString | ToolSchemaTypeBoolean | ToolSchemaTypeNumber | ToolSchemaTypeArray"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/tool_schema.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.UnboundChatCompleteOptions",
"type": "Type",
"tags": [],
"label": "UnboundChatCompleteOptions",
"description": [
"\nOptions used to call the {@link BoundChatCompleteAPI}"
],
"signature": [
"{ [P in \"abortSignal\" | \"metadata\" | \"temperature\" | \"system\" | \"stream\" | \"messages\" | \"modelName\" | \"maxRetries\" | \"retryConfiguration\" | Exclude<keyof TToolOptions, \"connectorId\" | \"functionCalling\">]: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteOptions",
"text": "ChatCompleteOptions"
},
"<TToolOptions, TStream>[P]; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/bound_api.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.UnboundOutputOptions",
"type": "Type",
"tags": [],
"label": "UnboundOutputOptions",
"description": [
"\nOptions used to call the {@link BoundOutputAPI}"
],
"signature": [
"{ id: TId; abortSignal?: AbortSignal | undefined; input: string; metadata?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteMetadata",
"text": "ChatCompleteMetadata"
},
" | undefined; schema?: TOutputSchema | undefined; retry?: { onValidationError?: number | boolean | undefined; } | undefined; system?: string | undefined; stream?: TStream | undefined; modelName?: string | undefined; maxRetries?: number | undefined; retryConfiguration?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteRetryConfiguration",
"text": "ChatCompleteRetryConfiguration"
},
" | undefined; previousMessages?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.Message",
"text": "Message"
},
"[] | undefined; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/output/bound_api.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.UserMessage",
"type": "Type",
"tags": [],
"label": "UserMessage",
"description": [
"\nRepresents a message from the user."
],
"signature": [
"MessageBase<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.MessageRole",
"text": "MessageRole"
},
".User> & { content: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.MessageContent",
"text": "MessageContent"
},
"; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/messages.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.defaultInferenceEndpoints",
"type": "Object",
"tags": [],
"label": "defaultInferenceEndpoints",
"description": [
"\nConstants for all default (preconfigured) inference endpoints."
],
"signature": [
"{ readonly ELSER: \".elser-2-elasticsearch\"; readonly MULTILINGUAL_E5_SMALL: \".multilingual-e5-small-elasticsearch\"; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/inference_endpoints.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.elasticModelDictionary",
"type": "Object",
"tags": [],
"label": "elasticModelDictionary",
"description": [],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/const.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.elasticModelDictionary.rainbowsprinkles",
"type": "Object",
"tags": [],
"label": "'rainbow-sprinkles'",
"description": [],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/const.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.elasticModelDictionary.rainbowsprinkles.provider",
"type": "string",
"tags": [],
"label": "provider",
"description": [],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/const.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.elasticModelDictionary.rainbowsprinkles.model",
"type": "string",
"tags": [],
"label": "model",
"description": [],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/const.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.elasticModelIds",
"type": "Object",
"tags": [],
"label": "elasticModelIds",
"description": [],
"signature": [
"{ readonly RainbowSprinkles: \"rainbow-sprinkles\"; }"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/inference_endpoints.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/inference-common",
"id": "def-common.InferenceTaskError",
"type": "Object",
"tags": [],
"label": "InferenceTaskError",
"description": [],
"signature": [
"typeof ",
{
"pluginId": "@kbn/sse-utils",
"scope": "common",
"docId": "kibKbnSseUtilsPluginApi",
"section": "def-common.ServerSentEventError",
"text": "ServerSentEventError"
}
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/errors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink