> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update knowledge-base search config

> Replace a knowledge base's retrieval re-rank / relevance-boost config. Every field has a no-op default, so a PUT of `{}` resets the KB to legacy raw-similarity ordering and an omitted knob never silently changes the others. Values are range-clamped server-side. Returns the normalised config. Requires the `knowledge:write` scope (admin / owner / developer).



## OpenAPI

````yaml /openapi.yaml put /api/v1/knowledge-bases/{id}/search-config
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
paths:
  /api/v1/knowledge-bases/{id}/search-config:
    put:
      tags:
        - Knowledge Bases
      summary: Update knowledge-base search config
      description: >-
        Replace a knowledge base's retrieval re-rank / relevance-boost config.
        Every field has a no-op default, so a PUT of `{}` resets the KB to
        legacy raw-similarity ordering and an omitted knob never silently
        changes the others. Values are range-clamped server-side. Returns the
        normalised config. Requires the `knowledge:write` scope (admin / owner /
        developer).
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
          description: Knowledge base ID (`kb_…`).
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                min_score:
                  type:
                    - number
                    - string
                  description: >-
                    Minimum raw vector similarity (0..1) a chunk must clear to
                    reach the agent. 0 = no floor (default).
                recency_boost:
                  type:
                    - number
                    - string
                  description: >-
                    Recency multiplier strength (0..5). 0 = off (default);
                    fresher docs get up to ×(1 + boost).
                recency_half_life_days:
                  type:
                    - number
                    - string
                  description: >-
                    Half-life in days of the recency decay (1..3650). Default
                    30.
                source_weights:
                  type: object
                  additionalProperties:
                    type:
                      - number
                      - string
                  description: >-
                    Map of source label → score multiplier (0..20, keys matched
                    case-insensitively). Default {}.
                include_categories:
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 120
                  maxItems: 200
                  description: Allow-list of categories; empty = allow all (default).
                exclude_categories:
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 120
                  maxItems: 200
                  description: Deny-list of categories. Default [].
      responses:
        '200':
          description: The normalised search-config after the update.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                properties:
                  data:
                    type: object
                    properties:
                      min_score:
                        type: number
                        description: >-
                          Minimum raw vector similarity (0..1) a chunk must
                          clear to reach the agent. 0 = no floor (default).
                      recency_boost:
                        type: number
                        description: >-
                          Recency multiplier strength (0..5). 0 = off (default);
                          fresher docs get up to ×(1 + boost).
                      recency_half_life_days:
                        type: number
                        description: >-
                          Half-life in days of the recency decay (1..3650).
                          Default 30.
                      source_weights:
                        type: object
                        additionalProperties:
                          type: number
                        description: >-
                          Map of source label → score multiplier (0..20, keys
                          matched case-insensitively). Default {}.
                      include_categories:
                        type: array
                        items:
                          type: string
                          minLength: 1
                          maxLength: 120
                        maxItems: 200
                        description: Allow-list of categories; empty = allow all (default).
                      exclude_categories:
                        type: array
                        items:
                          type: string
                          minLength: 1
                          maxLength: 120
                        maxItems: 200
                        description: Deny-list of categories. Default [].
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````