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
18 changes: 18 additions & 0 deletions packages/sie_server/src/sie_server/adapters/_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,24 @@ def resolve_embedding_options(
)


def resolve_query_instruction(
instruction: str | None,
options: dict[str, Any] | None,
*,
is_query: bool,
) -> str | None:
"""Return the instruction to format into the texts for ``extract_texts``.

A request instruction always wins, including an explicit ``""``. When the
request gives none, queries fall back to the ``default_instruction``
runtime option (the profile default, or a request override merged into
``options``). Documents never receive the default.
"""
if instruction is not None or not is_query:
return instruction
return (options or {}).get("default_instruction")


# ---------------------------------------------------------------------------
# Score-pair grouping (shared by ColBERT-family adapters)
# ---------------------------------------------------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
from sie_server.adapters._utils import (
extract_texts,
resolve_embedding_options,
resolve_query_instruction,
validate_output_types,
)
from sie_server.core.inference_output import EncodeOutput
Expand Down Expand Up @@ -212,7 +213,8 @@ def encode(
Args:
items: List of items to encode.
output_types: Which outputs to compute (only "dense" supported).
instruction: Optional instruction prefix.
instruction: Optional instruction prefix. For queries, ``None``
falls back to the ``default_instruction`` runtime option.
is_query: Whether items are queries (affects template selection).
prepared_items: Not used by this adapter.

Expand All @@ -236,7 +238,7 @@ def encode(

texts = extract_texts(
items,
instruction,
resolve_query_instruction(instruction, options, is_query=is_query),
is_query=is_query,
query_template=query_template,
doc_template=doc_template,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,12 @@
from sie_server.adapters._flash_base import FlashBaseAdapter
from sie_server.adapters._spec import AdapterSpec
from sie_server.adapters._types import ERR_NOT_LOADED, ERR_REQUIRES_TEXT, ComputePrecision
from sie_server.adapters._utils import apply_rotary_pos_emb, extract_texts, validate_output_types
from sie_server.adapters._utils import (
apply_rotary_pos_emb,
extract_texts,
resolve_query_instruction,
validate_output_types,
)
from sie_server.adapters.peft_lora_mixin import PEFTLoRAMixin
from sie_server.core.inference_output import EncodeOutput, SparseVector
from sie_server.types.inputs import Item
Expand Down Expand Up @@ -201,7 +206,8 @@ def encode(
Args:
items: List of items to encode.
output_types: Which outputs to compute (only "sparse" supported).
instruction: Optional instruction prefix.
instruction: Optional instruction prefix. For queries, ``None``
falls back to the ``default_instruction`` runtime option.
is_query: Whether items are queries (affects template selection).
prepared_items: Not used by this adapter.

Expand All @@ -221,7 +227,7 @@ def encode(

texts = extract_texts(
items,
instruction,
resolve_query_instruction(instruction, options, is_query=is_query),
is_query=is_query,
query_template=query_template,
doc_template=doc_template,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
from sie_server.adapters._utils import (
extract_texts,
resolve_embedding_options,
resolve_query_instruction,
validate_output_types,
)
from sie_server.adapters.peft_lora_mixin import PEFTLoRAMixin
Expand Down Expand Up @@ -219,7 +220,8 @@ def encode(
Args:
items: List of items to encode.
output_types: Which outputs to compute (only "dense" supported).
instruction: Optional instruction prefix.
instruction: Optional instruction prefix. For queries, ``None``
falls back to the ``default_instruction`` runtime option.
is_query: Whether items are queries (affects template selection).
prepared_items: Not used by this adapter.
options: Runtime options for normalize, pooling, templates.
Expand All @@ -244,7 +246,7 @@ def encode(

texts = extract_texts(
items,
instruction,
resolve_query_instruction(instruction, options, is_query=is_query),
is_query=is_query,
query_template=query_template,
doc_template=doc_template,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,12 @@
from sie_server.adapters._flash_pack import build_position_ids, mean_pool_packed
from sie_server.adapters._spec import AdapterSpec
from sie_server.adapters._types import ERR_NOT_LOADED, ComputePrecision, PoolingStrategy
from sie_server.adapters._utils import apply_rotary_pos_emb, extract_texts, validate_output_types
from sie_server.adapters._utils import (
apply_rotary_pos_emb,
extract_texts,
resolve_query_instruction,
validate_output_types,
)
from sie_server.core.inference_output import EncodeOutput
from sie_server.types.inputs import Item

Expand Down Expand Up @@ -236,7 +241,8 @@ def encode(
Args:
items: List of items to encode.
output_types: Which outputs to compute (only "dense" supported).
instruction: Optional instruction prefix (unused, template-based).
instruction: Optional instruction prefix. For queries, ``None``
falls back to the ``default_instruction`` runtime option.
is_query: Whether items are queries (affects template selection).
prepared_items: Not used by this adapter.

Expand All @@ -256,7 +262,7 @@ def encode(

texts = extract_texts(
items,
instruction,
resolve_query_instruction(instruction, options, is_query=is_query),
is_query=is_query,
query_template=query_template,
doc_template=doc_template,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,12 @@
from sie_server.adapters._flash_pack import build_position_ids, mean_pool_packed
from sie_server.adapters._spec import AdapterSpec
from sie_server.adapters._types import ERR_NOT_LOADED, ComputePrecision, PoolingStrategy
from sie_server.adapters._utils import apply_rotary_pos_emb, extract_texts, validate_output_types
from sie_server.adapters._utils import (
apply_rotary_pos_emb,
extract_texts,
resolve_query_instruction,
validate_output_types,
)
from sie_server.adapters.peft_lora_mixin import PEFTLoRAMixin
from sie_server.core.inference_output import EncodeOutput
from sie_server.types.inputs import Item
Expand Down Expand Up @@ -270,15 +275,10 @@ def encode(
doc_template = opts.get("doc_template", self._doc_template)
normalize = opts.get("normalize", self._normalize)
pooling = opts.get("pooling", self._pooling)
# The profile's default_instruction is query-only and fills in only
# when the request gave no instruction; an explicit "" is kept.
effective_instruction = instruction
if effective_instruction is None and is_query:
effective_instruction = opts.get("default_instruction")

texts = extract_texts(
items,
effective_instruction,
resolve_query_instruction(instruction, opts, is_query=is_query),
is_query=is_query,
query_template=query_template,
doc_template=doc_template,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@
from sie_server.adapters._flash_pack import mean_pool_packed
from sie_server.adapters._spec import AdapterSpec
from sie_server.adapters._types import ERR_NOT_LOADED, ComputePrecision, PoolingStrategy
from sie_server.adapters._utils import apply_rotary_pos_emb, extract_texts, validate_output_types
from sie_server.adapters._utils import (
apply_rotary_pos_emb,
extract_texts,
resolve_query_instruction,
Comment thread
coderabbitai[bot] marked this conversation as resolved.
validate_output_types,
)
from sie_server.adapters.peft_lora_mixin import PEFTLoRAMixin
from sie_server.core.inference_output import EncodeOutput
from sie_server.types.inputs import Item
Expand Down Expand Up @@ -172,7 +177,8 @@ def encode(
Args:
items: List of items to encode.
output_types: Which outputs to compute (only "dense" supported).
instruction: Optional instruction prefix.
instruction: Optional instruction prefix. For queries, ``None``
falls back to the ``default_instruction`` runtime option.
is_query: Whether items are queries (affects template selection).
prepared_items: Not used by this adapter.

Expand All @@ -194,7 +200,7 @@ def encode(

texts = extract_texts(
items,
instruction,
resolve_query_instruction(instruction, options, is_query=is_query),
is_query=is_query,
query_template=query_template,
doc_template=doc_template,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
from sie_server.adapters._flash_pack import build_position_ids
from sie_server.adapters._spec import AdapterSpec
from sie_server.adapters._types import ERR_NOT_LOADED, ComputePrecision
from sie_server.adapters._utils import extract_texts, validate_output_types
from sie_server.adapters._utils import extract_texts, resolve_query_instruction, validate_output_types
from sie_server.adapters.base import ModelAdapter
from sie_server.adapters.peft_lora_mixin import PEFTLoRAMixin
from sie_server.core.inference_output import EncodeOutput, SparseVector
Expand Down Expand Up @@ -230,7 +230,7 @@ def encode(

texts = extract_texts(
items,
instruction,
resolve_query_instruction(instruction, options, is_query=is_query),
is_query=is_query,
query_template=query_template,
doc_template=doc_template,
Expand Down
Loading
Loading