{"id":34765798,"url":"https://github.com/liyupi/yucongming-java-sdk","last_synced_at":"2025-12-25T07:12:02.959Z","repository":{"id":166023109,"uuid":"638165231","full_name":"liyupi/yucongming-java-sdk","owner":"liyupi","description":"鱼聪明 AI 的 Java SDK，几行代码使用 AI 助手能力！","archived":false,"fork":false,"pushed_at":"2024-07-06T07:51:15.000Z","size":631,"stargazers_count":182,"open_issues_count":13,"forks_count":22,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-07-06T08:55:02.970Z","etag":null,"topics":["ai","java","programmer","sdk"],"latest_commit_sha":null,"homepage":"https://www.yucongming.com","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/liyupi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-09T08:11:29.000Z","updated_at":"2024-07-06T07:51:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"d6ab2a76-45cb-4b4f-b9d2-c28967bb69ac","html_url":"https://github.com/liyupi/yucongming-java-sdk","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/liyupi/yucongming-java-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liyupi%2Fyucongming-java-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liyupi%2Fyucongming-java-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liyupi%2Fyucongming-java-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liyupi%2Fyucongming-java-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/liyupi","download_url":"https://codeload.github.com/liyupi/yucongming-java-sdk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liyupi%2Fyucongming-java-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28022941,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-25T02:00:05.988Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","java","programmer","sdk"],"created_at":"2025-12-25T07:12:02.025Z","updated_at":"2025-12-25T07:12:02.951Z","avatar_url":"https://github.com/liyupi.png","language":"Java","readme":"# 鱼聪明 Java SDK\n\n基于 Spring Boot Starter 开发，只需一行代码，使用强大的 AI 能力！\n\n鱼聪明 AI：https://yucongming.com\n\n官方公众号：鱼聪明AI\n\n![](./doc/imgs/wechat_qrcode.png)\n\n## 快速开始\n\n#### 0、引入 sdk\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.yucongming\u003c/groupId\u003e\n    \u003cartifactId\u003eyucongming-java-sdk\u003c/artifactId\u003e\n    \u003cversion\u003e0.0.4\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n#### 1、在 [鱼聪明 AI 开放平台](https://www.yucongming.com/dev) 获取开发者密钥对\n\n![](doc/imgs/dev_tutorial.png)\n\n#### 2、初始化 YuCongMingClient 对象\n\n方法 1：自主 new 对象\n\n```java\nString accessKey = \"你的 accessKey\";\nString secretKey = \"你的 secretKey\";\nYuCongMingClient client = new YuCongMingClient(accessKey, secretKey);\n```\n\n方法 2：通过配置注入对象\n\n修改配置：\n\n```yaml\nyuapi:\n  client:\n    access-key: 你的 access-key\n    secret-key: 你的 secret-key\n```\n\n使用客户端对象：\n\n```java\n@Resource\nprivate YuCongMingClient client;\n```\n\n#### 3、构造请求参数\n\n```java\nDevChatRequest devChatRequest = new DevChatRequest();\ndevChatRequest.setModelId(1651468516836098050L);\ndevChatRequest.setMessage(\"鱼皮\");\n```\n\n#### 4、获取响应结果\n\n```java\nBaseResponse\u003cDevChatResponse\u003e response = client.doChat(devChatRequest);\nSystem.out.println(response.getData());\n```\n\n\n\n## API 文档\n\n### AI 对话\n\n方法名：doChat\n\n请求参数：\n\n- modelId：使用的会话模型（助手）id\n- message：要发送的消息，不超过 1024 字\n\n响应结果：\n\n- code：响应状态码\n- data： \n  - content：对话结果内容\n- message：响应信息\n\n\n示例代码：\n\n```java\n// 构造请求\nDevChatRequest devChatRequest = new DevChatRequest();\ndevChatRequest.setModelId(1651468516836098050L);\ndevChatRequest.setMessage(\"鱼皮\");\n\n// 获取响应\nBaseResponse\u003cDevChatResponse\u003e response = client.doChat(devChatRequest);\nSystem.out.println(response.getData());\n```\n\n模型（助手）：\n\n设置自己的模型（助手）可以使AI的回答更加个性化，如 “1651468516836098050” 这个模型（助手）id会更加倾向于回答歌曲和歌单，你可以通过平台首页的 “创建助手” 和 “我的助手” 功能来创建、查看和修改模型（助手），查看模型（助手）即可看到模型（助手）id。\n\n![](doc/imgs/model_id.png)\n\n\n\n## Http 接入\n\n1. 获取 **AccessKey** 和 **SecretKey**\n![](doc/imgs/key_secret.png)\n2. 请求信息\n\n   URL ：[https://api.yucongming.com/api/dev/chat]()\n   请求方法：POST\n   请求头：\n   \n   | 请求头名称 | 值 | 示例值 |\n   | --- | --- | --- |\n   | accessKey | accessKey | 9vtw6bx8eh65uu5q62a8nhqdjf2asapp |\n   | nonce | 四位随机整数 | 1234 |\n   | body | 请求参数的 md5 加密值，请求参数详情见下方 | cf2623df4bf9d0485b0ab9392cbcef11 |\n   | timestamp | 当前时间戳（单位秒） | 1687775370 |\n   | sign | 签名，详情见下方 | d10ce4n429778060c0af1d5f3f388d39953e74d996022e6182094fa3a84adbe9 |\n\n3. 请求参数\n\n   | modelId | 模型（助手）id |\n   | --- | --- |\n   | message | 消息（问题） |\n\n4. 签名认证 \n\n   签名的值是 **请求参数的 md5 加密值 + . + SecretKey 的值进行 SHA256 加密**\n\n5. 示例代码（ Python ）\n   ```python\n   import hashlib\n   import time\n   import random\n   import requests\n   import json\n   \n   \n   class DevChatRequest:\n       def __init__(self, model_id, message: str):\n           self.model_id = model_id\n           self.message = message\n   \n       def to_dict(self):\n           return {\n               \"modelId\" : self.model_id,\n               \"message\" : self.message\n           }\n   \n   class YuCongMingClient:\n       HOST = 'https://api.yucongming.com/api/dev'\n   \n       def __init__(self, access_key, secret_key):\n           self.access_key = access_key\n           self.secret_key = secret_key\n   \n       def do_chat(self, dev_chat_request: DevChatRequest):\n           url = self.HOST + '/chat'\n           json_data = json.dumps(dev_chat_request.to_dict())\n           headers = self.get_headers(json_data)\n           response = requests.post(url, headers=headers, data=json_data)\n           return response.json()\n   \n       def get_headers(self, json_data):\n           encode_body = self.encode_body(json_data)\n           headers = {\n               'Content-Type': 'application/json',\n               'accessKey': self.access_key,\n               'nonce': self.generate_nonce(),\n               'body': encode_body,\n               'timestamp': str(int(time.time())),\n               'sign': self.generate_sign(encode_body)\n           }\n           return headers\n   \n       def generate_nonce(self):\n           return str(random.randint(1000, 9999))\n   \n       def encode_body(self, json_data):\n           md5 = hashlib.md5()\n           md5.update(json_data.encode('utf-8'))\n           return md5.hexdigest()\n   \n       def generate_sign(self, json_data):\n           sha256 = hashlib.sha256()\n           sign_str = json_data + \".\" +self.secret_key\n           sha256.update(sign_str.encode('utf-8'))\n           return sha256.hexdigest()\n   \n   \n   if __name__ == '__main__':\n       accessKey = \"你的 accessKey\";\n       secretKey = \"你的 secretKey\";\n       ycmc = YuCongMingClient(accessKey, secretKey)\n       print(ycmc.do_chat(DevChatRequest(\"1651468516836098050\", \"鱼皮\")))\n   \n   ```\n\n6. 返回状态码\n   \n   | Code | Message | 解释 |\n   | --- | --- | --- |\n   | 0 | ok |\n   |\n   | 40000 | 请求参数错误 | 检查参数名是否匹配、长度是否符合要求等 |\n   | 40100 | 未登录 |\n   |\n   | 40101 | 无权限 | 可能是由nonce、timestamp、sign 异常引起 |\n   | 40400 | 请求数据不存在 | ak、模型等不存在 |\n   | 40300 | 禁止访问 | 账号状态异常等 |\n   | 50000 | 系统内部异常 | 网络抖动，数据库操作失败等 |\n   | 50001 | 操作失败 | 限流等 |\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliyupi%2Fyucongming-java-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fliyupi%2Fyucongming-java-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliyupi%2Fyucongming-java-sdk/lists"}