@vibexp/api-client 0.9.0 → 0.11.0

package/dist/axios/types.gen.d.ts

@@ -671,6 +671,14 @@ export type EmbeddingProvider = {
      * Maximum number of simultaneous embedding requests VibeXP issues to this provider. Keep at 1 for single-threaded providers.
      */
     concurrency: number;
+    /**
+     * 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).
+     */
+    query_prefix?: string | null;
+    /**
+     * 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).
+     */
+    document_prefix?: string | null;
     is_default: boolean;
     base_url?: string | null;
     configuration: string;
@@ -703,6 +711,14 @@ export type CreateEmbeddingProviderRequest = {
      * Optional max simultaneous embedding requests to this provider; defaults to 1 when omitted.
      */
     concurrency?: number;
+    /**
+     * Optional instruction prefix prepended to search queries before embedding. Defaults to empty (no prefix) when omitted.
+     */
+    query_prefix?: string | null;
+    /**
+     * Optional instruction prefix prepended to document chunks before embedding. Defaults to empty (no prefix) when omitted.
+     */
+    document_prefix?: string | null;
     is_default?: boolean;
     base_url?: string;
     api_key?: string | null;
@@ -717,6 +733,14 @@ export type UpdateEmbeddingProviderRequest = {
     chunk_size?: number;
     chunk_overlap?: number;
     concurrency?: number;
+    /**
+     * Instruction prefix prepended to search queries before embedding. Send an empty string to clear a previously configured prefix.
+     */
+    query_prefix?: string | null;
+    /**
+     * Instruction prefix prepended to document chunks before embedding. Changing it triggers a team re-embed. Send an empty string to clear.
+     */
+    document_prefix?: string | null;
     is_default?: boolean;
     base_url?: string;
     api_key?: string;
@@ -798,6 +822,86 @@ export type EmbeddingCoverageResponse = {
      */
     coverage: Array<EmbeddingCoverageItem>;
 };
+export type ModelProvider = {
+    id: string;
+    user_id: string;
+    /**
+     * Team that owns this provider.
+     */
+    team_id?: string | null;
+    name: string;
+    provider_type: string;
+    /**
+     * Chat/completion model this provider requests.
+     */
+    model: string;
+    is_default: boolean;
+    base_url?: string | null;
+    configuration: string;
+    created_at: string;
+    updated_at: string;
+    /**
+     * Optimistic-concurrency version counter, incremented on each update. Note: create responses currently return 0 (the persisted row starts at 1) — read it from get/list/update responses instead.
+     */
+    version: number;
+};
+export type ModelProviderResponse = ModelProvider & {
+    has_api_key: boolean;
+};
+export type CreateModelProviderRequest = {
+    name: string;
+    provider_type: string;
+    /**
+     * Chat/completion model to use.
+     */
+    model: string;
+    is_default?: boolean;
+    base_url?: string;
+    api_key?: string | null;
+    configuration?: {
+        [key: string]: unknown;
+    };
+};
+export type UpdateModelProviderRequest = {
+    name?: string;
+    provider_type?: string;
+    model?: string;
+    is_default?: boolean;
+    base_url?: string;
+    api_key?: string;
+    configuration?: {
+        [key: string]: unknown;
+    };
+};
+export type ModelProviderListResponse = {
+    model_providers: Array<ModelProviderResponse>;
+    total_count: number;
+    page: number;
+    per_page: number;
+    total_pages: number;
+};
+export type ModelProviderResponseList = Array<ModelProviderResponse>;
+export type ValidateModelProviderRequest = {
+    provider_type: string;
+    /**
+     * Chat/completion model to probe for reachability and auth.
+     */
+    model: string;
+    base_url: string;
+    api_key?: string | null;
+    configuration?: {
+        [key: string]: unknown;
+    };
+};
+export type ValidateModelProviderResponse = {
+    is_valid: boolean;
+    message: string;
+    details?: {
+        response_time_ms?: number;
+        status_code?: number;
+        error_details?: string;
+    };
+};
 export type ResourceUsageItem = {
     /**
      * Type of resource (e.g., prompt, memory, artifact)
@@ -10525,6 +10629,442 @@ export type ValidateEmbeddingProviderSettingsResponses = {
     200: ValidateEmbeddingProviderResponse;
 };
 export type ValidateEmbeddingProviderSettingsResponse = ValidateEmbeddingProviderSettingsResponses[keyof ValidateEmbeddingProviderSettingsResponses];
+export type ListModelProvidersData = {
+    body?: never;
+    path: {
+        /**
+         * Team that owns the model provider(s).
+         */
+        team_id: string;
+    };
+    query?: never;
+    url: '/api/v1/{team_id}/model-providers';
+};
+export type ListModelProvidersErrors = {
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Failed to retrieve model providers (`DATABASE_ERROR`)
+     */
+    500: ErrorResponse;
+};
+export type ListModelProvidersError = ListModelProvidersErrors[keyof ListModelProvidersErrors];
+export type ListModelProvidersResponses = {
+    /**
+     * Model providers retrieved successfully
+     */
+    200: ModelProviderResponseList;
+};
+export type ListModelProvidersResponse = ListModelProvidersResponses[keyof ListModelProvidersResponses];
+export type CreateModelProviderData = {
+    body: CreateModelProviderRequest;
+    path: {
+        /**
+         * Team that owns the model provider(s).
+         */
+        team_id: string;
+    };
+    query?: never;
+    url: '/api/v1/{team_id}/model-providers';
+};
+export type CreateModelProviderErrors = {
+    /**
+     * Malformed JSON body (`BAD_REQUEST`) or missing required fields (`MODEL_PROVIDER_VALIDATION_FAILED` with `validation_errors`)
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * A provider with the same name already exists (`MODEL_PROVIDER_ALREADY_EXISTS`)
+     */
+    409: ErrorResponse;
+    /**
+     * Provider creation failed (`MODEL_PROVIDER_CREATE_FAILED`)
+     */
+    500: ErrorResponse;
+};
+export type CreateModelProviderError = CreateModelProviderErrors[keyof CreateModelProviderErrors];
+export type CreateModelProviderResponses = {
+    /**
+     * Model provider created successfully
+     */
+    200: ModelProviderResponse;
+};
+export type CreateModelProviderResponse = CreateModelProviderResponses[keyof CreateModelProviderResponses];
+export type DeleteModelProviderData = {
+    body?: never;
+    path: {
+        /**
+         * Team that owns the model provider(s).
+         */
+        team_id: string;
+        /**
+         * Model provider ID
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/{team_id}/model-providers/{id}';
+};
+export type DeleteModelProviderErrors = {
+    /**
+     * Cannot delete the last model provider (`MODEL_PROVIDER_LAST_DELETE_BLOCKED`)
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Model provider not found (`MODEL_PROVIDER_NOT_FOUND`)
+     */
+    404: ErrorResponse;
+    /**
+     * Provider deletion failed (`MODEL_PROVIDER_DELETE_FAILED`)
+     */
+    500: ErrorResponse;
+};
+export type DeleteModelProviderError = DeleteModelProviderErrors[keyof DeleteModelProviderErrors];
+export type DeleteModelProviderResponses = {
+    /**
+     * Model provider deleted successfully (no body)
+     */
+    204: void;
+};
+export type DeleteModelProviderResponse = DeleteModelProviderResponses[keyof DeleteModelProviderResponses];
+export type GetModelProviderData = {
+    body?: never;
+    path: {
+        /**
+         * Team that owns the model provider(s).
+         */
+        team_id: string;
+        /**
+         * Model provider ID
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/{team_id}/model-providers/{id}';
+};
+export type GetModelProviderErrors = {
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Model provider not found (`MODEL_PROVIDER_NOT_FOUND`)
+     */
+    404: ErrorResponse;
+    /**
+     * Failed to retrieve model provider (`DATABASE_ERROR`)
+     */
+    500: ErrorResponse;
+};
+export type GetModelProviderError = GetModelProviderErrors[keyof GetModelProviderErrors];
+export type GetModelProviderResponses = {
+    /**
+     * Model provider retrieved successfully
+     */
+    200: ModelProviderResponse;
+};
+export type GetModelProviderResponse = GetModelProviderResponses[keyof GetModelProviderResponses];
+export type UpdateModelProviderData = {
+    body: UpdateModelProviderRequest;
+    path: {
+        /**
+         * Team that owns the model provider(s).
+         */
+        team_id: string;
+        /**
+         * Model provider ID
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/{team_id}/model-providers/{id}';
+};
+export type UpdateModelProviderErrors = {
+    /**
+     * Malformed JSON body (`BAD_REQUEST`)
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Model provider not found (`MODEL_PROVIDER_NOT_FOUND`)
+     */
+    404: ErrorResponse;
+    /**
+     * Provider update failed (`MODEL_PROVIDER_UPDATE_FAILED`)
+     */
+    500: ErrorResponse;
+};
+export type UpdateModelProviderError = UpdateModelProviderErrors[keyof UpdateModelProviderErrors];
+export type UpdateModelProviderResponses = {
+    /**
+     * Model provider updated successfully
+     */
+    200: ModelProviderResponse;
+};
+export type UpdateModelProviderResponse = UpdateModelProviderResponses[keyof UpdateModelProviderResponses];
+export type ValidateModelProviderData = {
+    body: ValidateModelProviderRequest;
+    path: {
+        /**
+         * Team that owns the model provider(s).
+         */
+        team_id: string;
+    };
+    query?: never;
+    url: '/api/v1/{team_id}/model-providers/validate';
+};
+export type ValidateModelProviderErrors = {
+    /**
+     * Malformed JSON body (`BAD_REQUEST`) or missing required fields (`MODEL_PROVIDER_VALIDATION_FAILED` with `validation_errors`)
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Validation failed due to an internal service error (`INTERNAL_ERROR`)
+     */
+    500: ErrorResponse;
+};
+export type ValidateModelProviderError = ValidateModelProviderErrors[keyof ValidateModelProviderErrors];
+export type ValidateModelProviderResponses = {
+    /**
+     * Validation completed (check `is_valid` for the outcome)
+     */
+    200: ValidateModelProviderResponse;
+};
+export type ValidateModelProviderResponse2 = ValidateModelProviderResponses[keyof ValidateModelProviderResponses];
+export type ListModelProvidersSettingsData = {
+    body?: never;
+    path: {
+        /**
+         * Team that owns the model provider(s).
+         */
+        team_id: string;
+    };
+    query?: never;
+    url: '/api/v1/{team_id}/settings/model-providers';
+};
+export type ListModelProvidersSettingsErrors = {
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Failed to retrieve model providers (`DATABASE_ERROR`)
+     */
+    500: ErrorResponse;
+};
+export type ListModelProvidersSettingsError = ListModelProvidersSettingsErrors[keyof ListModelProvidersSettingsErrors];
+export type ListModelProvidersSettingsResponses = {
+    /**
+     * Model providers retrieved successfully
+     */
+    200: ModelProviderResponseList;
+};
+export type ListModelProvidersSettingsResponse = ListModelProvidersSettingsResponses[keyof ListModelProvidersSettingsResponses];
+export type CreateModelProviderSettingsData = {
+    body: CreateModelProviderRequest;
+    path: {
+        /**
+         * Team that owns the model provider(s).
+         */
+        team_id: string;
+    };
+    query?: never;
+    url: '/api/v1/{team_id}/settings/model-providers';
+};
+export type CreateModelProviderSettingsErrors = {
+    /**
+     * Malformed JSON body (`BAD_REQUEST`) or missing required fields (`MODEL_PROVIDER_VALIDATION_FAILED` with `validation_errors`)
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * A provider with the same name already exists (`MODEL_PROVIDER_ALREADY_EXISTS`)
+     */
+    409: ErrorResponse;
+    /**
+     * Provider creation failed (`MODEL_PROVIDER_CREATE_FAILED`)
+     */
+    500: ErrorResponse;
+};
+export type CreateModelProviderSettingsError = CreateModelProviderSettingsErrors[keyof CreateModelProviderSettingsErrors];
+export type CreateModelProviderSettingsResponses = {
+    /**
+     * Model provider created successfully
+     */
+    200: ModelProviderResponse;
+};
+export type CreateModelProviderSettingsResponse = CreateModelProviderSettingsResponses[keyof CreateModelProviderSettingsResponses];
+export type DeleteModelProviderSettingsData = {
+    body?: never;
+    path: {
+        /**
+         * Team that owns the model provider(s).
+         */
+        team_id: string;
+        /**
+         * Model provider ID
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/{team_id}/settings/model-providers/{id}';
+};
+export type DeleteModelProviderSettingsErrors = {
+    /**
+     * Cannot delete the last model provider (`MODEL_PROVIDER_LAST_DELETE_BLOCKED`)
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Model provider not found (`MODEL_PROVIDER_NOT_FOUND`)
+     */
+    404: ErrorResponse;
+    /**
+     * Provider deletion failed (`MODEL_PROVIDER_DELETE_FAILED`)
+     */
+    500: ErrorResponse;
+};
+export type DeleteModelProviderSettingsError = DeleteModelProviderSettingsErrors[keyof DeleteModelProviderSettingsErrors];
+export type DeleteModelProviderSettingsResponses = {
+    /**
+     * Model provider deleted successfully (no body)
+     */
+    204: void;
+};
+export type DeleteModelProviderSettingsResponse = DeleteModelProviderSettingsResponses[keyof DeleteModelProviderSettingsResponses];
+export type GetModelProviderSettingsData = {
+    body?: never;
+    path: {
+        /**
+         * Team that owns the model provider(s).
+         */
+        team_id: string;
+        /**
+         * Model provider ID
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/{team_id}/settings/model-providers/{id}';
+};
+export type GetModelProviderSettingsErrors = {
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Model provider not found (`MODEL_PROVIDER_NOT_FOUND`)
+     */
+    404: ErrorResponse;
+    /**
+     * Failed to retrieve model provider (`DATABASE_ERROR`)
+     */
+    500: ErrorResponse;
+};
+export type GetModelProviderSettingsError = GetModelProviderSettingsErrors[keyof GetModelProviderSettingsErrors];
+export type GetModelProviderSettingsResponses = {
+    /**
+     * Model provider retrieved successfully
+     */
+    200: ModelProviderResponse;
+};
+export type GetModelProviderSettingsResponse = GetModelProviderSettingsResponses[keyof GetModelProviderSettingsResponses];
+export type UpdateModelProviderSettingsData = {
+    body: UpdateModelProviderRequest;
+    path: {
+        /**
+         * Team that owns the model provider(s).
+         */
+        team_id: string;
+        /**
+         * Model provider ID
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/{team_id}/settings/model-providers/{id}';
+};
+export type UpdateModelProviderSettingsErrors = {
+    /**
+     * Malformed JSON body (`BAD_REQUEST`)
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Model provider not found (`MODEL_PROVIDER_NOT_FOUND`)
+     */
+    404: ErrorResponse;
+    /**
+     * Provider update failed (`MODEL_PROVIDER_UPDATE_FAILED`)
+     */
+    500: ErrorResponse;
+};
+export type UpdateModelProviderSettingsError = UpdateModelProviderSettingsErrors[keyof UpdateModelProviderSettingsErrors];
+export type UpdateModelProviderSettingsResponses = {
+    /**
+     * Model provider updated successfully
+     */
+    200: ModelProviderResponse;
+};
+export type UpdateModelProviderSettingsResponse = UpdateModelProviderSettingsResponses[keyof UpdateModelProviderSettingsResponses];
+export type ValidateModelProviderSettingsData = {
+    body: ValidateModelProviderRequest;
+    path: {
+        /**
+         * Team that owns the model provider(s).
+         */
+        team_id: string;
+    };
+    query?: never;
+    url: '/api/v1/{team_id}/settings/model-providers/validate';
+};
+export type ValidateModelProviderSettingsErrors = {
+    /**
+     * Malformed JSON body (`BAD_REQUEST`) or missing required fields (`MODEL_PROVIDER_VALIDATION_FAILED` with `validation_errors`)
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Validation failed due to an internal service error (`INTERNAL_ERROR`)
+     */
+    500: ErrorResponse;
+};
+export type ValidateModelProviderSettingsError = ValidateModelProviderSettingsErrors[keyof ValidateModelProviderSettingsErrors];
+export type ValidateModelProviderSettingsResponses = {
+    /**
+     * Validation completed (check `is_valid` for the outcome)
+     */
+    200: ValidateModelProviderResponse;
+};
+export type ValidateModelProviderSettingsResponse = ValidateModelProviderSettingsResponses[keyof ValidateModelProviderSettingsResponses];
 export type ListProjectsData = {
     body?: never;
     path: {