ai

const ai: object = AI

Defined in: js-api/grok.ts:33

AI API

Type Declaration

Name	Type	Description	Defined in
config	object	Configuration sub-namespace for AI provider settings.	js-api/src/ai.ts:202
get config.configured	boolean	-	js-api/src/ai.ts:207
get config.current	AIConfig	-	js-api/src/ai.ts:203
get config.indexEntities	boolean	-	js-api/src/ai.ts:211
get config.proxyToken	string	-	js-api/src/ai.ts:220
get config.proxyUrl	string	-	js-api/src/ai.ts:216
get onCancel	Observable<AITurnEvent>	-	js-api/src/ai.ts:196
get onChunk	Observable<AITurnEvent & object>	-	js-api/src/ai.ts:194
get onError	Observable<AITurnEvent & object>	-	js-api/src/ai.ts:197
get onPrompt	Observable<AITurnEvent>	-	js-api/src/ai.ts:193
get onResult	Observable<AITurnEvent & object>	-	js-api/src/ai.ts:195
chat()	(options?) => Promise<AIChat>	-	js-api/src/ai.ts:181
engines()	() => Promise<AIEngine[]>	-	js-api/src/ai.ts:171
getEngine()	(id) => Promise<AIEngine | null>	-	js-api/src/ai.ts:177
processPrompt()	(prompt) => Promise<boolean>	-	js-api/src/ai.ts:260
prompt()	(prompt, options?) => Promise<AIResult>	-	js-api/src/ai.ts:185
registerEngine()	(engine) => void	-	js-api/src/ai.ts:167
searchEntities()	(text, threshold?, limit?, types?) => Promise<Entity[]>	Performs a semantic search over indexed Datagrok entities. The input [text] is converted into a vector embedding using the configured embedding model and compared against stored entity embeddings using vector distance. Results are filtered by the provided similarity [threshold], optionally restricted to specific entity [types], and limited by [limit]. Throws Error if AI indexing is disabled or no AI provider is configured.	js-api/src/ai.ts:248
stream()	(prompt, options?) => AIStream	-	js-api/src/ai.ts:189