Interface SourceOperationsInterface

Source-document operations used by the API.

interface SourceOperationsInterface {
    compiledRule(name: string): CompiledRule | undefined;
    process(
        ref: string,
        rule: string,
        options?: IndexOptions,
    ): Promise<
        {
            chunks?: number;
            error?: {
                code: | "type_collision"
                | "interpolation_error"
                | "extraction_error"
                | "embedding_error"
                | "upsert_error"
                | "match_failed"
                | "rule_missing"
                | "no_content"
                | "source_unavailable"
                | "unsupported_content_type"
                | "invalid_reference"
                | "unknown_source"
                | "invalid_id"
                | "queue_stopped";
                details?: unknown;
                message: string;
            };
            matched_rules?: string[];
            source: string;
            status: "indexed"
            | "unchanged"
            | "deleted"
            | "failed";
        },
    >;
    render(ref: string, rule: string): Promise<SourceRenderOutcome>;
    storedRule(ref: string): Promise<string | null>;
    updateMetadata(
        ref: string,
        metadata: Record<string, unknown>,
    ): Promise<Record<string, unknown> | null>;
    validate(
        ref: string,
        rule: string,
    ):
        | {
            code: | "rule_missing"
            | "invalid_reference"
            | "unknown_source"
            | "invalid_id"
            | "queue_stopped";
            message: string;
        }
        | undefined;
}

Index

Methods

compiledRule process render storedRule updateMetadata validate

Methods

compiledRule

compiledRule(name: string): CompiledRule | undefined
The compiled rule a designated rule name resolves to in the merged rule set (config rules, then virtual rules: first of that name), or undefined when no such rule exists.
Parameters
- name: string
Returns CompiledRule | undefined
- Defined in packages/service/src/processor/SourceOperations.ts:63

process

process(
    ref: string,
    rule: string,
    options?: IndexOptions,
): Promise<
    {
        chunks?: number;
        error?: {
            code: | "type_collision"
            | "interpolation_error"
            | "extraction_error"
            | "embedding_error"
            | "upsert_error"
            | "match_failed"
            | "rule_missing"
            | "no_content"
            | "source_unavailable"
            | "unsupported_content_type"
            | "invalid_reference"
            | "unknown_source"
            | "invalid_id"
            | "queue_stopped";
            details?: unknown;
            message: string;
        };
        matched_rules?: string[];
        source: string;
        status: "indexed"
        | "unchanged"
        | "deleted"
        | "failed";
    },
>
Process a reference with its designated rule (see processSourceDocument); force re-embeds unchanged content.
Parameters
- ref: string
- rule: string
- Optionaloptions: IndexOptions
Returns Promise<
    {
        chunks?: number;
        error?: {
            code: | "type_collision"
            | "interpolation_error"
            | "extraction_error"
            | "embedding_error"
            | "upsert_error"
            | "match_failed"
            | "rule_missing"
            | "no_content"
            | "source_unavailable"
            | "unsupported_content_type"
            | "invalid_reference"
            | "unknown_source"
            | "invalid_id"
            | "queue_stopped";
            details?: unknown;
            message: string;
        };
        matched_rules?: string[];
        source: string;
        status: "indexed"
        | "unchanged"
        | "deleted"
        | "failed";
    },
>
- Defined in packages/service/src/processor/SourceOperations.ts:49

render

render(ref: string, rule: string): Promise<SourceRenderOutcome>
Retrieve and render a document without embedding or writing anything.
Parameters
- ref: string
- rule: string
Returns Promise<SourceRenderOutcome>
- Defined in packages/service/src/processor/SourceOperations.ts:65

storedRule

storedRule(ref: string): Promise<string | null>
Designated rule stored on the document's chunk-0 point, or null if not indexed.
Parameters
- ref: string
Returns Promise<string | null>
- Defined in packages/service/src/processor/SourceOperations.ts:57

updateMetadata

updateMetadata(
ref: string,
metadata: Record<string, unknown>,
): Promise<Record<string, unknown> | null>
Merge enrichment metadata into an indexed document's points; null if not indexed.
Parameters
- ref: string
- metadata: Record<string, unknown>
Returns Promise<Record<string, unknown> | null>
- Defined in packages/service/src/processor/SourceOperations.ts:67

validate

validate(
    ref: string,
    rule: string,
):
    | {
        code: | "rule_missing"
        | "invalid_reference"
        | "unknown_source"
        | "invalid_id"
        | "queue_stopped";
        message: string;
    }
    | undefined
Synchronously validate a notification; undefined when acceptable.
Parameters
- ref: string
- rule: string
Returns
    | {
        code: | "rule_missing"
        | "invalid_reference"
        | "unknown_source"
        | "invalid_id"
        | "queue_stopped";
        message: string;
    }
    | undefined
- {
      code:
          | "rule_missing"
          | "invalid_reference"
          | "unknown_source"
          | "invalid_id"
          | "queue_stopped";
      message: string;
  }
  - code:
        | "rule_missing"
        | "invalid_reference"
        | "unknown_source"
        | "invalid_id"
        | "queue_stopped"
    
    Rejection code.
  - message: string
    
    Human-readable error message.
- undefined
- Defined in packages/service/src/processor/SourceOperations.ts:55

Interface SourceOperationsInterface

Index

Methods

Methods

compiledRule

Parameters

Returns CompiledRule | undefined

process

Parameters

render

Parameters

Returns Promise<SourceRenderOutcome>

storedRule

Parameters

Returns Promise<string | null>

updateMetadata

Parameters

Returns Promise<Record<string, unknown> | null>

validate

Parameters

Returns
    | {
        code: | "rule_missing"
        | "invalid_reference"
        | "unknown_source"
        | "invalid_id"
        | "queue_stopped";
        message: string;
    }
    | undefined

code:
    | "rule_missing"
    | "invalid_reference"
    | "unknown_source"
    | "invalid_id"
    | "queue_stopped"

message: string

Settings

On This Page

Interface SourceOperationsInterface

Index

Methods

Methods

compiledRule

Parameters

Returns CompiledRule | undefined

process

Parameters

render

Parameters

Returns Promise<SourceRenderOutcome>

storedRule

Parameters

Returns Promise<string | null>

updateMetadata

Parameters

Returns Promise<Record<string, unknown> | null>

validate

Parameters

Returns | { code: | "rule_missing" | "invalid_reference" | "unknown_source" | "invalid_id" | "queue_stopped"; message: string; } | undefined

code: | "rule_missing" | "invalid_reference" | "unknown_source" | "invalid_id" | "queue_stopped"

message: string

Settings

On This Page

Returns
| {
code: | "rule_missing"
| "invalid_reference"
| "unknown_source"
| "invalid_id"
| "queue_stopped";
message: string;
}
| undefined

code:
| "rule_missing"
| "invalid_reference"
| "unknown_source"
| "invalid_id"
| "queue_stopped"