@breadstone/archipel-mcp 0.0.54 → 0.0.55

package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderLoadRequest.md

@@ -0,0 +1,40 @@
+---
+title: 'Interface: IIntelligenceProviderLoadRequest'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceProviderLoadRequest
+
+Defined in: providers/IIntelligenceProviderLoadRequest.ts:13
+
+Internal model/API load request passed to a provider adapter.
+
+## Properties
+
+### capability
+
+```ts
+readonly capability: IntelligenceCapability;
+```
+
+Defined in: providers/IIntelligenceProviderLoadRequest.ts:16
+
+***
+
+### configuration
+
+```ts
+readonly configuration: IIntelligenceProviderConfiguration;
+```
+
+Defined in: providers/IIntelligenceProviderLoadRequest.ts:17
+
+***
+
+### requestTimeoutMs
+
+```ts
+readonly requestTimeoutMs: number;
+```
+
+Defined in: providers/IIntelligenceProviderLoadRequest.ts:18

package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderProbeResult.md

@@ -0,0 +1,70 @@
+---
+title: 'Interface: IIntelligenceProviderProbeResult'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceProviderProbeResult
+
+Defined in: contracts/IIntelligenceProviderProbeResult.ts:13
+
+Provider-neutral result of a bounded provider availability probe.
+
+## Properties
+
+### capability
+
+```ts
+readonly capability: IntelligenceCapability;
+```
+
+Defined in: contracts/IIntelligenceProviderProbeResult.ts:19
+
+***
+
+### checkedAt
+
+```ts
+readonly checkedAt: Date;
+```
+
+Defined in: contracts/IIntelligenceProviderProbeResult.ts:20
+
+***
+
+### failureCode
+
+```ts
+readonly failureCode: string | null;
+```
+
+Defined in: contracts/IIntelligenceProviderProbeResult.ts:21
+
+***
+
+### model
+
+```ts
+readonly model: string;
+```
+
+Defined in: contracts/IIntelligenceProviderProbeResult.ts:18
+
+***
+
+### provider
+
+```ts
+readonly provider: string;
+```
+
+Defined in: contracts/IIntelligenceProviderProbeResult.ts:17
+
+***
+
+### status
+
+```ts
+readonly status: IntelligenceProviderProbeStatus;
+```
+
+Defined in: contracts/IIntelligenceProviderProbeResult.ts:16

package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeModuleOptions.md

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Interface: IIntelligenceRealtimeModuleOptions
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L14)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L13)
 
 Module-level resilience and resource limits for realtime intelligence.
 
@@ -17,7 +17,7 @@ Module-level resilience and resource limits for realtime intelligence.
 readonly optional closeTimeoutMs?: number;
 ```
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L36)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L32)
 
 Graceful close timeout, capped at five seconds.
 
@@ -29,7 +29,7 @@ Graceful close timeout, capped at five seconds.
 readonly optional connectionTimeoutMs?: number;
 ```
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L33)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L29)
 
 Provider token and WebSocket connection timeout, capped at five seconds.
 
@@ -41,7 +41,7 @@ Provider token and WebSocket connection timeout, capped at five seconds.
 readonly optional maxActiveSessions?: number;
 ```
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L24)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L20)
 
 Maximum simultaneous upstream sessions. Defaults to 1,000.
 
@@ -53,7 +53,7 @@ Maximum simultaneous upstream sessions. Defaults to 1,000.
 readonly optional maxBufferedBytes?: number;
 ```
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L30)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L26)
 
 Maximum upstream WebSocket buffered bytes. Defaults to 4 MiB.
 
@@ -65,7 +65,7 @@ Maximum upstream WebSocket buffered bytes. Defaults to 4 MiB.
 readonly optional maxPendingEvents?: number;
 ```
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L27)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L23)
 
 Maximum queued inbound or outbound events per session. Defaults to 512.
 
@@ -79,7 +79,7 @@ readonly optional meteringAdapter?:
 | Type<IntelligenceRealtimeMeteringPort>;
 ```
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L21)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L17)
 
 Application adapter that persists metering and audit events.
 
@@ -91,30 +91,18 @@ Application adapter that persists metering and audit events.
 readonly optional meteringIntervalMs?: number;
 ```
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L39)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L35)
 
 Provider-independent billing interval. Defaults to 30 seconds.
 
 ***
 
-### providerLoaders?
-
-```ts
-readonly optional providerLoaders?: Partial<Record<IntelligenceProviderName, IntelligenceRealtimeModelLoader>>;
-```
-
-Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L18)
-
-Tree-shakable realtime model loaders keyed by provider.
-
-***
-
 ### tokenRequestMaxRetries?
 
 ```ts
 readonly optional tokenRequestMaxRetries?: number;
 ```
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L42)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L38)
 
 Transient token request retries, capped at two.

package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Interface: IIntelligenceRealtimeSessionOptions
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L16)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L15)
 
 Options used to create one server-owned realtime model connection.
 
@@ -17,7 +17,7 @@ Options used to create one server-owned realtime model connection.
 readonly optional activeToolNames?: readonly string[];
 ```
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L32)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L31)
 
 Optional allow-list of registered Archipel tools exposed to this session.
 
@@ -29,7 +29,7 @@ Optional allow-list of registered Archipel tools exposed to this session.
 readonly optional metadata?: Readonly<Record<string, IntelligenceRealtimeMetadataValue>>;
 ```
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L35)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L34)
 
 Bounded, non-sensitive correlation metadata copied to metering events.
 
@@ -41,7 +41,7 @@ Bounded, non-sensitive correlation metadata copied to metering events.
 readonly model: string;
 ```
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L23)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L22)
 
 Realtime model identifier such as `gpt-realtime`.
 
@@ -53,7 +53,7 @@ Realtime model identifier such as `gpt-realtime`.
 readonly optional onClose?: (event) => void | Promise<void>;
 ```
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L44)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L43)
 
 Receives the terminal upstream connection state.
 
@@ -75,7 +75,7 @@ Receives the terminal upstream connection state.
 readonly optional onError?: (error) => void | Promise<void>;
 ```
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L41)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L40)
 
 Receives transport, provider, parsing, and metering adapter failures.
 
@@ -97,7 +97,7 @@ Receives transport, provider, parsing, and metering adapter failures.
 readonly optional onEvent?: (event) => void | Promise<void>;
 ```
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L38)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L37)
 
 Receives normalized provider events in wire order.
 
@@ -116,10 +116,10 @@ Receives normalized provider events in wire order.
 ### provider?
 
 ```ts
-readonly optional provider?: IntelligenceProviderName;
+readonly optional provider?: string;
 ```
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L26)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L25)
 
 Optional provider override. Defaults to the configured intelligence provider.
 
@@ -131,7 +131,7 @@ Optional provider override. Defaults to the configured intelligence provider.
 readonly optional sessionConfiguration?: IIntelligenceRealtimeSessionConfiguration;
 ```
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L29)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L28)
 
 Provider-neutral realtime session configuration.
 
@@ -143,6 +143,6 @@ Provider-neutral realtime session configuration.
 readonly sessionId: string;
 ```
 
-Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L20)
+Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L19)
 
 Application-owned identifier used for persistence, billing, and audit correlation.

package/data/packages/platform-intelligence/api/Interface.IIntelligenceRequestOptions.md

@@ -0,0 +1,98 @@
+---
+title: 'Interface: IIntelligenceRequestOptions'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceRequestOptions
+
+Defined in: contracts/IIntelligenceRequestOptions.ts:12
+
+Shared execution controls for bounded intelligence requests.
+
+## Extends
+
+- [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions)
+
+## Extended by
+
+- [`IIntelligenceEmbeddingBatchOptions`](Interface.IIntelligenceEmbeddingBatchOptions)
+- [`IIntelligenceEmbeddingOptions`](Interface.IIntelligenceEmbeddingOptions)
+- [`IIntelligenceImageGenerationOptions`](Interface.IIntelligenceImageGenerationOptions)
+- [`IIntelligenceLanguageGenerationOptions`](Interface.IIntelligenceLanguageGenerationOptions)
+- [`IIntelligenceRerankingOptions`](Interface.IIntelligenceRerankingOptions)
+- [`IIntelligenceSpeechGenerationOptions`](Interface.IIntelligenceSpeechGenerationOptions)
+- [`IIntelligenceTranscriptionOptions`](Interface.IIntelligenceTranscriptionOptions)
+- [`IIntelligenceStreamingTranscriptionOptions`](Interface.IIntelligenceStreamingTranscriptionOptions)
+- [`IIntelligenceVideoGenerationOptions`](Interface.IIntelligenceVideoGenerationOptions)
+
+## Properties
+
+### abortSignal?
+
+```ts
+readonly optional abortSignal?: AbortSignal;
+```
+
+Defined in: contracts/IIntelligenceRequestOptions.ts:16
+
+Caller-driven cancellation signal.
+
+***
+
+### headers?
+
+```ts
+readonly optional headers?: Readonly<Record<string, string>>;
+```
+
+Defined in: contracts/IIntelligenceRequestOptions.ts:19
+
+Additional outbound request headers.
+
+***
+
+### model?
+
+```ts
+readonly optional model?: IIntelligenceModelReference;
+```
+
+Defined in: contracts/IIntelligenceModelRequestOptions.ts:17
+
+Optional provider/model override.
+
+#### Inherited from
+
+[`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`model`](Interface.IIntelligenceModelRequestOptions#model)
+
+***
+
+### providerOptions?
+
+```ts
+readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
+```
+
+Defined in: contracts/IIntelligenceModelRequestOptions.ts:23
+
+Optional provider-specific settings.
+
+#### Inherited from
+
+[`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`providerOptions`](Interface.IIntelligenceModelRequestOptions#provideroptions)
+
+***
+
+### timeoutMs?
+
+```ts
+readonly optional timeoutMs?: number;
+```
+
+Defined in: contracts/IIntelligenceModelRequestOptions.ts:20
+
+Total provider-operation timeout in milliseconds.
+
+#### Inherited from
+
+[`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`timeoutMs`](Interface.IIntelligenceModelRequestOptions#timeoutms)

package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingOptions.md

@@ -0,0 +1,140 @@
+---
+title: 'Interface: IIntelligenceRerankingOptions\<TDocument\>'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceRerankingOptions\<TDocument\>
+
+Defined in: contracts/IIntelligenceRerankingOptions.ts:13
+
+Provider-neutral reranking options.
+
+## Extends
+
+- [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions)
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TDocument` *extends* \| `string` \| `Readonly`\<`Record`\<`string`, [`IntelligenceJsonValue`](TypeAlias.IntelligenceJsonValue)\>\> | `string` |
+
+## Properties
+
+### abortSignal?
+
+```ts
+readonly optional abortSignal?: AbortSignal;
+```
+
+Defined in: contracts/IIntelligenceRequestOptions.ts:16
+
+Caller-driven cancellation signal.
+
+#### Inherited from
+
+[`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`abortSignal`](Interface.IIntelligenceRequestOptions#abortsignal)
+
+***
+
+### documents
+
+```ts
+readonly documents: readonly TDocument[];
+```
+
+Defined in: contracts/IIntelligenceRerankingOptions.ts:19
+
+***
+
+### headers?
+
+```ts
+readonly optional headers?: Readonly<Record<string, string>>;
+```
+
+Defined in: contracts/IIntelligenceRequestOptions.ts:19
+
+Additional outbound request headers.
+
+#### Inherited from
+
+[`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`headers`](Interface.IIntelligenceRequestOptions#headers)
+
+***
+
+### maxRetries?
+
+```ts
+readonly optional maxRetries?: number;
+```
+
+Defined in: contracts/IIntelligenceRerankingOptions.ts:20
+
+***
+
+### model?
+
+```ts
+readonly optional model?: IIntelligenceModelReference;
+```
+
+Defined in: contracts/IIntelligenceModelRequestOptions.ts:17
+
+Optional provider/model override.
+
+#### Inherited from
+
+[`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`model`](Interface.IIntelligenceRequestOptions#model)
+
+***
+
+### providerOptions?
+
+```ts
+readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
+```
+
+Defined in: contracts/IIntelligenceModelRequestOptions.ts:23
+
+Optional provider-specific settings.
+
+#### Inherited from
+
+[`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`providerOptions`](Interface.IIntelligenceRequestOptions#provideroptions)
+
+***
+
+### query
+
+```ts
+readonly query: string;
+```
+
+Defined in: contracts/IIntelligenceRerankingOptions.ts:18
+
+***
+
+### timeoutMs?
+
+```ts
+readonly optional timeoutMs?: number;
+```
+
+Defined in: contracts/IIntelligenceModelRequestOptions.ts:20
+
+Total provider-operation timeout in milliseconds.
+
+#### Inherited from
+
+[`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`timeoutMs`](Interface.IIntelligenceRequestOptions#timeoutms)
+
+***
+
+### topN?
+
+```ts
+readonly optional topN?: number;
+```
+
+Defined in: contracts/IIntelligenceRerankingOptions.ts:21

package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingResult.md

@@ -0,0 +1,50 @@
+---
+title: 'Interface: IIntelligenceRerankingResult\<TDocument\>'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceRerankingResult\<TDocument\>
+
+Defined in: contracts/IIntelligenceRerankingResult.ts:12
+
+Provider-neutral reranking result.
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TDocument` *extends* \| `string` \| `Readonly`\<`Record`\<`string`, [`IntelligenceJsonValue`](TypeAlias.IntelligenceJsonValue)\>\> | `string` |
+
+## Properties
+
+### model
+
+```ts
+readonly model: string;
+```
+
+Defined in: contracts/IIntelligenceRerankingResult.ts:21
+
+***
+
+### provider
+
+```ts
+readonly provider: string;
+```
+
+Defined in: contracts/IIntelligenceRerankingResult.ts:20
+
+***
+
+### ranking
+
+```ts
+readonly ranking: readonly {
+  document: TDocument;
+  originalIndex: number;
+  score: number;
+}[];
+```
+
+Defined in: contracts/IIntelligenceRerankingResult.ts:15

package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadOptions.md

@@ -0,0 +1,94 @@
+---
+title: 'Interface: IIntelligenceSkillUploadOptions'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceSkillUploadOptions
+
+Defined in: contracts/IIntelligenceSkillUploadOptions.ts:12
+
+Provider-neutral skill bundle upload options.
+
+## Extends
+
+- [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions)
+
+## Properties
+
+### displayTitle?
+
+```ts
+readonly optional displayTitle?: string;
+```
+
+Defined in: contracts/IIntelligenceSkillUploadOptions.ts:19
+
+***
+
+### files
+
+```ts
+readonly files: readonly {
+  data:   | string
+     | Uint8Array<ArrayBufferLike>
+     | {
+     data: string | Uint8Array<ArrayBufferLike>;
+     type: "data";
+   }
+     | {
+     text: string;
+     type: "text";
+   };
+  path: string;
+}[];
+```
+
+Defined in: contracts/IIntelligenceSkillUploadOptions.ts:15
+
+***
+
+### model?
+
+```ts
+readonly optional model?: IIntelligenceModelReference;
+```
+
+Defined in: contracts/IIntelligenceModelRequestOptions.ts:17
+
+Optional provider/model override.
+
+#### Inherited from
+
+[`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`model`](Interface.IIntelligenceModelRequestOptions#model)
+
+***
+
+### providerOptions?
+
+```ts
+readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
+```
+
+Defined in: contracts/IIntelligenceModelRequestOptions.ts:23
+
+Optional provider-specific settings.
+
+#### Inherited from
+
+[`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`providerOptions`](Interface.IIntelligenceModelRequestOptions#provideroptions)
+
+***
+
+### timeoutMs?
+
+```ts
+readonly optional timeoutMs?: number;
+```
+
+Defined in: contracts/IIntelligenceModelRequestOptions.ts:20
+
+Total provider-operation timeout in milliseconds.
+
+#### Inherited from
+
+[`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`timeoutMs`](Interface.IIntelligenceModelRequestOptions#timeoutms)