@breadstone/archipel-mcp 0.0.53 → 0.0.55
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-image-generation.md +96 -0
- package/data/guides/ai-realtime-voice.md +69 -464
- package/data/guides/ai-text-generation.md +95 -622
- package/data/guides/index.md +3 -1
- package/data/guides/intelligence-prompts-warm-up.md +138 -0
- package/data/packages/platform-intelligence/api/Class.AnthropicIntelligenceProviderAdapter.md +78 -0
- package/data/packages/platform-intelligence/api/Class.DefaultIntelligencePromptPolicyAdapter.md +54 -0
- package/data/packages/platform-intelligence/api/Class.GatewayIntelligenceProviderAdapter.md +78 -0
- package/data/packages/platform-intelligence/api/Class.GoogleIntelligenceProviderAdapter.md +78 -0
- package/data/packages/platform-intelligence/api/Class.GrokIntelligenceProviderAdapter.md +78 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceAgent.md +95 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceAgentFactory.md +11 -23
- package/data/packages/platform-intelligence/api/Class.IntelligenceEmbeddingGenerator.md +25 -21
- package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +11 -7
- package/data/packages/platform-intelligence/api/Class.IntelligenceLanguageGenerator.md +159 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceMediaGenerator.md +60 -38
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
- package/data/packages/platform-intelligence/api/Class.IntelligencePromptExecutor.md +88 -0
- package/data/packages/platform-intelligence/api/Class.IntelligencePromptPolicyPort.md +48 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceProviderAssetUploader.md +21 -15
- package/data/packages/platform-intelligence/api/Class.IntelligenceProviderDiagnostics.md +55 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceProviderError.md +14 -4
- package/data/packages/platform-intelligence/api/Class.IntelligenceProviderRegistry.md +68 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeError.md +9 -9
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeMeteringPort.md +2 -2
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md +12 -12
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionPort.md +18 -18
- package/data/packages/platform-intelligence/api/Class.IntelligenceReranker.md +58 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceToolBase.md +14 -16
- package/data/packages/platform-intelligence/api/Class.IntelligenceToolRegistry.md +10 -14
- package/data/packages/platform-intelligence/api/Class.MiMoIntelligenceProviderAdapter.md +78 -0
- package/data/packages/platform-intelligence/api/Class.OpenAIIntelligenceProviderAdapter.md +102 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicAdvisor20260301Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicBash20241022Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicBash20250124Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250522Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250825Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20260120Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20241022Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20250124Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20251124Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicMemory20250818Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20241022Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250124Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250429Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250728Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchBM2520251119Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchRegex20251119Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20250910Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20260209Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20250305Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20260209Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGoogleCodeExecutionTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGoogleEnterpriseWebSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGoogleFileSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGoogleGoogleMapsTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGoogleGoogleSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGoogleUrlContextTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGoogleVertexRagStoreTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGrokCodeExecutionTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGrokFileSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGrokMcpServerTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGrokViewImageTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGrokViewXVideoTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGrokWebSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGrokXSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createIntelligenceJsonSchema.md +31 -0
- package/data/packages/platform-intelligence/api/Function.createIntelligenceTool.md +2 -2
- package/data/packages/platform-intelligence/api/Function.createMimoCustomTool.md +5 -5
- package/data/packages/platform-intelligence/api/Function.createOpenAIApplyPatchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAICodeInterpreterTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAICustomTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAIFileSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAIImageGenerationTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAILocalShellTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAIMcpTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAIShellTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAIToolSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchPreviewTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.defineIntelligenceTool.md +31 -0
- package/data/packages/platform-intelligence/api/Function.intelligencePrompt.md +31 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceAgentConfiguration.md +70 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchOptions.md +124 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchResult.md +70 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingOptions.md +114 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingResult.md +70 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadOptions.md +102 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadResult.md +60 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceGeneratedFile.md +40 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceGenerationStepStartEvent.md +50 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationOptions.md +170 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationResult.md +60 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageCompletion.md +141 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageGenerationOptions.md +234 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageStream.md +50 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelReference.md +34 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelRequestOptions.md +52 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelStatus.md +30 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +43 -25
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceObjectStream.md +56 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +50 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptDefinition.md +145 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptEffectivePolicy.md +30 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionContext.md +20 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionPolicy.md +70 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionResult.md +127 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptInvocation.md +49 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptPolicyRequest.md +60 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptRenderContext.md +26 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderAdapter.md +73 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +10 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderLoadRequest.md +40 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderProbeResult.md +70 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeAudioFormat.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeCloseEvent.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeModuleOptions.md +9 -21
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionConfiguration.md +11 -11
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +11 -11
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeToolDefinition.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTranscriptionConfiguration.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTurnDetectionConfiguration.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md +10 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRequestOptions.md +98 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingOptions.md +140 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingResult.md +50 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadOptions.md +94 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadResult.md +80 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationOptions.md +164 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationResult.md +50 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceStreamingTranscriptionOptions.md +139 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTool.md +7 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolCall.md +40 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolDefinition.md +91 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionEndEvent.md +50 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionStartEvent.md +30 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolRegistry.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionOptions.md +114 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionResult.md +84 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionStream.md +97 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceUsage.md +40 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationOptions.md +229 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationResult.md +50 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceModelMessage.md +43 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IIntelligencePromptModelRequirement.md +25 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceSchema.md +70 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceCapability.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceDefaultModels.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceJsonValue.md +22 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptCapability.md +20 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptDefinitionConfiguration.md +29 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptGenerationOptions.md +16 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptLatency.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptMode.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptQuality.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptReasoning.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderOptions.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderProbeStatus.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderToolOptions.md +17 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeClientEvent.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMetadataValue.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMeteringEvent.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeServerEvent.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeStatus.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRequestTimeouts.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolChoice.md +21 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolOutput.md +22 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolSet.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTranscriptionStreamPart.md +46 -0
- package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_API_KEY.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_BASE_URL.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_CONFIG_ENTRIES.md +14 -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 +2 -2
- 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.IntelligenceCapabilityNames.md +40 -0
- package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +2 -0
- package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-intelligence/api/index.md +98 -30
- package/package.json +1 -1
- package/data/packages/index.md +0 -8
- package/data/packages/platform-analytics/index.md +0 -209
- package/data/packages/platform-authentication/index.md +0 -725
- package/data/packages/platform-blob-storage/index.md +0 -416
- package/data/packages/platform-bootstrap/index.md +0 -162
- package/data/packages/platform-caching/index.md +0 -167
- package/data/packages/platform-configuration/index.md +0 -226
- package/data/packages/platform-core/index.md +0 -504
- package/data/packages/platform-cryptography/index.md +0 -142
- package/data/packages/platform-database/index.md +0 -337
- package/data/packages/platform-documents/index.md +0 -255
- package/data/packages/platform-esigning/index.md +0 -710
- package/data/packages/platform-feature-flags/index.md +0 -103
- package/data/packages/platform-health/index.md +0 -141
- package/data/packages/platform-intelligence/api/Class.IntelligenceStructuredGenerator.md +0 -70
- package/data/packages/platform-intelligence/api/Class.IntelligenceTelemetryRegistry.md +0 -44
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +0 -138
- package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +0 -39
- package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadGoogleRealtimeModel.md +0 -25
- package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadGrokRealtimeModel.md +0 -25
- package/data/packages/platform-intelligence/api/Function.loadMimoLanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadOpenAIRealtimeModel.md +0 -25
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +0 -168
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +0 -144
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +0 -78
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextStreamingOptions.md +0 -170
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +0 -24
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoaders.md +0 -14
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoader.md +0 -25
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoaders.md +0 -14
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTextStream.md +0 -14
- package/data/packages/platform-intelligence/index.md +0 -549
- package/data/packages/platform-logging/index.md +0 -150
- package/data/packages/platform-mailing/index.md +0 -470
- package/data/packages/platform-mapping/index.md +0 -123
- package/data/packages/platform-mcp/index.md +0 -335
- package/data/packages/platform-openapi/index.md +0 -207
- package/data/packages/platform-payments/index.md +0 -610
- package/data/packages/platform-queue/index.md +0 -192
- package/data/packages/platform-reporting/index.md +0 -233
- package/data/packages/platform-resources/index.md +0 -137
- package/data/packages/platform-telemetry/index.md +0 -262
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Function: loadMimoLanguageModel()'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Function: loadMimoLanguageModel()
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
function loadMimoLanguageModel(configuration): Promise<LanguageModelV4>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [providers/mimo/loadMimoLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/mimo/loadMimoLanguageModel.ts#L17)
|
|
13
|
-
|
|
14
|
-
Creates the Xiaomi MiMo language model from the resolved provider configuration.
|
|
15
|
-
|
|
16
|
-
## Parameters
|
|
17
|
-
|
|
18
|
-
| Parameter | Type | Description |
|
|
19
|
-
| ------ | ------ | ------ |
|
|
20
|
-
| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
|
|
21
|
-
|
|
22
|
-
## Returns
|
|
23
|
-
|
|
24
|
-
`Promise`\<`LanguageModelV4`\>
|
|
25
|
-
|
|
26
|
-
The configured language model instance.
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Function: loadOpenAILanguageModel()'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Function: loadOpenAILanguageModel()
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
function loadOpenAILanguageModel(configuration): Promise<LanguageModelV4>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [providers/openai/loadOpenAILanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/loadOpenAILanguageModel.ts#L17)
|
|
13
|
-
|
|
14
|
-
Creates the OpenAI language model from the resolved provider configuration.
|
|
15
|
-
|
|
16
|
-
## Parameters
|
|
17
|
-
|
|
18
|
-
| Parameter | Type | Description |
|
|
19
|
-
| ------ | ------ | ------ |
|
|
20
|
-
| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
|
|
21
|
-
|
|
22
|
-
## Returns
|
|
23
|
-
|
|
24
|
-
`Promise`\<`LanguageModelV4`\>
|
|
25
|
-
|
|
26
|
-
The configured language model instance.
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Function: loadOpenAIRealtimeModel()'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Function: loadOpenAIRealtimeModel()
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
function loadOpenAIRealtimeModel(configuration, options): Promise<RealtimeModelV4>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: providers/openai/loadOpenAIRealtimeModel.ts:17
|
|
13
|
-
|
|
14
|
-
Creates an OpenAI realtime model exclusively through the Vercel AI SDK provider.
|
|
15
|
-
|
|
16
|
-
## Parameters
|
|
17
|
-
|
|
18
|
-
| Parameter | Type |
|
|
19
|
-
| ------ | ------ |
|
|
20
|
-
| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) |
|
|
21
|
-
| `options` | `IIntelligenceRealtimeModelLoaderOptions` |
|
|
22
|
-
|
|
23
|
-
## Returns
|
|
24
|
-
|
|
25
|
-
`Promise`\<`RealtimeModelV4`\>
|
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceCompletionUsage'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IIntelligenceCompletionUsage
|
|
7
|
-
|
|
8
|
-
Defined in: [contracts/IIntelligenceCompletionUsage.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L6)
|
|
9
|
-
|
|
10
|
-
Captures usage telemetry returned by the intelligence provider.
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### inputTokens
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
readonly inputTokens: number | null;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [contracts/IIntelligenceCompletionUsage.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L14)
|
|
21
|
-
|
|
22
|
-
The number of input tokens consumed by the prompt.
|
|
23
|
-
|
|
24
|
-
***
|
|
25
|
-
|
|
26
|
-
### outputTokens
|
|
27
|
-
|
|
28
|
-
```ts
|
|
29
|
-
readonly outputTokens: number | null;
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Defined in: [contracts/IIntelligenceCompletionUsage.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L21)
|
|
33
|
-
|
|
34
|
-
The number of output tokens generated in the completion.
|
|
35
|
-
|
|
36
|
-
***
|
|
37
|
-
|
|
38
|
-
### totalTokens
|
|
39
|
-
|
|
40
|
-
```ts
|
|
41
|
-
readonly totalTokens: number | null;
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
Defined in: [contracts/IIntelligenceCompletionUsage.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L28)
|
|
45
|
-
|
|
46
|
-
The total number of tokens reported by the provider.
|
|
@@ -1,168 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceTextCompletion'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IIntelligenceTextCompletion
|
|
7
|
-
|
|
8
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L20)
|
|
9
|
-
|
|
10
|
-
Represents the normalized completion result produced by the intelligence provider.
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### files
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
readonly files: readonly GeneratedFile[];
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L56)
|
|
21
|
-
|
|
22
|
-
Files generated by provider-native tools such as image generation or code interpreter.
|
|
23
|
-
|
|
24
|
-
***
|
|
25
|
-
|
|
26
|
-
### finalStep?
|
|
27
|
-
|
|
28
|
-
```ts
|
|
29
|
-
readonly optional finalStep?: StepResult<ToolSet, Record<string, unknown>>;
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L84)
|
|
33
|
-
|
|
34
|
-
Final AI SDK generation step.
|
|
35
|
-
|
|
36
|
-
***
|
|
37
|
-
|
|
38
|
-
### model
|
|
39
|
-
|
|
40
|
-
```ts
|
|
41
|
-
readonly model: string;
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L42)
|
|
45
|
-
|
|
46
|
-
The model identifier used for the completion.
|
|
47
|
-
|
|
48
|
-
***
|
|
49
|
-
|
|
50
|
-
### provider
|
|
51
|
-
|
|
52
|
-
```ts
|
|
53
|
-
readonly provider: string;
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L35)
|
|
57
|
-
|
|
58
|
-
The provider that produced the completion.
|
|
59
|
-
|
|
60
|
-
***
|
|
61
|
-
|
|
62
|
-
### reasoning?
|
|
63
|
-
|
|
64
|
-
```ts
|
|
65
|
-
readonly optional reasoning?: (ReasoningOutput | ReasoningFileOutput)[];
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L63)
|
|
69
|
-
|
|
70
|
-
Reasoning parts reported by AI SDK 7 compatible models.
|
|
71
|
-
|
|
72
|
-
***
|
|
73
|
-
|
|
74
|
-
### reasoningText?
|
|
75
|
-
|
|
76
|
-
```ts
|
|
77
|
-
readonly optional reasoningText?: string;
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L70)
|
|
81
|
-
|
|
82
|
-
Concatenated reasoning text reported by the final generation step.
|
|
83
|
-
|
|
84
|
-
***
|
|
85
|
-
|
|
86
|
-
### sources
|
|
87
|
-
|
|
88
|
-
```ts
|
|
89
|
-
readonly sources: readonly LanguageModelV4Source[];
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L49)
|
|
93
|
-
|
|
94
|
-
Sources reported by provider-native tools such as web search.
|
|
95
|
-
|
|
96
|
-
***
|
|
97
|
-
|
|
98
|
-
### steps?
|
|
99
|
-
|
|
100
|
-
```ts
|
|
101
|
-
readonly optional steps?: StepResult<ToolSet, Record<string, unknown>>[];
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L77)
|
|
105
|
-
|
|
106
|
-
All AI SDK generation steps.
|
|
107
|
-
|
|
108
|
-
***
|
|
109
|
-
|
|
110
|
-
### text
|
|
111
|
-
|
|
112
|
-
```ts
|
|
113
|
-
readonly text: string;
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L28)
|
|
117
|
-
|
|
118
|
-
The generated text content.
|
|
119
|
-
|
|
120
|
-
***
|
|
121
|
-
|
|
122
|
-
### toolCalls?
|
|
123
|
-
|
|
124
|
-
```ts
|
|
125
|
-
readonly optional toolCalls?: TypedToolCall<ToolSet>[];
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L91)
|
|
129
|
-
|
|
130
|
-
Tool calls produced across the generation.
|
|
131
|
-
|
|
132
|
-
***
|
|
133
|
-
|
|
134
|
-
### toolResults?
|
|
135
|
-
|
|
136
|
-
```ts
|
|
137
|
-
readonly optional toolResults?: TypedToolResult<ToolSet>[];
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L98)
|
|
141
|
-
|
|
142
|
-
Tool results produced across the generation.
|
|
143
|
-
|
|
144
|
-
***
|
|
145
|
-
|
|
146
|
-
### usage
|
|
147
|
-
|
|
148
|
-
```ts
|
|
149
|
-
readonly usage:
|
|
150
|
-
| IIntelligenceCompletionUsage
|
|
151
|
-
| null;
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L112)
|
|
155
|
-
|
|
156
|
-
Token usage telemetry, or `null` when the provider does not report usage.
|
|
157
|
-
|
|
158
|
-
***
|
|
159
|
-
|
|
160
|
-
### warnings?
|
|
161
|
-
|
|
162
|
-
```ts
|
|
163
|
-
readonly optional warnings?: SharedV4Warning[];
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L105)
|
|
167
|
-
|
|
168
|
-
Provider or model warnings reported by the AI SDK.
|
package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md
DELETED
|
@@ -1,144 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceTextGenerationOptions'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IIntelligenceTextGenerationOptions
|
|
7
|
-
|
|
8
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L31)
|
|
9
|
-
|
|
10
|
-
Options that can be supplied when generating text with the intelligence provider.
|
|
11
|
-
|
|
12
|
-
## Extends
|
|
13
|
-
|
|
14
|
-
- `IntelligenceGenerateTextPassthroughOptions`
|
|
15
|
-
|
|
16
|
-
## Properties
|
|
17
|
-
|
|
18
|
-
### abortSignal?
|
|
19
|
-
|
|
20
|
-
```ts
|
|
21
|
-
readonly optional abortSignal?: AbortSignal;
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L81)
|
|
25
|
-
|
|
26
|
-
Optional AI SDK abort signal for this generation request.
|
|
27
|
-
|
|
28
|
-
The signal is linked with the platform timeout so either cancellation
|
|
29
|
-
source can stop the request.
|
|
30
|
-
|
|
31
|
-
***
|
|
32
|
-
|
|
33
|
-
### activeTools?
|
|
34
|
-
|
|
35
|
-
```ts
|
|
36
|
-
readonly optional activeTools?: string[];
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L112)
|
|
40
|
-
|
|
41
|
-
Optional list of tool names available to the model for this request.
|
|
42
|
-
|
|
43
|
-
***
|
|
44
|
-
|
|
45
|
-
### maxOutputTokens?
|
|
46
|
-
|
|
47
|
-
```ts
|
|
48
|
-
readonly optional maxOutputTokens?: number;
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L64)
|
|
52
|
-
|
|
53
|
-
Optional maximum output tokens override.
|
|
54
|
-
|
|
55
|
-
***
|
|
56
|
-
|
|
57
|
-
### model?
|
|
58
|
-
|
|
59
|
-
```ts
|
|
60
|
-
readonly optional model?: LanguageModel;
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L43)
|
|
64
|
-
|
|
65
|
-
Optional per-request AI SDK model override.
|
|
66
|
-
|
|
67
|
-
Use this escape hatch when a use case needs a provider-specific model
|
|
68
|
-
factory, wrapped model, middleware, or gateway model that should bypass
|
|
69
|
-
the configured platform model for this call.
|
|
70
|
-
|
|
71
|
-
***
|
|
72
|
-
|
|
73
|
-
### stopWhen?
|
|
74
|
-
|
|
75
|
-
```ts
|
|
76
|
-
readonly optional stopWhen?: StopCondition<ToolSet> | StopCondition<ToolSet>[];
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L105)
|
|
80
|
-
|
|
81
|
-
Optional AI SDK stop condition for multi-step tool execution.
|
|
82
|
-
|
|
83
|
-
***
|
|
84
|
-
|
|
85
|
-
### temperature?
|
|
86
|
-
|
|
87
|
-
```ts
|
|
88
|
-
readonly optional temperature?: number;
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L50)
|
|
92
|
-
|
|
93
|
-
Optional sampling temperature override.
|
|
94
|
-
|
|
95
|
-
***
|
|
96
|
-
|
|
97
|
-
### timeout?
|
|
98
|
-
|
|
99
|
-
```ts
|
|
100
|
-
readonly optional timeout?: TimeoutConfiguration<ToolSet>;
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L71)
|
|
104
|
-
|
|
105
|
-
Native AI SDK timeout configuration.
|
|
106
|
-
|
|
107
|
-
***
|
|
108
|
-
|
|
109
|
-
### toolChoice?
|
|
110
|
-
|
|
111
|
-
```ts
|
|
112
|
-
readonly optional toolChoice?: ToolChoice<ToolSet>;
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L98)
|
|
116
|
-
|
|
117
|
-
Optional AI SDK tool choice strategy.
|
|
118
|
-
|
|
119
|
-
***
|
|
120
|
-
|
|
121
|
-
### tools?
|
|
122
|
-
|
|
123
|
-
```ts
|
|
124
|
-
readonly optional tools?: ToolSet;
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L91)
|
|
128
|
-
|
|
129
|
-
Optional AI SDK tools available for this generation request.
|
|
130
|
-
|
|
131
|
-
Tools registered in the intelligence tool registry are merged with these
|
|
132
|
-
request-specific tools before calling the AI SDK.
|
|
133
|
-
|
|
134
|
-
***
|
|
135
|
-
|
|
136
|
-
### topP?
|
|
137
|
-
|
|
138
|
-
```ts
|
|
139
|
-
readonly optional topP?: number;
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L57)
|
|
143
|
-
|
|
144
|
-
Optional top-p (nucleus) sampling override.
|
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceTextGenerator'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IIntelligenceTextGenerator
|
|
7
|
-
|
|
8
|
-
Defined in: [interfaces/IIntelligenceTextGenerator.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L17)
|
|
9
|
-
|
|
10
|
-
Abstraction responsible for executing text completions using the configured provider.
|
|
11
|
-
|
|
12
|
-
## Methods
|
|
13
|
-
|
|
14
|
-
### generateText()
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
generateText(prompt, options?): Promise<IIntelligenceTextCompletion>;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [interfaces/IIntelligenceTextGenerator.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L28)
|
|
21
|
-
|
|
22
|
-
Generates a text completion using the configured intelligence provider.
|
|
23
|
-
|
|
24
|
-
#### Parameters
|
|
25
|
-
|
|
26
|
-
| Parameter | Type | Description |
|
|
27
|
-
| ------ | ------ | ------ |
|
|
28
|
-
| `prompt` | `Prompt` | The assembled prompt payload. |
|
|
29
|
-
| `options?` | [`IIntelligenceTextGenerationOptions`](Interface.IIntelligenceTextGenerationOptions) | Optional overrides for the text generation request. |
|
|
30
|
-
|
|
31
|
-
#### Returns
|
|
32
|
-
|
|
33
|
-
`Promise`\<[`IIntelligenceTextCompletion`](Interface.IIntelligenceTextCompletion)\>
|
|
34
|
-
|
|
35
|
-
The normalized text completion result.
|
|
36
|
-
|
|
37
|
-
***
|
|
38
|
-
|
|
39
|
-
### getConfiguration()
|
|
40
|
-
|
|
41
|
-
```ts
|
|
42
|
-
getConfiguration(): IIntelligenceProviderConfiguration;
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
Defined in: [interfaces/IIntelligenceTextGenerator.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L46)
|
|
46
|
-
|
|
47
|
-
Returns the currently resolved provider configuration.
|
|
48
|
-
|
|
49
|
-
#### Returns
|
|
50
|
-
|
|
51
|
-
[`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration)
|
|
52
|
-
|
|
53
|
-
The active provider configuration.
|
|
54
|
-
|
|
55
|
-
***
|
|
56
|
-
|
|
57
|
-
### streamText()
|
|
58
|
-
|
|
59
|
-
```ts
|
|
60
|
-
streamText(prompt, options?): Promise<StreamTextResult<ToolSet, Context, Output<string, string, never>>>;
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
Defined in: [interfaces/IIntelligenceTextGenerator.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L38)
|
|
64
|
-
|
|
65
|
-
Streams a text completion using the configured intelligence provider.
|
|
66
|
-
|
|
67
|
-
#### Parameters
|
|
68
|
-
|
|
69
|
-
| Parameter | Type | Description |
|
|
70
|
-
| ------ | ------ | ------ |
|
|
71
|
-
| `prompt` | `Prompt` | The assembled prompt payload. |
|
|
72
|
-
| `options?` | [`IIntelligenceTextStreamingOptions`](Interface.IIntelligenceTextStreamingOptions) | Optional overrides for the streaming request. |
|
|
73
|
-
|
|
74
|
-
#### Returns
|
|
75
|
-
|
|
76
|
-
`Promise`\<`StreamTextResult`\<`ToolSet`, `Context`, `Output`\<`string`, `string`, `never`\>\>\>
|
|
77
|
-
|
|
78
|
-
The native AI SDK streaming result.
|
package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextStreamingOptions.md
DELETED
|
@@ -1,170 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceTextStreamingOptions'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IIntelligenceTextStreamingOptions
|
|
7
|
-
|
|
8
|
-
Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L34)
|
|
9
|
-
|
|
10
|
-
Options that can be supplied when streaming text with the intelligence provider.
|
|
11
|
-
|
|
12
|
-
## Extends
|
|
13
|
-
|
|
14
|
-
- `IntelligenceStreamTextPassthroughOptions`
|
|
15
|
-
|
|
16
|
-
## Properties
|
|
17
|
-
|
|
18
|
-
### activeTools?
|
|
19
|
-
|
|
20
|
-
```ts
|
|
21
|
-
readonly optional activeTools?: string[];
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L98)
|
|
25
|
-
|
|
26
|
-
Optional list of tool names available to the model for this request.
|
|
27
|
-
|
|
28
|
-
***
|
|
29
|
-
|
|
30
|
-
### maxOutputTokens?
|
|
31
|
-
|
|
32
|
-
```ts
|
|
33
|
-
readonly optional maxOutputTokens?: number;
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L63)
|
|
37
|
-
|
|
38
|
-
Optional maximum output tokens override.
|
|
39
|
-
|
|
40
|
-
***
|
|
41
|
-
|
|
42
|
-
### model?
|
|
43
|
-
|
|
44
|
-
```ts
|
|
45
|
-
readonly optional model?: LanguageModel;
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L42)
|
|
49
|
-
|
|
50
|
-
Optional per-request AI SDK model override.
|
|
51
|
-
|
|
52
|
-
***
|
|
53
|
-
|
|
54
|
-
### onChunk?
|
|
55
|
-
|
|
56
|
-
```ts
|
|
57
|
-
readonly optional onChunk?: StreamTextOnChunkCallback<ToolSet>;
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L105)
|
|
61
|
-
|
|
62
|
-
Optional callback invoked for every emitted stream chunk.
|
|
63
|
-
|
|
64
|
-
***
|
|
65
|
-
|
|
66
|
-
### onEnd?
|
|
67
|
-
|
|
68
|
-
```ts
|
|
69
|
-
readonly optional onEnd?: GenerateTextOnEndCallback<NoInfer<ToolSet>, NoInfer<Context>>;
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:119](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L119)
|
|
73
|
-
|
|
74
|
-
Optional callback invoked when the full stream finishes.
|
|
75
|
-
|
|
76
|
-
***
|
|
77
|
-
|
|
78
|
-
### onError?
|
|
79
|
-
|
|
80
|
-
```ts
|
|
81
|
-
readonly optional onError?: StreamTextOnErrorCallback;
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:126](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L126)
|
|
85
|
-
|
|
86
|
-
Optional callback invoked when streaming fails.
|
|
87
|
-
|
|
88
|
-
***
|
|
89
|
-
|
|
90
|
-
### onStepEnd?
|
|
91
|
-
|
|
92
|
-
```ts
|
|
93
|
-
readonly optional onStepEnd?: GenerateTextOnStepEndCallback<NoInfer<ToolSet>, NoInfer<Context>>;
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L112)
|
|
97
|
-
|
|
98
|
-
Optional callback invoked when a stream step completes.
|
|
99
|
-
|
|
100
|
-
***
|
|
101
|
-
|
|
102
|
-
### stopWhen?
|
|
103
|
-
|
|
104
|
-
```ts
|
|
105
|
-
readonly optional stopWhen?: StopCondition<ToolSet> | StopCondition<ToolSet>[];
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L91)
|
|
109
|
-
|
|
110
|
-
Optional AI SDK stop condition for multi-step tool execution.
|
|
111
|
-
|
|
112
|
-
***
|
|
113
|
-
|
|
114
|
-
### temperature?
|
|
115
|
-
|
|
116
|
-
```ts
|
|
117
|
-
readonly optional temperature?: number;
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L49)
|
|
121
|
-
|
|
122
|
-
Optional sampling temperature override.
|
|
123
|
-
|
|
124
|
-
***
|
|
125
|
-
|
|
126
|
-
### timeout?
|
|
127
|
-
|
|
128
|
-
```ts
|
|
129
|
-
readonly optional timeout?: TimeoutConfiguration<ToolSet>;
|
|
130
|
-
```
|
|
131
|
-
|
|
132
|
-
Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L70)
|
|
133
|
-
|
|
134
|
-
Native AI SDK timeout configuration.
|
|
135
|
-
|
|
136
|
-
***
|
|
137
|
-
|
|
138
|
-
### toolChoice?
|
|
139
|
-
|
|
140
|
-
```ts
|
|
141
|
-
readonly optional toolChoice?: ToolChoice<ToolSet>;
|
|
142
|
-
```
|
|
143
|
-
|
|
144
|
-
Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L84)
|
|
145
|
-
|
|
146
|
-
Optional AI SDK tool choice strategy.
|
|
147
|
-
|
|
148
|
-
***
|
|
149
|
-
|
|
150
|
-
### tools?
|
|
151
|
-
|
|
152
|
-
```ts
|
|
153
|
-
readonly optional tools?: ToolSet;
|
|
154
|
-
```
|
|
155
|
-
|
|
156
|
-
Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L77)
|
|
157
|
-
|
|
158
|
-
Optional AI SDK tools available for this streaming request.
|
|
159
|
-
|
|
160
|
-
***
|
|
161
|
-
|
|
162
|
-
### topP?
|
|
163
|
-
|
|
164
|
-
```ts
|
|
165
|
-
readonly optional topP?: number;
|
|
166
|
-
```
|
|
167
|
-
|
|
168
|
-
Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L56)
|
|
169
|
-
|
|
170
|
-
Optional top-p (nucleus) sampling override.
|