API接口使用指南

在正式使用接口之前，您需要先在官网完成用户注册，获取您的API key。然后您可以选择适合您的模型进行调用。模型列表与说明您可以参见日月新著介绍。

用户认证

官网注册登录之后，您可以在首页--管理--用户--账户--安全菜单下找到您的API Key。如下图所示:

在您的模型调用中仅需要将api key设置在您的header 'X-Token'中即可。

示例代码如下:

 # add token in header
resp = client.post(f"/llm/models/{model}/complete", json={"text": text}, headers={"X-Token": api_key})

调用说明

日月新著接口遵循RESTful的接口设计风格，并且尽量秉持简洁、标准与包容的设计理念。尽量让您在同一个接口无感切换不同的模型调用。最大化便利您的使用。

您可以选用任何一款您趁手的HTTP调用框架，来访问和使用接口。

接口调用时使用的域名endpoint为： https://api.riyuexinzhu.com

调用的参数和返回都是用JSON的格式。由于资源与访问控制等问题，目前接口调用的并发度均为1，望您理解。

接口调用会涉及费用问题，所以请您确认账户余额超过1分钱。如果余额不足，您可以移步用户管理端进行充值。位置为首页--管理--用户--账户--概览菜单下，目前仅支持微信扫码支付，望您知悉。如下图所示：

语言模型

语言模型的使用为您封装为如下三个标准化的接口。已为您屏蔽不同模型的差异，提供一致化使用。助您快人一步接入顶级AI模型。

L1. 文字生成与补全接口

[POST] /llm/models/{model_name}/complete

接口功能: 调用大语言模型进行文字生成和补全, 使用POST方法调用

该接口支持的模型(model_name取值)与说明

url与header参数字段说明:

body入参字段说明:

返回参数字段说明:

请求示例:

https://api.riyuexinzhu.com/llm/models/gpt-3.5-turbo/complete

body入参:

 {
	'text': '为高级java开发工程师岗位编写岗位描述，要求5年以上工作经验，熟悉Spring， Webflux架构',
	'options': {
		'n': 2,
		'temperature': 0.3
	}
}

返回结果示例:

{
	'resp_code': 200,
	'resp_message': 'SUCCESS',
	'data': [
    '岗位描述：高级Java开发工程师\n\n我们正在寻找一位经验丰富、技术娴熟的高级Java开发工程师，加入我们的团队。作为高级Java开发工程师，您将负责设计、开发和维护高质量的Java应用程序，以满足我们的客户需求。您将与跨职能团队合作，参与项目的整个开发生命周期。\n\n职责和要求：\n\n1. 至少5年以上Java开发经验，具备扎实的编程基础和良好的面向对象设计思维；\n2. 精通Spring框架，熟悉Spring Boot和Spring Cloud等相关技术；\n3. 熟悉Webflux架构，有相关项目实施经验；\n4. 熟悉常用的数据库技术，如MySQL、Oracle等，并能够进行性能优化和调优；\n5. 具备良好的团队合作精神，能够与产品经理、设计师和测试人员紧密合作，理解业务需求并提供解决方案；\n6. 具备良好的沟通能力和解决问题的能力，能够快速学习和适应新的技术和工具；\n7. 具备良好的代码质量意识和工程化思维，能够编写可维护、可扩展、高效的代码；\n8. 具备良好的自我驱动力和问题解决能力，能够独立完成任务并按时交付。\n\n加分项：\n\n1. 有大规模分布式系统的设计和开发经验；\n2. 熟悉微服务架构和相关技术，如Docker、Kubernetes等；\n3. 熟悉前端开发技术，如HTML、CSS、JavaScript等；\n4. 有团队管理经验，能够指导和培养其他开发人员。\n\n我们提供具有竞争力的薪资待遇和良好的发展空间，欢迎有志之士加入我们的团队。如果您满足以上要求并对此岗位感兴趣，请将您的简历发送至我们的招聘邮箱。我们将尽快与您联系安排面试。', 
    '高级Java开发工程师岗位描述：\n\n职位概述：\n我们正在寻找一位有5年以上工作经验的高级Java开发工程师，熟悉Spring和Webflux架构。作为高级开发工程师，您将负责设计、开发和维护我们的Java应用程序，确保其高效、可靠和安全。\n\n职责和要求：\n- 负责设计、开发和维护Java应用程序，确保其高效、可靠和安全。\n- 熟悉Spring和Webflux架构，能够根据需求进行系统设计和架构设计。\n- 能够编写高质量的代码，进行单元测试和集成测试，确保代码的可靠性和稳定性。\n- 与产品经理和其他团队成员合作，理解业务需求并提供解决方案。\n- 进行代码审查，确保团队成员的代码质量和规范性。\n- 解决应用程序中的技术问题和故障，并提供相应的解决方案。\n- 持续学习和研究新的技术和工具，保持对行业趋势的了解。\n\n技能和经验要求：\n- 本科或以上学历，计算机科学或相关专业。\n- 5年以上Java开发经验，熟悉Java EE开发。\n- 熟悉Spring和Webflux框架，有相关项目经验。\n- 熟悉数据库设计和SQL语言。\n- 熟悉常用的前端技术，如HTML、CSS和JavaScript。\n- 熟悉敏捷开发方法和工具，如Scrum和JIRA。\n- 具备良好的沟通能力和团队合作精神。\n- 具备解决问题和分析能力，能够独立工作和承担压力。\n\n加分项：\n- 有云计算和微服务架构的经验。\n- 熟悉NoSQL数据库，如MongoDB和Redis。\n- 有大规模分布式系统开发经验。\n- 有DevOps经验，熟悉Docker和Kubernetes。\n- 有敏捷开发团队的管理经验。\n\n我们提供具有竞争力的薪资和福利待遇，以及良好的职业发展机会。如果您满足以上要求，并对我们的团队感兴趣，请将您的简历发送至我们的招聘邮箱。我们期待与您合作，共同推动我们的业务发展。'
    ],
	'pricing': {
		'account_balance': '99.9796',
		'tokens': 1400,
		'price': '0.0205'
	}
}

L2. 用户交互与聊天

[POST] /llm/models/{model_name}/chat

接口功能: 调用大语言模型进行用户交互与聊天, 使用POST方法调用

该接口支持的模型(model_name取值)与说明

url与header参数字段说明:

body入参字段说明:

返回参数字段说明:

请求示例:

https://api.riyuexinzhu.com/llm/models/chatglm_pro/chat

body入参:

 {
	'message': '优化一下简历中工作内容的描述, 目标岗位为架构师, 直接修改无需提意见',
	'system_message': '你是一位求职者，正在修改自己的简历, 目标岗位为架构师',
	'pre_messages': [{
		'role': 'user',
		'message': '应用技术:spring、mybatis、redis、orcale;\n研发工具:eclipse\n参与项目:客户管理系统\n项目介绍:该项目为中央结算中心银登新一代客户管理系统。维护客户、账户、资金账户以及用户的信息。分为客户端和中心端。所有的操作都由中心端人员审核后才能修改。\n工作内容:\n对接集团接口:客户开户、客户修改、账户开户、账户修改、对接授权系统;\n负责数据设计、接口设计,文档编写,系统研发等工作;\n负责统一审核模块开发。\n上线后负责需求跟进,BUG修复,接口优化等工作. '
	}]
}

返回结果示例:

{
	'resp_code': 200,
	'resp_message': 'SUCCESS',
	'data': ['" 工作内容:\\n\\n- 负责对接集团接口，包括客户开户、客户修改、账户开户、账户修改和对接授权系统等;  \\n- 负责数据设计和接口设计，编写文档，并进行系统研发;  \\n- 负责统一审核模块的开发;  \\n- 在上线后，负责需求跟进，BUG 修复和接口优化等工作。"'],
	'pricing': {
		'account_balance': '99.9974',
		'tokens': 244,
		'price': '0.0027'
	}
}

L3. 文字生成向量embeddings

[POST] /llm/models/{model_name}/embeddings

接口功能: 调用大语言模型生成embeddings向量, 使用POST方法调用

该接口支持的模型(model_name取值)与说明

url与header参数字段说明:

body入参字段说明:

返回参数字段说明:

请求示例:

https://api.riyuexinzhu.com/llm/models/chatglm_text_embedding/embeddings

body入参:

 {
	'texts': '优化一下简历中工作内容的描述, 目标岗位为架构师, 直接修改无需提意见',
}

返回结果示例:

{
	'resp_code': 200,
	'resp_message': 'SUCCESS',
	'data': [
    [0.13804447650909424, 0.2828400731086731, 0.08230237662792206, -0.13016682863235474, ......]
    ],
	'pricing': {
		'account_balance': '100.0000',
		'tokens': 25,
		'price': '0.0001'
	}
}

图像模型

图像模型接口为您提供的标准化接口如下。已为您屏蔽不同模型的差异，提供一致化使用。助您快人一步接入顶级AI模型。

I1. 根据用户输入生成图片

[POST] /images/models/{model_name}/generate

接口功能: 根据用户输入生成图片，不同模型差异较大，请您注意。 同时为了更好的兼容中文和为用户提供更好的生成效果，我们也提供对了您的输入提示词进行优化的功能。
我们为您生成的图片都提供了7天的暂存功能，您可以在用户管理端进行查看和下载

该接口支持的模型(model_name取值)与说明

url与header参数字段说明:

body入参字段说明:

返回参数字段说明:

请求示例:

https://api.riyuexinzhu.com/images/models/stable-diffusion-xl/generate

body入参:

 {
	'text': '一对老夫妻携手迎面走在乡间小路上，画面温馨，皮克斯动画风格, 暖色调',
	'options': {
		'return_mode': 'url'
	},
}

返回结果示例:

{
	'resp_code': 200,
	'resp_message': 'SUCCESS',
	'data': {
		'images': ['http://ai-agency-dev.oss-cn-beijing.aliyuncs.com/users%2F650e9aa4438be21ad250ae36%2Fimages%2Fstable-diffusion-xl-1024-v1-0%2F16954559420f96469c59e711ee816d969f0654c3c0.png?OSSAccessKeyId=LTAI4FvpNJmUZeSvCPTPRBAK&Expires=1696060743&Signature=PTFg6qACZUaFiWMXJ2Vgwk66fXo%3D'],
	},
	'pricing': {
		'account_balance': '99.8510',
		'price': '0.1491'
	},
	'tuned_text': "A heartwarming scene unfolds as an elderly couple strolls hand in hand along a quaint countryside path. The setting exudes a sense of tranquility and nostalgia, reminiscent of the beloved Pixar animation style. The colors in the scene are infused with warmth, casting a soft and inviting ambiance. The couple's love and companionship emanate from their intertwined hands, creating a tender and touching moment. The surrounding landscape is filled with charming details, such as blooming wildflowers, rolling green hills, and rustic wooden fences, further enhancing the idyllic atmosphere. The lighting gently bathes the scene, casting subtle shadows and highlighting the couple's joyful expressions. This prompt captures the essence of a cherished love story, inviting the AI image tools to bring this heartwarming scene to life, evoking feelings of love, happiness, and nostalgia.",
}

模型生成图片效果对比图，仅供参考。生成提示词: "一对老夫妻携手迎面走在乡间小路上，画面温馨，皮克斯动画风格, 暖色调"

I2. 对图片进行放大

[POST] /images/models/{model_name}/upscale

接口功能: 对用户的图片进行放大，Stable AI模型需要用户以base64格式传入原图，Midjourney则是对之前生成任务的候选图片序号进行放大。
我们为您生成的图片都提供了7天的暂存功能，您可以在用户管理端进行查看和下载

该接口支持的模型(model_name取值)与说明

url与header参数字段说明:

body入参字段说明:

返回参数字段说明:

请求示例:

https://api.riyuexinzhu.com/images/models/midjourney/upscale

body入参:

 {
	'return_mode': 'url',
	'midjourney': {
            'task_id': '6748039470737260',
            'index': 2
	},
}

返回结果示例:

{
	'resp_code': 200,
	'resp_message': 'SUCCESS',
	'data': {
		'images': ['http://ai-agency-dev.oss-cn-beijing.aliyuncs.com/users%2F650ea6da633db09d74dacd07%2Fimages%2Fmidjourney%2F16954590835fbf6be259ee11eea75d969f0654c3c0.png?OSSAccessKeyId=LTAI4FvpNJmUZeSvCPTPRBAK&Expires=1696063883&Signature=NrwqDm4AeUoAkk0e45getgPOTV8%3D'],
		'midjourney_task_id': '9473386523780902',		
	},
	'pricing': {
		'account_balance': '99.4155',
		'price': '0.2923'
	},
}

I3. 对图片进行修改

[POST] /images/models/{model_name}/modify

接口功能: 按照用户提示/修改要求对原图进行修改。
我们为您生成的图片都提供了7天的暂存功能，您可以在用户管理端进行查看和下载

该接口支持的模型(model_name取值)与说明

url与header参数字段说明:

body入参字段说明:

返回参数字段说明:

请求示例:

https://api.riyuexinzhu.com/images/models/stable-diffusion-xl/modify

body入参:

 {
    'return_mode': 'url',
    'image_base64': 'xxxxxx(图片base64内容)',
    'text': '能看到海'
	'stable_ai': {
	    'image_strength': 0.5,
	    'n': 1
	},
}

返回结果示例:

{
	'resp_code': 200,
	'resp_message': 'SUCCESS',
	'data': {
		'images': ['http://ai-agency-dev.oss-cn-beijing.aliyuncs.com/users%2F650eaf122009c5114f54afaa%2Fimages%2Fstable-diffusion-xl-1024-v1-0%2F169546118544a68a3e59f311ee9b5d969f0654c3c0.png?OSSAccessKeyId=LTAI4FvpNJmUZeSvCPTPRBAK&Expires=1696065986&Signature=%2BPtVyWEyFvZewp%2Fxqd4ygFLGUjI%3D'],
		'stable_ai_tuned_text': ' A breathtaking coastal scene with a vibrant sunset casting golden hues across the horizon. The ocean stretches endlessly, its waves crashing against jagged rocks. The sandy beach is dotted with seashells and footprints, while seagulls glide gracefully in the warm breeze. The water sparkles, reflecting the colorful sky above. The scene is serene and calming, invoking a sense of tranquility and peace. The lighting is soft and warm, creating a gentle glow that envelops the entire landscape. The composition is balanced, with the vastness of the sea contrasting with the stability of the rocks and the gentle curves of the beach. The overall mood is one of awe and appreciation for the beauty of nature.',		
	},
	'pricing': {
		'account_balance': '99.8510',
		'price': '0.1491'
	},
}

I4. 对Midjourney的task状态进行查询

[GET] /images/models/midjourney/tasks/{task_id}/status/async

接口功能: 适用于Midjourney的异步模式(调用时传入call_back_url)，可以主动查询任务状态

该接口支持的模型(model_name取值)与说明

url与header参数字段说明:

返回参数字段说明:

请求示例:

https://api.riyuexinzhu.com/images/models/midjourney/tasks/5764280314497708/status/async

返回结果示例:

{
	"resp_code": 200,
	"resp_message": "SUCCESS",
	"data": {
		"images": ["http://ai-agency-dev.oss-cn-beijing.aliyuncs.com/users%2F650eb51dba7a3262411a5f39%2Fimages%2Fmidjourney%2F1695462746e70c1b9c59f611eeb6bc969f0654c3c0.png?OSSAccessKeyId=LTAI4FvpNJmUZeSvCPTPRBAK&Expires=1696067556&Signature=CvFoztNIHmAaecDFp956BUQsDo0%3D"],
		"status": "succeeded",
		"progress": "100%"
	},
	"pricing": {
		"account_balance": "99.4155",
		"price": "0.2924"
	}
}

知识模型

知识模型可以助您构建您的私人知识库，并可以利用多种语言模型针对存储的知识进行问答。助您快人一步构建营销与客服助手，更好的服务客户。
特别说明一点，知识的存储和利用大语言模型的查询可以分开使用不同厂商的模型。例如可以使用openai的embedding模型进行知识存储，而用百度或者ChatGLM模型回答客户问题。
已经存储的知识可以在用户管理端进行查阅。
目前知识模型仅对VIP用户开放使用，由于资源限制，目前一个用户仅能存储1000个知识，每个知识最多长度为1000.望您理解。

知识模型包含如下三种接口：

K1. 用户添加知识

[POST] /knowledge/models/{model_name}/

接口功能: 使用Embeddings模型为用户存储知识，注意不同embedding下生成的知识不可通用。
使用限制: 由于资源问题，仅VIP用户使用, 目前仅知识单条输入。每位用户最多添加1000条知识，每条知识最多1000字。也即每位用户最多支持100万字知识内容。

该接口支持的模型(model_name取值)与说明

url与header参数字段说明:

body入参字段说明:

返回参数字段说明:

请求示例:

https://api.riyuexinzhu.com/knowledge/models/text-embedding-ada-002

body入参:

 {
	'content': '问题如何注意标准不同.',
	'domain': 'test',
}

返回结果示例:

{
	'resp_code': 200,
	'resp_message': 'SUCCESS',
	'data': {
		'id': 443824990325047596
	}
}

K2. 用户使用知识

[POST] /knowledge/models/{model_name}/ask

接口功能: 基于该embedding model下用户已有知识进行问答，可以指定所使用领域知识。默认回答模型使用gpt3.5-turbo-16k

该接口支持的模型(model_name取值)与说明

url与header参数字段说明:

body入参字段说明:

返回参数字段说明:

请求示例:

https://api.riyuexinzhu.com/knowledge/models/text-embedding-ada-002/ask

body入参:

 {
	"ask": "请帮我写一篇产品介绍微博，突出一下产品卖点和优势，要求字数不超过100字",,
	'domain': '妙控鼠标',
        "system_message": "你是一位市场营销人员",
        "options": {
            "n": 2,
            "answer_model": "gpt-4"
        },
}

返回结果示例:

{
	'resp_code': 200,
	'resp_message': 'SUCCESS',
	'data': {
		'answers': [
                    'Magic Mouse 妙控鼠标是一款功能强大、设计独特的无线鼠标。它有许多卖点和优势。首先，Magic Mouse采用Multi-Touch技术，操作非常方便，可以通过手势操作来提高工作效率。其次，它的圆柱形设计非常独特，给人一种时尚感。还有，Magic Mouse还拥有强大的自定义功能，用户可以根据自己的喜好来进行定制。最后，它的续航时间长，可以使用一个月。当然，也有一些缺点，比如对于一些用户来说，可能需要一定的适应时间；对于某些操作系统，可能存在兼容性问题。总体来说，考虑到Magic Mouse的独特设计和强大功能，它的价格是可以接受的，性价比也非常高。使用Magic Mouse的体验非常优秀，滚动轮流畅准确，手势操作方便，自定义功能强大。无论是工作还是娱乐，Magic Mouse都能提供出色的使用体验。', 
                    'Magic Mouse 妙控鼠标是一款非常独特和功能强大的无线鼠标。它具有许多卖点和优势。首先，它采用了先进的Multi-Touch技术，操作非常方便。通过手势操作，可以轻松提高工作效率。其次，它的圆柱形设计非常独特，给人一种时尚而高档的感觉。无论是外观还是手感都非常出色。另外，Magic Mouse 妙控鼠标还具有强大的自定义功能，用户可以根据自己的喜好和习惯进行个性化设置。最重要的是，它的续航时间非常长，可以连续使用一个月。这意味着用户不需要频繁充电，非常便利。\n\n当然，Magic Mouse 妙控鼠标也有一些缺点。对于一些用户来说，可能需要一些适应时间来熟悉和掌握手势操作。另外，对于某些操作系统，可能存在一些兼容性问题。但是考虑到Magic Mouse 妙控鼠标的独特设计和强大功能，这些小缺点都是可以接受的。\n\n综上所述，Magic Mouse 妙控鼠标是一款性价比非常高的无线鼠标。它的优点包括Multi-Touch技术的便利性，独特的圆柱形设计，强大的自定义功能以及长续航时间。虽然可能需要一定的适应时间，并且在某些操作系统上可能存在兼容性问题，但是考虑到其独特和强大的功能，Magic Mouse 妙控鼠标的价格仍然是可以接受的。无论是外观还是使用体验，它都是一款非常优秀的鼠标选择。']
                },
	'pricing': {
		'tokens': 1265,
		'price': '0.0370',
		'account_balance': '99.9631'
	},
}

K3. 用户删除知识

[DELETE] /knowledge/models/{model_name}/data/{_id}

接口功能: 删除用户embedding模型下对应_id的知识

该接口支持的模型(model_name取值)与说明

url与header参数字段说明:

返回参数字段说明:

请求示例:

https://api.riyuexinzhu.com/knowledge/models/text-embedding-ada-002/data/443824990325047603

返回结果示例:

{
	'resp_code': 200,
	'resp_message': 'SUCCESS',
}

如果您有任何问题，欢迎您随时扫码咨询。