Copy

请求语法

POST /zhiwen-chat/extraction HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
capabilityType	string	是	能力类型招投标抽取：BID_EXTRACTION 简历抽取：RESUME_EXTRACTION 实体抽取：ENTITY_EXTRACTION	ENTITY_EXTRACTION
userPrompt	string	是	提示词	你是一个专门用于命名实体识别（Named Entity Recognition, NER）的AI助手。你的任务是从给定的文本中，精准地抽取出文档里面所有出现的人名、地名和组织机构名，并按照指定的字典格式进行组织。
fileIdList	array	是	文档ID列表	[ "file_zhiwen_XXX" ]
stream	boolean	是	是否流式返回	true

返回参数

名称	类型	描述
output	object
-choices	array
-finishReason	string	结束原因
-message	object	消息体
-role	string	角色
-content	string	消息内容
requestId	string	请求ID
usage	object	token使用信息
-inputTokens	int	输入token数量
-outputTokens	int	输出token数量
-totalTokens	int	总token数量

示例

调用示例

import os
import requests

'''
API名称：信息抽取
API路径：https://dashscope.aliyuncs.com/api/v2/apps/zhiwen-chat/extraction
环境要求：Python >= 3.7
'''

url = "https://dashscope.aliyuncs.com/api/v2/apps/zhiwen-chat/extraction"
request_headers = {
    "Authorization": os.environ.get("DASHSCOPE_API_KEY"),  # 如果您没有配置环境变量，请在此处替换您的API-KEY
    "Content-Type": "application/json"
}
# 信息抽取
# 招投标抽取：BID_EXTRACTION 简历抽取：RESUME_EXTRACTION 实体抽取：ENTITY_EXTRACTION
request_body = {
    "capabilityType": "ENTITY_EXTRACTION",
    "userPrompt": "你是一个专门用于命名实体识别（Named Entity Recognition, NER）的AI助手。你的任务是从给定的文本中，精准地抽取出文档里面所有出现的人名、地名和组织机构名，并按照指定的字典格式进行组织。",
    "stream": True,
    "fileIdList": [
        "file_zhiwen_XXX"  # 替换为你的文档ID
    ]
}

with requests.post(url, json=request_body, headers=request_headers) as response:
    if request_body["stream"]:
        for line in response.iter_lines():
            if line:
                line = line.decode('utf-8')
                if line.startswith('data:'):
                    print("Received:", line[5:].strip())
    else:
        print("Received:", response.json())

正常返回示例

JSON格式

{
  "output": {
    "choices": [{
      "finishReason": "stop",
      "message": {
        "role": "assistant",
        "content": "好的，我将从给定的文本中抽取出所有的人名、地名和组织机构名，并按照指定的字典格式进行组织：文档信息抽取结果。"
      }
    }]
  },
  "requestId": "60a9c0f4-9414-9c94-81f3-f487f7769c9a",
  "usage": {
    "inputTokens": 100,
    "outputTokens": 100,
    "totalTokens": 200
  }
}

错误码

请参见错误码-通义数据挖掘。

​请求语法

​请求参数

​返回参数

​示例

​调用示例

​正常返回示例

​错误码

请求语法

请求参数

返回参数

示例

调用示例

正常返回示例

错误码