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

# 检索知识库

> 对知识库进行语义检索，返回相关文档片段。



## OpenAPI

````yaml /openapi/service-api-ja.json post /api/v1/knowledge/bases/{kb_uuid}/retrieve
openapi: 3.0.3
info:
  title: LangBot Service API
  description: >
    LangBot external service API documentation. These endpoints support API Key
    authentication for programmatic access to LangBot resources.


    **Authentication:**

    - User Token (via `Authorization: Bearer <token>`)

    - API Key (via `X-API-Key: <key>` or `Authorization: Bearer <key>`)


    All endpoints in this document support both authentication methods unless
    otherwise noted.
  version: 4.9.5
  contact:
    name: LangBot
    url: https://langbot.app
  license:
    name: AGPL-3.0
    url: https://github.com/langbot-app/LangBot/blob/master/LICENSE
servers:
  - url: http://localhost:5300
    description: Local development server
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: モデルプロバイダー
    description: >-
      Model provider management. Providers define API endpoints and keys; models
      reference providers via provider_uuid.
  - name: LLMモデル
    description: >-
      Large Language Model (LLM) management. Each model is associated with a
      provider.
  - name: 埋め込みモデル
    description: Embedding model management. Each model is associated with a provider.
  - name: ボット
    description: Bot instance management and messaging
  - name: パイプライン
    description: Pipeline configuration management
  - name: ナレッジベース
    description: Knowledge base management
  - name: ナレッジエンジン
    description: Knowledge engine (plugin-provided) queries
  - name: パーサー
    description: File parser (plugin-provided) queries
  - name: ファイル
    description: File upload operations
  - name: プラグイン
    description: Plugin installation, configuration, and management
  - name: システム
    description: System information (no auth required)
paths:
  /api/v1/knowledge/bases/{kb_uuid}/retrieve:
    post:
      tags:
        - Knowledge Bases
      summary: 检索知识库
      description: 对知识库进行语义检索，返回相关文档片段。
      parameters:
        - name: kb_uuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - query
              properties:
                query:
                  type: string
                  description: 检索查询文本
                retrieval_settings:
                  type: object
                  description: 检索参数（如 top_k 等）
                  properties:
                    top_k:
                      type: integer
      responses:
        '200':
          description: 成功
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 0
                  data:
                    type: object
                    properties:
                      results:
                        type: array
                        items:
                          type: object
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
    BearerAuth:
      type: http
      scheme: bearer

````