@vibexp/api-client 0.10.0 → 0.11.0

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.
@@ -671,6 +671,14 @@ export type EmbeddingProvider = {
671
671
  * Maximum number of simultaneous embedding requests VibeXP issues to this provider. Keep at 1 for single-threaded providers.
672
672
  */
673
673
  concurrency: number;
674
+ /**
675
+ * Instruction prefix prepended to search queries before they are embedded (only the text sent to the provider; nothing extra is stored). Asymmetric models require this — e.g. mxbai/BGE English expect "Represent this sentence for searching relevant passages: ", E5 expects "query: ". Empty/null means no prefix (default behaviour).
676
+ */
677
+ query_prefix?: string | null;
678
+ /**
679
+ * Instruction prefix prepended to document chunks before they are embedded (applied only to the text sent to the provider; the stored chunk content is unchanged). E5 expects "passage: "; mxbai/BGE embed documents raw. Changing this invalidates stored vectors and triggers a team re-embed. Empty/null means no prefix (default behaviour).
680
+ */
681
+ document_prefix?: string | null;
674
682
  is_default: boolean;
675
683
  base_url?: string | null;
676
684
  configuration: string;
@@ -703,6 +711,14 @@ export type CreateEmbeddingProviderRequest = {
703
711
  * Optional max simultaneous embedding requests to this provider; defaults to 1 when omitted.
704
712
  */
705
713
  concurrency?: number;
714
+ /**
715
+ * Optional instruction prefix prepended to search queries before embedding. Defaults to empty (no prefix) when omitted.
716
+ */
717
+ query_prefix?: string | null;
718
+ /**
719
+ * Optional instruction prefix prepended to document chunks before embedding. Defaults to empty (no prefix) when omitted.
720
+ */
721
+ document_prefix?: string | null;
706
722
  is_default?: boolean;
707
723
  base_url?: string;
708
724
  api_key?: string | null;
@@ -717,6 +733,14 @@ export type UpdateEmbeddingProviderRequest = {
717
733
  chunk_size?: number;
718
734
  chunk_overlap?: number;
719
735
  concurrency?: number;
736
+ /**
737
+ * Instruction prefix prepended to search queries before embedding. Send an empty string to clear a previously configured prefix.
738
+ */
739
+ query_prefix?: string | null;
740
+ /**
741
+ * Instruction prefix prepended to document chunks before embedding. Changing it triggers a team re-embed. Send an empty string to clear.
742
+ */
743
+ document_prefix?: string | null;
720
744
  is_default?: boolean;
721
745
  base_url?: string;
722
746
  api_key?: string;
package/dist/schema.d.ts CHANGED
@@ -4397,6 +4397,16 @@ export interface components {
4397
4397
  * @example 1
4398
4398
  */
4399
4399
  concurrency: number;
4400
+ /**
4401
+ * @description Instruction prefix prepended to search queries before they are embedded (only the text sent to the provider; nothing extra is stored). Asymmetric models require this — e.g. mxbai/BGE English expect "Represent this sentence for searching relevant passages: ", E5 expects "query: ". Empty/null means no prefix (default behaviour).
4402
+ * @example Represent this sentence for searching relevant passages:
4403
+ */
4404
+ query_prefix?: string | null;
4405
+ /**
4406
+ * @description Instruction prefix prepended to document chunks before they are embedded (applied only to the text sent to the provider; the stored chunk content is unchanged). E5 expects "passage: "; mxbai/BGE embed documents raw. Changing this invalidates stored vectors and triggers a team re-embed. Empty/null means no prefix (default behaviour).
4407
+ * @example passage:
4408
+ */
4409
+ document_prefix?: string | null;
4400
4410
  /** @example false */
4401
4411
  is_default: boolean;
4402
4412
  /**
@@ -4446,6 +4456,16 @@ export interface components {
4446
4456
  * @example 1
4447
4457
  */
4448
4458
  concurrency?: number;
4459
+ /**
4460
+ * @description Optional instruction prefix prepended to search queries before embedding. Defaults to empty (no prefix) when omitted.
4461
+ * @example Represent this sentence for searching relevant passages:
4462
+ */
4463
+ query_prefix?: string | null;
4464
+ /**
4465
+ * @description Optional instruction prefix prepended to document chunks before embedding. Defaults to empty (no prefix) when omitted.
4466
+ * @example passage:
4467
+ */
4468
+ document_prefix?: string | null;
4449
4469
  /** @example false */
4450
4470
  is_default?: boolean;
4451
4471
  /**
@@ -4465,6 +4485,10 @@ export interface components {
4465
4485
  chunk_size?: number;
4466
4486
  chunk_overlap?: number;
4467
4487
  concurrency?: number;
4488
+ /** @description Instruction prefix prepended to search queries before embedding. Send an empty string to clear a previously configured prefix. */
4489
+ query_prefix?: string | null;
4490
+ /** @description Instruction prefix prepended to document chunks before embedding. Changing it triggers a team re-embed. Send an empty string to clear. */
4491
+ document_prefix?: string | null;
4468
4492
  is_default?: boolean;
4469
4493
  /** Format: uri */
4470
4494
  base_url?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vibexp/api-client",
3
- "version": "0.10.0",
3
+ "version": "0.11.0",
4
4
  "description": "Typed VibeXP API client generated from the OpenAPI spec (openapi-fetch main entrypoint, axios SDK at ./axios)",
5
5
  "license": "MIT",
6
6
  "repository": {