# remote-client-sdk
**Repository Path**: yu_kai_lonely/remote-client-sdk
## Basic Information
- **Project Name**: remote-client-sdk
- **Description**: 一行代码调用各类包括但不限于第三方接口api，集成多种项目所需的api
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-11-20
- **Last Updated**: 2024-12-28
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# remote-client-sdk
* 一行代码调用各类api，包括多种gpt模型，如ChatGpt3.5, gpt-3.5-turbo, gpt-4o-mini, gpt-4 等多种模型，
天气查询，敏感词过滤，英汉互译，二维码生成，短信验证，qq邮箱验证,图形验证码生成等等多种api
##### 历史归档
| 版本 | 修改记录 | 版本说明 |
| :---: | :------------: | :----------------------------------------------------------: |
| 1.0.3 | 2024年12月6日 | 发布1.0.3版本，修复gpt远程调用报错，重载gpt调用方法 |
| 1.0.2 | 2024年12月1日 | 增强GPT模型，支持gpt-3.5-turbo, gpt-4o-mini, gpt-4。其中gpt-4由于价格过高，每天限制3次调用 |
| 0.0.9 | 2024年11月20日 | 封装接口，将方法注入容器 |
| 0.0.7 | 2024年11月10日 | 新增发送邮箱服务，生成图形验证码，敏感词过滤3个接口， |
| 0.0.5 | 2024年10月30日 | 新增天气查询，实名认证，短信服务三个接口3个接口 |
| 0.0.2 | 2024年10月27日 | 提供远程调用英汉互译接口、二维码生成接口、Gpt3.5等远程调用接口 |
## 目录
- [概述](#概述)
- [特性](#特性)
- [快速开始](#快速开始)
- [环境要求](#环境要求)
- [API增量模型(1.0.3版本)](#api增量模型103版本较上一版封装性更好新增部分api加强扩展性)
- [版本概述](#版本概述)
- [快速入门](#快速入门)
- [1. ChatGPT 3.5模型接口调用](#1chatgpt35模型接口调用)
- [2. ChatAI模型加强](#2ChatAI模型加强)
- [3. 快速生成二维码接口](#3快速生成二维码接口)
- [4. 英汉互译接口调用](#4英汉互译接口调用)
- [5. 天气查询接口调用](#5天气查询接口调用)
- [6. 身份证实名认证API](#6身份证实名认证api)
- [7. 短信验证码服务API](#7短信验证码服务api)
- [8. 图形验证码API](#8图形验证码api)
- [9. 发送邮箱验证码API](#9发送邮箱验证码api)
- [10. 敏感词过滤API](#10敏感词过滤api)
- '``````````````````````````````````````````````````````````````````````````````````````````````````````````````'
- [API增量模型(0.0.9版本，较上一版本扩展性更强，更推荐)](#api增量模型009版本较上一版本扩展性更强更推荐)
- [版本概述](#版本概述)
- [快速入门](#快速入门)
- [导入依赖](#导入依赖)
- [快速开始](#快速开始)
- [1.chatgpt增量模型接口调用](#1chatgpt增量模型接口调用)
- [2.快速生成二维码接口](#2快速生成二维码接口)
- [3.英汉互译接口调用](#3英汉互译接口调用)
- [4.天气查询接口调用](#4天气查询接口调用)
- [5.身份证实名认证api](#5身份证实名认证api)
- [6.短信验证码服务api](#6短信验证码服务api)
- [7.图形验证码api](#7图形验证码api)
- [8.发送邮箱验证码api](#8发送邮箱验证码api)
- [9.敏感词过滤api](#9敏感词过滤api)
- `----------------------------------------------------------------------------------`
- [api增量模型(0.0.7版本)](#api增量模型007版本)
- [配置](#配置)
- [chatgpt增量模型接口调用](#chatgpt增量模型接口调用)
- [快速生成二维码接口](#快速生成二维码接口)
- [英汉互译接口调用](#英汉互译接口调用)
- [天气查询接口调用](#天气查询接口调用)
- [身份证实名认证api](#身份证实名认证api)
- [短信验证码服务api](#短信验证码服务api)
- [图形验证码api](#图形验证码api)
- [发送邮箱验证码api](#发送邮箱验证码api)
- [敏感词过滤api](#敏感词过滤api)
- [更多api将持续更新中](#更多api将持续更新中)
## 概述
为了开发需求，在某些项目中可能需要调用许多第三方api接口，由于部分api接口文档特别复杂麻烦，且不易于被检索调用，
remote-client-sdk是一个高性能、可扩展、专门用来提供第三方远程调用服务接口的项目，
该项目旨在开发方便，快速开发调用，无需处理复杂响应，为开发者提供一个便捷的sdk
## 特性
* 高性能：基于Spring Boot，提供快速响应和高并发处理能力。
* 易于集成：提供简单易用的API，支持快速集成到现有项目中。
* 扩展性强：支持自定义消息处理逻辑和模型配置，满足复杂业务需求。
* 简单易用：各类常见api接口均已封装好，一行代码即可直接调用，简单易上手，无需阅读复杂生涩的开发文档。
## 快速开始
### 环境要求
* JDK 8或更高版本
* Maven 3.6.0或更高版本
* SpringBoot 2.X 版本
## api增量模型(1.0.3版本，较上一版封装性更好，新增部分api，加强扩展性)
### 版本概述
> **此版本较上一版本提高了用户的可用性，为防止上一版本中部分api秘钥被弃用，用户可以使用自己的api秘钥仅供自己的项目使用**
### 快速入门
> ### 导入依赖
```xml
io.github.lonelykkk
remote-client-sdk
1.0.3
```
> **用户可在yml/yaml等配置文件中填写自己的api秘钥以防上一版本秘钥过期（当然也可以不写，不写就会使用系统默认的api秘钥，肯能不太稳定）,如下所示,你只需要输入kkk.便会出现对应的提示**
```yml
kkk:
client:
api-code: a8041b5ea4ksad5d6f9f7cf54d3 # 对应部分阿里云的接口调用api秘钥，如天气查询，身份证验证，短信验证码，敏感词过滤等api
qq: test@qq.com # 对应发送qq邮箱stmp服务的账号
qq-mail-code: jhdogitzipnsadichhf #对应发送qq邮箱stmp服务的秘钥
```
> ### 快速开始
```java
@SpringBootTest
public class Test {
@Autowired
private RemoteClient remoteClient; //先注入容器
//gpt api调用
@org.junit.jupiter.api.Test
public void test01() {
String chat = remoteClient.getAiChat("帮我用java写一个快速排序代码");
System.out.println(chat);
}
//qq邮箱验证码api调用
@org.junit.jupiter.api.Test
public void test02() {
String smtp = remoteClient.sendSmtp("test@qq.com");
System.out.println(smtp);
}
//等等,其余业务逻辑与0.0.7版本一样
}
```
### 1.chatgpt3.5模型接口调用
> 接口描述
>
> > 一行代码调用你gpt接口，只需要输入问题即可返回回答，可方便快速集成在你的项目中。
> 入门案例
``` java
@Autowired
private RemoteClient remoteClient;
@Test
public void test01() {
String chat = remoteClient.getLowerAiChat("帮我介绍一下java快速排序");
log.info(chat); //打印gpt的回答
}
```
### 2.ChatAI模型加强
> 接口描述
> 新增0：gpt-3.5-turbo, 1：gpt-4o-mini 3：gpt-4 三种模型
> 不选择版本默认为 gpt-4o-mini 模型
```java
@Test
public void test04() {
//前面传入的字符串的字符串为你需要解答的问题，后面的数字为你指定的模型
//其中分别支持 0：gpt-3.5-turbo, 1：gpt-4o-mini 3：gpt-4 三种模型
String chat = remoteClient.getPowerAiChat("输入你需要翻译的内容，中英文均可",1);
System.out.println(chat); //输出翻译后的结果,为String类型
}
```
### 3.快速生成二维码接口
> 入门案例
* 第一个参数msg为String类型，输入你要存入即将要生成的二维码里面的数据
* 第二行参数size为Integer输入你需要生成二维码的大小
* 生成后的二维码图片默认保存在你当前springboot项目中的resources/imgCode目录下
* 该方法的返回值为你生成的二维码的路径，以String类型返回
```java
@Autowired
private RemoteClient remoteClient;
public void test02() {
//1.第一个参数msg为String类型，输入你要存入即将要生成的二维码里面的数据，如我输入 https://www.baidu.com/,扫描生成后的二维码将跳转至百度链接
//2.第二行参数size为Integer输入你需要生成二维码的大小,如输入150则二维码大小为 150*150px
//3.生成后的二维码图片默认保存在你当前springboot项目中的resources/imgCode目录下
//4.该方法的返回值为你生成的二维码的路径，以String类型返回
String url = remoteClient.getImgCode("https://www.baidu.com/", 150);
System.out.println(url);
}
```
### 4.英汉互译接口调用
> 入门案例
```java
public void test03() {
String translation = remoteClient.getTranslation("输入你需要翻译的内容，中英文均可");
System.out.println(translation); //输出翻译后的结果,为String类型
}
```
### 5.天气查询接口调用
> api描述
> 该api可用于查询当前地区24小时内的天气信息，只需要输入你需要查询的天气的地址，便可以返回对应地址的天气24小时的实体对象
> **强调**：此处使用的阿里云的天气查询api秘钥，你可以在yml处配置自己的apicode(如上文)
* 快速连接[阿里云天气api接口调用](https://market.aliyun.com/apimarket/detail/cmapi010812?spm=5176.730005.result.4.583e414aEOz59I&innerSource=search_%E5%A4%A9%E6%B0%94%E9%A2%84%E6%8A%A5%E6%8E%A5%E5%8F%A3#sku=yuncode4812000017)
- **获取你的apicode后在第一步yml文件中填写你的秘钥即可（不填写的话默认使用系统提供的秘钥）**
>> 入门案例
```java
@Autowired
private RemoteClient remoteClient;
public void RemoteClient{
try {
HourWeatherList hourWeatherList = remoteClient.getWeather("上海"); //在此处输入你的需要查询的天气的地点
// 定义日期格式
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyyMMddHHmm");
for (HourForecast forecast : hourWeatherList.getHourList()) {
// 解析字符串为 Date 对象
Date date = dateFormat.parse(forecast.getTime());
System.out.println("时间: " + date);
System.out.println("天气: " + forecast.getWeather());
System.out.println("温度: " + forecast.getTemperature());
System.out.println("风向: " + forecast.getWindDirection());
System.out.println("风力: " + forecast.getWindPower());
System.out.println("---------------------------");
}
} catch (Exception e) {
throw new RuntimeException();
}
}
```
### 6.身份证实名认证api
> 接口描述
> 该api提供了身份证实名认证服务，用户只需要传入姓名和身份证号便可以返回对应的身份信息
> **强调**：此处使用的阿里云的身份证验证pi秘钥，你可以在yml处配置自己的apicode
> **注意**：阿里云同一用户的apicode都是一样的，所有的阿里云增值服务只需要一个apicode就可以了，其他的都是共用的，你只需开启相应的服务就行
* 快速连接[阿里云身份验证api接口调用](https://market.aliyun.com/apimarket/detail/cmapi00066570#sku=yuncode6057000002)
**获取你的apicode后在第一步yml文件中填写你的秘钥即可（不填写的话默认使用系统提供的秘钥)**
>入门案例
```java
@Autowired
private RemoteClient remoteClient;
public void test05{
IdentityCard identityCard = remoteClient.getAuthenticationCard("传入姓名", "传入身份证号");
//打印输出结果
System.out.println("生日：" + identityCard.getBirthday());
System.out.println("响应结果(1.不一致 0.一致)：" + identityCard.getResult());
System.out.println("地址：" + identityCard.getAddress());
System.out.println("订单编号：" + identityCard.getOrderNo());
System.out.println("性别：" + identityCard.getSex());
System.out.println("描述：" + identityCard.getDesc());
}
```
### 7.短信验证码服务api
> 接口描述
> 该短信服务api为用户提供了发送短信验证码服务，用户只需要传入需要发送短信验证的手机号，
> 便可发送一个随机6位数验证码并返回
* 快速开启服务通道
- [短信验证码服务api]([https://market.aliyun.com/apimarket/detail/cmapi00066570#sku=yuncode6057000002](https://market.aliyun.com/apimarket/detail/cmapi00037891?spm=5176.730005.result.8.4375414aLKmosT&innerSource=search_%E7%9F%AD%E4%BF%A1#sku=yuncode31891000015))
>入门案例
```java
@Autowired
private RemoteClient remoteClient;
public void test06 {
final Integer sms = remoteClient.sendSms("输入你的手机号"); //返回这个随机生成的验证码，以便开发人员做后续验证码校验
System.out.println("验证码为：" + sms);
}
```
### 8.图形验证码api
> 功能描述
> 该图形验证码api可用于生成一个验证码图片，用户可以在如登录校验等类似功能时使用该api生成一个图形验证码
> 该api返回图形验证码的内容以及图片的绝对路径，用户可根据返回的内容进行校验，可以根据返回的图片路径进行相应处理，如存储在数据库或者存储在云空间等等响应给前端
> 入门案例
```java
public void test() throws Exception{
ImgCaptcha imgCaptcha = remoteClient.getImgCaptcha(5); //参数为int类型，用于指定你需要生成的图形验证码的数据量个数
System.out.println("验证码为：" + imgCaptcha.getCaptchaText());
System.out.println("路径为：" + imgCaptcha.getCaptchaUrl());
}
```
### 9.发送邮箱验证码api
> 功能描述
> 该邮箱验证码主要用于用户在进行登录注册时通过邮箱验证码进行验证，用户需要输入你的邮箱，之后便可对你指定的邮箱发送随机生成的验证码
> 随后返回一个String类型的字符串，你可以根据该验证码进行校验
> **注意**：此处可以填写你的邮箱服务秘钥
* 开启服务链接[qq邮箱开启smtp](https://blog.csdn.net/new_abc/article/details/142092915)
> 入门案例
```java
public void test() {
String code = remoteClient.sendSmtp("111@qq.com"); //此处输入你需要发送的邮箱，随后返回你发送的验证码方便后续校验
System.out.println("收到的邮箱验证码为：" + code);
}
```
```java
@Test
public void test05() {
String code = remoteClient.sendSmtp("1223@qq.com","邮件主题","邮件内容");
System.out.println("收到的邮箱验证码为：" + code);
}
```
### 10.敏感词过滤api
> 功能描述
> 该功能主要用于对文本合法性进行校验，查看是否有敏感词，如对用户发送的评论进行校验，如果有违禁词则会返回对应的结果方便开发人员进一步处理
> 返回类型为int类型，对应结果为 1：合规，2：不合规，3：疑似，4：审核失败，-1：api调用失败
* 开启服务快速通道[阿里云敏感词过滤接口调用](https://market.aliyun.com/apimarket/detail/cmapi00066351#sku=yuncode6035100001)
>入门案例
```java
public static void main(String[] args) throws Exception{
RemoteClient remoteClient = new RemoteClient();
//result：1：合规，2：不合规，3：疑似，4：审核失败，-1：api调用失败
int result = remoteClient.SensitiveFilter("你好");
//后续可对result进行判断以便做进一步处理
}
```
`-----------------------------------------------------------------------------------------------------------------------------------------------------------------`
## api增量模型(0.0.9版本，较上一版本扩展性更强，更推荐)
### 版本概述
> **此版本较0.0.7版本提高了用户的可用性，为防止上一版本中部分api秘钥被弃用，用户可以使用自己的api秘钥仅供自己的项目使用**
### 快速入门
> ### 导入依赖
```xml
io.github.lonelykkk
remote-client-sdk
0.0.9
```
> **用户可在yml/yaml等配置文件中填写自己的api秘钥以防上一版本秘钥过期（当然也可以不写，不写就会使用系统默认的api秘钥，肯能不太稳定）,如下所示,你只需要输入kkk.便会出现对应的提示**
```yml
kkk:
client:
api-code: a8041b5ea4ksad5d6f9f7cf54d3 # 对应部分阿里云的接口调用api秘钥，如天气查询，身份证验证，短信验证码，敏感词过滤等api
qq: test@qq.com # 对应发送qq邮箱stmp服务的账号
qq-mail-code: jhdogitzipnsadichhf #对应发送qq邮箱stmp服务的秘钥
```
> ### 快速开始
```java
@SpringBootTest
public class Test {
@Autowired
private RemoteClient remoteClient; //先注入容器
//gpt api调用
@org.junit.jupiter.api.Test
public void test01() {
String chat = remoteClient.getAiChat("帮我用java写一个快速排序代码");
System.out.println(chat);
}
//qq邮箱验证码api调用
@org.junit.jupiter.api.Test
public void test02() {
String smtp = remoteClient.sendSmtp("test@qq.com");
System.out.println(smtp);
}
//等等,其余业务逻辑与0.0.7版本一样
}
```
### 1.chatgpt增量模型接口调用
> 接口描述
>>
>> 一行代码调用你gpt接口，只需要输入问题即可返回回答，可方便快速集成在你的项目中。
> 入门案例
``` java
@Autowired
private RemoteClient remoteClient;
public void test01() {
String chat = remoteClient.getAiChat("帮我用java写一个快速排序代码");
log.info(chat); //打印gpt的回答
}
```
### 2.快速生成二维码接口
> 入门案例
* 第一个参数msg为String类型，输入你要存入即将要生成的二维码里面的数据
* 第二行参数size为Integer输入你需要生成二维码的大小
* 生成后的二维码图片默认保存在你当前springboot项目中的resources/imgCode目录下
* 该方法的返回值为你生成的二维码的路径，以String类型返回
```java
@Autowired
private RemoteClient remoteClient;
public void test02() {
//1.第一个参数msg为String类型，输入你要存入即将要生成的二维码里面的数据，如我输入 https://www.baidu.com/,扫描生成后的二维码将跳转至百度链接
//2.第二行参数size为Integer输入你需要生成二维码的大小,如输入150则二维码大小为 150*150px
//3.生成后的二维码图片默认保存在你当前springboot项目中的resources/imgCode目录下
//4.该方法的返回值为你生成的二维码的路径，以String类型返回
String url = remoteClient.getImgCode("https://www.baidu.com/", 150);
System.out.println(url);
}
```
### 3.英汉互译接口调用
> 入门案例
```java
public void test03() {
String translation = remoteClient.getTranslation("输入你需要翻译的内容，中英文均可");
System.out.println(translation); //输出翻译后的结果,为String类型
}
```
### 4.天气查询接口调用
> api描述
> 该api可用于查询当前地区24小时内的天气信息，只需要输入你需要查询的天气的地址，便可以返回对应地址的天气24小时的实体对象
> **强调**：此处使用的阿里云的天气查询api秘钥，你可以在yml处配置自己的apicode(如上文)
* 快速连接[阿里云天气api接口调用](https://market.aliyun.com/apimarket/detail/cmapi010812?spm=5176.730005.result.4.583e414aEOz59I&innerSource=search_%E5%A4%A9%E6%B0%94%E9%A2%84%E6%8A%A5%E6%8E%A5%E5%8F%A3#sku=yuncode4812000017)
- **获取你的apicode后在第一步yml文件中填写你的秘钥即可（不填写的话默认使用系统提供的秘钥）**
>> 入门案例
```java
@Autowired
private RemoteClient remoteClient;
public void RemoteClient{
try {
HourWeatherList hourWeatherList = remoteClient.getWeather("上海"); //在此处输入你的需要查询的天气的地点
// 定义日期格式
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyyMMddHHmm");
for (HourForecast forecast : hourWeatherList.getHourList()) {
// 解析字符串为 Date 对象
Date date = dateFormat.parse(forecast.getTime());
System.out.println("时间: " + date);
System.out.println("天气: " + forecast.getWeather());
System.out.println("温度: " + forecast.getTemperature());
System.out.println("风向: " + forecast.getWindDirection());
System.out.println("风力: " + forecast.getWindPower());
System.out.println("---------------------------");
}
} catch (Exception e) {
throw new RuntimeException();
}
}
```
### 5.身份证实名认证api
> 接口描述
> 该api提供了身份证实名认证服务，用户只需要传入姓名和身份证号便可以返回对应的身份信息
> **强调**：此处使用的阿里云的身份证验证pi秘钥，你可以在yml处配置自己的apicode
> **注意**：阿里云同一用户的apicode都是一样的，所有的阿里云增值服务只需要一个apicode就可以了，其他的都是共用的，你只需开启相应的服务就行
* 快速连接[阿里云身份验证api接口调用](https://market.aliyun.com/apimarket/detail/cmapi00066570#sku=yuncode6057000002)
**获取你的apicode后在第一步yml文件中填写你的秘钥即可（不填写的话默认使用系统提供的秘钥）**
>入门案例
```java
@Autowired
private RemoteClient remoteClient;
public void test05{
IdentityCard identityCard = remoteClient.getAuthenticationCard("传入姓名", "传入身份证号");
//打印输出结果
System.out.println("生日：" + identityCard.getBirthday());
System.out.println("响应结果(1.不一致 0.一致)：" + identityCard.getResult());
System.out.println("地址：" + identityCard.getAddress());
System.out.println("订单编号：" + identityCard.getOrderNo());
System.out.println("性别：" + identityCard.getSex());
System.out.println("描述：" + identityCard.getDesc());
}
```
### 6.短信验证码服务api
> 接口描述
> 该短信服务api为用户提供了发送短信验证码服务，用户只需要传入需要发送短信验证的手机号，
> 便可发送一个随机6位数验证码并返回
* 快速开启服务通道
- [短信验证码服务api]([https://market.aliyun.com/apimarket/detail/cmapi00066570#sku=yuncode6057000002](https://market.aliyun.com/apimarket/detail/cmapi00037891?spm=5176.730005.result.8.4375414aLKmosT&innerSource=search_%E7%9F%AD%E4%BF%A1#sku=yuncode31891000015))
>入门案例
```java
@Autowired
private RemoteClient remoteClient;
public void test06 {
final Integer sms = remoteClient.sendSms("输入你的手机号"); //返回这个随机生成的验证码，以便开发人员做后续验证码校验
System.out.println("验证码为：" + sms);
}
```
### 7.图形验证码api
> 功能描述
> 该图形验证码api可用于生成一个验证码图片，用户可以在如登录校验等类似功能时使用该api生成一个图形验证码
> 该api返回图形验证码的内容以及图片的绝对路径，用户可根据返回的内容进行校验，可以根据返回的图片路径进行相应处理，如存储在数据库或者存储在云空间等等响应给前端
> 入门案例
```java
public static void main(String[] args) throws Exception{
RemoteClient remoteClient = new RemoteClient();
ImgCaptcha imgCaptcha = remoteClient.getImgCaptcha(5); //参数为int类型，用于指定你需要生成的图形验证码的数据量个数
System.out.println("验证码为：" + imgCaptcha.getCaptchaText());
System.out.println("路径为：" + imgCaptcha.getCaptchaUrl());
}
```
### 8.发送邮箱验证码api
> 功能描述
> 该邮箱验证码主要用于用户在进行登录注册时通过邮箱验证码进行验证，用户需要输入你的邮箱，之后便可对你指定的邮箱发送随机生成的验证码
> 随后返回一个String类型的字符串，你可以根据该验证码进行校验
> **注意**：此处可以填写你的邮箱服务秘钥
* 开启服务链接[qq邮箱开启smtp](https://blog.csdn.net/new_abc/article/details/142092915)
> 入门案例
```java
public static void main(String[] args) throws Exception{
RemoteClient remoteClient = new RemoteClient();
String code = remoteClient.sendSmtp("111@qq.com"); //此处输入你需要发送的邮箱，随后返回你发送的验证码方便后续校验
System.out.println("收到的邮箱验证码为：" + code);
}
```
### 9.敏感词过滤api
> 功能描述
> 该功能主要用于对文本合法性进行校验，查看是否有敏感词，如对用户发送的评论进行校验，如果有违禁词则会返回对应的结果方便开发人员进一步处理
> 返回类型为int类型，对应结果为 1：合规，2：不合规，3：疑似，4：审核失败，-1：api调用失败
* 开启服务快速通道[阿里云敏感词过滤接口调用](https://market.aliyun.com/apimarket/detail/cmapi00066351#sku=yuncode6035100001)
>入门案例
```java
public static void main(String[] args) throws Exception{
RemoteClient remoteClient = new RemoteClient();
//result：1：合规，2：不合规，3：疑似，4：审核失败，-1：api调用失败
int result = remoteClient.SensitiveFilter("你好");
//后续可对result进行判断以便做进一步处理
}
```
`-----------------------------------------------------------------------------------------------------------------------------------------------------------------`
## api增量模型(0.0.7版本)
### 配置
1. 在pom.xml文件中添加以下依赖：
```xml
io.github.lonelykkk
remote-client-sdk
0.0.7
```
### chatgpt增量模型接口调用
> 接口描述
>>
>> 一行代码调用你gpt接口，只需要输入问题即可返回回答，可方便快速集成在你的项目中。
> 入门案例
``` java
public static void main(String[] args) {
RemoteClient remoteClient = new RemoteClient();
String chat = remoteClient.getAiChat("输入你的问题"); //以字符串类型，返回ai回答
System.out.println(chat); //输出答案
}
```
### 快速生成二维码接口
> 入门案例
* 第一个参数msg为String类型，输入你要存入即将要生成的二维码里面的数据
* 第二行参数size为Integer输入你需要生成二维码的大小
* 生成后的二维码图片默认保存在你当前springboot项目中的resources/imgCode目录下
* 该方法的返回值为你生成的二维码的路径，以String类型返回
```java
public static void main(String[] args) {
RemoteClient remoteClient = new RemoteClient();
//1.第一个参数msg为String类型，输入你要存入即将要生成的二维码里面的数据，如我输入 https://www.baidu.com/,扫描生成后的二维码将跳转至百度链接
//2.第二行参数size为Integer输入你需要生成二维码的大小,如输入150则二维码大小为 150*150px
//3.生成后的二维码图片默认保存在你当前springboot项目中的resources/imgCode目录下
//4.该方法的返回值为你生成的二维码的路径，以String类型返回
String url = remoteClient.getImgCode("https://www.baidu.com/", 150);
System.out.println(url);
}
```
### 英汉互译接口调用
> 入门案例
```java
public static void main(String[] args) {
RemoteClient remoteClient = new RemoteClient();
String translation = remoteClient.getTranslation("输入你需要翻译的内容，中英文均可");
System.out.println(translation); //输出翻译后的结果,为String类型
}
```
### 天气查询接口调用
> 接口描述
> 该api可用于查询当前地区24小时内的天气信息，只需要输入你需要查询的天气的地址，便可以返回对应地址的天气24小时的实体对象
> 入门案例
```java
public static void main(String[] args) {
RemoteClient remoteClient = new RemoteClient();
try {
HourWeatherList hourWeatherList = remoteClient.getWeather("上海"); //在此处输入你的需要查询的天气的地点
// 定义日期格式
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyyMMddHHmm");
for (HourForecast forecast : hourWeatherList.getHourList()) {
// 解析字符串为 Date 对象
Date date = dateFormat.parse(forecast.getTime());
System.out.println("Time: " + date);
System.out.println("Weather: " + forecast.getWeather());
System.out.println("Temperature: " + forecast.getTemperature());
System.out.println("Wind Direction: " + forecast.getWindDirection());
System.out.println("Wind Power: " + forecast.getWindPower());
System.out.println("---------------------------");
}
} catch (Exception e) {
throw new RuntimeException();
}
}
```
> 对应的实体类
```java
public class HourWeatherList {
@JsonProperty("remark")
private String remark;
@JsonProperty("ret_code")
private int retCode;
@JsonProperty("areaid")
private String areaId;
@JsonProperty("area")
private String area;
@JsonProperty("areaCode")
private String areaCode;
private List hourList;
}
```
```java
public class HourForecast {
@JsonProperty("time")
private String time;
@JsonProperty("wind_direction")
private String windDirection;
@JsonProperty("wind_power")
private String windPower;
@JsonProperty("areaid")
private String areaId;
@JsonProperty("weather_code")
private String weatherCode;
@JsonProperty("temperature")
private String temperature;
@JsonProperty("area")
private String area;
@JsonProperty("weather")
private String weather;
}
```
### 身份证实名认证api
> 接口描述
> 该api提供了身份证实名认证服务，用户只需要传入姓名和身份证号便可以返回对应的身份信息
>入门案例
```java
public static void main(String[] args) throws Exception{
RemoteClient remoteClient = new RemoteClient();
IdentityCard identityCard = remoteClient.getAuthenticationCard("传入姓名", "传入身份证号");
//打印输出结果
System.out.println("生日：" + identityCard.getBirthday());
System.out.println("响应结果(1.不一致 0.一致)：" + identityCard.getResult());
System.out.println("地址：" + identityCard.getAddress());
System.out.println("订单编号：" + identityCard.getOrderNo());
System.out.println("性别：" + identityCard.getSex());
System.out.println("desc：" + identityCard.getDesc());
}
```
> 对应的实体类
```java
public class IdentityCard {
private String birthday;
private int result; //1.不一致 0.一致
private String address; //地址
private String orderNo; //订单编号
private String sex; //性别
private String desc; //描述
}
```
### 短信验证码服务api
> 接口描述
> 该短信服务api为用户提供了发送短信验证码服务，用户只需要传入需要发送短信验证的手机号，
> 便可发送一个随机6位数验证码并返回
>入门案例
```java
public static void main(String[] args) throws Exception{
RemoteClient remoteClient = new RemoteClient();
final Integer sms = remoteClient.sendSms("输入你的手机号"); //返回这个随机生成的验证码，以便开发人员做后续验证码校验
System.out.println("验证码为：" + sms);
}
```
### 图形验证码api
> 功能描述
> 该图形验证码api可用于生成一个验证码图片，用户可以在如登录校验等类似功能时使用该api生成一个图形验证码
> 该api返回图形验证码的内容以及图片的绝对路径，用户可根据返回的内容进行校验，可以根据返回的图片路径进行相应处理，如存储在数据库或者存储在云空间等等响应给前端
> 入门案例
```java
public static void main(String[] args) throws Exception{
RemoteClient remoteClient = new RemoteClient();
ImgCaptcha imgCaptcha = remoteClient.getImgCaptcha(5); //参数为int类型，用于指定你需要生成的图形验证码的数据量个数
System.out.println("验证码为：" + imgCaptcha.getCaptchaText());
System.out.println("路径为：" + imgCaptcha.getCaptchaUrl());
}
```
### 发送邮箱验证码api
> 功能描述
> 该邮箱验证码主要用于用户在进行登录注册时通过邮箱验证码进行验证，用户需要输入你的邮箱，之后便可对你指定的邮箱发送随机生成的验证码
> 随后返回一个String类型的字符串，你可以根据该验证码进行校验
> 入门案例
```java
public static void main(String[] args) throws Exception{
RemoteClient remoteClient = new RemoteClient();
String code = remoteClient.sendSmtp("111@qq.com"); //此处输入你需要发送的邮箱，随后返回你发送的验证码方便后续校验
System.out.println("收到的邮箱验证码为：" + code);
}
```
### 敏感词过滤api
> 功能描述
> 该功能主要用于对文本合法性进行校验，查看是否有敏感词，如对用户发送的评论进行校验，如果有违禁词则会返回对应的结果方便开发人员进一步处理
> 返回类型为int类型，对应结果为 1：合规，2：不合规，3：疑似，4：审核失败，-1：api调用失败
>入门案例
```java
public static void main(String[] args) throws Exception{
RemoteClient remoteClient = new RemoteClient();
//result：1：合规，2：不合规，3：疑似，4：审核失败，-1：api调用失败
int result = remoteClient.SensitiveFilter("你好");
//后续可对result进行判断以便做进一步处理
}
```
## 更多api将持续更新中