汇云_api_技术文档
首页控制台定价日志下载关于
首页控制台定价日志下载关于
  1. Responses格式
  • 模型接口
    • 列出模型
      • 原生OpenAI格式
      • 原生Gemini格式
    • 聊天(Chat)
      • OpenAI
        • ChatCompletions格式
          • 基础文本对话
          • 流式响应
          • 图片理解
          • 函数调用
          • Logprobs 请求
          • 内容补全接口
          • 联网搜索
          • PDF文件分析
          • Codex
          • response_format
          • N测试
          • gpt-4-all(分析图片)
          • xAI联网搜索
          • 令牌用量查询(Token Usage)
        • Responses格式
          • 基础文本响应
            POST
          • 图像分析响应
            POST
          • 网络搜索工具
            POST
          • 文件搜索工具
            POST
          • Computer use
            POST
          • 流式响应
            POST
          • deep-research / 深度研究
            POST
          • 函数调用
            POST
          • 推理能力
            POST
          • 推理总结
            POST
      • Anthropic Claude
        • 原生Claude格式(推荐)
          • 文本生成
          • 图片理解
          • 文本生成 / 强制返回思考
          • 函数调用
          • 多轮函数调用
          • Web search / 联网搜索
        • OpenAI兼容格式
          • 文本生成
          • 图片理解
          • 文本生成 / 强制返回思考
          • 函数调用
          • 多轮函数调用
          • Web search / 联网搜索
      • Google Gemini
        • 原生Gemini格式
          • Gemini文本聊天
          • Gemini媒体识别
        • OpenAI兼容格式
          • 文本生成
          • 文本生成 / 强制返回思考
          • 文本生成 / 自定义思考预算
          • 图片理解
          • 函数调用
          • 全能多模态版本
          • 联网搜索
          • 文本转语音 / TTS
          • 音频理解
          • 视频理解
    • Midjourney
      • 1.文生图(Imagine)接口
      • 2.按钮点击(Action)接口
      • 3.图片融合(Blend)接口
      • 4.窗口执行(Modal)接口
      • 5.图生文(Describe)接口
      • 6.缩短提示词(Shorten)接口
      • 7.换脸(FaceSwap)接口
      • 8.上传(upload)接口
      • 9.查询接口
      • 10.批量查询接口
      • 11.获取种子(Seed)接口
      • 13.编辑图片(Edit)接口
      • 14.生成视频(Video)接口
      • 文生图 / OpenAI兼容接口
    • 图像(Images)
      • OpenAI格式
        • 图片生成 / gpt-image-1.5
        • 图片生成 / dall-e-3
        • 图片编辑 / edits接口
        • 图片编辑 / 网页版
        • 图片变体生成
        • gpt-4-all(生成图片)
        • xAI
      • Google Gemini
        • OpenAI聊天格式
          • 图片生成(Nano-banana2)
          • 图片生成(Nano-banana2-4K)
          • 图片生成 / Imagen 4
          • 图片编辑(Nano-banana)
          • 图片生成
          • 图片编辑
        • Gemini原生格式
          • 图像生成
      • 豆包(Doubao)
        • 文生图(纯文本输入单图输出)
        • 图文生图(单图输入单图输出)
        • 多图融合(多图输入单图输出)
        • 组图输出(多图输出)
      • 阿里通义千问
        • 文生图-Z-Image
        • 文生图
        • 文生图V2版
        • 文生图V1
        • 图像生成与编辑2.6
        • 通用图像编辑2.5
      • xAI / OpenAI兼容接口
      • flux / OpenAI兼容接口
      • flux-kontext-pro / OpenAI兼容接口
      • stable-diffusion / OpenAI兼容接口
      • ideogram / OpenAI兼容接口
      • recraftv3 / OpenAI兼容接口
      • flux携带参考图 / OpenAI兼容接口
    • 视频(Videos)
      • Sora-2
        • Sora-2(创建视频)
        • Sora-2(创建视频-带 Character)
        • Sora-2(编辑视频remix)
        • Sora2官方接口(Chat格式)
        • 查询视频1(异步任务)
        • 查询视频2(异步任务)
        • 获取视频内容
      • 豆包(Doubao)
        • 豆包-文生视频
        • 查询视频
      • 即梦(Jimeng)
        • 即梦AI-文生视频S2.0Pro
        • 查询视频
      • 可灵AI(Kling)
        • 可灵AI-文生视频
        • 可灵AI-文生视频kling-video-o1
        • 可灵AI-带参考视频kling-video-o1
        • 可灵AI-图生视频
        • 查询视频
      • 阿里通义千问
        • 通义万相2.6(创建视频)
        • 通义万相2.5(创建视频)
        • 查询视频(异步任务)
      • Veo 3
        • Veo 3
        • Veo 3(官方格式)
        • 查询视频
        • 查询视频(官方格式)
      • Vidu
        • Vidu-文生视频
        • 查询视频
      • OpenAI兼容接口
        • veo3
        • luma
        • runway
        • 智谱清言GLM
        • 可灵
    • 音频(Audio)
      • 原生OpenAI格式
        • 文本转语音 / TTS
        • 语音转文本 / whisper-1
        • 语音转文本 / gpt-4o-transcribe
        • 音频翻译
        • Audio接口 / 输出
        • Audio接口 / 输入
        • MiniMax语音合成TTS
        • 豆包语音2.0
      • 原生Gemini格式
    • 音乐(Music)
      • Suno
        • 生成歌曲
        • 生成歌词
        • 上传音乐
        • 歌曲拼接
        • 单个查询任务
        • 批量查询任务
      • Udio
        • Udio(Chat格式)
    • 嵌入(Embeddings)
      • 创建文本嵌入(OpenAI)
      • 批量创建嵌入(OpenAI)
      • 创建文本嵌入(Gemini)
    • 重排序 (Rerank)
      • Jina AI 重排序格式
      • Cohere 重排序格式
      • Xinference 重排序格式
    • 审查(Moderations)
      • 创建内容审核
    • GPTs 相关
      • GPTs对话
      • 搜索相关 GPTs
      • 查询 GPTs 详情
      • 批量查询 GPTs 详情
  1. Responses格式

文件搜索工具

POST
/responses

请求参数

Header 参数

Body 参数application/json

示例
{
  "model": "gpt-4.1",
  "tools": [
    {
      "type": "file_search",
      "vector_store_ids": [
        "vs_1234567890"
      ],
      "max_num_results": 20
    }
  ],
  "input": "古代棕龙有哪些特性和属性?"
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/responses' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "model": "gpt-4.1",
  "tools": [
    {
      "type": "file_search",
      "vector_store_ids": [
        "vs_1234567890"
      ],
      "max_num_results": 20
    }
  ],
  "input": "古代棕龙有哪些特性和属性?"
}'

返回响应

🟢200成功
application/json
Body

示例
{
  "id": "resp_67ccf4c55fc48190b71bd0463ad3306d09504fb6872380d7",
  "object": "response",
  "created_at": 1741485253,
  "status": "completed",
  "error": null,
  "incomplete_details": null,
  "instructions": null,
  "max_output_tokens": null,
  "model": "gpt-4.1",
  "output": [
    {
      "type": "file_search_call",
      "id": "fs_67ccf4c63cd08190887ef6464ba5681609504fb6872380d7",
      "status": "completed",
      "queries": [
        "古代棕龙的特性和属性"
      ],
      "results": null
    },
    {
      "type": "message",
      "id": "msg_67ccf4c93e5c81909d595b369351a9d309504fb6872380d7",
      "status": "completed",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "根据资料,古代棕龙具有以下特性和属性:\n\n1. 物理特征:古代棕龙体型庞大,体长可达25-30米,翼展约35米。它们的鳞片呈深棕色至铜色,随着年龄增长会变得更加暗沉。头部有特征性的双角和脊刺,下颚强壮,适合撕裂猎物。\n\n2. 能力:它们能喷吐强力的酸液,对目标造成严重腐蚀伤害。古代棕龙还拥有出色的掘地能力,常在沙漠或山地挖掘复杂的巢穴系统。\n\n3. 智力:被认为是龙族中最为狡猾和有耐心的品种,智力极高,精通多种语言,并具有复杂的战术思维。\n\n4. 栖息地:主要栖息在干旱的山地和沙漠地区,喜欢炎热干燥的环境。\n\n5. 宝藏:古代棕龙以其庞大的宝藏闻名,特别喜爱收集铜币、红宝石和火焰魔法物品。\n\n6. 寿命:是所有龙种中寿命最长的之一,可活2000-2500年,随着年龄增长其力量和魔法能力也会增强。\n\n7. 性格:极度领地意识强,性格暴躁易怒,对侵入者毫不留情,但也以其罕见的耐心著称,能为复仇等待几个世纪。",
          "annotations": [
            {
              "type": "file_citation",
              "index": 80,
              "file_id": "file-4wDz5b167pAf72nx1h9eiN",
              "filename": "dragons.pdf"
            },
            {
              "type": "file_citation",
              "index": 233,
              "file_id": "file-4wDz5b167pAf72nx1h9eiN",
              "filename": "dragons.pdf"
            },
            {
              "type": "file_citation",
              "index": 345,
              "file_id": "file-4wDz5b167pAf72nx1h9eiN",
              "filename": "dragons.pdf"
            },
            {
              "type": "file_citation",
              "index": 420,
              "file_id": "file-4wDz5b167pAf72nx1h9eiN",
              "filename": "dragons.pdf"
            },
            {
              "type": "file_citation",
              "index": 520,
              "file_id": "file-4wDz5b167pAf72nx1h9eiN",
              "filename": "dragons.pdf"
            },
            {
              "type": "file_citation",
              "index": 580,
              "file_id": "file-4wDz5b167pAf72nx1h9eiN",
              "filename": "dragons.pdf"
            },
            {
              "type": "file_citation",
              "index": 655,
              "file_id": "file-4wDz5b167pAf72nx1h9eiN",
              "filename": "dragons.pdf"
            },
            {
              "type": "file_citation",
              "index": 781,
              "file_id": "file-4wDz5b167pAf72nx1h9eiN",
              "filename": "dragons.pdf"
            }
          ]
        }
      ]
    }
  ],
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "reasoning": {
    "effort": null,
    "summary": null
  },
  "store": true,
  "temperature": 1,
  "text": {
    "format": {
      "type": "text"
    }
  },
  "tool_choice": "auto",
  "tools": [
    {
      "type": "file_search",
      "filters": null,
      "max_num_results": 20,
      "ranking_options": {
        "ranker": "auto",
        "score_threshold": 0
      },
      "vector_store_ids": [
        "vs_1234567890"
      ]
    }
  ],
  "top_p": 1,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 18307,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 348,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 18655
  },
  "user": null,
  "metadata": {}
}
修改于 2026-02-08 11:51:31
上一页
网络搜索工具
下一页
Computer use
Built with