@breadstone/archipel-mcp 0.0.43 → 0.0.45

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.
Files changed (120) hide show
  1. package/data/guides/ai-text-generation.md +402 -111
  2. package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +5 -5
  3. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +26 -2
  4. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +43 -9
  5. package/data/packages/platform-intelligence/api/Class.IntelligenceToolBase.md +93 -0
  6. package/data/packages/platform-intelligence/api/Class.IntelligenceToolRegistry.md +217 -0
  7. package/data/packages/platform-intelligence/api/Function.createAnthropicAdvisor20260301Tool.md +26 -0
  8. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20241022Tool.md +26 -0
  9. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20250124Tool.md +26 -0
  10. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250522Tool.md +26 -0
  11. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250825Tool.md +26 -0
  12. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20260120Tool.md +26 -0
  13. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20241022Tool.md +26 -0
  14. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20250124Tool.md +26 -0
  15. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20251124Tool.md +26 -0
  16. package/data/packages/platform-intelligence/api/Function.createAnthropicMemory20250818Tool.md +26 -0
  17. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20241022Tool.md +26 -0
  18. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250124Tool.md +26 -0
  19. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250429Tool.md +26 -0
  20. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250728Tool.md +26 -0
  21. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchBM2520251119Tool.md +26 -0
  22. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchRegex20251119Tool.md +26 -0
  23. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20250910Tool.md +26 -0
  24. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20260209Tool.md +26 -0
  25. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20250305Tool.md +26 -0
  26. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20260209Tool.md +26 -0
  27. package/data/packages/platform-intelligence/api/Function.createGoogleCodeExecutionTool.md +26 -0
  28. package/data/packages/platform-intelligence/api/Function.createGoogleEnterpriseWebSearchTool.md +26 -0
  29. package/data/packages/platform-intelligence/api/Function.createGoogleFileSearchTool.md +26 -0
  30. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleMapsTool.md +26 -0
  31. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleSearchTool.md +26 -0
  32. package/data/packages/platform-intelligence/api/Function.createGoogleUrlContextTool.md +26 -0
  33. package/data/packages/platform-intelligence/api/Function.createGoogleVertexRagStoreTool.md +26 -0
  34. package/data/packages/platform-intelligence/api/Function.createGrokCodeExecutionTool.md +26 -0
  35. package/data/packages/platform-intelligence/api/Function.createGrokFileSearchTool.md +26 -0
  36. package/data/packages/platform-intelligence/api/Function.createGrokMcpServerTool.md +26 -0
  37. package/data/packages/platform-intelligence/api/Function.createGrokViewImageTool.md +26 -0
  38. package/data/packages/platform-intelligence/api/Function.createGrokViewXVideoTool.md +26 -0
  39. package/data/packages/platform-intelligence/api/Function.createGrokWebSearchTool.md +26 -0
  40. package/data/packages/platform-intelligence/api/Function.createGrokXSearchTool.md +26 -0
  41. package/data/packages/platform-intelligence/api/Function.createIntelligenceTool.md +27 -0
  42. package/data/packages/platform-intelligence/api/Function.createOpenAIApplyPatchTool.md +26 -0
  43. package/data/packages/platform-intelligence/api/Function.createOpenAICodeInterpreterTool.md +26 -0
  44. package/data/packages/platform-intelligence/api/Function.createOpenAICustomTool.md +27 -0
  45. package/data/packages/platform-intelligence/api/Function.createOpenAIFileSearchTool.md +26 -0
  46. package/data/packages/platform-intelligence/api/Function.createOpenAIImageGenerationTool.md +26 -0
  47. package/data/packages/platform-intelligence/api/Function.createOpenAILocalShellTool.md +26 -0
  48. package/data/packages/platform-intelligence/api/Function.createOpenAIMcpTool.md +26 -0
  49. package/data/packages/platform-intelligence/api/Function.createOpenAIShellTool.md +26 -0
  50. package/data/packages/platform-intelligence/api/Function.createOpenAIToolSearchTool.md +26 -0
  51. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchPreviewTool.md +26 -0
  52. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchTool.md +26 -0
  53. package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +15 -2
  54. package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +4 -4
  55. package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +4 -4
  56. package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +4 -4
  57. package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +4 -4
  58. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +79 -0
  59. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +30 -6
  60. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +106 -5
  61. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +29 -4
  62. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextStreamingOptions.md +183 -0
  63. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTool.md +39 -0
  64. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolRegistry.md +146 -0
  65. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +3 -3
  66. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoaders.md +14 -0
  67. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTextStream.md +14 -0
  68. package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_API_KEY.md +1 -1
  69. package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_BASE_URL.md +1 -1
  70. package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_CONFIG_ENTRIES.md +14 -0
  71. package/data/packages/platform-intelligence/api/Variable.AnthropicIntelligenceToolNames.md +42 -0
  72. package/data/packages/platform-intelligence/api/Variable.GEMINI_API_KEY.md +2 -2
  73. package/data/packages/platform-intelligence/api/Variable.GOOGLE_API_KEY.md +1 -1
  74. package/data/packages/platform-intelligence/api/Variable.GOOGLE_BASE_URL.md +1 -1
  75. package/data/packages/platform-intelligence/api/Variable.GOOGLE_CONFIG_ENTRIES.md +14 -0
  76. package/data/packages/platform-intelligence/api/Variable.GROK_API_KEY.md +1 -1
  77. package/data/packages/platform-intelligence/api/Variable.GROK_BASE_URL.md +1 -1
  78. package/data/packages/platform-intelligence/api/Variable.GROK_CONFIG_ENTRIES.md +14 -0
  79. package/data/packages/platform-intelligence/api/Variable.GoogleIntelligenceToolNames.md +34 -0
  80. package/data/packages/platform-intelligence/api/Variable.GrokIntelligenceToolNames.md +34 -0
  81. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_API_KEY.md +1 -1
  82. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_BASE_URL.md +1 -1
  83. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
  84. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MODEL.md +1 -1
  85. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_PROVIDER.md +1 -1
  86. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
  87. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
  88. package/data/packages/platform-intelligence/api/Variable.OPENAI_API_KEY.md +1 -1
  89. package/data/packages/platform-intelligence/api/Variable.OPENAI_BASE_URL.md +1 -1
  90. package/data/packages/platform-intelligence/api/Variable.OPENAI_CONFIG_ENTRIES.md +14 -0
  91. package/data/packages/platform-intelligence/api/Variable.OpenAIIntelligenceToolNames.md +40 -0
  92. package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +1 -1
  93. package/data/packages/platform-intelligence/api/Variable.XAI_API_KEY.md +2 -2
  94. package/data/packages/platform-intelligence/api/Variable.XAI_BASE_URL.md +2 -2
  95. package/data/packages/platform-intelligence/api/index.md +72 -33
  96. package/data/packages/platform-intelligence/index.md +280 -69
  97. package/package.json +1 -1
  98. package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +0 -94
  99. package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +0 -106
  100. package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +0 -31
  101. package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +0 -34
  102. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +0 -71
  103. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +0 -70
  104. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +0 -46
  105. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +0 -78
  106. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +0 -46
  107. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +0 -72
  108. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +0 -35
  109. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +0 -70
  110. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +0 -58
  111. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +0 -46
  112. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +0 -46
  113. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +0 -34
  114. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +0 -70
  115. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +0 -34
  116. package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +0 -34
  117. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +0 -34
  118. package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +0 -34
  119. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md +0 -14
  120. package/data/packages/platform-intelligence/api/Variable.IntelligenceConversationMessageRoles.md +0 -26
@@ -1,94 +0,0 @@
1
- ---
2
- title: 'Abstract Class: IntelligenceCapabilityRegistrarBase'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Abstract Class: IntelligenceCapabilityRegistrarBase
7
-
8
- Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceCapabilityRegistrarBase.ts#L15)
9
-
10
- Provides a reusable registration flow that allows feature modules to contribute
11
- capabilities to the global intelligence registry while keeping their implementation details private.
12
-
13
- ## Implements
14
-
15
- - `OnModuleInit`
16
-
17
- ## Constructors
18
-
19
- ### Constructor
20
-
21
- ```ts
22
- protected new IntelligenceCapabilityRegistrarBase(registry): IntelligenceCapabilityRegistrarBase;
23
- ```
24
-
25
- Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceCapabilityRegistrarBase.ts#L30)
26
-
27
- Initializes a new instance of the IntelligenceCapabilityRegistrarBase class.
28
-
29
- #### Parameters
30
-
31
- | Parameter | Type | Description |
32
- | ------ | ------ | ------ |
33
- | `registry` | [`IntelligenceCapabilityRegistry`](Class.IntelligenceCapabilityRegistry) | Registry instance that receives contributed capabilities. |
34
-
35
- #### Returns
36
-
37
- `IntelligenceCapabilityRegistrarBase`
38
-
39
- ## Accessors
40
-
41
- ### registry
42
-
43
- #### Get Signature
44
-
45
- ```ts
46
- get protected registry(): IntelligenceCapabilityRegistry;
47
- ```
48
-
49
- Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceCapabilityRegistrarBase.ts#L44)
50
-
51
- Gets the registry instance that should be used to register capabilities.
52
-
53
- ##### Returns
54
-
55
- [`IntelligenceCapabilityRegistry`](Class.IntelligenceCapabilityRegistry)
56
-
57
- ## Methods
58
-
59
- ### getCapabilities()
60
-
61
- ```ts
62
- abstract protected getCapabilities(): readonly IIntelligenceCapability[];
63
- ```
64
-
65
- Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceCapabilityRegistrarBase.ts#L74)
66
-
67
- Returns the capabilities that should be registered for the module.
68
-
69
- #### Returns
70
-
71
- readonly [`IIntelligenceCapability`](Interface.IIntelligenceCapability)[]
72
-
73
- ***
74
-
75
- ### onModuleInit()
76
-
77
- ```ts
78
- onModuleInit(): void;
79
- ```
80
-
81
- Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceCapabilityRegistrarBase.ts#L58)
82
-
83
- Template method invoked by NestJS once the provider has been instantiated.
84
- Registers all capabilities returned by [getCapabilities](#getcapabilities).
85
-
86
- #### Returns
87
-
88
- `void`
89
-
90
- #### Implementation of
91
-
92
- ```ts
93
- OnModuleInit.onModuleInit
94
- ```
@@ -1,106 +0,0 @@
1
- ---
2
- title: 'Class: IntelligenceCapabilityRegistry'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Class: IntelligenceCapabilityRegistry
7
-
8
- Defined in: [IntelligenceCapabilityRegistry.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceCapabilityRegistry.ts#L15)
9
-
10
- Central registry responsible for resolving intelligence capabilities based on intent metadata.
11
-
12
- ## Implements
13
-
14
- - [`IIntelligenceCapabilityRegistry`](Interface.IIntelligenceCapabilityRegistry)
15
-
16
- ## Constructors
17
-
18
- ### Constructor
19
-
20
- ```ts
21
- new IntelligenceCapabilityRegistry(): IntelligenceCapabilityRegistry;
22
- ```
23
-
24
- #### Returns
25
-
26
- `IntelligenceCapabilityRegistry`
27
-
28
- ## Methods
29
-
30
- ### list()
31
-
32
- ```ts
33
- list(): readonly IIntelligenceCapability[];
34
- ```
35
-
36
- Defined in: [IntelligenceCapabilityRegistry.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceCapabilityRegistry.ts#L45)
37
-
38
- Returns a read-only snapshot of all registered capabilities.
39
-
40
- #### Returns
41
-
42
- readonly [`IIntelligenceCapability`](Interface.IIntelligenceCapability)[]
43
-
44
- A defensive copy of the registered capabilities.
45
-
46
- #### Implementation of
47
-
48
- [`IIntelligenceCapabilityRegistry`](Interface.IIntelligenceCapabilityRegistry).[`list`](Interface.IIntelligenceCapabilityRegistry#list)
49
-
50
- ***
51
-
52
- ### register()
53
-
54
- ```ts
55
- register(capability): void;
56
- ```
57
-
58
- Defined in: [IntelligenceCapabilityRegistry.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceCapabilityRegistry.ts#L27)
59
-
60
- Registers a capability in the registry.
61
-
62
- #### Parameters
63
-
64
- | Parameter | Type | Description |
65
- | ------ | ------ | ------ |
66
- | `capability` | [`IIntelligenceCapability`](Interface.IIntelligenceCapability) | The capability to register. |
67
-
68
- #### Returns
69
-
70
- `void`
71
-
72
- #### Implementation of
73
-
74
- [`IIntelligenceCapabilityRegistry`](Interface.IIntelligenceCapabilityRegistry).[`register`](Interface.IIntelligenceCapabilityRegistry#register)
75
-
76
- ***
77
-
78
- ### resolve()
79
-
80
- ```ts
81
- resolve(intent, context):
82
- | IIntelligenceCapability
83
- | null;
84
- ```
85
-
86
- Defined in: [IntelligenceCapabilityRegistry.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceCapabilityRegistry.ts#L40)
87
-
88
- Resolves the most suitable capability for the given intent and context.
89
-
90
- #### Parameters
91
-
92
- | Parameter | Type | Description |
93
- | ------ | ------ | ------ |
94
- | `intent` | [`IIntelligenceIntent`](Interface.IIntelligenceIntent) | The structured intent to match against. |
95
- | `context` | [`IIntelligenceContext`](Interface.IIntelligenceContext) | The aggregated context for the request. |
96
-
97
- #### Returns
98
-
99
- \| [`IIntelligenceCapability`](Interface.IIntelligenceCapability)
100
- \| `null`
101
-
102
- The matching capability, or `null` if none qualifies.
103
-
104
- #### Implementation of
105
-
106
- [`IIntelligenceCapabilityRegistry`](Interface.IIntelligenceCapabilityRegistry).[`resolve`](Interface.IIntelligenceCapabilityRegistry#resolve)
@@ -1,31 +0,0 @@
1
- ---
2
- title: 'Function: loadProviderFactory()'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Function: loadProviderFactory()
7
-
8
- ```ts
9
- function loadProviderFactory(moduleName, exportName): Promise<(model, options) => LanguageModelV2>;
10
- ```
11
-
12
- Defined in: [providers/ProviderFactoryLoader.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/ProviderFactoryLoader.ts#L17)
13
-
14
- Dynamically loads an AI SDK provider factory and returns the exported function reference.
15
-
16
- ## Parameters
17
-
18
- | Parameter | Type | Description |
19
- | ------ | ------ | ------ |
20
- | `moduleName` | `string` | The module that exports the factory function. |
21
- | `exportName` | `string` | The named export containing the factory function. |
22
-
23
- ## Returns
24
-
25
- `Promise`\<(`model`, `options`) => `LanguageModelV2`\>
26
-
27
- The resolved factory function.
28
-
29
- ## Throws
30
-
31
- When the module cannot be imported or the export is not a function.
@@ -1,34 +0,0 @@
1
- ---
2
- title: 'Interface: IIntelligenceArtifact'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IIntelligenceArtifact
7
-
8
- Defined in: [contracts/IIntelligenceArtifact.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceArtifact.ts#L6)
9
-
10
- Represents a structured artifact returned by a capability.
11
-
12
- ## Properties
13
-
14
- ### data
15
-
16
- ```ts
17
- readonly data: Record<string, unknown>;
18
- ```
19
-
20
- Defined in: [contracts/IIntelligenceArtifact.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceArtifact.ts#L21)
21
-
22
- The structured data payload of the artifact.
23
-
24
- ***
25
-
26
- ### type
27
-
28
- ```ts
29
- readonly type: string;
30
- ```
31
-
32
- Defined in: [contracts/IIntelligenceArtifact.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceArtifact.ts#L14)
33
-
34
- The artifact type discriminator.
@@ -1,71 +0,0 @@
1
- ---
2
- title: 'Interface: IIntelligenceCapability'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IIntelligenceCapability
7
-
8
- Defined in: [contracts/IIntelligenceCapability.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapability.ts#L16)
9
-
10
- Abstraction implemented by all capability providers.
11
-
12
- ## Properties
13
-
14
- ### metadata
15
-
16
- ```ts
17
- readonly metadata: IIntelligenceCapabilityMetadata;
18
- ```
19
-
20
- Defined in: [contracts/IIntelligenceCapability.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapability.ts#L24)
21
-
22
- Metadata describing the capability for orchestration and analytics purposes.
23
-
24
- ## Methods
25
-
26
- ### canHandle()
27
-
28
- ```ts
29
- canHandle(intent, context): boolean;
30
- ```
31
-
32
- Defined in: [contracts/IIntelligenceCapability.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapability.ts#L38)
33
-
34
- Determines whether this capability can handle the given intent and context.
35
-
36
- #### Parameters
37
-
38
- | Parameter | Type | Description |
39
- | ------ | ------ | ------ |
40
- | `intent` | [`IIntelligenceIntent`](Interface.IIntelligenceIntent) | The structured intent to evaluate. |
41
- | `context` | [`IIntelligenceContext`](Interface.IIntelligenceContext) | The aggregated context for the request. |
42
-
43
- #### Returns
44
-
45
- `boolean`
46
-
47
- `true` if the capability can handle the intent; otherwise `false`.
48
-
49
- ***
50
-
51
- ### execute()
52
-
53
- ```ts
54
- execute(payload): Promise<IIntelligenceCapabilityResult>;
55
- ```
56
-
57
- Defined in: [contracts/IIntelligenceCapability.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapability.ts#L47)
58
-
59
- Executes the capability with the given payload.
60
-
61
- #### Parameters
62
-
63
- | Parameter | Type | Description |
64
- | ------ | ------ | ------ |
65
- | `payload` | [`IIntelligenceCapabilityPayload`](Interface.IIntelligenceCapabilityPayload) | The payload forwarded for execution. |
66
-
67
- #### Returns
68
-
69
- `Promise`\<[`IIntelligenceCapabilityResult`](Interface.IIntelligenceCapabilityResult)\>
70
-
71
- The capability execution result.
@@ -1,70 +0,0 @@
1
- ---
2
- title: 'Interface: IIntelligenceCapabilityMetadata'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IIntelligenceCapabilityMetadata
7
-
8
- Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L6)
9
-
10
- Metadata describing a capability for orchestration and analytics purposes.
11
-
12
- ## Properties
13
-
14
- ### description
15
-
16
- ```ts
17
- readonly description: string;
18
- ```
19
-
20
- Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L28)
21
-
22
- A brief description of what the capability does.
23
-
24
- ***
25
-
26
- ### id
27
-
28
- ```ts
29
- readonly id: string;
30
- ```
31
-
32
- Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L14)
33
-
34
- Unique identifier for the capability.
35
-
36
- ***
37
-
38
- ### intentName
39
-
40
- ```ts
41
- readonly intentName: string;
42
- ```
43
-
44
- Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L42)
45
-
46
- The intent name this capability is designed to handle.
47
-
48
- ***
49
-
50
- ### name
51
-
52
- ```ts
53
- readonly name: string;
54
- ```
55
-
56
- Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L21)
57
-
58
- Human-readable name of the capability.
59
-
60
- ***
61
-
62
- ### priority
63
-
64
- ```ts
65
- readonly priority: number;
66
- ```
67
-
68
- Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L35)
69
-
70
- Evaluation priority (lower values are evaluated first).
@@ -1,46 +0,0 @@
1
- ---
2
- title: 'Interface: IIntelligenceCapabilityPayload'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IIntelligenceCapabilityPayload
7
-
8
- Defined in: [contracts/IIntelligenceCapabilityPayload.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityPayload.ts#L13)
9
-
10
- Payload forwarded to capabilities for execution.
11
-
12
- ## Properties
13
-
14
- ### context
15
-
16
- ```ts
17
- readonly context: IIntelligenceContext;
18
- ```
19
-
20
- Defined in: [contracts/IIntelligenceCapabilityPayload.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityPayload.ts#L28)
21
-
22
- The aggregated context for the request.
23
-
24
- ***
25
-
26
- ### intent
27
-
28
- ```ts
29
- readonly intent: IIntelligenceIntent;
30
- ```
31
-
32
- Defined in: [contracts/IIntelligenceCapabilityPayload.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityPayload.ts#L21)
33
-
34
- The structured intent resolved from the user message.
35
-
36
- ***
37
-
38
- ### userMessage
39
-
40
- ```ts
41
- readonly userMessage: string;
42
- ```
43
-
44
- Defined in: [contracts/IIntelligenceCapabilityPayload.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityPayload.ts#L35)
45
-
46
- The raw user message that triggered the capability.
@@ -1,78 +0,0 @@
1
- ---
2
- title: 'Interface: IIntelligenceCapabilityRegistry'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IIntelligenceCapabilityRegistry
7
-
8
- Defined in: [interfaces/IIntelligenceCapabilityRegistry.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceCapabilityRegistry.ts#L14)
9
-
10
- Registry abstraction responsible for resolving capabilities.
11
-
12
- ## Methods
13
-
14
- ### list()
15
-
16
- ```ts
17
- list(): readonly IIntelligenceCapability[];
18
- ```
19
-
20
- Defined in: [interfaces/IIntelligenceCapabilityRegistry.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceCapabilityRegistry.ts#L41)
21
-
22
- Returns a read-only snapshot of all registered capabilities.
23
-
24
- #### Returns
25
-
26
- readonly [`IIntelligenceCapability`](Interface.IIntelligenceCapability)[]
27
-
28
- A defensive copy of the registered capabilities.
29
-
30
- ***
31
-
32
- ### register()
33
-
34
- ```ts
35
- register(capability): void;
36
- ```
37
-
38
- Defined in: [interfaces/IIntelligenceCapabilityRegistry.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceCapabilityRegistry.ts#L23)
39
-
40
- Registers a capability in the registry.
41
-
42
- #### Parameters
43
-
44
- | Parameter | Type | Description |
45
- | ------ | ------ | ------ |
46
- | `capability` | [`IIntelligenceCapability`](Interface.IIntelligenceCapability) | The capability to register. |
47
-
48
- #### Returns
49
-
50
- `void`
51
-
52
- ***
53
-
54
- ### resolve()
55
-
56
- ```ts
57
- resolve(intent, context):
58
- | IIntelligenceCapability
59
- | null;
60
- ```
61
-
62
- Defined in: [interfaces/IIntelligenceCapabilityRegistry.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceCapabilityRegistry.ts#L33)
63
-
64
- Resolves the most suitable capability for the given intent and context.
65
-
66
- #### Parameters
67
-
68
- | Parameter | Type | Description |
69
- | ------ | ------ | ------ |
70
- | `intent` | [`IIntelligenceIntent`](Interface.IIntelligenceIntent) | The structured intent to match against. |
71
- | `context` | [`IIntelligenceContext`](Interface.IIntelligenceContext) | The aggregated context for the request. |
72
-
73
- #### Returns
74
-
75
- \| [`IIntelligenceCapability`](Interface.IIntelligenceCapability)
76
- \| `null`
77
-
78
- The matching capability, or `null` if none qualifies.
@@ -1,46 +0,0 @@
1
- ---
2
- title: 'Interface: IIntelligenceCapabilityResult'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IIntelligenceCapabilityResult
7
-
8
- Defined in: [contracts/IIntelligenceCapabilityResult.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityResult.ts#L14)
9
-
10
- Represents the outcome produced by a capability execution.
11
-
12
- ## Properties
13
-
14
- ### artifacts
15
-
16
- ```ts
17
- readonly artifacts: readonly IIntelligenceArtifact[];
18
- ```
19
-
20
- Defined in: [contracts/IIntelligenceCapabilityResult.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityResult.ts#L29)
21
-
22
- Structured artifacts produced alongside the messages.
23
-
24
- ***
25
-
26
- ### followUps
27
-
28
- ```ts
29
- readonly followUps: readonly IIntelligenceFollowUpQuestion[];
30
- ```
31
-
32
- Defined in: [contracts/IIntelligenceCapabilityResult.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityResult.ts#L36)
33
-
34
- Suggested follow-up questions to continue the dialogue.
35
-
36
- ***
37
-
38
- ### messages
39
-
40
- ```ts
41
- readonly messages: readonly IIntelligenceResponseMessage[];
42
- ```
43
-
44
- Defined in: [contracts/IIntelligenceCapabilityResult.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityResult.ts#L22)
45
-
46
- The assistant messages produced by the capability.
@@ -1,72 +0,0 @@
1
- ---
2
- title: 'Interface: IIntelligenceContext'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IIntelligenceContext
7
-
8
- Defined in: [contracts/IIntelligenceContext.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContext.ts#L12)
9
-
10
- Describes the context aggregated before routing a request to a capability.
11
-
12
- ## Properties
13
-
14
- ### conversationId
15
-
16
- ```ts
17
- readonly conversationId: string | null;
18
- ```
19
-
20
- Defined in: [contracts/IIntelligenceContext.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContext.ts#L27)
21
-
22
- The conversation identifier, or `null` for a new conversation.
23
-
24
- ***
25
-
26
- ### conversationPreview
27
-
28
- ```ts
29
- readonly conversationPreview:
30
- | IIntelligenceConversationSnapshot
31
- | null;
32
- ```
33
-
34
- Defined in: [contracts/IIntelligenceContext.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContext.ts#L34)
35
-
36
- A lightweight preview of the conversation history, or `null` when unavailable.
37
-
38
- ***
39
-
40
- ### nutritionSnapshot?
41
-
42
- ```ts
43
- readonly optional nutritionSnapshot?: Record<string, unknown> | null;
44
- ```
45
-
46
- Defined in: [contracts/IIntelligenceContext.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContext.ts#L48)
47
-
48
- Optional nutrition snapshot for context enrichment.
49
-
50
- ***
51
-
52
- ### userId
53
-
54
- ```ts
55
- readonly userId: string;
56
- ```
57
-
58
- Defined in: [contracts/IIntelligenceContext.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContext.ts#L20)
59
-
60
- The identifier of the requesting user.
61
-
62
- ***
63
-
64
- ### workoutSummary?
65
-
66
- ```ts
67
- readonly optional workoutSummary?: Record<string, unknown> | null;
68
- ```
69
-
70
- Defined in: [contracts/IIntelligenceContext.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContext.ts#L41)
71
-
72
- Optional workout summary for context enrichment.
@@ -1,35 +0,0 @@
1
- ---
2
- title: 'Interface: IIntelligenceContextBuilder'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IIntelligenceContextBuilder
7
-
8
- Defined in: [contracts/IIntelligenceContextBuilder.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContextBuilder.ts#L12)
9
-
10
- Responsible for composing the context supplied to capabilities.
11
-
12
- ## Methods
13
-
14
- ### build()
15
-
16
- ```ts
17
- build(userId, conversationId): Promise<IIntelligenceContext>;
18
- ```
19
-
20
- Defined in: [contracts/IIntelligenceContextBuilder.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContextBuilder.ts#L23)
21
-
22
- Builds the aggregated context for the given user and conversation.
23
-
24
- #### Parameters
25
-
26
- | Parameter | Type | Description |
27
- | ------ | ------ | ------ |
28
- | `userId` | `string` | The identifier of the requesting user. |
29
- | `conversationId` | `string` \| `null` | The conversation identifier, or `null` for a new conversation. |
30
-
31
- #### Returns
32
-
33
- `Promise`\<[`IIntelligenceContext`](Interface.IIntelligenceContext)\>
34
-
35
- The composed context instance.