@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
package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageGenerationOptions.md
ADDED
|
@@ -0,0 +1,234 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceLanguageGenerationOptions'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IIntelligenceLanguageGenerationOptions
|
|
7
|
+
|
|
8
|
+
Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:17
|
|
9
|
+
|
|
10
|
+
Provider-neutral language generation controls.
|
|
11
|
+
|
|
12
|
+
## Extends
|
|
13
|
+
|
|
14
|
+
- [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions)
|
|
15
|
+
|
|
16
|
+
## Properties
|
|
17
|
+
|
|
18
|
+
### abortSignal?
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
readonly optional abortSignal?: AbortSignal;
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Defined in: contracts/IIntelligenceRequestOptions.ts:16
|
|
25
|
+
|
|
26
|
+
Caller-driven cancellation signal.
|
|
27
|
+
|
|
28
|
+
#### Inherited from
|
|
29
|
+
|
|
30
|
+
[`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`abortSignal`](Interface.IIntelligenceRequestOptions#abortsignal)
|
|
31
|
+
|
|
32
|
+
***
|
|
33
|
+
|
|
34
|
+
### activeToolNames?
|
|
35
|
+
|
|
36
|
+
```ts
|
|
37
|
+
readonly optional activeToolNames?: readonly string[];
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:26
|
|
41
|
+
|
|
42
|
+
***
|
|
43
|
+
|
|
44
|
+
### headers?
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
readonly optional headers?: Readonly<Record<string, string>>;
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Defined in: contracts/IIntelligenceRequestOptions.ts:19
|
|
51
|
+
|
|
52
|
+
Additional outbound request headers.
|
|
53
|
+
|
|
54
|
+
#### Inherited from
|
|
55
|
+
|
|
56
|
+
[`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`headers`](Interface.IIntelligenceRequestOptions#headers)
|
|
57
|
+
|
|
58
|
+
***
|
|
59
|
+
|
|
60
|
+
### maxOutputTokens?
|
|
61
|
+
|
|
62
|
+
```ts
|
|
63
|
+
readonly optional maxOutputTokens?: number;
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:22
|
|
67
|
+
|
|
68
|
+
***
|
|
69
|
+
|
|
70
|
+
### maxRetries?
|
|
71
|
+
|
|
72
|
+
```ts
|
|
73
|
+
readonly optional maxRetries?: number;
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:23
|
|
77
|
+
|
|
78
|
+
***
|
|
79
|
+
|
|
80
|
+
### maxSteps?
|
|
81
|
+
|
|
82
|
+
```ts
|
|
83
|
+
readonly optional maxSteps?: number;
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:27
|
|
87
|
+
|
|
88
|
+
***
|
|
89
|
+
|
|
90
|
+
### model?
|
|
91
|
+
|
|
92
|
+
```ts
|
|
93
|
+
readonly optional model?: IIntelligenceModelReference;
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Defined in: contracts/IIntelligenceModelRequestOptions.ts:17
|
|
97
|
+
|
|
98
|
+
Optional provider/model override.
|
|
99
|
+
|
|
100
|
+
#### Inherited from
|
|
101
|
+
|
|
102
|
+
[`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`model`](Interface.IIntelligenceRequestOptions#model)
|
|
103
|
+
|
|
104
|
+
***
|
|
105
|
+
|
|
106
|
+
### onStepStart?
|
|
107
|
+
|
|
108
|
+
```ts
|
|
109
|
+
readonly optional onStepStart?: (event) => void | Promise<void>;
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:28
|
|
113
|
+
|
|
114
|
+
#### Parameters
|
|
115
|
+
|
|
116
|
+
| Parameter | Type |
|
|
117
|
+
| ------ | ------ |
|
|
118
|
+
| `event` | [`IIntelligenceGenerationStepStartEvent`](Interface.IIntelligenceGenerationStepStartEvent) |
|
|
119
|
+
|
|
120
|
+
#### Returns
|
|
121
|
+
|
|
122
|
+
`void` \| `Promise`\<`void`\>
|
|
123
|
+
|
|
124
|
+
***
|
|
125
|
+
|
|
126
|
+
### onToolExecutionEnd?
|
|
127
|
+
|
|
128
|
+
```ts
|
|
129
|
+
readonly optional onToolExecutionEnd?: (event) => void | Promise<void>;
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:30
|
|
133
|
+
|
|
134
|
+
#### Parameters
|
|
135
|
+
|
|
136
|
+
| Parameter | Type |
|
|
137
|
+
| ------ | ------ |
|
|
138
|
+
| `event` | [`IIntelligenceToolExecutionEndEvent`](Interface.IIntelligenceToolExecutionEndEvent) |
|
|
139
|
+
|
|
140
|
+
#### Returns
|
|
141
|
+
|
|
142
|
+
`void` \| `Promise`\<`void`\>
|
|
143
|
+
|
|
144
|
+
***
|
|
145
|
+
|
|
146
|
+
### onToolExecutionStart?
|
|
147
|
+
|
|
148
|
+
```ts
|
|
149
|
+
readonly optional onToolExecutionStart?: (event) => void | Promise<void>;
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:29
|
|
153
|
+
|
|
154
|
+
#### Parameters
|
|
155
|
+
|
|
156
|
+
| Parameter | Type |
|
|
157
|
+
| ------ | ------ |
|
|
158
|
+
| `event` | [`IIntelligenceToolExecutionStartEvent`](Interface.IIntelligenceToolExecutionStartEvent) |
|
|
159
|
+
|
|
160
|
+
#### Returns
|
|
161
|
+
|
|
162
|
+
`void` \| `Promise`\<`void`\>
|
|
163
|
+
|
|
164
|
+
***
|
|
165
|
+
|
|
166
|
+
### providerOptions?
|
|
167
|
+
|
|
168
|
+
```ts
|
|
169
|
+
readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
Defined in: contracts/IIntelligenceModelRequestOptions.ts:23
|
|
173
|
+
|
|
174
|
+
Optional provider-specific settings.
|
|
175
|
+
|
|
176
|
+
#### Inherited from
|
|
177
|
+
|
|
178
|
+
[`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`providerOptions`](Interface.IIntelligenceRequestOptions#provideroptions)
|
|
179
|
+
|
|
180
|
+
***
|
|
181
|
+
|
|
182
|
+
### temperature?
|
|
183
|
+
|
|
184
|
+
```ts
|
|
185
|
+
readonly optional temperature?: number;
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:20
|
|
189
|
+
|
|
190
|
+
***
|
|
191
|
+
|
|
192
|
+
### timeoutMs?
|
|
193
|
+
|
|
194
|
+
```ts
|
|
195
|
+
readonly optional timeoutMs?: number;
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
Defined in: contracts/IIntelligenceModelRequestOptions.ts:20
|
|
199
|
+
|
|
200
|
+
Total provider-operation timeout in milliseconds.
|
|
201
|
+
|
|
202
|
+
#### Inherited from
|
|
203
|
+
|
|
204
|
+
[`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`timeoutMs`](Interface.IIntelligenceRequestOptions#timeoutms)
|
|
205
|
+
|
|
206
|
+
***
|
|
207
|
+
|
|
208
|
+
### toolChoice?
|
|
209
|
+
|
|
210
|
+
```ts
|
|
211
|
+
readonly optional toolChoice?: IntelligenceToolChoice;
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:25
|
|
215
|
+
|
|
216
|
+
***
|
|
217
|
+
|
|
218
|
+
### tools?
|
|
219
|
+
|
|
220
|
+
```ts
|
|
221
|
+
readonly optional tools?: Readonly<Record<string, IIntelligenceToolDefinition<unknown, unknown>>>;
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:24
|
|
225
|
+
|
|
226
|
+
***
|
|
227
|
+
|
|
228
|
+
### topP?
|
|
229
|
+
|
|
230
|
+
```ts
|
|
231
|
+
readonly optional topP?: number;
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:21
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceLanguageStream'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IIntelligenceLanguageStream
|
|
7
|
+
|
|
8
|
+
Defined in: contracts/IIntelligenceLanguageStream.ts:12
|
|
9
|
+
|
|
10
|
+
Provider-neutral text stream.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### finishReason
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
readonly finishReason: PromiseLike<string>;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: contracts/IIntelligenceLanguageStream.ts:17
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### text
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
readonly text: PromiseLike<string>;
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Defined in: contracts/IIntelligenceLanguageStream.ts:16
|
|
31
|
+
|
|
32
|
+
***
|
|
33
|
+
|
|
34
|
+
### textStream
|
|
35
|
+
|
|
36
|
+
```ts
|
|
37
|
+
readonly textStream: AsyncIterable<string>;
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Defined in: contracts/IIntelligenceLanguageStream.ts:15
|
|
41
|
+
|
|
42
|
+
***
|
|
43
|
+
|
|
44
|
+
### usage
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
readonly usage: PromiseLike<IIntelligenceUsage | null>;
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Defined in: contracts/IIntelligenceLanguageStream.ts:18
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceModelReference'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IIntelligenceModelReference
|
|
7
|
+
|
|
8
|
+
Defined in: contracts/IIntelligenceModelReference.ts:6
|
|
9
|
+
|
|
10
|
+
Selects a provider-owned model without exposing a provider SDK model object.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### model?
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
readonly optional model?: string;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: contracts/IIntelligenceModelReference.ts:13
|
|
21
|
+
|
|
22
|
+
Provider model identifier.
|
|
23
|
+
|
|
24
|
+
***
|
|
25
|
+
|
|
26
|
+
### provider?
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
readonly optional provider?: string;
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Defined in: contracts/IIntelligenceModelReference.ts:10
|
|
33
|
+
|
|
34
|
+
Provider registered with [IntelligenceModule](Class.IntelligenceModule).
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceModelRequestOptions'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IIntelligenceModelRequestOptions
|
|
7
|
+
|
|
8
|
+
Defined in: contracts/IIntelligenceModelRequestOptions.ts:13
|
|
9
|
+
|
|
10
|
+
Shared provider/model controls for intelligence operations.
|
|
11
|
+
|
|
12
|
+
## Extended by
|
|
13
|
+
|
|
14
|
+
- [`IIntelligenceFileUploadOptions`](Interface.IIntelligenceFileUploadOptions)
|
|
15
|
+
- [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions)
|
|
16
|
+
- [`IIntelligenceSkillUploadOptions`](Interface.IIntelligenceSkillUploadOptions)
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
### model?
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
readonly optional model?: IIntelligenceModelReference;
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Defined in: contracts/IIntelligenceModelRequestOptions.ts:17
|
|
27
|
+
|
|
28
|
+
Optional provider/model override.
|
|
29
|
+
|
|
30
|
+
***
|
|
31
|
+
|
|
32
|
+
### providerOptions?
|
|
33
|
+
|
|
34
|
+
```ts
|
|
35
|
+
readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Defined in: contracts/IIntelligenceModelRequestOptions.ts:23
|
|
39
|
+
|
|
40
|
+
Optional provider-specific settings.
|
|
41
|
+
|
|
42
|
+
***
|
|
43
|
+
|
|
44
|
+
### timeoutMs?
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
readonly optional timeoutMs?: number;
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Defined in: contracts/IIntelligenceModelRequestOptions.ts:20
|
|
51
|
+
|
|
52
|
+
Total provider-operation timeout in milliseconds.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceModelStatus'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IIntelligenceModelStatus
|
|
7
|
+
|
|
8
|
+
Defined in: contracts/IIntelligenceModelStatus.ts:6
|
|
9
|
+
|
|
10
|
+
Safe resolved model status that never includes credentials.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### model
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
readonly model: string;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: contracts/IIntelligenceModelStatus.ts:10
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### provider
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
readonly provider: string;
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Defined in: contracts/IIntelligenceModelStatus.ts:9
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IIntelligenceModuleOptions
|
|
7
7
|
|
|
8
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
8
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L19)
|
|
9
9
|
|
|
10
10
|
Options for configuring the intelligence module.
|
|
11
11
|
|
|
@@ -17,36 +17,57 @@ Options for configuring the intelligence module.
|
|
|
17
17
|
readonly optional configEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
20
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L34)
|
|
21
21
|
|
|
22
22
|
Provider-specific configuration entries to register with the config module.
|
|
23
23
|
|
|
24
24
|
***
|
|
25
25
|
|
|
26
|
+
### defaultModels?
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
readonly optional defaultModels?: Readonly<Partial<Record<IntelligenceCapability, IIntelligenceModelReference>>>;
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L40)
|
|
33
|
+
|
|
34
|
+
Capability-specific default provider and model references.
|
|
35
|
+
|
|
36
|
+
***
|
|
37
|
+
|
|
26
38
|
### isGlobal?
|
|
27
39
|
|
|
28
40
|
```ts
|
|
29
41
|
readonly optional isGlobal?: boolean;
|
|
30
42
|
```
|
|
31
43
|
|
|
32
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
44
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L64)
|
|
33
45
|
|
|
34
46
|
When `true` the module is registered globally.
|
|
35
47
|
|
|
36
48
|
***
|
|
37
49
|
|
|
38
|
-
###
|
|
50
|
+
### promptPolicyAdapter?
|
|
39
51
|
|
|
40
52
|
```ts
|
|
41
|
-
readonly optional
|
|
53
|
+
readonly optional promptPolicyAdapter?: Type<IntelligencePromptPolicyPort>;
|
|
42
54
|
```
|
|
43
55
|
|
|
44
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
56
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L57)
|
|
57
|
+
|
|
58
|
+
Optional application policy adapter for provider-neutral prompt requirements.
|
|
59
|
+
|
|
60
|
+
***
|
|
61
|
+
|
|
62
|
+
### providerAdapters?
|
|
63
|
+
|
|
64
|
+
```ts
|
|
65
|
+
readonly optional providerAdapters?: readonly IIntelligenceProviderAdapter[];
|
|
66
|
+
```
|
|
45
67
|
|
|
46
|
-
|
|
68
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L37)
|
|
47
69
|
|
|
48
|
-
|
|
49
|
-
`@breadstone/archipel-platform-intelligence/providers/openai`.
|
|
70
|
+
Provider adapters imported from tree-shakable provider subpaths.
|
|
50
71
|
|
|
51
72
|
***
|
|
52
73
|
|
|
@@ -56,37 +77,34 @@ Import these from provider-specific subpaths such as
|
|
|
56
77
|
readonly optional realtime?: IIntelligenceRealtimeModuleOptions;
|
|
57
78
|
```
|
|
58
79
|
|
|
59
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
80
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L50)
|
|
60
81
|
|
|
61
82
|
Server-owned realtime model sessions, resilience limits, and metering.
|
|
62
83
|
|
|
63
84
|
***
|
|
64
85
|
|
|
65
|
-
###
|
|
86
|
+
### requestTimeouts?
|
|
66
87
|
|
|
67
88
|
```ts
|
|
68
|
-
readonly optional
|
|
69
|
-
| IIntelligenceTool
|
|
70
|
-
| Promise<IIntelligenceTool>
|
|
71
|
-
| Type<IIntelligenceTool>
|
|
72
|
-
| Provider<IIntelligenceTool>)[];
|
|
89
|
+
readonly optional requestTimeouts?: Readonly<Partial<Record<IntelligenceCapability, number>>>;
|
|
73
90
|
```
|
|
74
91
|
|
|
75
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
92
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L43)
|
|
76
93
|
|
|
77
|
-
|
|
94
|
+
Capability-specific total request timeout overrides.
|
|
78
95
|
|
|
79
96
|
***
|
|
80
97
|
|
|
81
|
-
###
|
|
98
|
+
### tools?
|
|
82
99
|
|
|
83
100
|
```ts
|
|
84
|
-
readonly optional
|
|
101
|
+
readonly optional tools?: readonly (
|
|
102
|
+
| IIntelligenceTool
|
|
103
|
+
| Promise<IIntelligenceTool>
|
|
104
|
+
| Type<IIntelligenceTool>
|
|
105
|
+
| Provider<IIntelligenceTool>)[];
|
|
85
106
|
```
|
|
86
107
|
|
|
87
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
88
|
-
|
|
89
|
-
When `true`, provider configuration is resolved during module initialization.
|
|
108
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L27)
|
|
90
109
|
|
|
91
|
-
|
|
92
|
-
native AI SDK model through `generateText()` or `streamText()` options.
|
|
110
|
+
Tool instances, tool factory promises, class providers, or custom Nest providers registered at bootstrap.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceObjectStream\<T\>'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IIntelligenceObjectStream\<T\>
|
|
7
|
+
|
|
8
|
+
Defined in: contracts/IIntelligenceObjectStream.ts:12
|
|
9
|
+
|
|
10
|
+
Provider-neutral structured-output stream.
|
|
11
|
+
|
|
12
|
+
## Type Parameters
|
|
13
|
+
|
|
14
|
+
| Type Parameter |
|
|
15
|
+
| ------ |
|
|
16
|
+
| `T` |
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
### finishReason
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
readonly finishReason: PromiseLike<string>;
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Defined in: contracts/IIntelligenceObjectStream.ts:17
|
|
27
|
+
|
|
28
|
+
***
|
|
29
|
+
|
|
30
|
+
### output
|
|
31
|
+
|
|
32
|
+
```ts
|
|
33
|
+
readonly output: PromiseLike<T>;
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Defined in: contracts/IIntelligenceObjectStream.ts:16
|
|
37
|
+
|
|
38
|
+
***
|
|
39
|
+
|
|
40
|
+
### partialOutputStream
|
|
41
|
+
|
|
42
|
+
```ts
|
|
43
|
+
readonly partialOutputStream: AsyncIterable<Partial<T>>;
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Defined in: contracts/IIntelligenceObjectStream.ts:15
|
|
47
|
+
|
|
48
|
+
***
|
|
49
|
+
|
|
50
|
+
### usage
|
|
51
|
+
|
|
52
|
+
```ts
|
|
53
|
+
readonly usage: PromiseLike<IIntelligenceUsage | null>;
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Defined in: contracts/IIntelligenceObjectStream.ts:18
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligencePrompt'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IIntelligencePrompt
|
|
7
|
+
|
|
8
|
+
Defined in: contracts/IIntelligencePrompt.ts:12
|
|
9
|
+
|
|
10
|
+
Provider-neutral language-model prompt.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### instructions?
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
readonly optional instructions?: string;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: contracts/IIntelligencePrompt.ts:15
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### messages?
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
readonly optional messages?: readonly IIntelligenceModelMessage[];
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Defined in: contracts/IIntelligencePrompt.ts:18
|
|
31
|
+
|
|
32
|
+
***
|
|
33
|
+
|
|
34
|
+
### prompt?
|
|
35
|
+
|
|
36
|
+
```ts
|
|
37
|
+
readonly optional prompt?: string;
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Defined in: contracts/IIntelligencePrompt.ts:17
|
|
41
|
+
|
|
42
|
+
***
|
|
43
|
+
|
|
44
|
+
### system?
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
readonly optional system?: string;
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Defined in: contracts/IIntelligencePrompt.ts:16
|