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

# 获取可用模型

> 按类型获取可用模型列表。主要用于查询知识库配置所需的 `text-embedding` 和 `rerank` 模型。



## OpenAPI

````yaml /zh/api-reference/openapi_knowledge.json get /workspaces/current/models/model-types/{model_type}
openapi: 3.0.1
info:
  title: 知识库 API
  description: >-
    用于管理知识库、文档、分段、元数据和标签的 API，包括创建、检索和配置操作。**注意：**单个知识库 API
    密钥有权操作同一账户下所有可见的知识库。请注意数据安全。
  version: 1.0.0
servers:
  - url: https://{api_base_url}
    description: Knowledge API 的基础 URL。自部署时，替换为你的 API 基础 URL。
    variables:
      api_base_url:
        default: api.dify.ai/v1
        description: API 基础 URL 的主机与路径，不含 `https://` 前缀。
security:
  - ApiKeyAuth: []
tags:
  - name: 知识库
    description: 用于管理知识库的操作，包括创建、配置和检索。
  - name: 文档
    description: 用于在知识库中创建、更新和管理文档的操作。
  - name: 分段
    description: 用于管理分段和子分段的操作。
  - name: 元数据
    description: 用于管理知识库元数据字段和文档元数据值的操作。
  - name: 标签
    description: 用于管理知识库标签和标签绑定的操作。
  - name: 模型
    description: 用于获取可用模型的操作。
  - name: 知识流水线
    description: 用于管理和运行知识流水线的操作，包括数据源插件和流水线执行。
paths:
  /workspaces/current/models/model-types/{model_type}:
    get:
      tags:
        - 模型
      summary: 获取可用模型
      description: 按类型获取可用模型列表。主要用于查询知识库配置所需的 `text-embedding` 和 `rerank` 模型。
      operationId: getAvailableModelsZh
      parameters:
        - name: model_type
          in: path
          required: true
          schema:
            type: string
            enum:
              - text-embedding
              - rerank
              - llm
              - tts
              - speech2text
              - moderation
          description: 要获取的模型类型。对于知识库配置，使用 `text-embedding` 获取嵌入模型，使用 `rerank` 获取重排序模型。
      responses:
        '200':
          description: 指定类型的可用模型。
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: 模型提供商及其可用模型的列表。
                    items:
                      type: object
                      properties:
                        provider:
                          type: string
                          description: 模型提供商标识符，例如 `openai`、`cohere`。
                        label:
                          type: object
                          description: 提供商的本地化显示名称。
                          properties:
                            en_US:
                              type: string
                              description: 英文显示名称。
                            zh_Hans:
                              type: string
                              description: 中文显示名称。
                        icon_small:
                          type: object
                          description: 提供商小图标的 URL。
                          properties:
                            en_US:
                              type: string
                              description: 小图标 URL。
                        icon_large:
                          type: object
                          description: 提供商大图标的 URL。
                          properties:
                            en_US:
                              type: string
                              description: 大图标 URL。
                        status:
                          type: string
                          description: 提供商状态。凭证已配置且有效时为 `active`。
                        models:
                          type: array
                          description: 该提供商的可用模型列表。
                          items:
                            type: object
                            properties:
                              model:
                                type: string
                                description: 模型标识符。创建或更新知识库时，将此值作为 `embedding_model` 参数使用。
                              label:
                                type: object
                                description: 模型的本地化显示名称。
                                properties:
                                  en_US:
                                    type: string
                                    description: 英文模型名称。
                                  zh_Hans:
                                    type: string
                                    description: 中文模型名称。
                              model_type:
                                type: string
                                description: 模型类型，与 `model_type` 路径参数匹配。
                              features:
                                type: array
                                nullable: true
                                description: 模型支持的功能，无功能时为 `null`。
                                items:
                                  type: string
                              fetch_from:
                                type: string
                                description: >-
                                  模型定义的来源。`predefined-model`
                                  表示内置模型，`customizable-model` 表示用户自配置的模型。
                              model_properties:
                                type: object
                                description: 模型特定的属性，例如 `context_size`。
                              status:
                                type: string
                                description: 模型可用状态。就绪时为 `active`。
              examples:
                success:
                  summary: 响应示例
                  value:
                    data:
                      - provider: openai
                        label:
                          en_US: OpenAI
                          zh_Hans: OpenAI
                        icon_small:
                          en_US: https://example.com/openai-small.svg
                        icon_large:
                          en_US: https://example.com/openai-large.svg
                        status: active
                        models:
                          - model: text-embedding-3-small
                            label:
                              en_US: text-embedding-3-small
                              zh_Hans: text-embedding-3-small
                            model_type: text-embedding
                            features: null
                            fetch_from: predefined-model
                            model_properties:
                              context_size: 8191
                            status: active
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API_KEY
      description: >-
        API Key 认证。对于所有 API 请求，请在 `Authorization` HTTP 头中包含您的 API Key，并加上
        `Bearer ` 前缀。示例：`Authorization: Bearer {API_KEY}`。**强烈建议将 API Key
        存储在服务端，不要在客户端共享或存储，以避免 API Key 泄漏导致严重后果。**

````