Notes: if you get the api keys from DB, also can add cache to improve speed.
30 | *
31 | * @return list of {@link OpenAiKey}
32 | */
33 | List get();
34 | }
35 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/apikey/OpenAiKeyWrapper.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.apikey;
18 |
19 | import cn.hutool.cache.CacheUtil;
20 | import cn.hutool.cache.impl.LFUCache;
21 | import cn.hutool.core.lang.WeightRandom;
22 | import cn.hutool.core.util.HashUtil;
23 | import java.util.*;
24 | import java.util.stream.Collectors;
25 | import lombok.Getter;
26 | import lombok.RequiredArgsConstructor;
27 | import lombok.extern.slf4j.Slf4j;
28 | import org.springframework.util.Assert;
29 |
30 | /**
31 | * @author lzhpo
32 | */
33 | @Slf4j
34 | @Getter
35 | @RequiredArgsConstructor
36 | @SuppressWarnings({"squid:S3864"})
37 | public class OpenAiKeyWrapper {
38 |
39 | private final OpenAiKeyProvider openAiKeyProvider;
40 | private final List invalidKeys = new ArrayList<>();
41 | private final LFUCache> randomLFUCache = CacheUtil.newLFUCache(0);
42 |
43 | /**
44 | * Wrap the {@link OpenAiKeyProvider#get()} result, in order to make api keys has weight random power.
45 | *
46 | * @return has weight random power api keys
47 | */
48 | public WeightRandom wrap() {
49 | List openAiKeys = openAiKeyProvider.get();
50 | Assert.notEmpty(openAiKeys, "The api keys is empty.");
51 | long cacheKey = hashKey(openAiKeys);
52 | return Optional.ofNullable(randomLFUCache.get(cacheKey)).orElseGet(() -> {
53 | log.debug("Not found openAiKeys in cache, will generate new one api key weight random.");
54 | Set> weightObjSet = openAiKeys.stream()
55 | .filter(OpenAiKey::isEnabled)
56 | .filter(openAiKey -> !invalidKeys.contains(openAiKey.getKey()))
57 | .peek(openAiKey -> log.debug("Found available api key: {}", openAiKey))
58 | .map(obj -> new WeightRandom.WeightObj<>(obj.getKey(), obj.getWeight()))
59 | .collect(Collectors.toSet());
60 | WeightRandom weightRandom = new WeightRandom<>(weightObjSet);
61 | randomLFUCache.put(cacheKey, weightRandom);
62 | return weightRandom;
63 | });
64 | }
65 |
66 | /**
67 | * Remove invalid api keys, support automatic key rotation.
68 | *
69 | * @param apiKey the api key
70 | */
71 | public void invalidKey(String apiKey) {
72 | randomLFUCache.clear();
73 | invalidKeys.add(apiKey);
74 | log.warn("Already removed the invalided api key: {}, total invalided keys: {}", apiKey, invalidKeys);
75 | }
76 |
77 | /**
78 | * Hash {@code openAiKeys}.
79 | *
80 | * @param openAiKeys the api keys
81 | * @return murmur hash64 result
82 | */
83 | public static long hashKey(List openAiKeys) {
84 | return HashUtil.murmur64(openAiKeys.toString().getBytes());
85 | }
86 | }
87 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/CommonConfig.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity;
18 |
19 | import com.fasterxml.jackson.annotation.JsonInclude;
20 | import com.fasterxml.jackson.annotation.JsonProperty;
21 | import javax.validation.constraints.Max;
22 | import javax.validation.constraints.Min;
23 | import lombok.AllArgsConstructor;
24 | import lombok.Data;
25 | import lombok.NoArgsConstructor;
26 | import lombok.experimental.SuperBuilder;
27 |
28 | /**
29 | * @author lzhpo
30 | */
31 | @Data
32 | @SuperBuilder
33 | @NoArgsConstructor
34 | @AllArgsConstructor
35 | @JsonInclude(JsonInclude.Include.NON_NULL)
36 | public class CommonConfig {
37 |
38 | /**
39 | * How many edits to generate for the input and instruction.
40 | */
41 | private Integer n;
42 |
43 | /**
44 | * What sampling temperature to use, between 0 and 2.
45 | *
46 | *
Higher values like 0.8 will make the output more random,
47 | * while lower values like 0.2 will make it more focused and deterministic.
48 | *
49 | *
We generally recommend altering this or top_p but not both.
50 | */
51 | @Min(0)
52 | @Max(2)
53 | private Number temperature;
54 |
55 | /**
56 | * An alternative to sampling with temperature, called nucleus sampling,
57 | * where the model considers the results of the tokens with top_p probability mass.
58 | * So 0.1 means only the tokens comprising the top 10% probability mass are considered.
59 | *
60 | *
We generally recommend altering this or temperature but not both.
61 | */
62 | @JsonProperty("top_p")
63 | private Number topP;
64 | }
65 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/CommonUsage.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class CommonUsage {
27 |
28 | /**
29 | * OpenAi calculate the input the number of tokens consumed.
30 | */
31 | @JsonProperty("prompt_tokens")
32 | private Long promptTokens;
33 |
34 | /**
35 | * OpenAi calculate the output the number of tokens consumed.
36 | */
37 | @JsonProperty("completion_tokens")
38 | private Long completionTokens;
39 |
40 | /**
41 | * OpenAi calculate the total number of tokens consumed by the input and output of this dialogue.
42 | *
totalTokens = {@link #promptTokens} + {@link #completionTokens}
43 | */
44 | @JsonProperty("total_tokens")
45 | private Long totalTokens;
46 | }
47 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/audio/CreateAudioRequest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.audio;
18 |
19 | import com.fasterxml.jackson.annotation.JsonInclude;
20 | import com.fasterxml.jackson.annotation.JsonProperty;
21 | import javax.validation.constraints.Max;
22 | import javax.validation.constraints.Min;
23 | import javax.validation.constraints.NotBlank;
24 | import lombok.AllArgsConstructor;
25 | import lombok.Builder;
26 | import lombok.Data;
27 | import lombok.NoArgsConstructor;
28 |
29 | /**
30 | * @author lzhpo
31 | */
32 | @Data
33 | @Builder
34 | @NoArgsConstructor
35 | @AllArgsConstructor
36 | @JsonInclude(JsonInclude.Include.NON_NULL)
37 | public class CreateAudioRequest {
38 |
39 | /**
40 | * ID of the model to use.
41 | *
42 | *
Only whisper-1 is currently available.
43 | */
44 | @NotBlank
45 | private String model = "whisper-1";
46 |
47 | /**
48 | * An optional text to guide the model's style or continue a previous audio segment.
49 | *
50 | *
The prompt should match the audio language.
51 | */
52 | private String prompt;
53 |
54 | /**
55 | * The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt.
56 | */
57 | @JsonProperty("response_format")
58 | private String responseFormat;
59 |
60 | /**
61 | * What sampling temperature to use, between 0 and 2.
62 | *
63 | *
Higher values like 0.8 will make the output more random,
64 | * while lower values like 0.2 will make it more focused and deterministic.
65 | *
66 | *
We generally recommend altering this or top_p but not both.
67 | */
68 | @Min(0)
69 | @Max(2)
70 | private Number temperature;
71 |
72 | /**
73 | * The language of the input audio.
74 | *
75 | *
Supplying the input language in ISO-639-1 format will improve accuracy and latency.
76 | */
77 | private String language;
78 | }
79 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/audio/CreateAudioResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.audio;
18 |
19 | import lombok.Data;
20 |
21 | /**
22 | * @author lzhpo
23 | */
24 | @Data
25 | public class CreateAudioResponse {
26 |
27 | private String text;
28 | }
29 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/billing/CreditGrants.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.billing;
18 |
19 | import java.util.List;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class CreditGrants {
27 |
28 | private String object;
29 | private List data;
30 | }
31 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/billing/CreditGrantsData.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.billing;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import java.math.BigDecimal;
21 | import lombok.Data;
22 |
23 | /**
24 | * @author lzhpo
25 | */
26 | @Data
27 | public class CreditGrantsData {
28 |
29 | private String id;
30 |
31 | private String object;
32 |
33 | @JsonProperty("grant_amount")
34 | private BigDecimal grantAmount;
35 |
36 | @JsonProperty("used_amount")
37 | private BigDecimal usedAmount;
38 |
39 | @JsonProperty("effective_at")
40 | private BigDecimal effectiveAt;
41 |
42 | @JsonProperty("expires_at")
43 | private BigDecimal expiresAt;
44 | }
45 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/billing/CreditGrantsResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.billing;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import java.math.BigDecimal;
21 | import lombok.Data;
22 |
23 | /**
24 | * @author lzhpo
25 | */
26 | @Data
27 | public class CreditGrantsResponse {
28 |
29 | private String object;
30 |
31 | @JsonProperty("total_granted")
32 | private BigDecimal totalGranted;
33 |
34 | @JsonProperty("total_used")
35 | private BigDecimal totalUsed;
36 |
37 | @JsonProperty("total_available")
38 | private BigDecimal totalAvailable;
39 |
40 | private CreditGrants grants;
41 | }
42 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/billing/SubscriptionAddress.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.billing;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class SubscriptionAddress {
27 |
28 | private String line1;
29 |
30 | private Object line2;
31 |
32 | private String city;
33 |
34 | private String state;
35 |
36 | @JsonProperty("postal_code")
37 | private String postalCode;
38 |
39 | private String country;
40 | }
41 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/billing/SubscriptionPlan.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.billing;
18 |
19 | import lombok.Data;
20 |
21 | /**
22 | * @author lzhpo
23 | */
24 | @Data
25 | public class SubscriptionPlan {
26 |
27 | private String title;
28 | private String id;
29 | }
30 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/billing/SubscriptionResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.billing;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import java.math.BigDecimal;
21 | import java.util.List;
22 | import lombok.Data;
23 |
24 | /**
25 | * @author lzhpo
26 | */
27 | @Data
28 | public class SubscriptionResponse {
29 |
30 | private String object;
31 |
32 | @JsonProperty("has_payment_method")
33 | private Boolean has_payment_method;
34 |
35 | private Boolean canceled;
36 |
37 | @JsonProperty("canceled_at")
38 | private Long canceledAt;
39 |
40 | private Object delinquent;
41 |
42 | @JsonProperty("access_until")
43 | private Long accessUntil;
44 |
45 | @JsonProperty("soft_limit")
46 | private Long softLimit;
47 |
48 | @JsonProperty("hard_limit")
49 | private Long hardLimit;
50 |
51 | @JsonProperty("system_hard_limit")
52 | private Long systemHardLimit;
53 |
54 | @JsonProperty("soft_limit_usd")
55 | private BigDecimal softLimitUsd;
56 |
57 | @JsonProperty("hard_limit_usd")
58 | private BigDecimal hardLimitUsd;
59 |
60 | @JsonProperty("system_hard_limit_usd")
61 | private BigDecimal systemHardLimitUsd;
62 |
63 | private SubscriptionPlan plan;
64 |
65 | @JsonProperty("account_name")
66 | private String accountName;
67 |
68 | @JsonProperty("po_number")
69 | private String poNumber;
70 |
71 | @JsonProperty("billing_email")
72 | private String billingEmail;
73 |
74 | @JsonProperty("tax_ids")
75 | private List taxIds;
76 |
77 | @JsonProperty("billing_address")
78 | private SubscriptionAddress billingAddress;
79 |
80 | @JsonProperty("business_address")
81 | private SubscriptionAddress businessAddress;
82 | }
83 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/billing/UsageDailyCosts.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.billing;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import java.math.BigDecimal;
21 | import java.util.List;
22 | import lombok.Data;
23 |
24 | /**
25 | * @author lzhpo
26 | */
27 | @Data
28 | public class UsageDailyCosts {
29 |
30 | private BigDecimal timestamp;
31 |
32 | @JsonProperty("line_items")
33 | private List lineItems;
34 | }
35 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/billing/UsageLineItems.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.billing;
18 |
19 | import java.math.BigDecimal;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class UsageLineItems {
27 |
28 | private String name;
29 | private BigDecimal cost;
30 | }
31 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/billing/UsageResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.billing;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import java.math.BigDecimal;
21 | import java.util.List;
22 | import lombok.Data;
23 |
24 | /**
25 | * @author lzhpo
26 | */
27 | @Data
28 | public class UsageResponse {
29 |
30 | private String object;
31 |
32 | @JsonProperty("daily_costs")
33 | private List dailyCosts;
34 |
35 | @JsonProperty("total_usage")
36 | private BigDecimal totalUsage;
37 | }
38 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/chat/ChatCompletionChoice.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.chat;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class ChatCompletionChoice {
27 |
28 | private Long index;
29 |
30 | private ChatCompletionMessage message;
31 |
32 | @JsonProperty("finish_reason")
33 | private String finishReason;
34 | }
35 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/chat/ChatCompletionFunction.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.chat;
18 |
19 | import com.fasterxml.jackson.annotation.JsonInclude;
20 | import javax.validation.constraints.NotBlank;
21 | import javax.validation.constraints.NotNull;
22 | import lombok.AllArgsConstructor;
23 | import lombok.Data;
24 | import lombok.NoArgsConstructor;
25 | import lombok.experimental.SuperBuilder;
26 | import org.hibernate.validator.constraints.Length;
27 |
28 | /**
29 | * @author lzhpo
30 | */
31 | @Data
32 | @SuperBuilder
33 | @NoArgsConstructor
34 | @AllArgsConstructor
35 | @JsonInclude(JsonInclude.Include.NON_NULL)
36 | public class ChatCompletionFunction {
37 |
38 | /**
39 | * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
40 | */
41 | @NotBlank
42 | @Length(max = 64)
43 | private String name;
44 |
45 | /**
46 | * A description of what the function does, used by the model to choose when and how to call the function.
47 | */
48 | private String description;
49 |
50 | /**
51 | * The parameters the functions accepts, described as a JSON Schema object.
52 | *
See the guide for examples, and the JSON Schema reference for documentation about the format.
53 | *
54 | *
55 | * To describe a function that accepts no parameters, provide the value {"type": "object", "properties": {}}.
56 | *
57 | */
58 | @NotNull
59 | private ChatCompletionParameter parameters;
60 | }
61 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/chat/ChatCompletionFunctionCall.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.chat;
18 |
19 | import com.fasterxml.jackson.annotation.JsonInclude;
20 | import lombok.AllArgsConstructor;
21 | import lombok.Data;
22 | import lombok.NoArgsConstructor;
23 | import lombok.experimental.SuperBuilder;
24 |
25 | /**
26 | * @author lzhpo
27 | */
28 | @Data
29 | @SuperBuilder
30 | @NoArgsConstructor
31 | @AllArgsConstructor
32 | @JsonInclude(JsonInclude.Include.NON_NULL)
33 | public class ChatCompletionFunctionCall {
34 |
35 | /**
36 | * The name of the function to call.
37 | */
38 | private String name;
39 |
40 | /**
41 | * The arguments to call the function with, as generated by the model in JSON format.
42 | *
Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema.
43 | *
Validate the arguments in your code before calling your function.
44 | */
45 | private String arguments;
46 | }
47 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/chat/ChatCompletionMessage.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.chat;
18 |
19 | import com.fasterxml.jackson.annotation.JsonInclude;
20 | import com.fasterxml.jackson.annotation.JsonProperty;
21 | import javax.validation.constraints.NotBlank;
22 | import javax.validation.constraints.NotNull;
23 | import lombok.AllArgsConstructor;
24 | import lombok.Builder;
25 | import lombok.Data;
26 | import lombok.NoArgsConstructor;
27 | import lombok.experimental.SuperBuilder;
28 |
29 | /**
30 | * @author lzhpo
31 | */
32 | @Data
33 | @SuperBuilder
34 | @NoArgsConstructor
35 | @AllArgsConstructor
36 | @JsonInclude(JsonInclude.Include.NON_NULL)
37 | public class ChatCompletionMessage {
38 |
39 | /**
40 | * A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
41 | *
42 | *
safety-best-practices
43 | */
44 | @NotBlank
45 | @Builder.Default
46 | private String role = "user";
47 |
48 | /**
49 | * The input content.
50 | */
51 | @NotNull
52 | private String content;
53 |
54 | /**
55 | * The name of the author of this message. May contain a-z, A-Z, 0-9, and underscores, with a maximum length of 64 characters.
56 | */
57 | private String name;
58 |
59 | /**
60 | * The name and arguments of a function that should be called, as generated by the model.
61 | */
62 | @JsonProperty("function_call")
63 | private ChatCompletionFunctionCall functionCall;
64 | }
65 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/chat/ChatCompletionParameter.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.chat;
18 |
19 | import com.fasterxml.jackson.annotation.JsonInclude;
20 | import java.util.List;
21 | import lombok.AllArgsConstructor;
22 | import lombok.Data;
23 | import lombok.NoArgsConstructor;
24 | import lombok.experimental.SuperBuilder;
25 |
26 | /**
27 | * @author lzhpo
28 | */
29 | @Data
30 | @SuperBuilder
31 | @NoArgsConstructor
32 | @AllArgsConstructor
33 | @JsonInclude(JsonInclude.Include.NON_NULL)
34 | public class ChatCompletionParameter {
35 |
36 | /**
37 | * The parameter type.
38 | */
39 | private String type;
40 |
41 | /**
42 | * The parameter properties.
43 | */
44 | private Object properties;
45 |
46 | /**
47 | * The required properties entry from {@link ChatCompletionParameter#properties}.
48 | */
49 | private List required;
50 | }
51 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/chat/ChatCompletionRequest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.chat;
18 |
19 | import cn.hutool.core.collection.ListUtil;
20 | import com.fasterxml.jackson.annotation.JsonInclude;
21 | import com.fasterxml.jackson.annotation.JsonProperty;
22 | import com.lzhpo.chatgpt.entity.CommonConfig;
23 | import java.util.List;
24 | import java.util.Map;
25 | import javax.validation.Valid;
26 | import javax.validation.constraints.Max;
27 | import javax.validation.constraints.Min;
28 | import javax.validation.constraints.NotBlank;
29 | import javax.validation.constraints.NotEmpty;
30 | import lombok.*;
31 | import lombok.experimental.SuperBuilder;
32 |
33 | /**
34 | * @author lzhpo
35 | */
36 | @Data
37 | @SuperBuilder
38 | @NoArgsConstructor
39 | @AllArgsConstructor
40 | @EqualsAndHashCode(callSuper = true)
41 | @JsonInclude(JsonInclude.Include.NON_NULL)
42 | public class ChatCompletionRequest extends CommonConfig {
43 |
44 | /**
45 | * ID of the model to use.
46 | *
47 | *
You can use the List models API to see all of your available models,
48 | * or see our Model overview for descriptions of them.
49 | * Model endpoint compatibility
50 | */
51 | @NotBlank
52 | @Builder.Default
53 | private String model = "gpt-3.5-turbo";
54 |
55 | /**
56 | * The messages to generate chat completions for, in the chat format.
57 | */
58 | @Valid
59 | @NotEmpty
60 | private List messages;
61 |
62 | /**
63 | * A list of functions the model may generate JSON inputs for.
64 | * function-calling-and-other-api-updates
65 | */
66 | private List functions;
67 |
68 | /**
69 | * Controls how the model responds to function calls. "none" means the model does not call a function,
70 | *
and responds to the end-user. "auto" means the model can pick between an end-user or calling a function.
71 | *
Specifying a particular function via {"name":\ "my_function"} forces the model to call that function.
72 | *
73 | *
"none" is the default when no functions are present.
74 | *
"auto" is the default if functions are present.
75 | *
76 | */
77 | @JsonProperty("function_call")
78 | private Object functionCall;
79 |
80 | /**
81 | * If set, partial message deltas will be sent, like in ChatGPT.
82 | * Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a {@code data: [DONE]} message.
83 | *
84 | *
See the OpenAI Cookbook for example code.
85 | */
86 | private Boolean stream;
87 |
88 | /**
89 | * Up to 4 sequences where the API will stop generating further tokens.
90 | */
91 | private String stop;
92 |
93 | /**
94 | * The maximum number of tokens to generate in the chat completion. Defaults to inf.
95 | *
96 | *
The total length of input tokens and generated tokens is limited by the model's context length.
97 | */
98 | @JsonProperty("max_tokens")
99 | private Integer maxTokens;
100 |
101 | /**
102 | * Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far,
103 | * increasing the model's likelihood to talk about new topics.
104 | *
105 | *
See more information about frequency and presence penalties.
106 | */
107 | @Min(-2)
108 | @Max(2)
109 | @JsonProperty("presence_penalty")
110 | private Number presencePenalty;
111 |
112 | /**
113 | * Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far,
114 | * decreasing the model's likelihood to repeat the same line verbatim.
115 | *
116 | *
See more information about frequency and presence penalties.
117 | */
118 | @Min(-2)
119 | @Max(2)
120 | @JsonProperty("frequency_penalty")
121 | private Number frequencyPenalty;
122 |
123 | /**
124 | * Modify the likelihood of specified tokens appearing in the completion.
125 | *
126 | *
Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100.
127 | * Mathematically, the bias is added to the logits generated by the model prior to sampling.
128 | * The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.
129 | */
130 | @JsonProperty("logit_bias")
131 | private Map logitBias;
132 |
133 | /**
134 | * A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
135 | *
136 | *
Learn more.
137 | */
138 | private String user;
139 |
140 | /**
141 | * User {@code content} to create one chat request.
142 | *
143 | * @param content content
144 | */
145 | public static ChatCompletionRequest create(String content) {
146 | ChatCompletionMessage message = new ChatCompletionMessage();
147 | message.setContent(content);
148 | return ChatCompletionRequest.builder().messages(ListUtil.of(message)).build();
149 | }
150 | }
151 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/chat/ChatCompletionResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.chat;
18 |
19 | import com.lzhpo.chatgpt.entity.CommonUsage;
20 | import java.util.List;
21 | import lombok.Data;
22 |
23 | /**
24 | * @author lzhpo
25 | */
26 | @Data
27 | public class ChatCompletionResponse {
28 |
29 | private String id;
30 | private String object;
31 | private Long created;
32 | private String model;
33 | private CommonUsage usage;
34 | private List choices;
35 | }
36 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/completions/CompletionChoice.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.completions;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class CompletionChoice {
27 |
28 | private String text;
29 |
30 | private Long index;
31 |
32 | private Integer logprobs;
33 |
34 | @JsonProperty("finish_reason")
35 | private String finishReason;
36 | }
37 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/completions/CompletionRequest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.completions;
18 |
19 | import com.fasterxml.jackson.annotation.JsonInclude;
20 | import com.fasterxml.jackson.annotation.JsonProperty;
21 | import com.lzhpo.chatgpt.entity.CommonConfig;
22 | import java.util.Map;
23 | import javax.validation.constraints.Max;
24 | import javax.validation.constraints.Min;
25 | import javax.validation.constraints.NotBlank;
26 | import lombok.*;
27 | import lombok.experimental.SuperBuilder;
28 |
29 | /**
30 | * @author lzhpo
31 | */
32 | @Data
33 | @SuperBuilder
34 | @NoArgsConstructor
35 | @AllArgsConstructor
36 | @EqualsAndHashCode(callSuper = true)
37 | @JsonInclude(JsonInclude.Include.NON_NULL)
38 | public class CompletionRequest extends CommonConfig {
39 |
40 | /**
41 | * ID of the model to use.
42 | *
43 | *
You can use the List models API to see all of your available models,
44 | * or see our Model overview for descriptions of them.
45 | * Model endpoint compatibility
46 | */
47 | @NotBlank
48 | @Builder.Default
49 | private String model = "text-davinci-003";
50 |
51 | /**
52 | * The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.
53 | *
54 | *
Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.
55 | */
56 | private String prompt;
57 |
58 | /**
59 | * The suffix that comes after a completion of inserted text.
60 | */
61 | private String suffix;
62 |
63 | /**
64 | * The maximum number of tokens to generate in the completion.
65 | *
66 | *
The token count of your prompt plus max_tokens cannot exceed the model's context length.
67 | * Most models have a context length of 2048 tokens (except for the newest models, which support 4096).
68 | */
69 | @JsonProperty("max_tokens")
70 | private Integer maxTokens;
71 |
72 | /**
73 | * If set, partial message deltas will be sent, like in ChatGPT.
74 | * Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a {@code data: [DONE]} message.
75 | *
76 | *
See the OpenAI Cookbook for example code.
77 | */
78 | private Boolean stream;
79 |
80 | /**
81 | * Include the log probabilities on the logprobs most likely tokens, as well the chosen tokens.
82 | * For example, if logprobs is 5, the API will return a list of the 5 most likely tokens.
83 | * The API will always return the logprob of the sampled token, so there may be up to logprobs+1 elements in the response.
84 | *
85 | *
The maximum value for logprobs is 5. If you need more than this, please contact us through our Help center and describe your use case.
86 | */
87 | private Integer logprobs;
88 |
89 | /**
90 | * Echo back the prompt in addition to the completion.
91 | */
92 | private String echo;
93 |
94 | /**
95 | * Up to 4 sequences where the API will stop generating further tokens.
96 | * The returned text will not contain the stop sequence.
97 | */
98 | private String stop;
99 |
100 | /**
101 | * Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far,
102 | * increasing the model's likelihood to talk about new topics.
103 | *
104 | *
See more information about frequency and presence penalties.
105 | */
106 | @Min(-2)
107 | @Max(2)
108 | @JsonProperty("presence_penalty")
109 | private Number presencePenalty;
110 |
111 | /**
112 | * Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far,
113 | * decreasing the model's likelihood to repeat the same line verbatim.
114 | *
115 | *
See more information about frequency and presence penalties.
116 | */
117 | @Min(-2)
118 | @Max(2)
119 | @JsonProperty("frequency_penalty")
120 | private Number frequencyPenalty;
121 |
122 | /**
123 | * Generates best_of completions server-side and returns the "best" (the one with the highest log probability per token). Results cannot be streamed.
124 | *
125 | *
When used with n, best_of controls the number of candidate completions and n specifies how many to return – best_of must be greater than n.
126 | *
127 | *
Note: Because this parameter generates many completions, it can quickly consume your token quota.
128 | * Use carefully and ensure that you have reasonable settings for max_tokens and stop.
129 | */
130 | @JsonProperty("best_of")
131 | private Integer bestOf;
132 |
133 | /**
134 | * Modify the likelihood of specified tokens appearing in the completion.
135 | *
136 | *
Accepts a json object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100.
137 | * You can use this tokenizer tool (which works for both GPT-2 and GPT-3) to convert text to token IDs.
138 | * Mathematically, the bias is added to the logits generated by the model prior to sampling.
139 | * The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection;
140 | * values like -100 or 100 should result in a ban or exclusive selection of the relevant token.
141 | *
142 | *
As an example, you can pass {"50256": -100} to prevent the <|endoftext|> token from being generated.
143 | */
144 | @JsonProperty("logit_bias")
145 | private Map logitBias;
146 |
147 | /**
148 | * A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
149 | *
150 | *
Learn more.
151 | */
152 | private String user;
153 | }
154 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/completions/CompletionResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.completions;
18 |
19 | import com.lzhpo.chatgpt.entity.CommonUsage;
20 | import java.util.List;
21 | import lombok.Data;
22 |
23 | /**
24 | * @author lzhpo
25 | */
26 | @Data
27 | public class CompletionResponse {
28 |
29 | private String id;
30 | private String object;
31 | private Long created;
32 | private String model;
33 | private CommonUsage usage;
34 | private List choices;
35 | }
36 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/edit/EditChoice.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.edit;
18 |
19 | import lombok.Data;
20 |
21 | /**
22 | * @author lzhpo
23 | */
24 | @Data
25 | public class EditChoice {
26 |
27 | private String text;
28 | private Long index;
29 | }
30 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/edit/EditRequest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.edit;
18 |
19 | import com.fasterxml.jackson.annotation.JsonInclude;
20 | import com.lzhpo.chatgpt.entity.CommonConfig;
21 | import javax.validation.constraints.NotBlank;
22 | import lombok.*;
23 | import lombok.experimental.SuperBuilder;
24 |
25 | /**
26 | * @author lzhpo
27 | */
28 | @Data
29 | @SuperBuilder
30 | @NoArgsConstructor
31 | @AllArgsConstructor
32 | @EqualsAndHashCode(callSuper = true)
33 | @JsonInclude(JsonInclude.Include.NON_NULL)
34 | public class EditRequest extends CommonConfig {
35 |
36 | /**
37 | * ID of the model to use.
38 | *
39 | *
You can use the text-davinci-edit-001 or code-davinci-edit-001 model with this endpoint.
40 | */
41 | @NotBlank
42 | @Builder.Default
43 | private String model = "text-davinci-edit-001";
44 |
45 | /**
46 | * The input text to use as a starting point for the edit.
47 | */
48 | @NotBlank
49 | private String input;
50 |
51 | /**
52 | * The instruction that tells the model how to edit the prompt.
53 | */
54 | @NotBlank
55 | private String instruction;
56 | }
57 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/edit/EditResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.edit;
18 |
19 | import com.lzhpo.chatgpt.entity.CommonUsage;
20 | import java.util.List;
21 | import lombok.Data;
22 |
23 | /**
24 | * @author lzhpo
25 | */
26 | @Data
27 | public class EditResponse {
28 |
29 | private String object;
30 | private Long created;
31 | private List choices;
32 | private CommonUsage usage;
33 | }
34 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/embeddings/EmbeddingData.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.embeddings;
18 |
19 | import java.math.BigDecimal;
20 | import java.util.List;
21 | import lombok.Data;
22 |
23 | /**
24 | * @author lzhpo
25 | */
26 | @Data
27 | public class EmbeddingData {
28 |
29 | private String object;
30 | private List embedding;
31 | private Long index;
32 | }
33 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/embeddings/EmbeddingRequest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.embeddings;
18 |
19 | import com.fasterxml.jackson.annotation.JsonInclude;
20 | import java.util.List;
21 | import javax.validation.constraints.NotBlank;
22 | import javax.validation.constraints.NotEmpty;
23 | import lombok.AllArgsConstructor;
24 | import lombok.Builder;
25 | import lombok.Data;
26 | import lombok.NoArgsConstructor;
27 |
28 | /**
29 | * @author lzhpo
30 | */
31 | @Data
32 | @Builder
33 | @NoArgsConstructor
34 | @AllArgsConstructor
35 | @JsonInclude(JsonInclude.Include.NON_NULL)
36 | public class EmbeddingRequest {
37 |
38 | /**
39 | * ID of the model to use.
40 | *
41 | *
You can use the List models API to see all of your available models,
42 | * or see our Model overview for descriptions of them.
43 | * Model endpoint compatibility
44 | */
45 | @NotBlank
46 | private String model;
47 |
48 | /**
49 | * Input text to get embeddings for, encoded as a string or array of tokens.
50 | * To get embeddings for multiple inputs in a single request, pass an array of strings or array of token arrays.
51 | * Each input must not exceed 8192 tokens in length.
52 | */
53 | @NotEmpty
54 | private List input;
55 |
56 | /**
57 | * A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
58 | * Learn more.
59 | */
60 | private String user;
61 | }
62 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/embeddings/EmbeddingResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.embeddings;
18 |
19 | import com.lzhpo.chatgpt.entity.CommonUsage;
20 | import java.util.List;
21 | import lombok.Data;
22 |
23 | /**
24 | * @author lzhpo
25 | */
26 | @Data
27 | public class EmbeddingResponse {
28 |
29 | private String object;
30 | private List data;
31 | private String model;
32 | private CommonUsage usage;
33 | }
34 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/files/DeleteFileResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.files;
18 |
19 | import lombok.Data;
20 |
21 | /**
22 | * @author lzhpo
23 | */
24 | @Data
25 | public class DeleteFileResponse {
26 |
27 | private String id;
28 | private String object;
29 | private String deleted;
30 | }
31 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/files/ListFileData.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.files;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class ListFileData {
27 |
28 | private String id;
29 |
30 | private String object;
31 |
32 | private Long bytes;
33 |
34 | @JsonProperty("created_at")
35 | private Long createdAt;
36 |
37 | private String filename;
38 |
39 | private String purpose;
40 | }
41 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/files/ListFileResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.files;
18 |
19 | import java.util.List;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class ListFileResponse {
27 |
28 | private List data;
29 | }
30 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/files/RetrieveFileResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.files;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class RetrieveFileResponse {
27 |
28 | private String id;
29 |
30 | private String object;
31 |
32 | private Long bytes;
33 |
34 | @JsonProperty("created_at")
35 | private Long createdAt;
36 |
37 | private String filename;
38 |
39 | private String purpose;
40 | }
41 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/files/UploadFileResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.files;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class UploadFileResponse {
27 |
28 | private String id;
29 |
30 | private String object;
31 |
32 | private Long bytes;
33 |
34 | @JsonProperty("created_at")
35 | private Long createdAt;
36 |
37 | private String filename;
38 |
39 | private String purpose;
40 | }
41 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/finetunes/CancelFineTuneEvent.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.finetunes;
18 |
19 | import lombok.Data;
20 |
21 | /**
22 | * @author lzhpo
23 | */
24 | @Data
25 | public class CancelFineTuneEvent {
26 |
27 | private String type;
28 | private String time;
29 | private String message;
30 | }
31 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/finetunes/CancelFineTuneResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.finetunes;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import java.util.List;
21 | import lombok.Data;
22 |
23 | /**
24 | * @author lzhpo
25 | */
26 | @Data
27 | public class CancelFineTuneResponse {
28 |
29 | private String id;
30 |
31 | private String object;
32 |
33 | private String model;
34 |
35 | @JsonProperty("created_at")
36 | private Long createdAt;
37 |
38 | private List events;
39 |
40 | @JsonProperty("fine_tuned_model")
41 | private String fineTunedModel;
42 |
43 | private Hyperparams hyperparams;
44 |
45 | @JsonProperty("organization_id")
46 | private String organizationId;
47 |
48 | @JsonProperty("result_files")
49 | private List resultFiles;
50 |
51 | private String status;
52 |
53 | @JsonProperty("validation_files")
54 | private List validationFiles;
55 |
56 | @JsonProperty("training_files")
57 | private List trainingFiles;
58 |
59 | @JsonProperty("updated_at")
60 | private Long updatedAt;
61 | }
62 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/finetunes/CreateFineTuneEvents.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.finetunes;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class CreateFineTuneEvents {
27 |
28 | private String object;
29 |
30 | @JsonProperty("created_at")
31 | private Long createdAt;
32 |
33 | private String level;
34 |
35 | private String message;
36 | }
37 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/finetunes/CreateFineTuneRequest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.finetunes;
18 |
19 | import com.fasterxml.jackson.annotation.JsonInclude;
20 | import com.fasterxml.jackson.annotation.JsonProperty;
21 | import java.util.List;
22 | import javax.validation.constraints.NotBlank;
23 | import lombok.AllArgsConstructor;
24 | import lombok.Builder;
25 | import lombok.Data;
26 | import lombok.NoArgsConstructor;
27 |
28 | /**
29 | * @author lzhpo
30 | */
31 | @Data
32 | @Builder
33 | @NoArgsConstructor
34 | @AllArgsConstructor
35 | @JsonInclude(JsonInclude.Include.NON_NULL)
36 | public class CreateFineTuneRequest {
37 |
38 | /**
39 | * The ID of an uploaded file that contains training data.
40 | *
41 | *
See upload file for how to upload a file.
42 | *
43 | *
Your dataset must be formatted as a JSONL file, where each training example is a JSON object with the keys "prompt" and "completion".
44 | * Additionally, you must upload your file with the purpose fine-tune. See the fine-tuning guide for more details.
45 | */
46 | @NotBlank
47 | @JsonProperty("training_file")
48 | private String trainingFile;
49 |
50 | /**
51 | * The ID of an uploaded file that contains validation data.
52 | *
53 | *
If you provide this file, the data is used to generate validation metrics periodically during fine-tuning.
54 | * These metrics can be viewed in the fine-tuning results file.
55 | * Your train and validation data should be mutually exclusive.
56 | *
57 | *
Your dataset must be formatted as a JSONL file, where each validation example is a JSON object with the keys "prompt" and "completion".
58 | * Additionally, you must upload your file with the purpose fine-tune.
59 | * See the fine-tuning guide for more details.
60 | */
61 | @JsonProperty("validation_file")
62 | private String validationFile;
63 |
64 | /**
65 | * The name of the base model to fine-tune.
66 | *
67 | *
You can select one of "ada", "babbage", "curie", "davinci", or a fine-tuned model created after 2022-04-21.
68 | * To learn more about these models, see the Models documentation.
69 | */
70 | private String model;
71 |
72 | /**
73 | * The number of epochs to train the model for.
74 | *
75 | *
An epoch refers to one full cycle through the training dataset.
76 | */
77 | @JsonProperty("n_epochs")
78 | private Integer nEpochs;
79 |
80 | /**
81 | * The batch size to use for training.
82 | *
83 | *
The batch size is the number of training examples used to train a single forward and backward pass.
84 | *
85 | *
By default, the batch size will be dynamically configured to be ~0.2% of the number of examples in the training set,
86 | * capped at 256 - in general, we've found that larger batch sizes tend to work better for larger datasets.
87 | */
88 | @JsonProperty("batch_size")
89 | private Integer batchSize;
90 |
91 | /**
92 | * The learning rate multiplier to use for training.
93 | *
94 | *
The fine-tuning learning rate is the original learning rate used for pretraining multiplied by this value.
95 | *
96 | *
By default, the learning rate multiplier is the 0.05, 0.1, or 0.2 depending on final batch_size (larger learning rates tend to perform better with larger batch sizes).
97 | * We recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results.
98 | */
99 | @JsonProperty("learning_rate_multiplier")
100 | private Number learningRateMultiplier;
101 |
102 | /**
103 | * The weight to use for loss on the prompt tokens.
104 | *
105 | *
This controls how much the model tries to learn to generate the prompt (as compared to the completion which always has a weight of 1.0),
106 | * and can add a stabilizing effect to training when completions are short.
107 | *
108 | *
If prompts are extremely long (relative to completions),
109 | * it may make sense to reduce this weight so as to avoid over-prioritizing learning the prompt.
110 | */
111 | @JsonProperty("prompt_loss_weight")
112 | private Number promptLossWeight;
113 |
114 | /**
115 | * If set, we calculate classification-specific metrics such as accuracy and F-1 score using the validation set at the end of every epoch.
116 | * These metrics can be viewed in the results file.
117 | *
118 | *
In order to compute classification metrics, you must provide a validation_file.
119 | * Additionally, you must specify classification_n_classes for multiclass classification or classification_positive_class for binary classification.
120 | */
121 | @JsonProperty("compute_classification_metrics")
122 | private Boolean computeClassificationMetrics;
123 |
124 | /**
125 | * The number of classes in a classification task.
126 | *
127 | *
This parameter is required for multiclass classification.
128 | */
129 | @JsonProperty("classification_n_classes")
130 | private Integer classificationNClasses;
131 |
132 | /**
133 | * The positive class in binary classification.
134 | *
135 | *
This parameter is needed to generate precision, recall, and F1 metrics when doing binary classification.
136 | */
137 | @JsonProperty("classification_positive_class")
138 | private String classificationPositiveClass;
139 |
140 | /**
141 | * If this is provided, we calculate F-beta scores at the specified beta values.
142 | * The F-beta score is a generalization of F-1 score. This is only used for binary classification.
143 | *
144 | *
With a beta of 1 (i.e. the F-1 score), precision and recall are given the same weight.
145 | * A larger beta score puts more weight on recall and less on precision.
146 | * A smaller beta score puts more weight on precision and less on recall.
147 | */
148 | @JsonProperty("classification_betas")
149 | private List classificationBetas;
150 |
151 | /**
152 | * A string of up to 40 characters that will be added to your fine-tuned model name.
153 | *
154 | *
For example, a suffix of "custom-model-name" would produce a model name like ada:ft-your-org:custom-model-name-2022-02-15-04-21-04.
155 | */
156 | private String suffix;
157 | }
158 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/finetunes/CreateFineTuneResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.finetunes;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import java.util.List;
21 | import lombok.Data;
22 |
23 | /**
24 | * @author lzhpo
25 | */
26 | @Data
27 | public class CreateFineTuneResponse {
28 |
29 | private String id;
30 |
31 | private String object;
32 |
33 | private String model;
34 |
35 | @JsonProperty("created_at")
36 | private Long createdAt;
37 |
38 | @JsonProperty("fine_tuned_model")
39 | private String fineTunedModel;
40 |
41 | private Hyperparams hyperparams;
42 |
43 | @JsonProperty("organization_id")
44 | private String organizationId;
45 |
46 | private String status;
47 |
48 | @JsonProperty("updated_at")
49 | private Long updatedAt;
50 |
51 | private List events;
52 |
53 | @JsonProperty("result_files")
54 | private List resultFiles;
55 |
56 | @JsonProperty("validation_files")
57 | private List validationFiles;
58 |
59 | @JsonProperty("training_files")
60 | private List trainingFiles;
61 | }
62 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/finetunes/DeleteFineTuneModelResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.finetunes;
18 |
19 | import lombok.Data;
20 |
21 | /**
22 | * @author lzhpo
23 | */
24 | @Data
25 | public class DeleteFineTuneModelResponse {
26 |
27 | private String id;
28 | private String object;
29 | private Boolean deleted;
30 | }
31 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/finetunes/FineTuneEvent.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.finetunes;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class FineTuneEvent {
27 |
28 | private String object;
29 |
30 | @JsonProperty("created_at")
31 | private Long createdAt;
32 |
33 | private String level;
34 |
35 | private String message;
36 | }
37 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/finetunes/FineTuneFiles.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.finetunes;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class FineTuneFiles {
27 |
28 | private String id;
29 |
30 | private String object;
31 |
32 | private Long bytes;
33 |
34 | @JsonProperty("created_at")
35 | private Long createdAt;
36 |
37 | private String filename;
38 |
39 | private String purpose;
40 |
41 | private String status;
42 |
43 | @JsonProperty("status_details")
44 | private String statusDetails;
45 | }
46 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/finetunes/Hyperparams.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.finetunes;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import java.math.BigDecimal;
21 | import lombok.Data;
22 |
23 | /**
24 | * @author lzhpo
25 | */
26 | @Data
27 | public class Hyperparams {
28 |
29 | @JsonProperty("batch_size")
30 | private Integer batchSize;
31 |
32 | @JsonProperty("learning_rate_multiplier")
33 | private BigDecimal learningRateMultiplier;
34 |
35 | @JsonProperty("n_epochs")
36 | private Integer nEpochs;
37 |
38 | @JsonProperty("prompt_loss_weight")
39 | private BigDecimal prompt_loss_weight;
40 | }
41 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/finetunes/ListFineTuneData.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.finetunes;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import java.util.List;
21 | import lombok.Data;
22 |
23 | /**
24 | * @author lzhpo
25 | */
26 | @Data
27 | public class ListFineTuneData {
28 |
29 | private String id;
30 |
31 | private String object;
32 |
33 | private String model;
34 |
35 | @JsonProperty("created_at")
36 | private Long createdAt;
37 |
38 | @JsonProperty("fine_tuned_model")
39 | private String fineTunedModel;
40 |
41 | private Hyperparams hyperparams;
42 |
43 | @JsonProperty("organizationId")
44 | private String organizationId;
45 |
46 | @JsonProperty("result_files")
47 | private List resultFiles;
48 |
49 | private String status;
50 |
51 | @JsonProperty("validation_files")
52 | private List validationFiles;
53 |
54 | @JsonProperty("training_files")
55 | private List trainingFiles;
56 |
57 | @JsonProperty("updated_at")
58 | private Long updatedAt;
59 | }
60 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/finetunes/ListFineTuneEventData.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.finetunes;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class ListFineTuneEventData {
27 |
28 | private String object;
29 |
30 | @JsonProperty("created_at")
31 | private Long createdAt;
32 |
33 | private String level;
34 |
35 | private String message;
36 | }
37 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/finetunes/ListFineTuneEventResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.finetunes;
18 |
19 | import java.util.List;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class ListFineTuneEventResponse {
27 |
28 | private String object;
29 | private List data;
30 | }
31 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/finetunes/ListFineTuneResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.finetunes;
18 |
19 | import java.util.List;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class ListFineTuneResponse {
27 |
28 | private String object;
29 | private List data;
30 | }
31 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/finetunes/RetrieveFineTuneResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.finetunes;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import java.util.List;
21 | import lombok.Data;
22 |
23 | /**
24 | * @author lzhpo
25 | */
26 | @Data
27 | public class RetrieveFineTuneResponse {
28 |
29 | private String id;
30 |
31 | private String object;
32 |
33 | private String model;
34 |
35 | @JsonProperty("created_at")
36 | private Long createdAt;
37 |
38 | private List events;
39 |
40 | @JsonProperty("fine_tuned_model")
41 | private String fineTunedModel;
42 |
43 | private Hyperparams hyperparams;
44 |
45 | @JsonProperty("organization_id")
46 | private String organizationId;
47 |
48 | @JsonProperty("result_files")
49 | private List resultFiles;
50 |
51 | private String status;
52 |
53 | @JsonProperty("validation_files")
54 | private List validationFiles;
55 |
56 | @JsonProperty("training_files")
57 | private List trainingFiles;
58 |
59 | @JsonProperty("updated_at")
60 | private Long updatedAt;
61 | }
62 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/image/CreateImageRequest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.image;
18 |
19 | import com.fasterxml.jackson.annotation.JsonInclude;
20 | import javax.validation.constraints.NotBlank;
21 | import lombok.*;
22 | import lombok.experimental.SuperBuilder;
23 | import org.hibernate.validator.constraints.Length;
24 |
25 | /**
26 | * @author lzhpo
27 | */
28 | @Data
29 | @SuperBuilder
30 | @NoArgsConstructor
31 | @AllArgsConstructor
32 | @EqualsAndHashCode(callSuper = true)
33 | @JsonInclude(JsonInclude.Include.NON_NULL)
34 | public class CreateImageRequest extends CreateImageVariationRequest {
35 |
36 | /**
37 | * A text description of the desired image(s). The maximum length is 1000 characters.
38 | */
39 | @NotBlank
40 | @Length(max = 1000)
41 | private String prompt;
42 | }
43 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/image/CreateImageResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.image;
18 |
19 | import java.util.List;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class CreateImageResponse {
27 |
28 | private Long created;
29 | private List data;
30 | }
31 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/image/CreateImageResponseFormat.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.image;
18 |
19 | import com.fasterxml.jackson.annotation.JsonValue;
20 | import lombok.AllArgsConstructor;
21 | import lombok.Getter;
22 |
23 | /**
24 | * @author lzhpo
25 | */
26 | @Getter
27 | @AllArgsConstructor
28 | public enum CreateImageResponseFormat {
29 |
30 | /**
31 | * The url.
32 | */
33 | URL("url"),
34 |
35 | /**
36 | * The b64_json.
37 | */
38 | B64_JSON("b64_json");
39 |
40 | @JsonValue
41 | private final String value;
42 | }
43 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/image/CreateImageSize.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.image;
18 |
19 | import com.fasterxml.jackson.annotation.JsonValue;
20 | import lombok.AllArgsConstructor;
21 | import lombok.Getter;
22 |
23 | /**
24 | * @author lzhpo
25 | */
26 | @Getter
27 | @AllArgsConstructor
28 | public enum CreateImageSize {
29 | X_256_256("256x256"),
30 |
31 | X_512_512("512x512"),
32 |
33 | X_1024_1024("1024x1024");
34 |
35 | @JsonValue
36 | private final String value;
37 | }
38 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/image/CreateImageUrl.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.image;
18 |
19 | import lombok.Data;
20 |
21 | /**
22 | * @author lzhpo
23 | */
24 | @Data
25 | public class CreateImageUrl {
26 |
27 | private String url;
28 | }
29 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/image/CreateImageVariationRequest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.image;
18 |
19 | import com.fasterxml.jackson.annotation.JsonInclude;
20 | import com.fasterxml.jackson.annotation.JsonProperty;
21 | import javax.validation.constraints.Max;
22 | import javax.validation.constraints.Min;
23 | import lombok.*;
24 | import lombok.experimental.SuperBuilder;
25 |
26 | /**
27 | * @author lzhpo
28 | */
29 | @Data
30 | @SuperBuilder
31 | @NoArgsConstructor
32 | @AllArgsConstructor
33 | @JsonInclude(JsonInclude.Include.NON_NULL)
34 | public class CreateImageVariationRequest {
35 |
36 | /**
37 | * The number of images to generate. Must be between 1 and 10.
38 | */
39 | @Min(1)
40 | @Max(10)
41 | private Integer n;
42 |
43 | /**
44 | * The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.
45 | */
46 | private CreateImageSize size;
47 |
48 | /**
49 | * The format in which the generated images are returned. Must be one of url or b64_json.
50 | */
51 | @JsonProperty("response_format")
52 | private CreateImageResponseFormat responseFormat;
53 |
54 | /**
55 | * A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
56 | * Learn more.
57 | */
58 | private String user;
59 | }
60 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/model/ListModelsResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.model;
18 |
19 | import java.util.List;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class ListModelsResponse {
27 |
28 | private List data;
29 | }
30 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/model/ModelPermission.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.model;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class ModelPermission {
27 |
28 | private String id;
29 |
30 | private String object;
31 |
32 | private Long created;
33 |
34 | @JsonProperty("allow_create_engine")
35 | private String allowCreateEngine;
36 |
37 | @JsonProperty("allow_sampling")
38 | private String allowSampling;
39 |
40 | @JsonProperty("allow_logprobs")
41 | private String allowLogprobs;
42 |
43 | @JsonProperty("allow_search_indices")
44 | private String allowSearchIndices;
45 |
46 | @JsonProperty("allow_view")
47 | private String allowView;
48 |
49 | @JsonProperty("allow_fine_tuning")
50 | private String allowFineTuning;
51 |
52 | private String organization;
53 |
54 | private String group;
55 |
56 | @JsonProperty("is_blocking")
57 | private Boolean blocking;
58 | }
59 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/model/RetrieveModelResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.model;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import java.util.List;
21 | import lombok.Data;
22 |
23 | /**
24 | * @author lzhpo
25 | */
26 | @Data
27 | public class RetrieveModelResponse {
28 |
29 | private String id;
30 |
31 | private String object;
32 |
33 | @JsonProperty("owned_by")
34 | private String ownedBy;
35 |
36 | private List permission;
37 | }
38 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/moderations/ModerationCategory.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.moderations;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class ModerationCategory {
27 |
28 | private Boolean hate;
29 |
30 | @JsonProperty("hate/threatening")
31 | private Boolean threatening;
32 |
33 | @JsonProperty("self-harm")
34 | private Boolean selfHarm;
35 |
36 | private Boolean sexual;
37 |
38 | @JsonProperty("sexual/minors")
39 | private Boolean minors;
40 |
41 | private Boolean violence;
42 |
43 | @JsonProperty("violence/graphic")
44 | private Boolean graphic;
45 | }
46 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/moderations/ModerationCategoryScore.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.moderations;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import java.math.BigDecimal;
21 | import lombok.Data;
22 |
23 | /**
24 | * @author lzhpo
25 | */
26 | @Data
27 | public class ModerationCategoryScore {
28 |
29 | private BigDecimal hate;
30 |
31 | @JsonProperty("hate/threatening")
32 | private BigDecimal threatening;
33 |
34 | @JsonProperty("self-harm")
35 | private BigDecimal selfHarm;
36 |
37 | private BigDecimal sexual;
38 |
39 | @JsonProperty("sexual/minors")
40 | private BigDecimal minors;
41 |
42 | private BigDecimal violence;
43 |
44 | @JsonProperty("violence/graphic")
45 | private BigDecimal graphic;
46 | }
47 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/moderations/ModerationRequest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.moderations;
18 |
19 | import com.fasterxml.jackson.annotation.JsonInclude;
20 | import java.util.List;
21 | import javax.validation.constraints.NotBlank;
22 | import javax.validation.constraints.NotEmpty;
23 | import lombok.*;
24 |
25 | /**
26 | * @author lzhpo
27 | */
28 | @Data
29 | @Builder
30 | @NoArgsConstructor
31 | @AllArgsConstructor
32 | @JsonInclude(JsonInclude.Include.NON_NULL)
33 | public class ModerationRequest {
34 |
35 | /**
36 | * The input text to classify.
37 | */
38 | @NotEmpty
39 | private List input;
40 |
41 | /**
42 | * Two content moderations models are available: text-moderation-stable and text-moderation-latest.
43 | *
44 | *
The default is text-moderation-latest which will be automatically upgraded over time.
45 | * This ensures you are always using our most accurate model.
46 | * If you use text-moderation-stable, we will provide advanced notice before updating the model.
47 | * Accuracy of text-moderation-stable may be slightly lower than for text-moderation-latest.
48 | */
49 | @NotBlank
50 | @Builder.Default
51 | private String model = "text-moderation-latest";
52 | }
53 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/moderations/ModerationResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.moderations;
18 |
19 | import java.util.List;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class ModerationResponse {
27 |
28 | private String id;
29 | private String model;
30 | private List results;
31 | }
32 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/moderations/ModerationResult.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.moderations;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class ModerationResult {
27 |
28 | private ModerationCategory categories;
29 |
30 | @JsonProperty("category_scores")
31 | private ModerationCategoryScore categoryScores;
32 |
33 | private Boolean flagged;
34 | }
35 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/users/UserData.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.users;
18 |
19 | import lombok.Data;
20 |
21 | /**
22 | * @author lzhpo
23 | */
24 | @Data
25 | public class UserData {
26 |
27 | private String object;
28 | private String role;
29 | private Long created;
30 | private UserInfo user;
31 | }
32 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/users/UserInfo.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.users;
18 |
19 | import lombok.Data;
20 |
21 | /**
22 | * @author lzhpo
23 | */
24 | @Data
25 | public class UserInfo {
26 |
27 | private String object;
28 | private String id;
29 | private String name;
30 | private String email;
31 | private String picture;
32 | }
33 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/users/UserMembers.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.users;
18 |
19 | import java.util.List;
20 | import lombok.Data;
21 |
22 | /**
23 | * @author lzhpo
24 | */
25 | @Data
26 | public class UserMembers {
27 |
28 | private String object;
29 | private List data;
30 | }
31 |
--------------------------------------------------------------------------------
/src/main/java/com/lzhpo/chatgpt/entity/users/UserResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023 lzhpo
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package com.lzhpo.chatgpt.entity.users;
18 |
19 | import com.fasterxml.jackson.annotation.JsonProperty;
20 | import java.util.List;
21 | import lombok.Data;
22 |
23 | /**
24 | * @author lzhpo
25 | */
26 | @Data
27 | public class UserResponse {
28 |
29 | private UserMembers members;
30 |
31 | private List