@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
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceIntent'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IIntelligenceIntent
|
|
7
|
-
|
|
8
|
-
Defined in: [contracts/IIntelligenceIntent.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntent.ts#L12)
|
|
9
|
-
|
|
10
|
-
Represents the structured intent resolved from a user message.
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### confidence
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
readonly confidence: number;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [contracts/IIntelligenceIntent.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntent.ts#L27)
|
|
21
|
-
|
|
22
|
-
The confidence score of the intent resolution (0–1).
|
|
23
|
-
|
|
24
|
-
***
|
|
25
|
-
|
|
26
|
-
### entities
|
|
27
|
-
|
|
28
|
-
```ts
|
|
29
|
-
readonly entities: readonly IIntelligenceIntentEntity[];
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Defined in: [contracts/IIntelligenceIntent.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntent.ts#L34)
|
|
33
|
-
|
|
34
|
-
Named entities extracted from the user message.
|
|
35
|
-
|
|
36
|
-
***
|
|
37
|
-
|
|
38
|
-
### name
|
|
39
|
-
|
|
40
|
-
```ts
|
|
41
|
-
readonly name: string;
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
Defined in: [contracts/IIntelligenceIntent.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntent.ts#L20)
|
|
45
|
-
|
|
46
|
-
The canonical name of the intent.
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceIntentEntity'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IIntelligenceIntentEntity
|
|
7
|
-
|
|
8
|
-
Defined in: [contracts/IIntelligenceIntentEntity.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntentEntity.ts#L6)
|
|
9
|
-
|
|
10
|
-
Represents an entity extracted from a resolved intelligence intent.
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### name
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
readonly name: string;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [contracts/IIntelligenceIntentEntity.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntentEntity.ts#L14)
|
|
21
|
-
|
|
22
|
-
The name of the extracted entity.
|
|
23
|
-
|
|
24
|
-
***
|
|
25
|
-
|
|
26
|
-
### value
|
|
27
|
-
|
|
28
|
-
```ts
|
|
29
|
-
readonly value: string;
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Defined in: [contracts/IIntelligenceIntentEntity.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntentEntity.ts#L21)
|
|
33
|
-
|
|
34
|
-
The resolved value of the entity.
|
|
@@ -1,70 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceMessageModel'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IIntelligenceMessageModel
|
|
7
|
-
|
|
8
|
-
Defined in: [contracts/IIntelligenceMessageModel.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L12)
|
|
9
|
-
|
|
10
|
-
Represents a normalized message stored in persistence.
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### content
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
readonly content: string;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [contracts/IIntelligenceMessageModel.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L34)
|
|
21
|
-
|
|
22
|
-
The textual content of the message.
|
|
23
|
-
|
|
24
|
-
***
|
|
25
|
-
|
|
26
|
-
### createdAt
|
|
27
|
-
|
|
28
|
-
```ts
|
|
29
|
-
readonly createdAt: Date;
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Defined in: [contracts/IIntelligenceMessageModel.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L41)
|
|
33
|
-
|
|
34
|
-
The timestamp when the message was created.
|
|
35
|
-
|
|
36
|
-
***
|
|
37
|
-
|
|
38
|
-
### id
|
|
39
|
-
|
|
40
|
-
```ts
|
|
41
|
-
readonly id: string;
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
Defined in: [contracts/IIntelligenceMessageModel.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L20)
|
|
45
|
-
|
|
46
|
-
Unique identifier of the persisted message.
|
|
47
|
-
|
|
48
|
-
***
|
|
49
|
-
|
|
50
|
-
### metadata?
|
|
51
|
-
|
|
52
|
-
```ts
|
|
53
|
-
readonly optional metadata?: unknown;
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
Defined in: [contracts/IIntelligenceMessageModel.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L48)
|
|
57
|
-
|
|
58
|
-
Optional metadata attached to the message.
|
|
59
|
-
|
|
60
|
-
***
|
|
61
|
-
|
|
62
|
-
### role
|
|
63
|
-
|
|
64
|
-
```ts
|
|
65
|
-
readonly role: IntelligenceConversationMessageRole;
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
Defined in: [contracts/IIntelligenceMessageModel.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L27)
|
|
69
|
-
|
|
70
|
-
The role of the message author.
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceMessagePayload'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IIntelligenceMessagePayload
|
|
7
|
-
|
|
8
|
-
Defined in: [contracts/IIntelligenceMessagePayload.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessagePayload.ts#L6)
|
|
9
|
-
|
|
10
|
-
Carries the payload submitted when messaging the intelligence entrypoint.
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### conversationId
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
readonly conversationId: string | null;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [contracts/IIntelligenceMessagePayload.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessagePayload.ts#L14)
|
|
21
|
-
|
|
22
|
-
The conversation identifier, or `null` to start a new conversation.
|
|
23
|
-
|
|
24
|
-
***
|
|
25
|
-
|
|
26
|
-
### message
|
|
27
|
-
|
|
28
|
-
```ts
|
|
29
|
-
readonly message: string;
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Defined in: [contracts/IIntelligenceMessagePayload.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessagePayload.ts#L21)
|
|
33
|
-
|
|
34
|
-
The user message to process.
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligencePrompt'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IIntelligencePrompt
|
|
7
|
-
|
|
8
|
-
Defined in: [contracts/IIntelligencePrompt.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePrompt.ts#L12)
|
|
9
|
-
|
|
10
|
-
Represents the input supplied to the intelligence text generator.
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### messages
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
readonly messages: readonly IIntelligencePromptMessage[];
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [contracts/IIntelligencePrompt.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePrompt.ts#L27)
|
|
21
|
-
|
|
22
|
-
The ordered list of messages forming the prompt.
|
|
23
|
-
|
|
24
|
-
***
|
|
25
|
-
|
|
26
|
-
### systemPrompt
|
|
27
|
-
|
|
28
|
-
```ts
|
|
29
|
-
readonly systemPrompt: string | null;
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Defined in: [contracts/IIntelligencePrompt.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePrompt.ts#L20)
|
|
33
|
-
|
|
34
|
-
The optional system-level prompt prepended to the conversation.
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligencePromptMessage'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IIntelligencePromptMessage
|
|
7
|
-
|
|
8
|
-
Defined in: [contracts/IIntelligencePromptMessage.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePromptMessage.ts#L12)
|
|
9
|
-
|
|
10
|
-
Describes a normalized message used for text generation prompts.
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### content
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
readonly content: string;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [contracts/IIntelligencePromptMessage.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePromptMessage.ts#L27)
|
|
21
|
-
|
|
22
|
-
The textual content of the message.
|
|
23
|
-
|
|
24
|
-
***
|
|
25
|
-
|
|
26
|
-
### role
|
|
27
|
-
|
|
28
|
-
```ts
|
|
29
|
-
readonly role: IntelligenceConversationMessageRole;
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Defined in: [contracts/IIntelligencePromptMessage.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePromptMessage.ts#L20)
|
|
33
|
-
|
|
34
|
-
The role of the message author.
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceResponseMessage'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IIntelligenceResponseMessage
|
|
7
|
-
|
|
8
|
-
Defined in: [contracts/IIntelligenceResponseMessage.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceResponseMessage.ts#L6)
|
|
9
|
-
|
|
10
|
-
Represents a single assistant message returned by a capability.
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### content
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
readonly content: string;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [contracts/IIntelligenceResponseMessage.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceResponseMessage.ts#L14)
|
|
21
|
-
|
|
22
|
-
The textual content of the assistant response.
|
|
23
|
-
|
|
24
|
-
***
|
|
25
|
-
|
|
26
|
-
### metadata?
|
|
27
|
-
|
|
28
|
-
```ts
|
|
29
|
-
readonly optional metadata?: Record<string, unknown>;
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Defined in: [contracts/IIntelligenceResponseMessage.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceResponseMessage.ts#L21)
|
|
33
|
-
|
|
34
|
-
Optional metadata attached to the response message.
|
package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Type Alias: IntelligenceConversationMessageRole'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Type Alias: IntelligenceConversationMessageRole
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
type IntelligenceConversationMessageRole = typeof IntelligenceConversationMessageRoles[keyof typeof IntelligenceConversationMessageRoles];
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [contracts/IntelligenceConversationMessageRoles.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceConversationMessageRoles.ts#L17)
|
|
13
|
-
|
|
14
|
-
Represents the union of supported conversation message roles.
|
package/data/packages/platform-intelligence/api/Variable.IntelligenceConversationMessageRoles.md
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Variable: IntelligenceConversationMessageRoles'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Variable: IntelligenceConversationMessageRoles
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
const IntelligenceConversationMessageRoles: {
|
|
10
|
-
Assistant: "assistant";
|
|
11
|
-
System: "system";
|
|
12
|
-
User: "user";
|
|
13
|
-
};
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
Defined in: [contracts/IntelligenceConversationMessageRoles.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceConversationMessageRoles.ts#L6)
|
|
17
|
-
|
|
18
|
-
Enumerates the conversation roles used for contextual snapshots and messages.
|
|
19
|
-
|
|
20
|
-
## Type Declaration
|
|
21
|
-
|
|
22
|
-
| Name | Type | Default value | Defined in |
|
|
23
|
-
| ------ | ------ | ------ | ------ |
|
|
24
|
-
| <a id="property-assistant"></a> `Assistant` | `"assistant"` | `'assistant'` | [contracts/IntelligenceConversationMessageRoles.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceConversationMessageRoles.ts#L8) |
|
|
25
|
-
| <a id="property-system"></a> `System` | `"system"` | `'system'` | [contracts/IntelligenceConversationMessageRoles.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceConversationMessageRoles.ts#L9) |
|
|
26
|
-
| <a id="property-user"></a> `User` | `"user"` | `'user'` | [contracts/IntelligenceConversationMessageRoles.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceConversationMessageRoles.ts#L7) |
|