Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1211,6 +1211,7 @@ console.log(result.content);
- [GitToolsetOptions](type-aliases/GitToolsetOptions.md)
- [GitToolResult](type-aliases/GitToolResult.md)
- [GitToolRefusal](type-aliases/GitToolRefusal.md)
- [GitToolRuntimeSettings](type-aliases/GitToolRuntimeSettings.md)
- [EnhancedGroundingSource](type-aliases/EnhancedGroundingSource.md)
- [SegmentSupport](type-aliases/SegmentSupport.md)
- [SegmentAttribution](type-aliases/SegmentAttribution.md)
Expand Down Expand Up @@ -1311,6 +1312,12 @@ console.log(result.content);
- [KnowledgeGroundingMetadata](type-aliases/KnowledgeGroundingMetadata.md)
- [KnowledgeValidationIssue](type-aliases/KnowledgeValidationIssue.md)
- [KnowledgeValidationResult](type-aliases/KnowledgeValidationResult.md)
- [KnowledgeNormalizeOptions](type-aliases/KnowledgeNormalizeOptions.md)
- [KnowledgeNormalizeResult](type-aliases/KnowledgeNormalizeResult.md)
- [KnowledgeResolvedRetrieval](type-aliases/KnowledgeResolvedRetrieval.md)
- [KnowledgeScoredCandidate](type-aliases/KnowledgeScoredCandidate.md)
- [KnowledgeSelection](type-aliases/KnowledgeSelection.md)
- [KnowledgeAssembledContext](type-aliases/KnowledgeAssembledContext.md)
- [KnowledgeGroundingInput](type-aliases/KnowledgeGroundingInput.md)
- [KnowledgeGroundingOutcome](type-aliases/KnowledgeGroundingOutcome.md)
- [KnowledgeEngineStatus](type-aliases/KnowledgeEngineStatus.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/api/functions/assembleKnowledgeContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Function: assembleKnowledgeContext()

> **assembleKnowledgeContext**(`selection`, `config`): `KnowledgeAssembledContext`
> **assembleKnowledgeContext**(`selection`, `config`): [`KnowledgeAssembledContext`](../type-aliases/KnowledgeAssembledContext.md)

Defined in: [knowledge/context.ts:77](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/context.ts#L77)

Expand All @@ -19,12 +19,12 @@ entry was degraded or dropped for budget.

### selection

`KnowledgeSelection`
[`KnowledgeSelection`](../type-aliases/KnowledgeSelection.md)

### config

[`KnowledgeContextConfig`](../type-aliases/KnowledgeContextConfig.md) \| `undefined`

## Returns

`KnowledgeAssembledContext`
[`KnowledgeAssembledContext`](../type-aliases/KnowledgeAssembledContext.md)
6 changes: 3 additions & 3 deletions docs/api/functions/normalizeAndValidate.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Function: normalizeAndValidate()

> **normalizeAndValidate**(`sources`, `options`): `Promise`\<`KnowledgeNormalizeResult`\>
> **normalizeAndValidate**(`sources`, `options`): `Promise`\<[`KnowledgeNormalizeResult`](../type-aliases/KnowledgeNormalizeResult.md)\>

Defined in: [knowledge/resolve.ts:105](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/resolve.ts#L105)

Expand All @@ -23,8 +23,8 @@ contract is stable if a future source kind needs asynchronous loading.

### options

`KnowledgeNormalizeOptions`
[`KnowledgeNormalizeOptions`](../type-aliases/KnowledgeNormalizeOptions.md)

## Returns

`Promise`\<`KnowledgeNormalizeResult`\>
`Promise`\<[`KnowledgeNormalizeResult`](../type-aliases/KnowledgeNormalizeResult.md)\>
6 changes: 3 additions & 3 deletions docs/api/functions/retrieve.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Function: retrieve()

> **retrieve**(`snapshot`, `request`, `config`, `blockedDomains?`): `KnowledgeSelection`
> **retrieve**(`snapshot`, `request`, `config`, `blockedDomains?`): [`KnowledgeSelection`](../type-aliases/KnowledgeSelection.md)

Defined in: [knowledge/retrieval.ts:160](https://github.com/juspay/neurolink/blob/release/src/lib/knowledge/retrieval.ts#L160)

Expand All @@ -26,12 +26,12 @@ a confidence class. Context assembly is a separate, later step.

### config

`KnowledgeResolvedRetrieval`
[`KnowledgeResolvedRetrieval`](../type-aliases/KnowledgeResolvedRetrieval.md)

### blockedDomains?

`string`[]

## Returns

`KnowledgeSelection`
[`KnowledgeSelection`](../type-aliases/KnowledgeSelection.md)
60 changes: 60 additions & 0 deletions docs/api/type-aliases/GitToolRuntimeSettings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
[**NeuroLink API Reference**](../README.md)

---

[NeuroLink API Reference](../README.md) / GitToolRuntimeSettings

# Type Alias: GitToolRuntimeSettings

> **GitToolRuntimeSettings** = `object`

Defined in: [types/gitTools.ts:83](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L83)

Resolved git toolset settings for one host.

Deliberately not marked internal: it is the return type of
`configureGitTools`, so it is named by an emitted declaration. Marking it
would make `stripInternal` delete the type without touching the import that
references it, leaving a .d.ts that fails to compile for any consumer using
`skipLibCheck: false`. (Note that the tag is matched as plain text anywhere
in the doc comment, so it cannot even be named here to explain itself.)

## Properties

### repoRoot

> **repoRoot**: `string`

Defined in: [types/gitTools.ts:84](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L84)

---

### timeoutMs

> **timeoutMs**: `number`

Defined in: [types/gitTools.ts:85](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L85)

---

### maxOutputBytes

> **maxOutputBytes**: `number`

Defined in: [types/gitTools.ts:86](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L86)

---

### previewChars

> **previewChars**: `number`

Defined in: [types/gitTools.ts:87](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L87)

---

### gitExecutable

> **gitExecutable**: `string`

Defined in: [types/gitTools.ts:88](https://github.com/juspay/neurolink/blob/release/src/lib/types/gitTools.ts#L88)
45 changes: 45 additions & 0 deletions docs/api/type-aliases/KnowledgeAssembledContext.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
[**NeuroLink API Reference**](../README.md)

---

[NeuroLink API Reference](../README.md) / KnowledgeAssembledContext

# Type Alias: KnowledgeAssembledContext

> **KnowledgeAssembledContext** = `object`

Defined in: [types/knowledge.ts:473](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L473)

The assembled ephemeral-context string plus its diagnostics.

## Properties

### assembledContext

> **assembledContext**: `string`

Defined in: [types/knowledge.ts:474](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L474)

---

### citations

> **citations**: [`KnowledgeCitation`](KnowledgeCitation.md)[]

Defined in: [types/knowledge.ts:475](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L475)

---

### contextTokens

> **contextTokens**: `number`

Defined in: [types/knowledge.ts:476](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L476)

---

### truncated

> **truncated**: `boolean`

Defined in: [types/knowledge.ts:477](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L477)
12 changes: 6 additions & 6 deletions docs/api/type-aliases/KnowledgeEngineStatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **KnowledgeEngineStatus** = `object`

Defined in: [types/knowledge.ts:492](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L492)
Defined in: [types/knowledge.ts:499](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L499)

Snapshot of engine health for telemetry and host introspection.

Expand All @@ -18,36 +18,36 @@ Snapshot of engine health for telemetry and host introspection.

> **enabled**: `boolean`

Defined in: [types/knowledge.ts:493](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L493)
Defined in: [types/knowledge.ts:500](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L500)

---

### ready

> **ready**: `boolean`

Defined in: [types/knowledge.ts:494](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L494)
Defined in: [types/knowledge.ts:501](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L501)

---

### entryCount

> **entryCount**: `number`

Defined in: [types/knowledge.ts:495](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L495)
Defined in: [types/knowledge.ts:502](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L502)

---

### lastError

> **lastError**: `string` \| `null`

Defined in: [types/knowledge.ts:496](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L496)
Defined in: [types/knowledge.ts:503](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L503)

---

### validationIssues

> **validationIssues**: [`KnowledgeValidationIssue`](KnowledgeValidationIssue.md)[]

Defined in: [types/knowledge.ts:497](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L497)
Defined in: [types/knowledge.ts:504](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L504)
8 changes: 4 additions & 4 deletions docs/api/type-aliases/KnowledgeGroundingInput.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **KnowledgeGroundingInput** = `object`

Defined in: [types/knowledge.ts:474](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L474)
Defined in: [types/knowledge.ts:481](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L481)

Per-turn input to `KnowledgeGroundingEngine.ground()`.

Expand All @@ -18,20 +18,20 @@ Per-turn input to `KnowledgeGroundingEngine.ground()`.

> **query**: `string`

Defined in: [types/knowledge.ts:475](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L475)
Defined in: [types/knowledge.ts:482](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L482)

---

### recentTurns?

> `optional` **recentTurns?**: [`KnowledgeConversationTurn`](KnowledgeConversationTurn.md)[]

Defined in: [types/knowledge.ts:476](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L476)
Defined in: [types/knowledge.ts:483](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L483)

---

### scope?

> `optional` **scope?**: [`KnowledgeRequestScope`](KnowledgeRequestScope.md)

Defined in: [types/knowledge.ts:477](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L477)
Defined in: [types/knowledge.ts:484](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L484)
8 changes: 4 additions & 4 deletions docs/api/type-aliases/KnowledgeGroundingOutcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **KnowledgeGroundingOutcome** = `object`

Defined in: [types/knowledge.ts:485](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L485)
Defined in: [types/knowledge.ts:492](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L492)

The engine's per-turn output: the ephemeral context to inject (null on
no-match, when disabled, or on fail-open), the aggregate metadata for the
Expand All @@ -20,20 +20,20 @@ result, and the full retrieval for host diagnostics.

> **ephemeralContext**: [`EphemeralContext`](EphemeralContext.md) \| `null`

Defined in: [types/knowledge.ts:486](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L486)
Defined in: [types/knowledge.ts:493](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L493)

---

### metadata

> **metadata**: [`KnowledgeGroundingMetadata`](KnowledgeGroundingMetadata.md)

Defined in: [types/knowledge.ts:487](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L487)
Defined in: [types/knowledge.ts:494](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L494)

---

### retrieval

> **retrieval**: [`KnowledgeRetrievalResult`](KnowledgeRetrievalResult.md) \| `null`

Defined in: [types/knowledge.ts:488](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L488)
Defined in: [types/knowledge.ts:495](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L495)
21 changes: 21 additions & 0 deletions docs/api/type-aliases/KnowledgeNormalizeOptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[**NeuroLink API Reference**](../README.md)

---

[NeuroLink API Reference](../README.md) / KnowledgeNormalizeOptions

# Type Alias: KnowledgeNormalizeOptions

> **KnowledgeNormalizeOptions** = `object`

Defined in: [types/knowledge.ts:432](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L432)

Options for normalizing + validating a set of sources before indexing.

## Properties

### manifestVersion

> **manifestVersion**: `string`

Defined in: [types/knowledge.ts:433](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L433)
29 changes: 29 additions & 0 deletions docs/api/type-aliases/KnowledgeNormalizeResult.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
[**NeuroLink API Reference**](../README.md)

---

[NeuroLink API Reference](../README.md) / KnowledgeNormalizeResult

# Type Alias: KnowledgeNormalizeResult

> **KnowledgeNormalizeResult** = `object`

Defined in: [types/knowledge.ts:437](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L437)

Normalized entries paired with the validation outcome.

## Properties

### entries

> **entries**: [`NormalizedKnowledgeEntry`](NormalizedKnowledgeEntry.md)[]

Defined in: [types/knowledge.ts:438](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L438)

---

### validation

> **validation**: [`KnowledgeValidationResult`](KnowledgeValidationResult.md)

Defined in: [types/knowledge.ts:439](https://github.com/juspay/neurolink/blob/release/src/lib/types/knowledge.ts#L439)
Loading
Loading