@breadstone/archipel-mcp 0.0.55 → 0.0.56

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 (104) hide show
  1. package/data/guides/ai-image-generation.md +52 -47
  2. package/data/guides/ai-realtime-voice.md +48 -41
  3. package/data/guides/ai-text-generation.md +54 -60
  4. package/data/guides/health-indicators.md +67 -66
  5. package/data/guides/intelligence-prompts-warm-up.md +52 -63
  6. package/data/packages/platform-intelligence/api/Class.AnthropicIntelligenceProviderAdapter.md +57 -13
  7. package/data/packages/platform-intelligence/api/Class.GatewayIntelligenceProviderAdapter.md +57 -13
  8. package/data/packages/platform-intelligence/api/Class.GoogleIntelligenceProviderAdapter.md +57 -13
  9. package/data/packages/platform-intelligence/api/Class.GrokIntelligenceProviderAdapter.md +57 -13
  10. package/data/packages/platform-intelligence/api/Class.IntelligenceAgent.md +5 -5
  11. package/data/packages/platform-intelligence/api/Class.IntelligenceEmbeddingGenerator.md +4 -4
  12. package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +10 -9
  13. package/data/packages/platform-intelligence/api/Class.IntelligenceImageGenerator.md +117 -0
  14. package/data/packages/platform-intelligence/api/Class.IntelligenceLanguageGenerator.md +7 -7
  15. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
  16. package/data/packages/platform-intelligence/api/Class.IntelligencePromptPolicyPort.md +1 -1
  17. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderAdapterPort.md +104 -0
  18. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderDiagnostics.md +3 -3
  19. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderRegistry.md +5 -5
  20. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeMeteringPort.md +1 -1
  21. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md +5 -5
  22. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionPort.md +15 -15
  23. package/data/packages/platform-intelligence/api/Class.IntelligenceReranker.md +3 -3
  24. package/data/packages/platform-intelligence/api/Class.IntelligenceSpeechGenerator.md +117 -0
  25. package/data/packages/platform-intelligence/api/Class.IntelligenceToolRegistry.md +5 -5
  26. package/data/packages/platform-intelligence/api/Class.IntelligenceTranscriptionGenerator.md +139 -0
  27. package/data/packages/platform-intelligence/api/Class.IntelligenceVideoGenerator.md +117 -0
  28. package/data/packages/platform-intelligence/api/Class.MiMoIntelligenceProviderAdapter.md +57 -13
  29. package/data/packages/platform-intelligence/api/Class.OpenAIIntelligenceProviderAdapter.md +38 -18
  30. package/data/packages/platform-intelligence/api/Function.createIntelligenceJsonSchema.md +1 -1
  31. package/data/packages/platform-intelligence/api/Function.defineIntelligenceTool.md +1 -1
  32. package/data/packages/platform-intelligence/api/Interface.IIntelligenceAgentConfiguration.md +7 -7
  33. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchOptions.md +25 -9
  34. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchResult.md +7 -7
  35. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingOptions.md +24 -8
  36. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingResult.md +7 -7
  37. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadOptions.md +23 -7
  38. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadResult.md +6 -6
  39. package/data/packages/platform-intelligence/api/Interface.IIntelligenceGeneratedFile.md +4 -4
  40. package/data/packages/platform-intelligence/api/Interface.IIntelligenceGenerationStepStartEvent.md +5 -5
  41. package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationOptions.md +29 -13
  42. package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationResult.md +6 -6
  43. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageCompletion.md +13 -13
  44. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageGenerationOptions.md +33 -17
  45. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageStream.md +5 -5
  46. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelReference.md +3 -3
  47. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelRequestOptions.md +24 -4
  48. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelStatus.md +3 -3
  49. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +30 -8
  50. package/data/packages/platform-intelligence/api/Interface.IIntelligenceObjectStream.md +5 -5
  51. package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +5 -5
  52. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderLoadRequest.md +20 -6
  53. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderProbeResult.md +7 -7
  54. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +21 -9
  55. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md +174 -10
  56. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRequestOptions.md +22 -6
  57. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingOptions.md +26 -10
  58. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingResult.md +4 -4
  59. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadOptions.md +22 -6
  60. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadResult.md +8 -8
  61. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationOptions.md +29 -13
  62. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationResult.md +5 -5
  63. package/data/packages/platform-intelligence/api/Interface.IIntelligenceStreamingTranscriptionOptions.md +25 -9
  64. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolCall.md +4 -4
  65. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolDefinition.md +7 -7
  66. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionEndEvent.md +5 -5
  67. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionStartEvent.md +3 -3
  68. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionOptions.md +24 -8
  69. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionResult.md +8 -8
  70. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionStream.md +9 -9
  71. package/data/packages/platform-intelligence/api/Interface.IIntelligenceUsage.md +161 -4
  72. package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationOptions.md +34 -18
  73. package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationResult.md +5 -5
  74. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceModelMessage.md +1 -1
  75. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceSchema.md +1 -1
  76. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceCapability.md +1 -1
  77. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceDefaultModels.md +1 -1
  78. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceJsonValue.md +1 -1
  79. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -1
  80. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderOptions.md +1 -1
  81. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderProbeStatus.md +1 -1
  82. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderToolOptions.md +1 -1
  83. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRequestTimeouts.md +1 -1
  84. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolChoice.md +1 -1
  85. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolOutput.md +1 -1
  86. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolSet.md +1 -1
  87. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTranscriptionStreamPart.md +1 -1
  88. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_API_KEY.md +1 -1
  89. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_BASE_URL.md +1 -1
  90. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_CONFIG_ENTRIES.md +1 -1
  91. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_API_KEY.md +1 -1
  92. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_BASE_URL.md +1 -1
  93. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
  94. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MODEL.md +1 -1
  95. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_PROVIDER.md +1 -1
  96. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
  97. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
  98. package/data/packages/platform-intelligence/api/Variable.IntelligenceCapabilityNames.md +11 -11
  99. package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +2 -2
  100. package/data/packages/platform-intelligence/api/index.md +8 -5
  101. package/data/packages/platform-intelligence/index.md +86 -0
  102. package/package.json +1 -1
  103. package/data/packages/platform-intelligence/api/Class.IntelligenceMediaGenerator.md +0 -140
  104. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderAdapter.md +0 -73
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceFileUploadOptions
7
7
 
8
- Defined in: contracts/IIntelligenceFileUploadOptions.ts:12
8
+ Defined in: [contracts/IIntelligenceFileUploadOptions.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadOptions.ts#L12)
9
9
 
10
10
  Provider-neutral file upload options.
11
11
 
@@ -31,7 +31,7 @@ readonly data:
31
31
  };
32
32
  ```
33
33
 
34
- Defined in: contracts/IIntelligenceFileUploadOptions.ts:15
34
+ Defined in: [contracts/IIntelligenceFileUploadOptions.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadOptions.ts#L15)
35
35
 
36
36
  ***
37
37
 
@@ -41,7 +41,7 @@ Defined in: contracts/IIntelligenceFileUploadOptions.ts:15
41
41
  readonly optional filename?: string;
42
42
  ```
43
43
 
44
- Defined in: contracts/IIntelligenceFileUploadOptions.ts:17
44
+ Defined in: [contracts/IIntelligenceFileUploadOptions.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadOptions.ts#L17)
45
45
 
46
46
  ***
47
47
 
@@ -51,7 +51,7 @@ Defined in: contracts/IIntelligenceFileUploadOptions.ts:17
51
51
  readonly optional mediaType?: string;
52
52
  ```
53
53
 
54
- Defined in: contracts/IIntelligenceFileUploadOptions.ts:16
54
+ Defined in: [contracts/IIntelligenceFileUploadOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadOptions.ts#L16)
55
55
 
56
56
  ***
57
57
 
@@ -61,7 +61,7 @@ Defined in: contracts/IIntelligenceFileUploadOptions.ts:16
61
61
  readonly optional model?: IIntelligenceModelReference;
62
62
  ```
63
63
 
64
- Defined in: contracts/IIntelligenceModelRequestOptions.ts:17
64
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L24)
65
65
 
66
66
  Optional provider/model override.
67
67
 
@@ -77,7 +77,7 @@ Optional provider/model override.
77
77
  readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
78
78
  ```
79
79
 
80
- Defined in: contracts/IIntelligenceModelRequestOptions.ts:23
80
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L33)
81
81
 
82
82
  Optional provider-specific settings.
83
83
 
@@ -87,13 +87,29 @@ Optional provider-specific settings.
87
87
 
88
88
  ***
89
89
 
90
+ ### requestId?
91
+
92
+ ```ts
93
+ readonly optional requestId?: string;
94
+ ```
95
+
96
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L27)
97
+
98
+ Correlation identifier included in structured Archipel logs.
99
+
100
+ #### Inherited from
101
+
102
+ [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`requestId`](Interface.IIntelligenceModelRequestOptions#requestid)
103
+
104
+ ***
105
+
90
106
  ### timeoutMs?
91
107
 
92
108
  ```ts
93
109
  readonly optional timeoutMs?: number;
94
110
  ```
95
111
 
96
- Defined in: contracts/IIntelligenceModelRequestOptions.ts:20
112
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L30)
97
113
 
98
114
  Total provider-operation timeout in milliseconds.
99
115
 
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceFileUploadResult
7
7
 
8
- Defined in: contracts/IIntelligenceFileUploadResult.ts:6
8
+ Defined in: [contracts/IIntelligenceFileUploadResult.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadResult.ts#L6)
9
9
 
10
10
  Normalized provider-managed file upload result.
11
11
 
@@ -17,7 +17,7 @@ Normalized provider-managed file upload result.
17
17
  readonly optional filename?: string;
18
18
  ```
19
19
 
20
- Defined in: contracts/IIntelligenceFileUploadResult.ts:12
20
+ Defined in: [contracts/IIntelligenceFileUploadResult.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadResult.ts#L12)
21
21
 
22
22
  ***
23
23
 
@@ -27,7 +27,7 @@ Defined in: contracts/IIntelligenceFileUploadResult.ts:12
27
27
  readonly optional mediaType?: string;
28
28
  ```
29
29
 
30
- Defined in: contracts/IIntelligenceFileUploadResult.ts:11
30
+ Defined in: [contracts/IIntelligenceFileUploadResult.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadResult.ts#L11)
31
31
 
32
32
  ***
33
33
 
@@ -37,7 +37,7 @@ Defined in: contracts/IIntelligenceFileUploadResult.ts:11
37
37
  readonly provider: string;
38
38
  ```
39
39
 
40
- Defined in: contracts/IIntelligenceFileUploadResult.ts:10
40
+ Defined in: [contracts/IIntelligenceFileUploadResult.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadResult.ts#L10)
41
41
 
42
42
  ***
43
43
 
@@ -47,7 +47,7 @@ Defined in: contracts/IIntelligenceFileUploadResult.ts:10
47
47
  readonly providerReference: Readonly<Record<string, string>>;
48
48
  ```
49
49
 
50
- Defined in: contracts/IIntelligenceFileUploadResult.ts:9
50
+ Defined in: [contracts/IIntelligenceFileUploadResult.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadResult.ts#L9)
51
51
 
52
52
  ***
53
53
 
@@ -57,4 +57,4 @@ Defined in: contracts/IIntelligenceFileUploadResult.ts:9
57
57
  readonly warnings: readonly string[];
58
58
  ```
59
59
 
60
- Defined in: contracts/IIntelligenceFileUploadResult.ts:13
60
+ Defined in: [contracts/IIntelligenceFileUploadResult.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadResult.ts#L13)
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceGeneratedFile
7
7
 
8
- Defined in: contracts/IIntelligenceGeneratedFile.ts:6
8
+ Defined in: [contracts/IIntelligenceGeneratedFile.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGeneratedFile.ts#L6)
9
9
 
10
10
  Binary content generated by an intelligence capability.
11
11
 
@@ -17,7 +17,7 @@ Binary content generated by an intelligence capability.
17
17
  readonly data: Uint8Array;
18
18
  ```
19
19
 
20
- Defined in: contracts/IIntelligenceGeneratedFile.ts:9
20
+ Defined in: [contracts/IIntelligenceGeneratedFile.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGeneratedFile.ts#L9)
21
21
 
22
22
  ***
23
23
 
@@ -27,7 +27,7 @@ Defined in: contracts/IIntelligenceGeneratedFile.ts:9
27
27
  readonly optional filename?: string;
28
28
  ```
29
29
 
30
- Defined in: contracts/IIntelligenceGeneratedFile.ts:11
30
+ Defined in: [contracts/IIntelligenceGeneratedFile.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGeneratedFile.ts#L11)
31
31
 
32
32
  ***
33
33
 
@@ -37,4 +37,4 @@ Defined in: contracts/IIntelligenceGeneratedFile.ts:11
37
37
  readonly mediaType: string;
38
38
  ```
39
39
 
40
- Defined in: contracts/IIntelligenceGeneratedFile.ts:10
40
+ Defined in: [contracts/IIntelligenceGeneratedFile.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGeneratedFile.ts#L10)
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceGenerationStepStartEvent
7
7
 
8
- Defined in: contracts/IIntelligenceGenerationStepStartEvent.ts:6
8
+ Defined in: [contracts/IIntelligenceGenerationStepStartEvent.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGenerationStepStartEvent.ts#L6)
9
9
 
10
10
  Language generation step metadata.
11
11
 
@@ -17,7 +17,7 @@ Language generation step metadata.
17
17
  readonly callId: string;
18
18
  ```
19
19
 
20
- Defined in: contracts/IIntelligenceGenerationStepStartEvent.ts:7
20
+ Defined in: [contracts/IIntelligenceGenerationStepStartEvent.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGenerationStepStartEvent.ts#L7)
21
21
 
22
22
  ***
23
23
 
@@ -27,7 +27,7 @@ Defined in: contracts/IIntelligenceGenerationStepStartEvent.ts:7
27
27
  readonly modelId: string;
28
28
  ```
29
29
 
30
- Defined in: contracts/IIntelligenceGenerationStepStartEvent.ts:9
30
+ Defined in: [contracts/IIntelligenceGenerationStepStartEvent.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGenerationStepStartEvent.ts#L9)
31
31
 
32
32
  ***
33
33
 
@@ -37,7 +37,7 @@ Defined in: contracts/IIntelligenceGenerationStepStartEvent.ts:9
37
37
  readonly provider: string;
38
38
  ```
39
39
 
40
- Defined in: contracts/IIntelligenceGenerationStepStartEvent.ts:8
40
+ Defined in: [contracts/IIntelligenceGenerationStepStartEvent.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGenerationStepStartEvent.ts#L8)
41
41
 
42
42
  ***
43
43
 
@@ -47,4 +47,4 @@ Defined in: contracts/IIntelligenceGenerationStepStartEvent.ts:8
47
47
  readonly stepNumber: number;
48
48
  ```
49
49
 
50
- Defined in: contracts/IIntelligenceGenerationStepStartEvent.ts:10
50
+ Defined in: [contracts/IIntelligenceGenerationStepStartEvent.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGenerationStepStartEvent.ts#L10)
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceImageGenerationOptions
7
7
 
8
- Defined in: contracts/IIntelligenceImageGenerationOptions.ts:12
8
+ Defined in: [contracts/IIntelligenceImageGenerationOptions.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceImageGenerationOptions.ts#L12)
9
9
 
10
10
  Provider-neutral image generation options.
11
11
 
@@ -21,7 +21,7 @@ Provider-neutral image generation options.
21
21
  readonly optional abortSignal?: AbortSignal;
22
22
  ```
23
23
 
24
- Defined in: contracts/IIntelligenceRequestOptions.ts:16
24
+ Defined in: [contracts/IIntelligenceRequestOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L16)
25
25
 
26
26
  Caller-driven cancellation signal.
27
27
 
@@ -37,7 +37,7 @@ Caller-driven cancellation signal.
37
37
  readonly optional aspectRatio?: `${number}:${number}`;
38
38
  ```
39
39
 
40
- Defined in: contracts/IIntelligenceImageGenerationOptions.ts:26
40
+ Defined in: [contracts/IIntelligenceImageGenerationOptions.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceImageGenerationOptions.ts#L26)
41
41
 
42
42
  ***
43
43
 
@@ -47,7 +47,7 @@ Defined in: contracts/IIntelligenceImageGenerationOptions.ts:26
47
47
  readonly optional count?: number;
48
48
  ```
49
49
 
50
- Defined in: contracts/IIntelligenceImageGenerationOptions.ts:23
50
+ Defined in: [contracts/IIntelligenceImageGenerationOptions.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceImageGenerationOptions.ts#L23)
51
51
 
52
52
  ***
53
53
 
@@ -57,7 +57,7 @@ Defined in: contracts/IIntelligenceImageGenerationOptions.ts:23
57
57
  readonly optional headers?: Readonly<Record<string, string>>;
58
58
  ```
59
59
 
60
- Defined in: contracts/IIntelligenceRequestOptions.ts:19
60
+ Defined in: [contracts/IIntelligenceRequestOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L19)
61
61
 
62
62
  Additional outbound request headers.
63
63
 
@@ -73,7 +73,7 @@ Additional outbound request headers.
73
73
  readonly optional maxImagesPerCall?: number;
74
74
  ```
75
75
 
76
- Defined in: contracts/IIntelligenceImageGenerationOptions.ts:24
76
+ Defined in: [contracts/IIntelligenceImageGenerationOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceImageGenerationOptions.ts#L24)
77
77
 
78
78
  ***
79
79
 
@@ -83,7 +83,7 @@ Defined in: contracts/IIntelligenceImageGenerationOptions.ts:24
83
83
  readonly optional maxRetries?: number;
84
84
  ```
85
85
 
86
- Defined in: contracts/IIntelligenceImageGenerationOptions.ts:22
86
+ Defined in: [contracts/IIntelligenceImageGenerationOptions.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceImageGenerationOptions.ts#L22)
87
87
 
88
88
  ***
89
89
 
@@ -93,7 +93,7 @@ Defined in: contracts/IIntelligenceImageGenerationOptions.ts:22
93
93
  readonly optional model?: IIntelligenceModelReference;
94
94
  ```
95
95
 
96
- Defined in: contracts/IIntelligenceModelRequestOptions.ts:17
96
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L24)
97
97
 
98
98
  Optional provider/model override.
99
99
 
@@ -115,7 +115,7 @@ readonly prompt:
115
115
  };
116
116
  ```
117
117
 
118
- Defined in: contracts/IIntelligenceImageGenerationOptions.ts:15
118
+ Defined in: [contracts/IIntelligenceImageGenerationOptions.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceImageGenerationOptions.ts#L15)
119
119
 
120
120
  ***
121
121
 
@@ -125,7 +125,7 @@ Defined in: contracts/IIntelligenceImageGenerationOptions.ts:15
125
125
  readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
126
126
  ```
127
127
 
128
- Defined in: contracts/IIntelligenceModelRequestOptions.ts:23
128
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L33)
129
129
 
130
130
  Optional provider-specific settings.
131
131
 
@@ -135,13 +135,29 @@ Optional provider-specific settings.
135
135
 
136
136
  ***
137
137
 
138
+ ### requestId?
139
+
140
+ ```ts
141
+ readonly optional requestId?: string;
142
+ ```
143
+
144
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L27)
145
+
146
+ Correlation identifier included in structured Archipel logs.
147
+
148
+ #### Inherited from
149
+
150
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`requestId`](Interface.IIntelligenceRequestOptions#requestid)
151
+
152
+ ***
153
+
138
154
  ### seed?
139
155
 
140
156
  ```ts
141
157
  readonly optional seed?: number;
142
158
  ```
143
159
 
144
- Defined in: contracts/IIntelligenceImageGenerationOptions.ts:27
160
+ Defined in: [contracts/IIntelligenceImageGenerationOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceImageGenerationOptions.ts#L27)
145
161
 
146
162
  ***
147
163
 
@@ -151,7 +167,7 @@ Defined in: contracts/IIntelligenceImageGenerationOptions.ts:27
151
167
  readonly optional size?: `${number}x${number}`;
152
168
  ```
153
169
 
154
- Defined in: contracts/IIntelligenceImageGenerationOptions.ts:25
170
+ Defined in: [contracts/IIntelligenceImageGenerationOptions.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceImageGenerationOptions.ts#L25)
155
171
 
156
172
  ***
157
173
 
@@ -161,7 +177,7 @@ Defined in: contracts/IIntelligenceImageGenerationOptions.ts:25
161
177
  readonly optional timeoutMs?: number;
162
178
  ```
163
179
 
164
- Defined in: contracts/IIntelligenceModelRequestOptions.ts:20
180
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L30)
165
181
 
166
182
  Total provider-operation timeout in milliseconds.
167
183
 
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceImageGenerationResult
7
7
 
8
- Defined in: contracts/IIntelligenceImageGenerationResult.ts:13
8
+ Defined in: [contracts/IIntelligenceImageGenerationResult.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceImageGenerationResult.ts#L13)
9
9
 
10
10
  Provider-neutral image generation result.
11
11
 
@@ -17,7 +17,7 @@ Provider-neutral image generation result.
17
17
  readonly images: readonly IIntelligenceGeneratedFile[];
18
18
  ```
19
19
 
20
- Defined in: contracts/IIntelligenceImageGenerationResult.ts:16
20
+ Defined in: [contracts/IIntelligenceImageGenerationResult.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceImageGenerationResult.ts#L16)
21
21
 
22
22
  ***
23
23
 
@@ -27,7 +27,7 @@ Defined in: contracts/IIntelligenceImageGenerationResult.ts:16
27
27
  readonly model: string;
28
28
  ```
29
29
 
30
- Defined in: contracts/IIntelligenceImageGenerationResult.ts:18
30
+ Defined in: [contracts/IIntelligenceImageGenerationResult.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceImageGenerationResult.ts#L18)
31
31
 
32
32
  ***
33
33
 
@@ -37,7 +37,7 @@ Defined in: contracts/IIntelligenceImageGenerationResult.ts:18
37
37
  readonly provider: string;
38
38
  ```
39
39
 
40
- Defined in: contracts/IIntelligenceImageGenerationResult.ts:17
40
+ Defined in: [contracts/IIntelligenceImageGenerationResult.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceImageGenerationResult.ts#L17)
41
41
 
42
42
  ***
43
43
 
@@ -47,7 +47,7 @@ Defined in: contracts/IIntelligenceImageGenerationResult.ts:17
47
47
  readonly usage: IIntelligenceUsage | null;
48
48
  ```
49
49
 
50
- Defined in: contracts/IIntelligenceImageGenerationResult.ts:20
50
+ Defined in: [contracts/IIntelligenceImageGenerationResult.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceImageGenerationResult.ts#L20)
51
51
 
52
52
  ***
53
53
 
@@ -57,4 +57,4 @@ Defined in: contracts/IIntelligenceImageGenerationResult.ts:20
57
57
  readonly warnings: readonly string[];
58
58
  ```
59
59
 
60
- Defined in: contracts/IIntelligenceImageGenerationResult.ts:19
60
+ Defined in: [contracts/IIntelligenceImageGenerationResult.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceImageGenerationResult.ts#L19)
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceLanguageCompletion\<TOutput\>
7
7
 
8
- Defined in: contracts/IIntelligenceLanguageCompletion.ts:14
8
+ Defined in: [contracts/IIntelligenceLanguageCompletion.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageCompletion.ts#L14)
9
9
 
10
10
  Normalized language generation result.
11
11
 
@@ -23,7 +23,7 @@ Normalized language generation result.
23
23
  readonly files: readonly IIntelligenceGeneratedFile[];
24
24
  ```
25
25
 
26
- Defined in: contracts/IIntelligenceLanguageCompletion.ts:29
26
+ Defined in: [contracts/IIntelligenceLanguageCompletion.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageCompletion.ts#L29)
27
27
 
28
28
  ***
29
29
 
@@ -33,7 +33,7 @@ Defined in: contracts/IIntelligenceLanguageCompletion.ts:29
33
33
  readonly finishReason: string;
34
34
  ```
35
35
 
36
- Defined in: contracts/IIntelligenceLanguageCompletion.ts:21
36
+ Defined in: [contracts/IIntelligenceLanguageCompletion.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageCompletion.ts#L21)
37
37
 
38
38
  ***
39
39
 
@@ -43,7 +43,7 @@ Defined in: contracts/IIntelligenceLanguageCompletion.ts:21
43
43
  readonly model: string;
44
44
  ```
45
45
 
46
- Defined in: contracts/IIntelligenceLanguageCompletion.ts:20
46
+ Defined in: [contracts/IIntelligenceLanguageCompletion.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageCompletion.ts#L20)
47
47
 
48
48
  ***
49
49
 
@@ -53,7 +53,7 @@ Defined in: contracts/IIntelligenceLanguageCompletion.ts:20
53
53
  readonly output: TOutput;
54
54
  ```
55
55
 
56
- Defined in: contracts/IIntelligenceLanguageCompletion.ts:18
56
+ Defined in: [contracts/IIntelligenceLanguageCompletion.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageCompletion.ts#L18)
57
57
 
58
58
  ***
59
59
 
@@ -63,7 +63,7 @@ Defined in: contracts/IIntelligenceLanguageCompletion.ts:18
63
63
  readonly provider: string;
64
64
  ```
65
65
 
66
- Defined in: contracts/IIntelligenceLanguageCompletion.ts:19
66
+ Defined in: [contracts/IIntelligenceLanguageCompletion.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageCompletion.ts#L19)
67
67
 
68
68
  ***
69
69
 
@@ -73,7 +73,7 @@ Defined in: contracts/IIntelligenceLanguageCompletion.ts:19
73
73
  readonly optional reasoningText?: string;
74
74
  ```
75
75
 
76
- Defined in: contracts/IIntelligenceLanguageCompletion.ts:22
76
+ Defined in: [contracts/IIntelligenceLanguageCompletion.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageCompletion.ts#L22)
77
77
 
78
78
  ***
79
79
 
@@ -88,7 +88,7 @@ readonly sources: readonly {
88
88
  }[];
89
89
  ```
90
90
 
91
- Defined in: contracts/IIntelligenceLanguageCompletion.ts:23
91
+ Defined in: [contracts/IIntelligenceLanguageCompletion.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageCompletion.ts#L23)
92
92
 
93
93
  ***
94
94
 
@@ -98,7 +98,7 @@ Defined in: contracts/IIntelligenceLanguageCompletion.ts:23
98
98
  readonly text: string;
99
99
  ```
100
100
 
101
- Defined in: contracts/IIntelligenceLanguageCompletion.ts:17
101
+ Defined in: [contracts/IIntelligenceLanguageCompletion.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageCompletion.ts#L17)
102
102
 
103
103
  ***
104
104
 
@@ -108,7 +108,7 @@ Defined in: contracts/IIntelligenceLanguageCompletion.ts:17
108
108
  readonly toolCalls: readonly IIntelligenceToolCall[];
109
109
  ```
110
110
 
111
- Defined in: contracts/IIntelligenceLanguageCompletion.ts:30
111
+ Defined in: [contracts/IIntelligenceLanguageCompletion.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageCompletion.ts#L30)
112
112
 
113
113
  ***
114
114
 
@@ -118,7 +118,7 @@ Defined in: contracts/IIntelligenceLanguageCompletion.ts:30
118
118
  readonly toolResults: readonly unknown[];
119
119
  ```
120
120
 
121
- Defined in: contracts/IIntelligenceLanguageCompletion.ts:31
121
+ Defined in: [contracts/IIntelligenceLanguageCompletion.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageCompletion.ts#L31)
122
122
 
123
123
  ***
124
124
 
@@ -128,7 +128,7 @@ Defined in: contracts/IIntelligenceLanguageCompletion.ts:31
128
128
  readonly usage: IIntelligenceUsage | null;
129
129
  ```
130
130
 
131
- Defined in: contracts/IIntelligenceLanguageCompletion.ts:33
131
+ Defined in: [contracts/IIntelligenceLanguageCompletion.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageCompletion.ts#L33)
132
132
 
133
133
  ***
134
134
 
@@ -138,4 +138,4 @@ Defined in: contracts/IIntelligenceLanguageCompletion.ts:33
138
138
  readonly warnings: readonly string[];
139
139
  ```
140
140
 
141
- Defined in: contracts/IIntelligenceLanguageCompletion.ts:32
141
+ Defined in: [contracts/IIntelligenceLanguageCompletion.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageCompletion.ts#L32)