{ "id": "elasticAssistant", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [], "functions": [], "interfaces": [ { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantTool", "type": "Interface", "tags": [], "label": "AssistantTool", "description": [ "\nInterfaces for registering tools to be used by the elastic assistant" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantTool.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantTool.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantTool.description", "type": "string", "tags": [], "label": "description", "description": [], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantTool.sourceRegister", "type": "string", "tags": [], "label": "sourceRegister", "description": [], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantTool.isSupported", "type": "Function", "tags": [], "label": "isSupported", "description": [], "signature": [ "(params: ", { "pluginId": "elasticAssistant", "scope": "server", "docId": "kibElasticAssistantPluginApi", "section": "def-server.AssistantToolParams", "text": "AssistantToolParams" }, ") => boolean" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantTool.isSupported.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "elasticAssistant", "scope": "server", "docId": "kibElasticAssistantPluginApi", "section": "def-server.AssistantToolParams", "text": "AssistantToolParams" } ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantTool.getTool", "type": "Function", "tags": [], "label": "getTool", "description": [], "signature": [ "(params: ", { "pluginId": "elasticAssistant", "scope": "server", "docId": "kibElasticAssistantPluginApi", "section": "def-server.AssistantToolParams", "text": "AssistantToolParams" }, ") => ", "Tool", " | ", "DynamicStructuredTool", "<", "ZodObjectAny", "> | null" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantTool.getTool.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "elasticAssistant", "scope": "server", "docId": "kibElasticAssistantPluginApi", "section": "def-server.AssistantToolParams", "text": "AssistantToolParams" } ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams", "type": "Interface", "tags": [], "label": "AssistantToolParams", "description": [], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.alertsIndexPattern", "type": "string", "tags": [], "label": "alertsIndexPattern", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.anonymizationFields", "type": "Array", "tags": [], "label": "anonymizationFields", "description": [], "signature": [ "{ id: string; field: string; namespace?: string | undefined; timestamp?: string | undefined; createdBy?: string | undefined; updatedBy?: string | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; allowed?: boolean | undefined; anonymized?: boolean | undefined; }[] | undefined" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.inference", "type": "Object", "tags": [], "label": "inference", "description": [], "signature": [ { "pluginId": "inference", "scope": "server", "docId": "kibInferencePluginApi", "section": "def-server.InferenceServerStart", "text": "InferenceServerStart" }, " | undefined" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.isEnabledKnowledgeBase", "type": "boolean", "tags": [], "label": "isEnabledKnowledgeBase", "description": [], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.connectorId", "type": "string", "tags": [], "label": "connectorId", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.contentReferencesStore", "type": "Object", "tags": [], "label": "contentReferencesStore", "description": [], "signature": [ { "pluginId": "@kbn/elastic-assistant-common", "scope": "common", "docId": "kibKbnElasticAssistantCommonPluginApi", "section": "def-common.ContentReferencesStore", "text": "ContentReferencesStore" }, " | undefined" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.description", "type": "string", "tags": [], "label": "description", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.esClient", "type": "Object", "tags": [], "label": "esClient", "description": [], "signature": [ "{ create: { (this: That, params: ", "CreateRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "WriteResponseBase", ">; (this: That, params: ", "CreateRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "WriteResponseBase", ", unknown>>; (this: That, params: ", "CreateRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", ">; }; update: { (this: That, params: ", "UpdateRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "UpdateResponse", ">; (this: That, params: ", "UpdateRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "UpdateResponse", ", unknown>>; (this: That, params: ", "UpdateRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", ">; }; get: { (this: That, params: ", "GetRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "GetResponse", ">; (this: That, params: ", "GetRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "GetResponse", ", unknown>>; (this: That, params: ", "GetRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "GetResponse", ">; }; delete: { (this: That, params: ", "DeleteRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "WriteResponseBase", ">; (this: That, params: ", "DeleteRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "WriteResponseBase", ", unknown>>; (this: That, params: ", "DeleteRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", ">; }; helpers: ", "default", "; search: { >(this: That, params?: ", "SearchRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "SearchResponse", ">; >(this: That, params?: ", "SearchRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "SearchResponse", ", unknown>>; >(this: That, params?: ", "SearchRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "SearchResponse", ">; }; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kConnector]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kProfiling]: symbol | null; [kQueryRules]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSimulate]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", ") => ", "default", "; asyncSearch: ", "default", "; autoscaling: ", "default", "; bulk: { (this: That, params: ", "BulkRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "BulkResponse", ">; (this: That, params: ", "BulkRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "BulkResponse", ", unknown>>; (this: That, params: ", "BulkRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "BulkResponse", ">; }; capabilities: { (this: That, params?: ", "TODO", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "TODO", ">; (this: That, params?: ", "TODO", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "TODO", ", unknown>>; (this: That, params?: ", "TODO", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "TODO", ">; }; cat: ", "default", "; ccr: ", "default", "; clearScroll: { (this: That, params?: ", "ClearScrollRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ClearScrollResponse", ">; (this: That, params?: ", "ClearScrollRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ClearScrollResponse", ", unknown>>; (this: That, params?: ", "ClearScrollRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "ClearScrollResponse", ">; }; closePointInTime: { (this: That, params: ", "ClosePointInTimeRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ClosePointInTimeResponse", ">; (this: That, params: ", "ClosePointInTimeRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ClosePointInTimeResponse", ", unknown>>; (this: That, params: ", "ClosePointInTimeRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ClosePointInTimeResponse", ">; }; cluster: ", "default", "; connector: ", "default", "; count: { (this: That, params?: ", "CountRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "CountResponse", ">; (this: That, params?: ", "CountRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "CountResponse", ", unknown>>; (this: That, params?: ", "CountRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "CountResponse", ">; }; danglingIndices: ", "default", "; deleteByQuery: { (this: That, params: ", "DeleteByQueryRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "DeleteByQueryResponse", ">; (this: That, params: ", "DeleteByQueryRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "DeleteByQueryResponse", ", unknown>>; (this: That, params: ", "DeleteByQueryRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "DeleteByQueryResponse", ">; }; deleteByQueryRethrottle: { (this: That, params: ", "DeleteByQueryRethrottleRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "TasksTaskListResponseBase", ">; (this: That, params: ", "DeleteByQueryRethrottleRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "TasksTaskListResponseBase", ", unknown>>; (this: That, params: ", "DeleteByQueryRethrottleRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "TasksTaskListResponseBase", ">; }; deleteScript: { (this: That, params: ", "DeleteScriptRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "AcknowledgedResponseBase", ">; (this: That, params: ", "DeleteScriptRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "AcknowledgedResponseBase", ", unknown>>; (this: That, params: ", "DeleteScriptRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "AcknowledgedResponseBase", ">; }; enrich: ", "default", "; eql: ", "default", "; esql: ", "default", "; exists: { (this: That, params: ", "ExistsRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params: ", "ExistsRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params: ", "ExistsRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise; }; existsSource: { (this: That, params: ", "ExistsSourceRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params: ", "ExistsSourceRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params: ", "ExistsSourceRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise; }; explain: { (this: That, params: ", "ExplainRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ExplainResponse", ">; (this: That, params: ", "ExplainRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ExplainResponse", ", unknown>>; (this: That, params: ", "ExplainRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ExplainResponse", ">; }; features: ", "default", "; fieldCaps: { (this: That, params?: ", "FieldCapsRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "FieldCapsResponse", ">; (this: That, params?: ", "FieldCapsRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "FieldCapsResponse", ", unknown>>; (this: That, params?: ", "FieldCapsRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "FieldCapsResponse", ">; }; fleet: ", "default", "; getScript: { (this: That, params: ", "GetScriptRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "GetScriptResponse", ">; (this: That, params: ", "GetScriptRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "GetScriptResponse", ", unknown>>; (this: That, params: ", "GetScriptRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "GetScriptResponse", ">; }; getScriptContext: { (this: That, params?: ", "GetScriptContextRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "GetScriptContextResponse", ">; (this: That, params?: ", "GetScriptContextRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "GetScriptContextResponse", ", unknown>>; (this: That, params?: ", "GetScriptContextRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "GetScriptContextResponse", ">; }; getScriptLanguages: { (this: That, params?: ", "GetScriptLanguagesRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "GetScriptLanguagesResponse", ">; (this: That, params?: ", "GetScriptLanguagesRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "GetScriptLanguagesResponse", ", unknown>>; (this: That, params?: ", "GetScriptLanguagesRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "GetScriptLanguagesResponse", ">; }; getSource: { (this: That, params: ", "GetSourceRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params: ", "GetSourceRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params: ", "GetSourceRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise; }; graph: ", "default", "; healthReport: { (this: That, params?: ", "HealthReportRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "HealthReportResponse", ">; (this: That, params?: ", "HealthReportRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "HealthReportResponse", ", unknown>>; (this: That, params?: ", "HealthReportRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "HealthReportResponse", ">; }; ilm: ", "default", "; index: { (this: That, params: ", "IndexRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "WriteResponseBase", ">; (this: That, params: ", "IndexRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "WriteResponseBase", ", unknown>>; (this: That, params: ", "IndexRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", ">; }; indices: ", "default", "; inference: ", "default", "; info: { (this: That, params?: ", "InfoRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "InfoResponse", ">; (this: That, params?: ", "InfoRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "InfoResponse", ", unknown>>; (this: That, params?: ", "InfoRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "InfoResponse", ">; }; ingest: ", "default", "; knnSearch: { (this: That, params: ", "KnnSearchRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "KnnSearchResponse", ">; (this: That, params: ", "KnnSearchRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "KnnSearchResponse", ", unknown>>; (this: That, params: ", "KnnSearchRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "KnnSearchResponse", ">; }; license: ", "default", "; logstash: ", "default", "; mget: { (this: That, params?: ", "MgetRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "MgetResponse", ">; (this: That, params?: ", "MgetRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "MgetResponse", ", unknown>>; (this: That, params?: ", "MgetRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "MgetResponse", ">; }; migration: ", "default", "; ml: ", "default", "; monitoring: ", "default", "; msearch: { >(this: That, params: ", "MsearchRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "MsearchResponse", ">; >(this: That, params: ", "MsearchRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "MsearchResponse", ", unknown>>; >(this: That, params: ", "MsearchRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "MsearchResponse", ">; }; msearchTemplate: { >(this: That, params: ", "MsearchTemplateRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "MsearchTemplateResponse", ">; >(this: That, params: ", "MsearchTemplateRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "MsearchTemplateResponse", ", unknown>>; >(this: That, params: ", "MsearchTemplateRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "MsearchTemplateResponse", ">; }; mtermvectors: { (this: That, params?: ", "MtermvectorsRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "MtermvectorsResponse", ">; (this: That, params?: ", "MtermvectorsRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "MtermvectorsResponse", ", unknown>>; (this: That, params?: ", "MtermvectorsRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", ">; }; nodes: ", "default", "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "OpenPointInTimeResponse", ">; (this: That, params: ", "OpenPointInTimeRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "OpenPointInTimeResponse", ", unknown>>; (this: That, params: ", "OpenPointInTimeRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", ">; }; ping: { (this: That, params?: ", "PingRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params?: ", "PingRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params?: ", "PingRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise; }; profiling: ", "default", "; putScript: { (this: That, params: ", "PutScriptRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "AcknowledgedResponseBase", ">; (this: That, params: ", "PutScriptRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "AcknowledgedResponseBase", ", unknown>>; (this: That, params: ", "PutScriptRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "AcknowledgedResponseBase", ">; }; queryRules: ", "default", "; rankEval: { (this: That, params: ", "RankEvalRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "RankEvalResponse", ">; (this: That, params: ", "RankEvalRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "RankEvalResponse", ", unknown>>; (this: That, params: ", "RankEvalRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "RankEvalResponse", ">; }; reindex: { (this: That, params: ", "ReindexRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ReindexResponse", ">; (this: That, params: ", "ReindexRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ReindexResponse", ", unknown>>; (this: That, params: ", "ReindexRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ReindexResponse", ">; }; reindexRethrottle: { (this: That, params: ", "ReindexRethrottleRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ReindexRethrottleResponse", ">; (this: That, params: ", "ReindexRethrottleRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ReindexRethrottleResponse", ", unknown>>; (this: That, params: ", "ReindexRethrottleRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ReindexRethrottleResponse", ">; }; renderSearchTemplate: { (this: That, params?: ", "RenderSearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "RenderSearchTemplateResponse", ">; (this: That, params?: ", "RenderSearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "RenderSearchTemplateResponse", ", unknown>>; (this: That, params?: ", "RenderSearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "RenderSearchTemplateResponse", ">; }; rollup: ", "default", "; scriptsPainlessExecute: { (this: That, params?: ", "ScriptsPainlessExecuteRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ScriptsPainlessExecuteResponse", ">; (this: That, params?: ", "ScriptsPainlessExecuteRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ScriptsPainlessExecuteResponse", ", unknown>>; (this: That, params?: ", "ScriptsPainlessExecuteRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "ScriptsPainlessExecuteResponse", ">; }; scroll: { >(this: That, params: ", "ScrollRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ScrollResponse", ">; >(this: That, params: ", "ScrollRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ScrollResponse", ", unknown>>; >(this: That, params: ", "ScrollRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ScrollResponse", ">; }; searchApplication: ", "default", "; searchMvt: { (this: That, params: ", "SearchMvtRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params: ", "SearchMvtRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params: ", "SearchMvtRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise; }; searchShards: { (this: That, params?: ", "SearchShardsRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "SearchShardsResponse", ">; (this: That, params?: ", "SearchShardsRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "SearchShardsResponse", ", unknown>>; (this: That, params?: ", "SearchShardsRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "SearchShardsResponse", ">; }; searchTemplate: { (this: That, params?: ", "SearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "SearchTemplateResponse", ">; (this: That, params?: ", "SearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "SearchTemplateResponse", ", unknown>>; (this: That, params?: ", "SearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", "; security: ", "default", "; shutdown: ", "default", "; simulate: ", "default", "; slm: ", "default", "; snapshot: ", "default", "; sql: ", "default", "; ssl: ", "default", "; synonyms: ", "default", "; tasks: ", "default", "; termsEnum: { (this: That, params: ", "TermsEnumRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "TermsEnumResponse", ">; (this: That, params: ", "TermsEnumRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "TermsEnumResponse", ", unknown>>; (this: That, params: ", "TermsEnumRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "TermsEnumResponse", ">; }; termvectors: { (this: That, params: ", "TermvectorsRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "TermvectorsResponse", ">; (this: That, params: ", "TermvectorsRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "TermvectorsResponse", ", unknown>>; (this: That, params: ", "TermvectorsRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "TermvectorsResponse", ">; }; textStructure: ", "default", "; transform: ", "default", "; updateByQuery: { (this: That, params: ", "UpdateByQueryRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "UpdateByQueryResponse", ">; (this: That, params: ", "UpdateByQueryRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "UpdateByQueryResponse", ", unknown>>; (this: That, params: ", "UpdateByQueryRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "UpdateByQueryResponse", ">; }; updateByQueryRethrottle: { (this: That, params: ", "UpdateByQueryRethrottleRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "UpdateByQueryRethrottleResponse", ">; (this: That, params: ", "UpdateByQueryRethrottleRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "UpdateByQueryRethrottleResponse", ", unknown>>; (this: That, params: ", "UpdateByQueryRethrottleRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "UpdateByQueryRethrottleResponse", ">; }; watcher: ", "default", "; xpack: ", "default", "; }" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.kbDataClient", "type": "Object", "tags": [], "label": "kbDataClient", "description": [], "signature": [ "AIAssistantKnowledgeBaseDataClient", " | undefined" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.langChainTimeout", "type": "number", "tags": [], "label": "langChainTimeout", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.llm", "type": "CompoundType", "tags": [], "label": "llm", "description": [], "signature": [ "ActionsClientLlm", " | ", "AssistantToolLlm", " | undefined" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.llmTasks", "type": "Object", "tags": [], "label": "llmTasks", "description": [], "signature": [ { "pluginId": "llmTasks", "scope": "server", "docId": "kibLlmTasksPluginApi", "section": "def-server.LlmTasksPluginStart", "text": "LlmTasksPluginStart" }, " | undefined" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.isOssModel", "type": "CompoundType", "tags": [], "label": "isOssModel", "description": [], "signature": [ "boolean | undefined" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.logger", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ { "pluginId": "@kbn/logging", "scope": "common", "docId": "kibKbnLoggingPluginApi", "section": "def-common.Logger", "text": "Logger" } ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.onNewReplacements", "type": "Function", "tags": [], "label": "onNewReplacements", "description": [], "signature": [ "((newReplacements: Zod.objectOutputType<{}, Zod.ZodString, \"strip\">) => void) | undefined" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.onNewReplacements.$1", "type": "CompoundType", "tags": [], "label": "newReplacements", "description": [], "signature": [ "Zod.objectOutputType<{}, Zod.ZodString, \"strip\">" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.replacements", "type": "CompoundType", "tags": [], "label": "replacements", "description": [], "signature": [ "Zod.objectOutputType<{}, Zod.ZodString, \"strip\"> | undefined" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.request", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ "KibanaRequest", " | undefined; model?: string | undefined; replacements?: Zod.objectOutputType<{}, Zod.ZodString, \"strip\"> | undefined; langSmithProject?: string | undefined; langSmithApiKey?: string | undefined; } | { subAction: \"invokeAI\" | \"invokeStream\"; anonymizationFields: { id: string; field: string; namespace?: string | undefined; timestamp?: string | undefined; createdBy?: string | undefined; updatedBy?: string | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; allowed?: boolean | undefined; anonymized?: boolean | undefined; }[]; apiConfig: { connectorId: string; actionTypeId: string; provider?: \"Other\" | \"OpenAI\" | \"Azure OpenAI\" | undefined; model?: string | undefined; defaultSystemPromptId?: string | undefined; }; endpointIds: string[]; insightType: \"incompatible_antivirus\" | \"noisy_process_tree\"; model?: string | undefined; replacements?: Zod.objectOutputType<{}, Zod.ZodString, \"strip\"> | undefined; langSmithProject?: string | undefined; langSmithApiKey?: string | undefined; }, any>" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.size", "type": "number", "tags": [], "label": "size", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.AssistantToolParams.telemetry", "type": "Object", "tags": [], "label": "telemetry", "description": [], "signature": [ "AnalyticsServiceSetup", " | undefined" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginSetupDependencies", "type": "Interface", "tags": [], "label": "ElasticAssistantPluginSetupDependencies", "description": [], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginSetupDependencies.actions", "type": "Object", "tags": [], "label": "actions", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.PluginSetupContract", "text": "PluginSetupContract" } ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginSetupDependencies.ml", "type": "CompoundType", "tags": [], "label": "ml", "description": [], "signature": [ "JobServiceProvider", " & ", "AnomalyDetectorsProvider", " & ", "MlSystemProvider", " & ", "ModulesProvider", " & ", "ResultsServiceProvider", " & { alertingServiceProvider(savedObjectsClient: ", "SavedObjectsClientContract", ", request: ", "KibanaRequest", "): { preview: (args_0: Readonly<{} & { timeRange: string; sampleSize: number; alertParams: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>; }>) => Promise; execute: (params: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>, spaceId: string, state?: ", "AnomalyDetectionRuleState", " | undefined) => Promise<{ payload: ", "AnomalyDetectionAlertPayload", "; context: ", "AnomalyDetectionAlertContext", "; name: string; isHealthy: boolean; stateUpdate: ", "AnomalyDetectionRuleState", "; } | undefined>; }; } & ", "TrainedModelsProvider" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginSetupDependencies.taskManager", "type": "Object", "tags": [], "label": "taskManager", "description": [], "signature": [ { "pluginId": "taskManager", "scope": "server", "docId": "kibTaskManagerPluginApi", "section": "def-server.TaskManagerSetupContract", "text": "TaskManagerSetupContract" } ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginSetupDependencies.spaces", "type": "Object", "tags": [], "label": "spaces", "description": [], "signature": [ { "pluginId": "spaces", "scope": "server", "docId": "kibSpacesPluginApi", "section": "def-server.SpacesPluginSetup", "text": "SpacesPluginSetup" }, " | undefined" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStartDependencies", "type": "Interface", "tags": [], "label": "ElasticAssistantPluginStartDependencies", "description": [], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStartDependencies.actions", "type": "Object", "tags": [], "label": "actions", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.PluginStartContract", "text": "PluginStartContract" } ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStartDependencies.llmTasks", "type": "Object", "tags": [], "label": "llmTasks", "description": [], "signature": [ { "pluginId": "llmTasks", "scope": "server", "docId": "kibLlmTasksPluginApi", "section": "def-server.LlmTasksPluginStart", "text": "LlmTasksPluginStart" } ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStartDependencies.inference", "type": "Object", "tags": [], "label": "inference", "description": [], "signature": [ { "pluginId": "inference", "scope": "server", "docId": "kibInferencePluginApi", "section": "def-server.InferenceServerStart", "text": "InferenceServerStart" } ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStartDependencies.spaces", "type": "Object", "tags": [], "label": "spaces", "description": [], "signature": [ { "pluginId": "spaces", "scope": "server", "docId": "kibSpacesPluginApi", "section": "def-server.SpacesPluginStart", "text": "SpacesPluginStart" }, " | undefined" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStartDependencies.licensing", "type": "Object", "tags": [], "label": "licensing", "description": [], "signature": [ { "pluginId": "licensing", "scope": "server", "docId": "kibLicensingPluginApi", "section": "def-server.LicensingPluginStart", "text": "LicensingPluginStart" } ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStartDependencies.productDocBase", "type": "Object", "tags": [], "label": "productDocBase", "description": [], "signature": [ { "pluginId": "productDocBase", "scope": "server", "docId": "kibProductDocBasePluginApi", "section": "def-server.ProductDocBaseStartContract", "text": "ProductDocBaseStartContract" } ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [], "setup": { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginSetup", "type": "Interface", "tags": [], "label": "ElasticAssistantPluginSetup", "description": [ "The plugin setup interface" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginSetup.actions", "type": "Object", "tags": [], "label": "actions", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.PluginSetupContract", "text": "PluginSetupContract" } ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false } ], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStart", "type": "Interface", "tags": [], "label": "ElasticAssistantPluginStart", "description": [ "The plugin start interface" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStart.actions", "type": "Object", "tags": [], "label": "actions", "description": [ "\nActions plugin start contract." ], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.PluginStartContract", "text": "PluginStartContract" } ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStart.inference", "type": "Object", "tags": [], "label": "inference", "description": [ "\nInference plugin start contract." ], "signature": [ { "pluginId": "inference", "scope": "server", "docId": "kibInferencePluginApi", "section": "def-server.InferenceServerStart", "text": "InferenceServerStart" } ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStart.registerFeatures", "type": "Function", "tags": [], "label": "registerFeatures", "description": [ "\nRegister features to be used by the elastic assistant.\n\nNote: Be sure to use the pluginName that is sent in the request headers by your plugin to ensure it is extracted\nand the correct features are available. See {@link getPluginNameFromRequest} for more details.\n" ], "signature": [ "(pluginName: string, features: Partial<", { "pluginId": "@kbn/elastic-assistant-common", "scope": "common", "docId": "kibKbnElasticAssistantCommonPluginApi", "section": "def-common.AssistantFeatures", "text": "AssistantFeatures" }, ">) => void" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStart.registerFeatures.$1", "type": "string", "tags": [], "label": "pluginName", "description": [ "Name of the plugin the features should be registered to" ], "signature": [ "string" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStart.registerFeatures.$2", "type": "Object", "tags": [], "label": "features", "description": [ "Partial to be registered with for the given plugin" ], "signature": [ "Partial<", { "pluginId": "@kbn/elastic-assistant-common", "scope": "common", "docId": "kibKbnElasticAssistantCommonPluginApi", "section": "def-common.AssistantFeatures", "text": "AssistantFeatures" }, ">" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStart.getRegisteredFeatures", "type": "Function", "tags": [], "label": "getRegisteredFeatures", "description": [ "\nGet the registered features for a given plugin name." ], "signature": [ "(pluginName: string) => ", { "pluginId": "@kbn/elastic-assistant-common", "scope": "common", "docId": "kibKbnElasticAssistantCommonPluginApi", "section": "def-common.AssistantFeatures", "text": "AssistantFeatures" } ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStart.getRegisteredFeatures.$1", "type": "string", "tags": [], "label": "pluginName", "description": [ "Name of the plugin to get the features for" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/services/app_context.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStart.registerTools", "type": "Function", "tags": [], "label": "registerTools", "description": [ "\nRegister tools to be used by the elastic assistant.\n\nNote: Be sure to use the pluginName that is sent in the request headers by your plugin to ensure it is extracted\nand the correct tools are selected. See {@link getPluginNameFromRequest} for more details.\n" ], "signature": [ "(pluginName: string, tools: ", { "pluginId": "elasticAssistant", "scope": "server", "docId": "kibElasticAssistantPluginApi", "section": "def-server.AssistantTool", "text": "AssistantTool" }, "[]) => void" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStart.registerTools.$1", "type": "string", "tags": [], "label": "pluginName", "description": [ "Name of the plugin the tool should be registered to" ], "signature": [ "string" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStart.registerTools.$2", "type": "Array", "tags": [], "label": "tools", "description": [ "AssistantTools to be registered with for the given plugin" ], "signature": [ { "pluginId": "elasticAssistant", "scope": "server", "docId": "kibElasticAssistantPluginApi", "section": "def-server.AssistantTool", "text": "AssistantTool" }, "[]" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStart.getRegisteredTools", "type": "Function", "tags": [], "label": "getRegisteredTools", "description": [ "\nGet the registered tools for a given plugin name." ], "signature": [ "(pluginName: string) => ", { "pluginId": "elasticAssistant", "scope": "server", "docId": "kibElasticAssistantPluginApi", "section": "def-server.AssistantTool", "text": "AssistantTool" }, "[]" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "elasticAssistant", "id": "def-server.ElasticAssistantPluginStart.getRegisteredTools.$1", "type": "string", "tags": [], "label": "pluginName", "description": [ "Name of the plugin to get the tools for" ], "path": "x-pack/solutions/security/plugins/elastic_assistant/server/services/app_context.ts", "deprecated": false, "trackAdoption": false } ] } ], "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] } }