@breadstone/archipel-mcp 0.0.42 → 0.0.44
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/guides/ai-text-generation.md +397 -107
- package/data/packages/platform-bootstrap/api/Function.useExpressServer.md +32 -0
- package/data/packages/platform-bootstrap/api/Interface.IExpressServerStepOptions.md +46 -0
- package/data/packages/platform-bootstrap/api/index.md +2 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +5 -5
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +26 -2
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +43 -9
- package/data/packages/platform-intelligence/api/Class.IntelligenceToolBase.md +93 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceToolRegistry.md +217 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicAdvisor20260301Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicBash20241022Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicBash20250124Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250522Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250825Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20260120Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20241022Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20250124Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20251124Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicMemory20250818Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20241022Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250124Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250429Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250728Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchBM2520251119Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchRegex20251119Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20250910Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20260209Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20250305Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20260209Tool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createGoogleCodeExecutionTool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createGoogleEnterpriseWebSearchTool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createGoogleFileSearchTool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createGoogleGoogleMapsTool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createGoogleGoogleSearchTool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createGoogleUrlContextTool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createGoogleVertexRagStoreTool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createIntelligenceTool.md +27 -0
- package/data/packages/platform-intelligence/api/Function.createOpenAIApplyPatchTool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createOpenAICodeInterpreterTool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createOpenAICustomTool.md +27 -0
- package/data/packages/platform-intelligence/api/Function.createOpenAIFileSearchTool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createOpenAIImageGenerationTool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createOpenAILocalShellTool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createOpenAIMcpTool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createOpenAIShellTool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createOpenAIToolSearchTool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchPreviewTool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchTool.md +26 -0
- package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +15 -2
- package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +4 -4
- package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +4 -4
- package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +4 -4
- package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +79 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +30 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +106 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +29 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextStreamingOptions.md +183 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTool.md +39 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolRegistry.md +146 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +3 -3
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoaders.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTextStream.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_API_KEY.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_BASE_URL.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.AnthropicIntelligenceToolNames.md +42 -0
- package/data/packages/platform-intelligence/api/Variable.GEMINI_API_KEY.md +2 -2
- package/data/packages/platform-intelligence/api/Variable.GOOGLE_API_KEY.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.GOOGLE_BASE_URL.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.GOOGLE_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.GROK_API_KEY.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.GROK_BASE_URL.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.GROK_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.GoogleIntelligenceToolNames.md +34 -0
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_API_KEY.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_BASE_URL.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MODEL.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_PROVIDER.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.OPENAI_API_KEY.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.OPENAI_BASE_URL.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.OPENAI_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.OpenAIIntelligenceToolNames.md +40 -0
- package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.XAI_API_KEY.md +2 -2
- package/data/packages/platform-intelligence/api/Variable.XAI_BASE_URL.md +2 -2
- package/data/packages/platform-intelligence/api/index.md +64 -33
- package/data/packages/platform-intelligence/index.md +278 -69
- package/package.json +1 -1
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +0 -94
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +0 -106
- package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +0 -31
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +0 -34
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +0 -71
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +0 -70
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +0 -78
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +0 -72
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +0 -35
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +0 -70
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +0 -58
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +0 -34
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +0 -70
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +0 -34
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +0 -34
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +0 -34
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +0 -34
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md +0 -14
- package/data/packages/platform-intelligence/api/Variable.IntelligenceConversationMessageRoles.md +0 -26
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AnthropicIntelligenceToolNames'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: AnthropicIntelligenceToolNames
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const AnthropicIntelligenceToolNames: {
|
|
10
|
+
Advisor: "advisor";
|
|
11
|
+
Bash: "bash";
|
|
12
|
+
CodeExecution: "code_execution";
|
|
13
|
+
Computer: "computer";
|
|
14
|
+
Memory: "memory";
|
|
15
|
+
TextEditor: "str_replace_editor";
|
|
16
|
+
TextEditorBasedEdit: "str_replace_based_edit_tool";
|
|
17
|
+
ToolSearchBM25: "tool_search_tool_bm25";
|
|
18
|
+
ToolSearchRegex: "tool_search_tool_regex";
|
|
19
|
+
WebFetch: "web_fetch";
|
|
20
|
+
WebSearch: "web_search";
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Defined in: [providers/anthropic/AnthropicIntelligenceToolNames.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/AnthropicIntelligenceToolNames.ts#L6)
|
|
25
|
+
|
|
26
|
+
Anthropic provider-defined tool names exposed through Archipel.
|
|
27
|
+
|
|
28
|
+
## Type Declaration
|
|
29
|
+
|
|
30
|
+
| Name | Type | Default value | Defined in |
|
|
31
|
+
| ------ | ------ | ------ | ------ |
|
|
32
|
+
| <a id="property-advisor"></a> `Advisor` | `"advisor"` | `'advisor'` | [providers/anthropic/AnthropicIntelligenceToolNames.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/AnthropicIntelligenceToolNames.ts#L7) |
|
|
33
|
+
| <a id="property-bash"></a> `Bash` | `"bash"` | `'bash'` | [providers/anthropic/AnthropicIntelligenceToolNames.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/AnthropicIntelligenceToolNames.ts#L8) |
|
|
34
|
+
| <a id="property-codeexecution"></a> `CodeExecution` | `"code_execution"` | `'code_execution'` | [providers/anthropic/AnthropicIntelligenceToolNames.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/AnthropicIntelligenceToolNames.ts#L9) |
|
|
35
|
+
| <a id="property-computer"></a> `Computer` | `"computer"` | `'computer'` | [providers/anthropic/AnthropicIntelligenceToolNames.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/AnthropicIntelligenceToolNames.ts#L10) |
|
|
36
|
+
| <a id="property-memory"></a> `Memory` | `"memory"` | `'memory'` | [providers/anthropic/AnthropicIntelligenceToolNames.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/AnthropicIntelligenceToolNames.ts#L11) |
|
|
37
|
+
| <a id="property-texteditor"></a> `TextEditor` | `"str_replace_editor"` | `'str_replace_editor'` | [providers/anthropic/AnthropicIntelligenceToolNames.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/AnthropicIntelligenceToolNames.ts#L12) |
|
|
38
|
+
| <a id="property-texteditorbasededit"></a> `TextEditorBasedEdit` | `"str_replace_based_edit_tool"` | `'str_replace_based_edit_tool'` | [providers/anthropic/AnthropicIntelligenceToolNames.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/AnthropicIntelligenceToolNames.ts#L13) |
|
|
39
|
+
| <a id="property-toolsearchbm25"></a> `ToolSearchBM25` | `"tool_search_tool_bm25"` | `'tool_search_tool_bm25'` | [providers/anthropic/AnthropicIntelligenceToolNames.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/AnthropicIntelligenceToolNames.ts#L14) |
|
|
40
|
+
| <a id="property-toolsearchregex"></a> `ToolSearchRegex` | `"tool_search_tool_regex"` | `'tool_search_tool_regex'` | [providers/anthropic/AnthropicIntelligenceToolNames.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/AnthropicIntelligenceToolNames.ts#L15) |
|
|
41
|
+
| <a id="property-webfetch"></a> `WebFetch` | `"web_fetch"` | `'web_fetch'` | [providers/anthropic/AnthropicIntelligenceToolNames.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/AnthropicIntelligenceToolNames.ts#L16) |
|
|
42
|
+
| <a id="property-websearch"></a> `WebSearch` | `"web_search"` | `'web_search'` | [providers/anthropic/AnthropicIntelligenceToolNames.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/AnthropicIntelligenceToolNames.ts#L17) |
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const GEMINI_API_KEY: IConfigKey<string>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [providers/google/env.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/env.ts#L13)
|
|
13
13
|
|
|
14
|
-
Google-specific Gemini API key.
|
|
14
|
+
Google-specific Gemini API key alias.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const GOOGLE_API_KEY: IConfigKey<string>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [providers/google/env.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/env.ts#L10)
|
|
13
13
|
|
|
14
14
|
Google-specific API key.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const GOOGLE_BASE_URL: IConfigKey<string>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [providers/google/env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/env.ts#L16)
|
|
13
13
|
|
|
14
14
|
Google-specific base URL.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: GOOGLE\_CONFIG\_ENTRIES'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: GOOGLE\_CONFIG\_ENTRIES
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const GOOGLE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [providers/google/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/env.ts#L19)
|
|
13
|
+
|
|
14
|
+
Configuration entries used by the Google intelligence provider.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const GROK_API_KEY: IConfigKey<string>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [providers/grok/env.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/env.ts#L10)
|
|
13
13
|
|
|
14
14
|
Grok-specific API key.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const GROK_BASE_URL: IConfigKey<string>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [providers/grok/env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/env.ts#L16)
|
|
13
13
|
|
|
14
14
|
Grok-specific base URL.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: GROK\_CONFIG\_ENTRIES'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: GROK\_CONFIG\_ENTRIES
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const GROK_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [providers/grok/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/env.ts#L22)
|
|
13
|
+
|
|
14
|
+
Configuration entries used by the Grok intelligence provider.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: GoogleIntelligenceToolNames'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: GoogleIntelligenceToolNames
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const GoogleIntelligenceToolNames: {
|
|
10
|
+
CodeExecution: "code_execution";
|
|
11
|
+
EnterpriseWebSearch: "enterprise_web_search";
|
|
12
|
+
FileSearch: "file_search";
|
|
13
|
+
GoogleMaps: "google_maps";
|
|
14
|
+
GoogleSearch: "google_search";
|
|
15
|
+
UrlContext: "url_context";
|
|
16
|
+
VertexRagStore: "vertex_rag_store";
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [providers/google/GoogleIntelligenceToolNames.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/GoogleIntelligenceToolNames.ts#L6)
|
|
21
|
+
|
|
22
|
+
Google provider-defined tool names exposed through Archipel.
|
|
23
|
+
|
|
24
|
+
## Type Declaration
|
|
25
|
+
|
|
26
|
+
| Name | Type | Default value | Defined in |
|
|
27
|
+
| ------ | ------ | ------ | ------ |
|
|
28
|
+
| <a id="property-codeexecution"></a> `CodeExecution` | `"code_execution"` | `'code_execution'` | [providers/google/GoogleIntelligenceToolNames.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/GoogleIntelligenceToolNames.ts#L7) |
|
|
29
|
+
| <a id="property-enterprisewebsearch"></a> `EnterpriseWebSearch` | `"enterprise_web_search"` | `'enterprise_web_search'` | [providers/google/GoogleIntelligenceToolNames.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/GoogleIntelligenceToolNames.ts#L8) |
|
|
30
|
+
| <a id="property-filesearch"></a> `FileSearch` | `"file_search"` | `'file_search'` | [providers/google/GoogleIntelligenceToolNames.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/GoogleIntelligenceToolNames.ts#L9) |
|
|
31
|
+
| <a id="property-googlemaps"></a> `GoogleMaps` | `"google_maps"` | `'google_maps'` | [providers/google/GoogleIntelligenceToolNames.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/GoogleIntelligenceToolNames.ts#L10) |
|
|
32
|
+
| <a id="property-googlesearch"></a> `GoogleSearch` | `"google_search"` | `'google_search'` | [providers/google/GoogleIntelligenceToolNames.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/GoogleIntelligenceToolNames.ts#L11) |
|
|
33
|
+
| <a id="property-urlcontext"></a> `UrlContext` | `"url_context"` | `'url_context'` | [providers/google/GoogleIntelligenceToolNames.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/GoogleIntelligenceToolNames.ts#L12) |
|
|
34
|
+
| <a id="property-vertexragstore"></a> `VertexRagStore` | `"vertex_rag_store"` | `'vertex_rag_store'` | [providers/google/GoogleIntelligenceToolNames.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/GoogleIntelligenceToolNames.ts#L13) |
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const INTELLIGENCE_API_KEY: IConfigKey<string>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [env.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L40)
|
|
13
13
|
|
|
14
14
|
Global API key override for the intelligence provider.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const INTELLIGENCE_BASE_URL: IConfigKey<string>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [env.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L43)
|
|
13
13
|
|
|
14
14
|
Global base URL override for the intelligence provider.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const INTELLIGENCE_MAX_OUTPUT_TOKENS: IConfigKey<number>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [env.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L34)
|
|
13
13
|
|
|
14
14
|
Maximum number of output tokens for the AI model.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const INTELLIGENCE_MODEL: IConfigKey<string>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L25)
|
|
13
13
|
|
|
14
14
|
AI model identifier to use for text generation.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const INTELLIGENCE_PROVIDER: IConfigKey<string>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [env.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L37)
|
|
13
13
|
|
|
14
14
|
Intelligence provider name (e.g. openai, anthropic, google, grok).
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const INTELLIGENCE_TEMPERATURE: IConfigKey<number>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [env.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L28)
|
|
13
13
|
|
|
14
14
|
Sampling temperature for the AI model.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const INTELLIGENCE_TOP_P: IConfigKey<number>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [env.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L31)
|
|
13
13
|
|
|
14
14
|
Top-p (nucleus sampling) for the AI model.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const OPENAI_API_KEY: IConfigKey<string>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [providers/openai/env.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/env.ts#L10)
|
|
13
13
|
|
|
14
14
|
OpenAI-specific API key.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const OPENAI_BASE_URL: IConfigKey<string>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [providers/openai/env.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/env.ts#L13)
|
|
13
13
|
|
|
14
14
|
OpenAI-specific base URL.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: OPENAI\_CONFIG\_ENTRIES'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: OPENAI\_CONFIG\_ENTRIES
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const OPENAI_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [providers/openai/env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/env.ts#L16)
|
|
13
|
+
|
|
14
|
+
Configuration entries used by the OpenAI intelligence provider.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: OpenAIIntelligenceToolNames'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: OpenAIIntelligenceToolNames
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const OpenAIIntelligenceToolNames: {
|
|
10
|
+
ApplyPatch: "apply_patch";
|
|
11
|
+
CodeInterpreter: "code_interpreter";
|
|
12
|
+
FileSearch: "file_search";
|
|
13
|
+
ImageGeneration: "image_generation";
|
|
14
|
+
LocalShell: "local_shell";
|
|
15
|
+
Mcp: "mcp";
|
|
16
|
+
Shell: "shell";
|
|
17
|
+
ToolSearch: "tool_search";
|
|
18
|
+
WebSearch: "web_search";
|
|
19
|
+
WebSearchPreview: "web_search_preview";
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Defined in: [providers/openai/OpenAIIntelligenceToolNames.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/OpenAIIntelligenceToolNames.ts#L6)
|
|
24
|
+
|
|
25
|
+
OpenAI provider-defined tool names exposed through Archipel.
|
|
26
|
+
|
|
27
|
+
## Type Declaration
|
|
28
|
+
|
|
29
|
+
| Name | Type | Default value | Defined in |
|
|
30
|
+
| ------ | ------ | ------ | ------ |
|
|
31
|
+
| <a id="property-applypatch"></a> `ApplyPatch` | `"apply_patch"` | `'apply_patch'` | [providers/openai/OpenAIIntelligenceToolNames.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/OpenAIIntelligenceToolNames.ts#L7) |
|
|
32
|
+
| <a id="property-codeinterpreter"></a> `CodeInterpreter` | `"code_interpreter"` | `'code_interpreter'` | [providers/openai/OpenAIIntelligenceToolNames.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/OpenAIIntelligenceToolNames.ts#L8) |
|
|
33
|
+
| <a id="property-filesearch"></a> `FileSearch` | `"file_search"` | `'file_search'` | [providers/openai/OpenAIIntelligenceToolNames.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/OpenAIIntelligenceToolNames.ts#L9) |
|
|
34
|
+
| <a id="property-imagegeneration"></a> `ImageGeneration` | `"image_generation"` | `'image_generation'` | [providers/openai/OpenAIIntelligenceToolNames.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/OpenAIIntelligenceToolNames.ts#L10) |
|
|
35
|
+
| <a id="property-localshell"></a> `LocalShell` | `"local_shell"` | `'local_shell'` | [providers/openai/OpenAIIntelligenceToolNames.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/OpenAIIntelligenceToolNames.ts#L11) |
|
|
36
|
+
| <a id="property-mcp"></a> `Mcp` | `"mcp"` | `'mcp'` | [providers/openai/OpenAIIntelligenceToolNames.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/OpenAIIntelligenceToolNames.ts#L12) |
|
|
37
|
+
| <a id="property-shell"></a> `Shell` | `"shell"` | `'shell'` | [providers/openai/OpenAIIntelligenceToolNames.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/OpenAIIntelligenceToolNames.ts#L13) |
|
|
38
|
+
| <a id="property-toolsearch"></a> `ToolSearch` | `"tool_search"` | `'tool_search'` | [providers/openai/OpenAIIntelligenceToolNames.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/OpenAIIntelligenceToolNames.ts#L14) |
|
|
39
|
+
| <a id="property-websearch"></a> `WebSearch` | `"web_search"` | `'web_search'` | [providers/openai/OpenAIIntelligenceToolNames.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/OpenAIIntelligenceToolNames.ts#L15) |
|
|
40
|
+
| <a id="property-websearchpreview"></a> `WebSearchPreview` | `"web_search_preview"` | `'web_search_preview'` | [providers/openai/OpenAIIntelligenceToolNames.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/OpenAIIntelligenceToolNames.ts#L16) |
|
package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md
CHANGED
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const PLATFORM_INTELLIGENCE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [env.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L50)
|
|
13
13
|
|
|
14
14
|
All configuration entries required by `platform-intelligence`.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const XAI_API_KEY: IConfigKey<string>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [providers/grok/env.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/env.ts#L13)
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
xAI-specific API key alias for Grok.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const XAI_BASE_URL: IConfigKey<string>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [providers/grok/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/env.ts#L19)
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
xAI-specific base URL alias for Grok.
|
|
@@ -9,50 +9,37 @@ editUrl: false
|
|
|
9
9
|
|
|
10
10
|
| Class | Description |
|
|
11
11
|
| ------ | ------ |
|
|
12
|
-
| [IntelligenceCapabilityRegistrarBase](Class.IntelligenceCapabilityRegistrarBase) | Provides a reusable registration flow that allows feature modules to contribute capabilities to the global intelligence registry while keeping their implementation details private. |
|
|
13
|
-
| [IntelligenceCapabilityRegistry](Class.IntelligenceCapabilityRegistry) | Central registry responsible for resolving intelligence capabilities based on intent metadata. |
|
|
14
12
|
| [IntelligenceConfigurationError](Class.IntelligenceConfigurationError) | Error thrown when an intelligence provider configuration is invalid or missing. |
|
|
15
|
-
| [IntelligenceHealthIndicator](Class.IntelligenceHealthIndicator) | Health indicator for the intelligence infrastructure. Verifies that
|
|
16
|
-
| [IntelligenceModule](Class.IntelligenceModule) | Core module exposing the shared intelligence infrastructure
|
|
13
|
+
| [IntelligenceHealthIndicator](Class.IntelligenceHealthIndicator) | Health indicator for the intelligence infrastructure. Verifies that the intelligence provider configuration can be resolved. |
|
|
14
|
+
| [IntelligenceModule](Class.IntelligenceModule) | Core module exposing the shared intelligence infrastructure. |
|
|
17
15
|
| [IntelligenceProviderError](Class.IntelligenceProviderError) | Error thrown when an intelligence provider call fails. |
|
|
18
16
|
| [IntelligenceTextGenerator](Class.IntelligenceTextGenerator) | Executes text completions using the configured intelligence provider. |
|
|
17
|
+
| [IntelligenceToolBase](Class.IntelligenceToolBase) | Base class for class-based AI SDK tools. |
|
|
18
|
+
| [IntelligenceToolRegistry](Class.IntelligenceToolRegistry) | Registry for class-based intelligence tools. |
|
|
19
19
|
| [IntelligenceValidationError](Class.IntelligenceValidationError) | Error thrown when an intelligence input validation fails. |
|
|
20
20
|
|
|
21
21
|
## Interfaces
|
|
22
22
|
|
|
23
23
|
| Interface | Description |
|
|
24
24
|
| ------ | ------ |
|
|
25
|
-
| [IIntelligenceArtifact](Interface.IIntelligenceArtifact) | Represents a structured artifact returned by a capability. |
|
|
26
|
-
| [IIntelligenceCapability](Interface.IIntelligenceCapability) | Abstraction implemented by all capability providers. |
|
|
27
|
-
| [IIntelligenceCapabilityMetadata](Interface.IIntelligenceCapabilityMetadata) | Metadata describing a capability for orchestration and analytics purposes. |
|
|
28
|
-
| [IIntelligenceCapabilityPayload](Interface.IIntelligenceCapabilityPayload) | Payload forwarded to capabilities for execution. |
|
|
29
|
-
| [IIntelligenceCapabilityRegistry](Interface.IIntelligenceCapabilityRegistry) | Registry abstraction responsible for resolving capabilities. |
|
|
30
|
-
| [IIntelligenceCapabilityResult](Interface.IIntelligenceCapabilityResult) | Represents the outcome produced by a capability execution. |
|
|
31
25
|
| [IIntelligenceCompletionUsage](Interface.IIntelligenceCompletionUsage) | Captures usage telemetry returned by the intelligence provider. |
|
|
32
|
-
| [
|
|
33
|
-
| [IIntelligenceContextBuilder](Interface.IIntelligenceContextBuilder) | Responsible for composing the context supplied to capabilities. |
|
|
34
|
-
| [IIntelligenceConversationMessageSnapshot](Interface.IIntelligenceConversationMessageSnapshot) | Represents a single message returned within a conversation snapshot. |
|
|
35
|
-
| [IIntelligenceConversationSnapshot](Interface.IIntelligenceConversationSnapshot) | Represents a lightweight snapshot of a conversation used for context building. |
|
|
36
|
-
| [IIntelligenceFollowUpQuestion](Interface.IIntelligenceFollowUpQuestion) | Represents a follow-up question suggested to keep the dialogue active. |
|
|
37
|
-
| [IIntelligenceIntent](Interface.IIntelligenceIntent) | Represents the structured intent resolved from a user message. |
|
|
38
|
-
| [IIntelligenceIntentEntity](Interface.IIntelligenceIntentEntity) | Represents an entity extracted from a resolved intelligence intent. |
|
|
39
|
-
| [IIntelligenceMessageModel](Interface.IIntelligenceMessageModel) | Represents a normalized message stored in persistence. |
|
|
40
|
-
| [IIntelligenceMessagePayload](Interface.IIntelligenceMessagePayload) | Carries the payload submitted when messaging the intelligence entrypoint. |
|
|
41
|
-
| [IIntelligencePrompt](Interface.IIntelligencePrompt) | Represents the input supplied to the intelligence text generator. |
|
|
42
|
-
| [IIntelligencePromptMessage](Interface.IIntelligencePromptMessage) | Describes a normalized message used for text generation prompts. |
|
|
26
|
+
| [IIntelligenceModuleOptions](Interface.IIntelligenceModuleOptions) | Options for configuring the intelligence module. |
|
|
43
27
|
| [IIntelligenceProviderConfiguration](Interface.IIntelligenceProviderConfiguration) | Describes the resolved configuration for the intelligence provider. |
|
|
44
|
-
| [IIntelligenceResponseMessage](Interface.IIntelligenceResponseMessage) | Represents a single assistant message returned by a capability. |
|
|
45
28
|
| [IIntelligenceTextCompletion](Interface.IIntelligenceTextCompletion) | Represents the normalized completion result produced by the intelligence provider. |
|
|
46
29
|
| [IIntelligenceTextGenerationOptions](Interface.IIntelligenceTextGenerationOptions) | Options that can be supplied when generating text with the intelligence provider. |
|
|
47
30
|
| [IIntelligenceTextGenerator](Interface.IIntelligenceTextGenerator) | Abstraction responsible for executing text completions using the configured provider. |
|
|
31
|
+
| [IIntelligenceTextStreamingOptions](Interface.IIntelligenceTextStreamingOptions) | Options that can be supplied when streaming text with the intelligence provider. |
|
|
32
|
+
| [IIntelligenceTool](Interface.IIntelligenceTool) | Minimal shape required by the intelligence tool registry. |
|
|
33
|
+
| [IIntelligenceToolRegistry](Interface.IIntelligenceToolRegistry) | Contract for the intelligence tool registry. |
|
|
48
34
|
|
|
49
35
|
## Type Aliases
|
|
50
36
|
|
|
51
37
|
| Type Alias | Description |
|
|
52
38
|
| ------ | ------ |
|
|
53
|
-
| [
|
|
54
|
-
| [
|
|
39
|
+
| [IntelligenceLanguageModelLoader](TypeAlias.IntelligenceLanguageModelLoader) | Represents a factory responsible for creating a configured language model instance. |
|
|
40
|
+
| [IntelligenceLanguageModelLoaders](TypeAlias.IntelligenceLanguageModelLoaders) | Maps configured intelligence providers to their tree-shakable model loader. |
|
|
55
41
|
| [IntelligenceProviderName](TypeAlias.IntelligenceProviderName) | Represents the union of supported intelligence provider identifiers. |
|
|
42
|
+
| [IntelligenceTextStream](TypeAlias.IntelligenceTextStream) | Native AI SDK streaming result returned by the intelligence text generator. |
|
|
56
43
|
|
|
57
44
|
## Variables
|
|
58
45
|
|
|
@@ -60,11 +47,16 @@ editUrl: false
|
|
|
60
47
|
| ------ | ------ |
|
|
61
48
|
| [ANTHROPIC\_API\_KEY](Variable.ANTHROPIC_API_KEY) | Anthropic-specific API key. |
|
|
62
49
|
| [ANTHROPIC\_BASE\_URL](Variable.ANTHROPIC_BASE_URL) | Anthropic-specific base URL. |
|
|
63
|
-
| [
|
|
50
|
+
| [ANTHROPIC\_CONFIG\_ENTRIES](Variable.ANTHROPIC_CONFIG_ENTRIES) | Configuration entries used by the Anthropic intelligence provider. |
|
|
51
|
+
| [AnthropicIntelligenceToolNames](Variable.AnthropicIntelligenceToolNames) | Anthropic provider-defined tool names exposed through Archipel. |
|
|
52
|
+
| [GEMINI\_API\_KEY](Variable.GEMINI_API_KEY) | Google-specific Gemini API key alias. |
|
|
64
53
|
| [GOOGLE\_API\_KEY](Variable.GOOGLE_API_KEY) | Google-specific API key. |
|
|
65
54
|
| [GOOGLE\_BASE\_URL](Variable.GOOGLE_BASE_URL) | Google-specific base URL. |
|
|
55
|
+
| [GOOGLE\_CONFIG\_ENTRIES](Variable.GOOGLE_CONFIG_ENTRIES) | Configuration entries used by the Google intelligence provider. |
|
|
56
|
+
| [GoogleIntelligenceToolNames](Variable.GoogleIntelligenceToolNames) | Google provider-defined tool names exposed through Archipel. |
|
|
66
57
|
| [GROK\_API\_KEY](Variable.GROK_API_KEY) | Grok-specific API key. |
|
|
67
58
|
| [GROK\_BASE\_URL](Variable.GROK_BASE_URL) | Grok-specific base URL. |
|
|
59
|
+
| [GROK\_CONFIG\_ENTRIES](Variable.GROK_CONFIG_ENTRIES) | Configuration entries used by the Grok intelligence provider. |
|
|
68
60
|
| [INTELLIGENCE\_API\_KEY](Variable.INTELLIGENCE_API_KEY) | Global API key override for the intelligence provider. |
|
|
69
61
|
| [INTELLIGENCE\_BASE\_URL](Variable.INTELLIGENCE_BASE_URL) | Global base URL override for the intelligence provider. |
|
|
70
62
|
| [INTELLIGENCE\_MAX\_OUTPUT\_TOKENS](Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS) | Maximum number of output tokens for the AI model. |
|
|
@@ -72,21 +64,60 @@ editUrl: false
|
|
|
72
64
|
| [INTELLIGENCE\_PROVIDER](Variable.INTELLIGENCE_PROVIDER) | Intelligence provider name (e.g. openai, anthropic, google, grok). |
|
|
73
65
|
| [INTELLIGENCE\_TEMPERATURE](Variable.INTELLIGENCE_TEMPERATURE) | Sampling temperature for the AI model. |
|
|
74
66
|
| [INTELLIGENCE\_TOP\_P](Variable.INTELLIGENCE_TOP_P) | Top-p (nucleus sampling) for the AI model. |
|
|
75
|
-
| [IntelligenceConversationMessageRoles](Variable.IntelligenceConversationMessageRoles) | Enumerates the conversation roles used for contextual snapshots and messages. |
|
|
76
67
|
| [IntelligenceProviderNames](Variable.IntelligenceProviderNames) | Enumerates the supported model providers powering the intelligence pipeline. |
|
|
77
68
|
| [OPENAI\_API\_KEY](Variable.OPENAI_API_KEY) | OpenAI-specific API key. |
|
|
78
69
|
| [OPENAI\_BASE\_URL](Variable.OPENAI_BASE_URL) | OpenAI-specific base URL. |
|
|
70
|
+
| [OPENAI\_CONFIG\_ENTRIES](Variable.OPENAI_CONFIG_ENTRIES) | Configuration entries used by the OpenAI intelligence provider. |
|
|
71
|
+
| [OpenAIIntelligenceToolNames](Variable.OpenAIIntelligenceToolNames) | OpenAI provider-defined tool names exposed through Archipel. |
|
|
79
72
|
| [PLATFORM\_INTELLIGENCE\_CONFIG\_ENTRIES](Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES) | All configuration entries required by `platform-intelligence`. |
|
|
80
|
-
| [XAI\_API\_KEY](Variable.XAI_API_KEY) |
|
|
81
|
-
| [XAI\_BASE\_URL](Variable.XAI_BASE_URL) |
|
|
73
|
+
| [XAI\_API\_KEY](Variable.XAI_API_KEY) | xAI-specific API key alias for Grok. |
|
|
74
|
+
| [XAI\_BASE\_URL](Variable.XAI_BASE_URL) | xAI-specific base URL alias for Grok. |
|
|
82
75
|
|
|
83
76
|
## Functions
|
|
84
77
|
|
|
85
78
|
| Function | Description |
|
|
86
79
|
| ------ | ------ |
|
|
80
|
+
| [createAnthropicAdvisor20260301Tool](Function.createAnthropicAdvisor20260301Tool) | Creates an Anthropic advisor tool registration. |
|
|
81
|
+
| [createAnthropicBash20241022Tool](Function.createAnthropicBash20241022Tool) | Creates an Anthropic bash tool registration for the 2024-10-22 version. |
|
|
82
|
+
| [createAnthropicBash20250124Tool](Function.createAnthropicBash20250124Tool) | Creates an Anthropic bash tool registration for the 2025-01-24 version. |
|
|
83
|
+
| [createAnthropicCodeExecution20250522Tool](Function.createAnthropicCodeExecution20250522Tool) | Creates an Anthropic code-execution tool registration for the 2025-05-22 version. |
|
|
84
|
+
| [createAnthropicCodeExecution20250825Tool](Function.createAnthropicCodeExecution20250825Tool) | Creates an Anthropic code-execution tool registration for the 2025-08-25 version. |
|
|
85
|
+
| [createAnthropicCodeExecution20260120Tool](Function.createAnthropicCodeExecution20260120Tool) | Creates an Anthropic code-execution tool registration for the 2026-01-20 version. |
|
|
86
|
+
| [createAnthropicComputer20241022Tool](Function.createAnthropicComputer20241022Tool) | Creates an Anthropic computer-use tool registration for the 2024-10-22 version. |
|
|
87
|
+
| [createAnthropicComputer20250124Tool](Function.createAnthropicComputer20250124Tool) | Creates an Anthropic computer-use tool registration for the 2025-01-24 version. |
|
|
88
|
+
| [createAnthropicComputer20251124Tool](Function.createAnthropicComputer20251124Tool) | Creates an Anthropic computer-use tool registration for the 2025-11-24 version. |
|
|
89
|
+
| [createAnthropicMemory20250818Tool](Function.createAnthropicMemory20250818Tool) | Creates an Anthropic memory tool registration. |
|
|
90
|
+
| [createAnthropicTextEditor20241022Tool](Function.createAnthropicTextEditor20241022Tool) | Creates an Anthropic text-editor tool registration for the 2024-10-22 version. |
|
|
91
|
+
| [createAnthropicTextEditor20250124Tool](Function.createAnthropicTextEditor20250124Tool) | Creates an Anthropic text-editor tool registration for the 2025-01-24 version. |
|
|
92
|
+
| [createAnthropicTextEditor20250429Tool](Function.createAnthropicTextEditor20250429Tool) | Creates an Anthropic text-editor tool registration for the 2025-04-29 version. |
|
|
93
|
+
| [createAnthropicTextEditor20250728Tool](Function.createAnthropicTextEditor20250728Tool) | Creates an Anthropic text-editor tool registration for the 2025-07-28 version. |
|
|
94
|
+
| [createAnthropicToolSearchBM2520251119Tool](Function.createAnthropicToolSearchBM2520251119Tool) | Creates an Anthropic BM25 tool-search tool registration. |
|
|
95
|
+
| [createAnthropicToolSearchRegex20251119Tool](Function.createAnthropicToolSearchRegex20251119Tool) | Creates an Anthropic regex tool-search tool registration. |
|
|
96
|
+
| [createAnthropicWebFetch20250910Tool](Function.createAnthropicWebFetch20250910Tool) | Creates an Anthropic web-fetch tool registration for the 2025-09-10 version. |
|
|
97
|
+
| [createAnthropicWebFetch20260209Tool](Function.createAnthropicWebFetch20260209Tool) | Creates an Anthropic web-fetch tool registration for the 2026-02-09 version. |
|
|
98
|
+
| [createAnthropicWebSearch20250305Tool](Function.createAnthropicWebSearch20250305Tool) | Creates an Anthropic web-search tool registration for the 2025-03-05 version. |
|
|
99
|
+
| [createAnthropicWebSearch20260209Tool](Function.createAnthropicWebSearch20260209Tool) | Creates an Anthropic web-search tool registration for the 2026-02-09 version. |
|
|
100
|
+
| [createGoogleCodeExecutionTool](Function.createGoogleCodeExecutionTool) | Creates a Google code-execution tool registration. |
|
|
101
|
+
| [createGoogleEnterpriseWebSearchTool](Function.createGoogleEnterpriseWebSearchTool) | Creates a Google enterprise-web-search tool registration. |
|
|
102
|
+
| [createGoogleFileSearchTool](Function.createGoogleFileSearchTool) | Creates a Google file-search tool registration. |
|
|
103
|
+
| [createGoogleGoogleMapsTool](Function.createGoogleGoogleMapsTool) | Creates a Google Maps grounding tool registration. |
|
|
104
|
+
| [createGoogleGoogleSearchTool](Function.createGoogleGoogleSearchTool) | Creates a Google Search grounding tool registration. |
|
|
105
|
+
| [createGoogleUrlContextTool](Function.createGoogleUrlContextTool) | Creates a Google URL context tool registration. |
|
|
106
|
+
| [createGoogleVertexRagStoreTool](Function.createGoogleVertexRagStoreTool) | Creates a Google Vertex RAG Store tool registration. |
|
|
107
|
+
| [createIntelligenceTool](Function.createIntelligenceTool) | Adapts a native AI SDK tool to the Archipel intelligence tool schema. |
|
|
108
|
+
| [createOpenAIApplyPatchTool](Function.createOpenAIApplyPatchTool) | Creates an OpenAI apply-patch tool registration. |
|
|
109
|
+
| [createOpenAICodeInterpreterTool](Function.createOpenAICodeInterpreterTool) | Creates an OpenAI code-interpreter tool registration. |
|
|
110
|
+
| [createOpenAICustomTool](Function.createOpenAICustomTool) | Creates an OpenAI custom provider-defined tool registration. |
|
|
111
|
+
| [createOpenAIFileSearchTool](Function.createOpenAIFileSearchTool) | Creates an OpenAI file-search tool registration. |
|
|
112
|
+
| [createOpenAIImageGenerationTool](Function.createOpenAIImageGenerationTool) | Creates an OpenAI image-generation tool registration. |
|
|
113
|
+
| [createOpenAILocalShellTool](Function.createOpenAILocalShellTool) | Creates an OpenAI local-shell tool registration. |
|
|
114
|
+
| [createOpenAIMcpTool](Function.createOpenAIMcpTool) | Creates an OpenAI MCP connector tool registration. |
|
|
115
|
+
| [createOpenAIShellTool](Function.createOpenAIShellTool) | Creates an OpenAI shell tool registration. |
|
|
116
|
+
| [createOpenAIToolSearchTool](Function.createOpenAIToolSearchTool) | Creates an OpenAI tool-search tool registration. |
|
|
117
|
+
| [createOpenAIWebSearchPreviewTool](Function.createOpenAIWebSearchPreviewTool) | Creates an OpenAI web-search-preview tool registration. |
|
|
118
|
+
| [createOpenAIWebSearchTool](Function.createOpenAIWebSearchTool) | Creates an OpenAI web-search tool registration. |
|
|
87
119
|
| [createProviderOptions](Function.createProviderOptions) | Creates the provider options object consumed by the AI SDK model factories. |
|
|
88
|
-
| [loadAnthropicLanguageModel](Function.loadAnthropicLanguageModel) |
|
|
89
|
-
| [loadGoogleLanguageModel](Function.loadGoogleLanguageModel) |
|
|
90
|
-
| [loadGrokLanguageModel](Function.loadGrokLanguageModel) |
|
|
91
|
-
| [loadOpenAILanguageModel](Function.loadOpenAILanguageModel) |
|
|
92
|
-
| [loadProviderFactory](Function.loadProviderFactory) | Dynamically loads an AI SDK provider factory and returns the exported function reference. |
|
|
120
|
+
| [loadAnthropicLanguageModel](Function.loadAnthropicLanguageModel) | Creates the Anthropic language model from the resolved provider configuration. |
|
|
121
|
+
| [loadGoogleLanguageModel](Function.loadGoogleLanguageModel) | Creates the Google Gemini language model from the resolved provider configuration. |
|
|
122
|
+
| [loadGrokLanguageModel](Function.loadGrokLanguageModel) | Creates the Grok language model through the OpenAI-compatible xAI endpoint. |
|
|
123
|
+
| [loadOpenAILanguageModel](Function.loadOpenAILanguageModel) | Creates the OpenAI language model from the resolved provider configuration. |
|