, String> {
13 |
14 | /**
15 | * The template which contains placeholders in the form ${myPlaceholder} that
16 | * are replaced for input documents before creating a request to a LLM.
17 | */
18 | private final String promptTemplate;
19 |
20 | /**
21 | * creates an instance of the {@link LargeLanguageModelChain}
22 | *
23 | * @param promptTemplate {@link #promptTemplate}
24 | */
25 | protected LargeLanguageModelChain(final String promptTemplate) {
26 | this.promptTemplate = promptTemplate;
27 | }
28 |
29 | /**
30 | * @return {@link #promptTemplate}
31 | */
32 | protected final String getPromptTemplate() {
33 | return promptTemplate;
34 | }
35 | }
36 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/llm/azure/chat/AzureOpenAiChatCompletionsChain.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.azure.chat;
2 |
3 | import java.net.URI;
4 |
5 | import org.springframework.http.MediaType;
6 | import org.springframework.web.reactive.function.BodyInserters;
7 | import org.springframework.web.reactive.function.client.WebClient;
8 | import org.springframework.web.reactive.function.client.WebClient.ResponseSpec;
9 | import org.springframework.web.util.UriComponentsBuilder;
10 |
11 | import com.fasterxml.jackson.databind.ObjectMapper;
12 |
13 | import io.github.cupybara.javalangchains.chains.llm.openai.chat.OpenAiChatCompletionsChain;
14 | import io.github.cupybara.javalangchains.chains.llm.openai.chat.OpenAiChatCompletionsParameters;
15 | import io.github.cupybara.javalangchains.chains.llm.openai.chat.OpenAiChatCompletionsRequest;
16 |
17 | /**
18 | * {@link OpenAiChatCompletionsChain} adopted for usage of Azure OpenAI Services
19 | */
20 | public final class AzureOpenAiChatCompletionsChain extends OpenAiChatCompletionsChain {
21 |
22 | private final URI requestUri;
23 |
24 | /**
25 | * @param resourceName Name of the azure resource
26 | * @param deploymentName Name of the azure openai service deployment
27 | * @param apiVersion The target API Version
28 | * @param promptTemplate The template which contains placeholders in the form
29 | * ${myPlaceholder} that are replaced for input documents
30 | * before creating a request to a LLM.
31 | * @param parameters The {@link OpenAiChatCompletionsParameters} allows to
32 | * finetune requests to the OpenAI API
33 | * @param apiKey The API-Key used for Authentication (passed using the
34 | * "api-key" Header)
35 | * @param systemTemplate The template for the system role which contains
36 | * placeholders in the form ${myPlaceholder} that are
37 | * replaced for input documents before creating a request
38 | * to a LLM.
39 | * @param objectMapper The {@link ObjectMapper} used for body serialization
40 | * and deserialization
41 | * @param webClient The {@link WebClient} used for executing requests to
42 | * the OpenAI API
43 | */
44 | public AzureOpenAiChatCompletionsChain(final String resourceName, final String deploymentName,
45 | final String apiVersion, final String promptTemplate, final OpenAiChatCompletionsParameters parameters,
46 | final String apiKey, final String systemTemplate, final ObjectMapper objectMapper,
47 | final WebClient webClient) {
48 | super(promptTemplate, parameters, apiKey, systemTemplate, objectMapper, webClient);
49 |
50 | if (parameters.getModel() != null) {
51 | throw new IllegalArgumentException(
52 | "the model parameter cannot be used for the Azure OpenAI Services, it is passed via deploymentName instead");
53 | }
54 |
55 | this.requestUri = UriComponentsBuilder.newInstance().scheme("https")
56 | .host(String.format("%s.openai.azure.com", resourceName)).queryParam("api-version", apiVersion)
57 | .path(String.format("/openai/deployments/%s/chat/completions", deploymentName)).build().toUri();
58 | }
59 |
60 | /**
61 | * @param resourceName Name of the azure resource
62 | * @param deploymentName Name of the azure openai service deployment
63 | * @param apiVersion The target API Version
64 | * @param promptTemplate The template which contains placeholders in the form
65 | * ${myPlaceholder} that are replaced for input documents
66 | * before creating a request to a LLM.
67 | * @param parameters The {@link OpenAiChatCompletionsParameters} allows to
68 | * finetune requests to the OpenAI API
69 | * @param apiKey The API-Key used for Authentication (passed using the
70 | * "api-key" Header)
71 | * @param systemTemplate The template for the system role which contains
72 | * placeholders in the form ${myPlaceholder} that are
73 | * replaced for input documents before creating a request
74 | */
75 | public AzureOpenAiChatCompletionsChain(final String resourceName, final String deploymentName,
76 | final String apiVersion, final String promptTemplate, final OpenAiChatCompletionsParameters parameters,
77 | final String apiKey, final String systemTemplate) {
78 | this(resourceName, deploymentName, apiVersion, promptTemplate, parameters, apiKey, systemTemplate,
79 | createDefaultObjectMapper(), createDefaultWebClient());
80 | }
81 |
82 | /**
83 | * @param resourceName Name of the azure resource
84 | * @param deploymentName Name of the azure openai service deployment
85 | * @param apiVersion The target API Version
86 | * @param promptTemplate The template which contains placeholders in the form
87 | * ${myPlaceholder} that are replaced for input documents
88 | * before creating a request to a LLM.
89 | * @param parameters The {@link OpenAiChatCompletionsParameters} allows to
90 | * finetune requests to the OpenAI API
91 | * @param apiKey The API-Key used for Authentication (passed using the
92 | * "api-key" Header)
93 | */
94 | public AzureOpenAiChatCompletionsChain(final String resourceName, final String deploymentName,
95 | final String apiVersion, final String promptTemplate, final OpenAiChatCompletionsParameters parameters,
96 | final String apiKey) {
97 | this(resourceName, deploymentName, apiVersion, promptTemplate, parameters, apiKey, null);
98 | }
99 |
100 | @Override
101 | protected ResponseSpec createResponseSpec(final OpenAiChatCompletionsRequest request, final WebClient webClient,
102 | final ObjectMapper objectMapper) {
103 | return webClient.post().uri(requestUri).contentType(MediaType.APPLICATION_JSON).header("api-key", getApiKey())
104 | .body(BodyInserters.fromValue(requestToBody(request, objectMapper))).retrieve();
105 | }
106 | }
107 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/llm/azure/completions/AzureOpenAiCompletionsChain.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.azure.completions;
2 |
3 | import java.net.URI;
4 |
5 | import org.springframework.http.MediaType;
6 | import org.springframework.web.reactive.function.BodyInserters;
7 | import org.springframework.web.reactive.function.client.WebClient;
8 | import org.springframework.web.reactive.function.client.WebClient.ResponseSpec;
9 | import org.springframework.web.util.UriComponentsBuilder;
10 |
11 | import com.fasterxml.jackson.databind.ObjectMapper;
12 |
13 | import io.github.cupybara.javalangchains.chains.llm.openai.chat.OpenAiChatCompletionsParameters;
14 | import io.github.cupybara.javalangchains.chains.llm.openai.completions.OpenAiCompletionsChain;
15 | import io.github.cupybara.javalangchains.chains.llm.openai.completions.OpenAiCompletionsParameters;
16 | import io.github.cupybara.javalangchains.chains.llm.openai.completions.OpenAiCompletionsRequest;
17 |
18 | /**
19 | * {@link OpenAiCompletionsChain} adopted for usage of Azure OpenAI Services
20 | */
21 | public final class AzureOpenAiCompletionsChain extends OpenAiCompletionsChain {
22 |
23 | private final URI requestUri;
24 |
25 | /**
26 | * @param resourceName Name of the azure resource
27 | * @param deploymentName Name of the azure openai service deployment
28 | * @param apiVersion The target API Version
29 | * @param promptTemplate The template which contains placeholders in the form
30 | * ${myPlaceholder} that are replaced for input documents
31 | * before creating a request to a LLM.
32 | * @param parameters The {@link OpenAiChatCompletionsParameters} allows to
33 | * finetune requests to the OpenAI API
34 | * @param apiKey The API-Key used for Authentication (passed using the
35 | * "api-key" Header)
36 | * @param objectMapper The {@link ObjectMapper} used for body serialization
37 | * and deserialization
38 | * @param webClient The {@link WebClient} used for executing requests to
39 | * the OpenAI API
40 | */
41 | public AzureOpenAiCompletionsChain(final String resourceName, final String deploymentName, final String apiVersion,
42 | final String promptTemplate, final OpenAiCompletionsParameters parameters, final String apiKey,
43 | final ObjectMapper objectMapper, final WebClient webClient) {
44 | super(promptTemplate, parameters, apiKey, objectMapper, webClient);
45 |
46 | if (parameters.getModel() != null) {
47 | throw new IllegalArgumentException(
48 | "the model parameter cannot be used for the Azure OpenAI Services, it is passed via deploymentName instead");
49 | }
50 |
51 | this.requestUri = UriComponentsBuilder.newInstance().scheme("https")
52 | .host(String.format("%s.openai.azure.com", resourceName)).queryParam("api-version", apiVersion)
53 | .path(String.format("/openai/deployments/%s/completions", deploymentName)).build().toUri();
54 | }
55 |
56 | /**
57 | * @param resourceName Name of the azure resource
58 | * @param deploymentName Name of the azure openai service deployment
59 | * @param apiVersion The target API Version
60 | * @param promptTemplate The template which contains placeholders in the form
61 | * ${myPlaceholder} that are replaced for input documents
62 | * before creating a request to a LLM.
63 | * @param parameters The {@link OpenAiChatCompletionsParameters} allows to
64 | * finetune requests to the OpenAI API
65 | * @param apiKey The API-Key used for Authentication (passed using the
66 | * "api-key" Header)
67 | */
68 | public AzureOpenAiCompletionsChain(final String resourceName, final String deploymentName, final String apiVersion,
69 | final String promptTemplate, final OpenAiCompletionsParameters parameters, final String apiKey) {
70 | this(resourceName, deploymentName, apiVersion, promptTemplate, parameters, apiKey, createDefaultObjectMapper(),
71 | createDefaultWebClient());
72 | }
73 |
74 | @Override
75 | protected ResponseSpec createResponseSpec(final OpenAiCompletionsRequest request, final WebClient webClient,
76 | final ObjectMapper objectMapper) {
77 | return webClient.post().uri(requestUri).contentType(MediaType.APPLICATION_JSON).header("api-key", getApiKey())
78 | .body(BodyInserters.fromValue(requestToBody(request, objectMapper))).retrieve();
79 | }
80 | }
81 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/llm/openai/OpenAiChain.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.openai;
2 |
3 | import java.util.Map;
4 |
5 | import org.springframework.http.HttpHeaders;
6 | import org.springframework.http.MediaType;
7 | import org.springframework.web.reactive.function.BodyInserters;
8 | import org.springframework.web.reactive.function.client.WebClient;
9 | import org.springframework.web.reactive.function.client.WebClient.ResponseSpec;
10 | import org.springframework.web.util.UriComponentsBuilder;
11 |
12 | import com.fasterxml.jackson.annotation.JsonInclude;
13 | import com.fasterxml.jackson.core.JsonProcessingException;
14 | import com.fasterxml.jackson.databind.ObjectMapper;
15 |
16 | import io.github.cupybara.javalangchains.chains.llm.LargeLanguageModelChain;
17 |
18 | /**
19 | * {@link LargeLanguageModelChain} for usage with the OpenAI /completions API
20 | *
21 | * @param the static parameter type
22 | * @param the static request type
23 | * @param the static response type
24 | */
25 | public abstract class OpenAiChain, I extends P, O extends OpenAiResponse>
26 | extends LargeLanguageModelChain {
27 |
28 | /**
29 | * The request path (/v1/chat/completions or /v1/completions)
30 | */
31 | private final String requestPath;
32 |
33 | /**
34 | * The response type class
35 | */
36 | private final Class responseClass;
37 |
38 | /**
39 | * The {@link OpenAiParameters} allows to tune requests to the OpenAI API
40 | */
41 | private final P parameters;
42 |
43 | /**
44 | * The API-Key used for Authentication
45 | */
46 | private final String apiKey;
47 |
48 | /**
49 | * The {@link ObjectMapper} used for body serialization and deserialization
50 | */
51 | private final ObjectMapper objectMapper;
52 |
53 | /**
54 | * The {@link WebClient} used for executing requests to the OpenAI API
55 | */
56 | private final WebClient webClient;
57 |
58 | /**
59 | * @param promptTemplate {@link #getPromptTemplate()}
60 | * @param requestPath {@link #requestPath}
61 | * @param responseClass {@link #responseClass}
62 | * @param parameters {@link #parameters}r
63 | * @param apiKey {@link #apiKey}
64 | * @param objectMapper {@link #objectMapper}
65 | * @param webClient {@link #webClient}
66 | */
67 | protected OpenAiChain(final String promptTemplate, final String requestPath, final Class responseClass,
68 | final P parameters, final String apiKey, final ObjectMapper objectMapper, final WebClient webClient) {
69 | super(promptTemplate);
70 | this.requestPath = requestPath;
71 | this.responseClass = responseClass;
72 | this.parameters = parameters;
73 | this.apiKey = apiKey;
74 | this.objectMapper = objectMapper;
75 | this.webClient = webClient;
76 | }
77 |
78 | /**
79 | * @param promptTemplate {@link #getPromptTemplate()}
80 | * @param requestPath {@link #requestPath}
81 | * @param responseClass {@link #responseClass}
82 | * @param parameters {@link #parameters}
83 | * @param apiKey {@link #apiKey}
84 | */
85 | protected OpenAiChain(final String promptTemplate, final String requestPath, final Class responseClass,
86 | final P parameters, final String apiKey) {
87 | this(promptTemplate, requestPath, responseClass, parameters, apiKey, createDefaultObjectMapper(),
88 | createDefaultWebClient());
89 | }
90 |
91 | /**
92 | * creates the request entity from the current document
93 | *
94 | * @param input the current document
95 | * @return the request entity
96 | */
97 | protected abstract I createRequest(final Map input);
98 |
99 | /**
100 | * creates the chain output from the response entity
101 | *
102 | * @param response the response entity
103 | * @return this chain's output
104 | */
105 | protected abstract String createOutput(O response);
106 |
107 | @Override
108 | public String run(final Map input) {
109 | final I request = createRequest(input);
110 | if (parameters != null) {
111 | request.copyFrom(parameters);
112 | }
113 |
114 | return createResponseSpec(request, webClient, objectMapper).bodyToMono(String.class)
115 | .map(responseBody -> bodyToResponse(responseBody, objectMapper)).map(this::createOutput).block();
116 | }
117 |
118 | /**
119 | * executes the request to the OpenAI API. Protected so that it may be
120 | * overridden for other OpenAI API Providers.
121 | *
122 | * @param request the request entity
123 | * @param webClient the {@link WebClient} to use for the request
124 | * @param objectMapper the {@link ObjectMapper} used for body serialization
125 | * @return the {@link ResponseSpec}
126 | */
127 | protected ResponseSpec createResponseSpec(final I request, final WebClient webClient,
128 | final ObjectMapper objectMapper) {
129 | return this.webClient.post()
130 | .uri(UriComponentsBuilder.newInstance().scheme("https").host("api.openai.com").path(requestPath).build()
131 | .toUri())
132 | .contentType(MediaType.APPLICATION_JSON).header(HttpHeaders.AUTHORIZATION, "Bearer " + apiKey)
133 | .body(BodyInserters.fromValue(requestToBody(request, objectMapper))).retrieve();
134 | }
135 |
136 | /**
137 | * Serializes the request entity
138 | *
139 | * @param request the request entity to serialize
140 | * @param objectMapper {@link ObjectMapper} used for serialization
141 | * @return serialized the serialized request body
142 | */
143 | protected String requestToBody(final I request, final ObjectMapper objectMapper) {
144 | try {
145 | return objectMapper.writeValueAsString(request);
146 | } catch (final JsonProcessingException jsonProcessingException) {
147 | throw new IllegalStateException("error creating request body", jsonProcessingException);
148 | }
149 | }
150 |
151 | private O bodyToResponse(final String responseBody, final ObjectMapper objectMapper) {
152 | try {
153 | return objectMapper.readValue(responseBody, this.responseClass);
154 | } catch (final JsonProcessingException jsonProcessingException) {
155 | throw new IllegalStateException("error deserializing responseBody " + responseBody,
156 | jsonProcessingException);
157 | }
158 | }
159 |
160 | /**
161 | * @return {@link #apiKey}p
162 | */
163 | protected final String getApiKey() {
164 | return apiKey;
165 | }
166 |
167 | /**
168 | * @return a default configured {@link ObjectMapper}
169 | */
170 | public static ObjectMapper createDefaultObjectMapper() {
171 | return new ObjectMapper().setSerializationInclusion(JsonInclude.Include.NON_NULL);
172 | }
173 |
174 | /**
175 | * @return a default configured {@link WebClient}
176 | */
177 | public static WebClient createDefaultWebClient() {
178 | return WebClient.create();
179 | }
180 | }
181 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/llm/openai/OpenAiParameters.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.openai;
2 |
3 | import com.fasterxml.jackson.annotation.JsonIgnore;
4 | import com.fasterxml.jackson.annotation.JsonProperty;
5 |
6 | /**
7 | * Contains the intersection of parameters for the /chat/completions and
8 | * /completions api
9 | *
10 | * @param The type of this Parameter Class for typed fluent api return
11 | * values
12 | */
13 | public abstract class OpenAiParameters> {
14 |
15 | /**
16 | * The base type for correctly typed fluent api return values
17 | */
18 | @JsonIgnore
19 | private final Class typeClass;
20 |
21 | /**
22 | * From
23 | * https://github.com/openai/openai-openapi/blob/master/openapi.yaml
24 | *
25 | * The maximum number of tokens allowed for the generated answer. By default,
26 | * the number of tokens the model can return will be (4096 - prompt tokens).
27 | */
28 | @JsonProperty("max_tokens")
29 | private Integer maxTokens;
30 |
31 | /**
32 | * From
33 | * https://github.com/openai/openai-openapi/blob/master/openapi.yaml
34 | *
35 | * ID of the model to use. Currently, only `gpt-3.5-turbo` and
36 | * `gpt-3.5-turbo-0301` are supported.
37 | */
38 | private String model;
39 |
40 | /**
41 | * From
42 | * https://github.com/openai/openai-openapi/blob/master/openapi.yaml
43 | *
44 | * How many completions to generate for each prompt.
45 | **
46 | * Note:** Because this parameter generates many completions, it can quickly
47 | * consume your token quota. Use carefully and ensure that you have reasonable
48 | * settings for `max_tokens` and `stop`.
49 | */
50 | @JsonProperty
51 | private Integer n;
52 |
53 | /**
54 | * From
55 | * https://github.com/openai/openai-openapi/blob/master/openapi.yaml
56 | *
57 | * What sampling temperature to use, between 0 and 2. Higher values like 0.8
58 | * will make the output more random, while lower values like 0.2 will make it
59 | * more focused and deterministic.
60 | *
61 | * We generally recommend altering this or `top_p` but not both.
62 | */
63 | @JsonProperty
64 | private Double temperature;
65 |
66 | /**
67 | * @param typeClass {@link #typeClass}
68 | */
69 | protected OpenAiParameters(final Class typeClass) {
70 | this.typeClass = typeClass;
71 | }
72 |
73 | /**
74 | * @return {@link #maxTokens}
75 | */
76 | public Integer getMaxTokens() {
77 | return maxTokens;
78 | }
79 |
80 | /**
81 | * @param maxTokens {@link #maxTokens}
82 | */
83 | public void setMaxTokens(final Integer maxTokens) {
84 | this.maxTokens = maxTokens;
85 | }
86 |
87 | /**
88 | * @param maxTokens {@link #maxTokens}
89 | * @return this
90 | */
91 | public T maxTokens(final Integer maxTokens) {
92 | setMaxTokens(maxTokens);
93 | return this.typeClass.cast(this);
94 | }
95 |
96 | /**
97 | * @return {@link #model}
98 | */
99 | public String getModel() {
100 | return model;
101 | }
102 |
103 | /**
104 | * @param model {@link #model}
105 | */
106 | public void setModel(final String model) {
107 | this.model = model;
108 | }
109 |
110 | /**
111 | * @param model {@link #model}
112 | * @return this
113 | */
114 | public T model(final String model) {
115 | setModel(model);
116 | return this.typeClass.cast(this);
117 | }
118 |
119 | /**
120 | * @return {@link #n}
121 | */
122 | public Integer getN() {
123 | return n;
124 | }
125 |
126 | /**
127 | * @param n {@link #n}
128 | */
129 | public void setN(final Integer n) {
130 | this.n = n;
131 | }
132 |
133 | /**
134 | * @param n {@link #n}
135 | * @return this
136 | */
137 | public T n(final Integer n) {
138 | setN(n);
139 | return this.typeClass.cast(this);
140 | }
141 |
142 | /**
143 | * @return {@link #temperature}
144 | */
145 | public Double getTemperature() {
146 | return temperature;
147 | }
148 |
149 | /**
150 | * @param temperature {@link #temperature}
151 | */
152 | public void setTemperature(final Double temperature) {
153 | this.temperature = temperature;
154 | }
155 |
156 | /**
157 | * @param temperature {@link #temperature}
158 | * @return this
159 | */
160 | public T temperature(final Double temperature) {
161 | this.setTemperature(temperature);
162 | return this.typeClass.cast(this);
163 | }
164 |
165 | /**
166 | * copies parameter values from another instance of {@link OpenAiParameters}
167 | *
168 | * @param parameters the source {@link OpenAiParameters}
169 | */
170 | public void copyFrom(final T parameters) {
171 | this.setMaxTokens(parameters.getMaxTokens());
172 | this.setModel(parameters.getModel());
173 | this.setN(parameters.getN());
174 | this.setTemperature(parameters.getTemperature());
175 | }
176 | }
177 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/llm/openai/OpenAiResponse.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.openai;
2 |
3 | import java.util.List;
4 |
5 | import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
6 |
7 | /**
8 | * Model class for the response body of an OpenAI request
9 | */
10 | @JsonIgnoreProperties(ignoreUnknown = true)
11 | public abstract class OpenAiResponse {
12 |
13 | /**
14 | * All contained choice instances of the response.
15 | */
16 | private final List choices;
17 |
18 | /**
19 | * @param choices {@link #choices}
20 | */
21 | protected OpenAiResponse(final List choices) {
22 | this.choices = choices;
23 | }
24 |
25 | /**
26 | * @return {@link #choices}
27 | */
28 | public List getChoices() {
29 | return choices;
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/llm/openai/chat/OpenAiChatCompletionsChain.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.openai.chat;
2 |
3 | import java.util.LinkedList;
4 | import java.util.List;
5 | import java.util.Map;
6 |
7 | import org.apache.commons.text.StringSubstitutor;
8 | import org.springframework.web.reactive.function.client.WebClient;
9 |
10 | import com.fasterxml.jackson.databind.ObjectMapper;
11 |
12 | import io.github.cupybara.javalangchains.chains.llm.openai.OpenAiChain;
13 |
14 | /**
15 | * {@link OpenAiChain} for usage with the OpenAI /chat/completions API
16 | */
17 | public class OpenAiChatCompletionsChain extends
18 | OpenAiChain {
19 |
20 | /**
21 | * The template for the system role which contains placeholders in the form
22 | * ${myPlaceholder} that are replaced for input documents before creating a
23 | * request to a LLM.
24 | */
25 | private final String systemTemplate;
26 |
27 | /**
28 | * @param promptTemplate {@link #getPromptTemplate()}
29 | * @param parameters {@link #parameters}r
30 | * @param apiKey {@link #apiKey}
31 | * @param systemTemplate {@link #systemTemplate}
32 | * @param objectMapper {@link #objectMapper}
33 | * @param webClient {@link #webClient}
34 | */
35 | public OpenAiChatCompletionsChain(final String promptTemplate, final OpenAiChatCompletionsParameters parameters,
36 | final String apiKey, final String systemTemplate, final ObjectMapper objectMapper,
37 | final WebClient webClient) {
38 | super(promptTemplate, "/v1/chat/completions", OpenAiChatCompletionsResponse.class, parameters, apiKey,
39 | objectMapper, webClient);
40 | this.systemTemplate = systemTemplate;
41 | }
42 |
43 | /**
44 | * @param promptTemplate {@link #getPromptTemplate()}
45 | * @param parameters {@link #parameters}
46 | * @param apiKey {@link #apiKey}
47 | * @param systemTemplate {@link #systemTemplate}s
48 | */
49 | public OpenAiChatCompletionsChain(final String promptTemplate, final OpenAiChatCompletionsParameters parameters,
50 | final String apiKey, final String systemTemplate) {
51 | this(promptTemplate, parameters, apiKey, systemTemplate, createDefaultObjectMapper(), createDefaultWebClient());
52 | }
53 |
54 | /**
55 | * @param promptTemplate {@link #getPromptTemplate()}
56 | * @param parameters {@link #parameters}
57 | * @param apiKey {@link #apiKey}
58 | */
59 | public OpenAiChatCompletionsChain(final String promptTemplate, final OpenAiChatCompletionsParameters parameters,
60 | final String apiKey) {
61 | this(promptTemplate, parameters, apiKey, null);
62 | }
63 |
64 | @Override
65 | protected OpenAiChatCompletionsRequest createRequest(Map input) {
66 | final List messages = new LinkedList<>();
67 | if (systemTemplate != null) {
68 | messages.add(new OpenAiChatMessage("system", new StringSubstitutor(input).replace(systemTemplate)));
69 | }
70 | messages.add(new OpenAiChatMessage("user", new StringSubstitutor(input).replace(getPromptTemplate())));
71 |
72 | return new OpenAiChatCompletionsRequest(messages);
73 | }
74 |
75 | @Override
76 | protected String createOutput(final OpenAiChatCompletionsResponse response) {
77 | return response.getChoices().get(0).getMessage().getContent();
78 | }
79 | }
80 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/llm/openai/chat/OpenAiChatCompletionsChoice.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.openai.chat;
2 |
3 | import com.fasterxml.jackson.annotation.JsonCreator;
4 | import com.fasterxml.jackson.annotation.JsonCreator.Mode;
5 | import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
6 | import com.fasterxml.jackson.annotation.JsonProperty;
7 |
8 | /**
9 | * Model class for choices in an OpenAI /chat/completions response
10 | */
11 | @JsonIgnoreProperties(ignoreUnknown = true)
12 | public final class OpenAiChatCompletionsChoice {
13 |
14 | /**
15 | * the {@link OpenAiChatMessage} for this response choice
16 | */
17 | private final OpenAiChatMessage message;
18 |
19 | /**
20 | * @param message {@link #message}
21 | */
22 | @JsonCreator(mode = Mode.PROPERTIES)
23 | public OpenAiChatCompletionsChoice(final @JsonProperty("message") OpenAiChatMessage message) {
24 | this.message = message;
25 | }
26 |
27 | /**
28 | * @return {@link #message}
29 | */
30 | public OpenAiChatMessage getMessage() {
31 | return message;
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/llm/openai/chat/OpenAiChatCompletionsParameters.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.openai.chat;
2 |
3 | import java.util.Map;
4 |
5 | import com.fasterxml.jackson.annotation.JsonProperty;
6 |
7 | import io.github.cupybara.javalangchains.chains.llm.openai.OpenAiParameters;
8 |
9 | /**
10 | * Parameters for calling an OpenAI Chat Model
11 | *
12 | * https://platform.openai.com/docs/api-reference/chat/create
13 | */
14 | public class OpenAiChatCompletionsParameters extends OpenAiParameters {
15 |
16 | /**
17 | * From
18 | * https://github.com/openai/openai-openapi/blob/master/openapi.yaml
19 | *
20 | * Number between -2.0 and 2.0. Positive values penalize new tokens based on
21 | * their existing frequency in the text so far, decreasing the model's
22 | * likelihood to repeat the same line verbatim.
23 | */
24 | @JsonProperty("frequence_penalty")
25 | private Double frequencePenalty;
26 |
27 | /**
28 | * From
29 | * https://github.com/openai/openai-openapi/blob/master/openapi.yaml
30 | *
31 | * Modify the likelihood of specified tokens appearing in the completion.
32 | * Accepts a json object that maps tokens (specified by their token ID in the
33 | * tokenizer) to an associated bias value from -100 to 100. Mathematically, the
34 | * bias is added to the logits generated by the model prior to sampling. The
35 | * exact effect will vary per model, but values between -1 and 1 should decrease
36 | * or increase likelihood of selection; values like -100 or 100 should result in
37 | * a ban or exclusive selection of the relevant token.
38 | */
39 | private Map logitBias;
40 |
41 | /**
42 | * From
43 | * https://github.com/openai/openai-openapi/blob/master/openapi.yaml
44 | *
45 | * Number between -2.0 and 2.0. Positive values penalize new tokens based on
46 | * whether they appear in the text so far, increasing the model's likelihood to
47 | * talk about new topics.
48 | */
49 | @JsonProperty("precence_penalty")
50 | private Double presencePenalty;
51 |
52 | /**
53 | * creates an instance of {@link OpenAiChatCompletionsParameters}
54 | */
55 | public OpenAiChatCompletionsParameters() {
56 | super(OpenAiChatCompletionsParameters.class);
57 | }
58 |
59 | /**
60 | * @return {@link #frequencePenalty}
61 | */
62 | public Double getFrequencePenalty() {
63 | return frequencePenalty;
64 | }
65 |
66 | /**
67 | * @param frequencePenalty {@link #frequencePenalty}
68 | */
69 | public void setFrequencePenalty(final Double frequencePenalty) {
70 | this.frequencePenalty = frequencePenalty;
71 | }
72 |
73 | /**
74 | * @param frequencePenalty {@link #frequencePenalty}
75 | * @return this
76 | */
77 | public OpenAiChatCompletionsParameters frequencePenalty(final Double frequencePenalty) {
78 | this.setFrequencePenalty(frequencePenalty);
79 | return this;
80 | }
81 |
82 | /**
83 | * @return {@link #logitBias}
84 | */
85 | public Map getLogitBias() {
86 | return logitBias;
87 | }
88 |
89 | /**
90 | * @param logitBias {@link #logitBias}
91 | */
92 | public void setLogitBias(final Map logitBias) {
93 | this.logitBias = logitBias;
94 | }
95 |
96 | /**
97 | * @param logitBias {@link #logitBias}
98 | * @return this
99 | */
100 | public OpenAiChatCompletionsParameters logitBias(final Map logitBias) {
101 | setLogitBias(logitBias);
102 | return this;
103 | }
104 |
105 | /**
106 | * @return {@link #presencePenalty}
107 | */
108 | public Double getPresencePenalty() {
109 | return presencePenalty;
110 | }
111 |
112 | /**
113 | * @param presencePenalty {@link #presencePenalty}
114 | */
115 | public void setPresencePenalty(final Double presencePenalty) {
116 | this.presencePenalty = presencePenalty;
117 | }
118 |
119 | /**
120 | * @param presencePenalty {@link #presencePenalty}
121 | * @return this
122 | */
123 | public OpenAiChatCompletionsParameters presencePenalty(final Double presencePenalty) {
124 | this.setPresencePenalty(presencePenalty);
125 | return this;
126 | }
127 |
128 | /**
129 | * copies parameter values from another instance of {@link OpenAiChatCompletionsParameters}
130 | *
131 | * @param parameters the source {@link OpenAiChatCompletionsParameters}
132 | */
133 | @Override
134 | public void copyFrom(final OpenAiChatCompletionsParameters parameters) {
135 | super.copyFrom(parameters);
136 |
137 | this.setFrequencePenalty(parameters.getFrequencePenalty());
138 | this.setLogitBias(parameters.getLogitBias());
139 | this.setPresencePenalty(parameters.getPresencePenalty());
140 | }
141 | }
142 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/llm/openai/chat/OpenAiChatCompletionsRequest.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.openai.chat;
2 |
3 | import java.util.List;
4 |
5 | /**
6 | * Model class for the OpenAI /chat/completions request body
7 | */
8 | public final class OpenAiChatCompletionsRequest extends OpenAiChatCompletionsParameters {
9 |
10 | /**
11 | * The {@link OpenAiChatMessage} instances of the conversation
12 | */
13 | private final List messages;
14 |
15 | /**
16 | * @param messages {@link #messages}
17 | */
18 | public OpenAiChatCompletionsRequest(final List messages) {
19 | this.messages = messages;
20 | }
21 |
22 | /**
23 | * @return {@link #messages}
24 | */
25 | public List getMessages() {
26 | return messages;
27 | }
28 | }
29 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/llm/openai/chat/OpenAiChatCompletionsResponse.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.openai.chat;
2 |
3 | import java.util.List;
4 |
5 | import com.fasterxml.jackson.annotation.JsonCreator;
6 | import com.fasterxml.jackson.annotation.JsonCreator.Mode;
7 |
8 | import io.github.cupybara.javalangchains.chains.llm.openai.OpenAiResponse;
9 |
10 | import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
11 | import com.fasterxml.jackson.annotation.JsonProperty;
12 |
13 | /**
14 | * Model class for the response body of an OpenAI /chat/completions request
15 | */
16 | @JsonIgnoreProperties(ignoreUnknown = true)
17 | public final class OpenAiChatCompletionsResponse extends OpenAiResponse {
18 |
19 | /**
20 | * @param choices {@link #getChoices()}
21 | */
22 | @JsonCreator(mode = Mode.PROPERTIES)
23 | public OpenAiChatCompletionsResponse(final @JsonProperty("choices") List choices) {
24 | super(choices);
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/llm/openai/chat/OpenAiChatMessage.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.openai.chat;
2 |
3 | import com.fasterxml.jackson.annotation.JsonCreator;
4 | import com.fasterxml.jackson.annotation.JsonProperty;
5 | import com.fasterxml.jackson.annotation.JsonCreator.Mode;
6 |
7 | /**
8 | * Model class for request and response messages of an OpenAI /chat/completions
9 | * request
10 | */
11 | public final class OpenAiChatMessage {
12 |
13 | /**
14 | * system|user|assistant
15 | */
16 | private final String role;
17 |
18 | /**
19 | * Message text
20 | */
21 | private final String content;
22 |
23 | /**
24 | * @param role {@link #role}
25 | * @param content {@link #content}
26 | */
27 | @JsonCreator(mode = Mode.PROPERTIES)
28 | public OpenAiChatMessage(final @JsonProperty("role") String role, final @JsonProperty("content") String content) {
29 | this.role = role;
30 | this.content = content;
31 | }
32 |
33 | /**
34 | * @return {@link #role}
35 | */
36 | public String getRole() {
37 | return role;
38 | }
39 |
40 | /**
41 | * @return {@link #content}
42 | */
43 | public String getContent() {
44 | return content;
45 | }
46 | }
47 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/llm/openai/completions/OpenAiCompletionsChain.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.openai.completions;
2 |
3 | import java.util.Map;
4 |
5 | import org.apache.commons.text.StringSubstitutor;
6 | import org.springframework.web.reactive.function.client.WebClient;
7 |
8 | import com.fasterxml.jackson.databind.ObjectMapper;
9 |
10 | import io.github.cupybara.javalangchains.chains.llm.openai.OpenAiChain;
11 |
12 | /**
13 | * {@link OpenAiChain} for usage with the OpenAI /completions API
14 | */
15 | public class OpenAiCompletionsChain
16 | extends OpenAiChain {
17 |
18 | /**
19 | * @param promptTemplate {@link #getPromptTemplate()}
20 | * @param parameters {@link #parameters}r
21 | * @param apiKey {@link #apiKey}
22 | * @param objectMapper {@link #objectMapper}
23 | * @param webClient {@link #webClient}
24 | */
25 | public OpenAiCompletionsChain(final String promptTemplate, final OpenAiCompletionsParameters parameters,
26 | final String apiKey, final ObjectMapper objectMapper, final WebClient webClient) {
27 | super(promptTemplate, "/v1/completions", OpenAiCompletionsResponse.class, parameters, apiKey, objectMapper,
28 | webClient);
29 | }
30 |
31 | /**
32 | * @param promptTemplate {@link #getPromptTemplate()}
33 | * @param parameters {@link #parameters}
34 | * @param apiKey {@link #apiKey}
35 | */
36 | public OpenAiCompletionsChain(final String promptTemplate, final OpenAiCompletionsParameters parameters,
37 | final String apiKey) {
38 | this(promptTemplate, parameters, apiKey, createDefaultObjectMapper(), createDefaultWebClient());
39 | }
40 |
41 | @Override
42 | protected OpenAiCompletionsRequest createRequest(final Map input) {
43 | return new OpenAiCompletionsRequest(new StringSubstitutor(input).replace(getPromptTemplate()));
44 | }
45 |
46 | @Override
47 | protected String createOutput(final OpenAiCompletionsResponse response) {
48 | return response.getChoices().get(0).getText();
49 | }
50 | }
51 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/llm/openai/completions/OpenAiCompletionsChoice.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.openai.completions;
2 |
3 | import com.fasterxml.jackson.annotation.JsonCreator;
4 | import com.fasterxml.jackson.annotation.JsonCreator.Mode;
5 | import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
6 | import com.fasterxml.jackson.annotation.JsonProperty;
7 |
8 | /**
9 | * Model class for choices in an OpenAI /completions response
10 | */
11 | @JsonIgnoreProperties(ignoreUnknown = true)
12 | public final class OpenAiCompletionsChoice {
13 |
14 | /**
15 | * the completion result
16 | */
17 | private final String text;
18 |
19 | /**
20 | * @param text {@link #text}
21 | */
22 | @JsonCreator(mode = Mode.PROPERTIES)
23 | public OpenAiCompletionsChoice(final @JsonProperty("text") String text) {
24 | this.text = text;
25 | }
26 |
27 | /**
28 | * @return {@link #text}
29 | */
30 | public String getText() {
31 | return text;
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/llm/openai/completions/OpenAiCompletionsParameters.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.openai.completions;
2 |
3 | import java.util.Set;
4 |
5 | import io.github.cupybara.javalangchains.chains.llm.openai.OpenAiParameters;
6 |
7 | /**
8 | * Parameters for calling an OpenAI Completions Model
9 | *
10 | * https://platform.openai.com/docs/api-reference/completions/create
11 | */
12 | public class OpenAiCompletionsParameters extends OpenAiParameters {
13 |
14 | /**
15 | * From
16 | * https://github.com/openai/openai-openapi/blob/master/openapi.yaml
17 | *
18 | * Up to 4 sequences where the API will stop generating further tokens. The
19 | * returned text will not contain the stop sequence.
20 | */
21 | private Set stop;
22 |
23 | /**
24 | * Creates an instance of {@link OpenAiCompletionsParameters}
25 | */
26 | public OpenAiCompletionsParameters() {
27 | super(OpenAiCompletionsParameters.class);
28 | }
29 |
30 | /**
31 | * @return {@link #stop}
32 | */
33 | public Set getStop() {
34 | return stop;
35 | }
36 |
37 | /**
38 | * @param stop {@link #stop}
39 | */
40 | public void setStop(final Set stop) {
41 | this.stop = stop;
42 | }
43 |
44 | /**
45 | * @param stop {@link #stop}
46 | * @return this
47 | */
48 | public OpenAiCompletionsParameters stop(final Set stop) {
49 | setStop(stop);
50 | return this;
51 | }
52 | }
53 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/llm/openai/completions/OpenAiCompletionsRequest.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.openai.completions;
2 |
3 | /**
4 | * Model class for the OpenAI /completions request body
5 | */
6 | public final class OpenAiCompletionsRequest extends OpenAiCompletionsParameters {
7 |
8 | /**
9 | * The prompt for the model
10 | */
11 | private final String prompt;
12 |
13 | /**
14 | * @param prompt {@link #prompt}
15 | */
16 | public OpenAiCompletionsRequest(final String prompt) {
17 | this.prompt = prompt;
18 | }
19 |
20 | /**
21 | * @return {@link #prompt}
22 | */
23 | public String getPrompt() {
24 | return prompt;
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/llm/openai/completions/OpenAiCompletionsResponse.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.openai.completions;
2 |
3 | import java.util.List;
4 |
5 | import com.fasterxml.jackson.annotation.JsonCreator;
6 | import com.fasterxml.jackson.annotation.JsonCreator.Mode;
7 |
8 | import io.github.cupybara.javalangchains.chains.llm.openai.OpenAiResponse;
9 |
10 | import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
11 | import com.fasterxml.jackson.annotation.JsonProperty;
12 |
13 | /**
14 | * Model class for the response body of an OpenAI /completions request
15 | */
16 | @JsonIgnoreProperties(ignoreUnknown = true)
17 | public final class OpenAiCompletionsResponse extends OpenAiResponse {
18 |
19 | /**
20 | * @param choices {@link #getChoices()}
21 | */
22 | @JsonCreator(mode = Mode.PROPERTIES)
23 | public OpenAiCompletionsResponse(final @JsonProperty("choices") List choices) {
24 | super(choices);
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/qa/AnswerWithSources.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.qa;
2 |
3 | import java.util.Collections;
4 | import java.util.List;
5 | import java.util.stream.Collectors;
6 |
7 | /**
8 | * Model class for QA output with sources
9 | */
10 | public final class AnswerWithSources {
11 |
12 | private final String answer;
13 | private final List sources;
14 |
15 | /**
16 | * Creates an instance of {@link AnswerWithSources}
17 | *
18 | * @param answer {@link #answer}
19 | * @param sources {@link #sources}
20 | */
21 | public AnswerWithSources(final String answer, final List sources) {
22 | this.answer = answer;
23 | this.sources = sources;
24 | }
25 |
26 | /**
27 | * Creates an instance of {@link AnswerWithSources}
28 | *
29 | * @param answer {@link #answer}
30 | */
31 | public AnswerWithSources(final String answer) {
32 | this(answer, Collections.emptyList());
33 | }
34 |
35 | /**
36 | * @return {@link #answer}
37 | */
38 | public String getAnswer() {
39 | return answer;
40 | }
41 |
42 | /**
43 | * @return {@link #sources}
44 | */
45 | public List getSources() {
46 | return sources;
47 | }
48 |
49 | @Override
50 | public String toString() {
51 | return String.format("%s (%s)", getAnswer(), getSources().stream().collect(Collectors.joining(", ")));
52 | }
53 | }
54 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/qa/CombineDocumentsChain.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.qa;
2 |
3 | import java.util.HashMap;
4 | import java.util.Map;
5 | import java.util.concurrent.atomic.AtomicReference;
6 | import java.util.stream.Collectors;
7 | import java.util.stream.Stream;
8 |
9 | import org.apache.commons.text.StringSubstitutor;
10 |
11 | import io.github.cupybara.javalangchains.chains.Chain;
12 | import io.github.cupybara.javalangchains.util.PromptConstants;
13 | import io.github.cupybara.javalangchains.util.PromptTemplates;
14 |
15 | /**
16 | * This {@link Chain} is used to combine multiple retrieved documents into one
17 | * prompt which can then be used to target a LLM in subsequent steps.
18 | */
19 | public class CombineDocumentsChain implements Chain>, Map> {
20 |
21 | /**
22 | * The template for each single document which contains placeholders in the form
23 | * ${myPlaceholder} that are replaced for each the keys of each input document.
24 | */
25 | private final String documentPromptTemplate;
26 |
27 | /**
28 | * creates an instance of the {@link CombineDocumentsChain}
29 | *
30 | * @param documentPromptTemplate {@link #documentPromptTemplate}
31 | */
32 | public CombineDocumentsChain(final String documentPromptTemplate) {
33 | this.documentPromptTemplate = documentPromptTemplate;
34 | }
35 |
36 | /**
37 | * creates an instance of the {@link CombineDocumentsChain}
38 | */
39 | public CombineDocumentsChain() {
40 | this(PromptTemplates.QA_DOCUMENT);
41 | }
42 |
43 | @Override
44 | public Map run(final Stream> input) {
45 | final AtomicReference questionRef = new AtomicReference<>();
46 |
47 | final String combinedContent = input.map(document -> {
48 | if (questionRef.get() == null) {
49 | questionRef.set(document.get(PromptConstants.QUESTION));
50 | }
51 | return this.createDocumentPrompt(document);
52 | }).collect(Collectors.joining("\n\n"));
53 |
54 | final Map result = new HashMap<>();
55 | result.put(PromptConstants.QUESTION, questionRef.get());
56 | result.put(PromptConstants.CONTENT, combinedContent);
57 | return result;
58 | }
59 |
60 | private String createDocumentPrompt(final Map document) {
61 | return new StringSubstitutor(document).replace(documentPromptTemplate);
62 | }
63 | }
64 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/qa/MapAnswerWithSourcesChain.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.qa;
2 |
3 | import java.util.Arrays;
4 | import java.util.regex.Matcher;
5 | import java.util.regex.Pattern;
6 | import java.util.stream.Collectors;
7 |
8 | import io.github.cupybara.javalangchains.chains.Chain;
9 |
10 | /**
11 | * Splits answers with sources from a QA chain.
12 | *
13 | * Examples
14 | *
15 | *
16 | * I don't know who James Anderson is.
17 | * SOURCES:
18 | *
19 | *
20 | *
21 | * There are two different John Does mentioned, one is a scientist and humanitarian, and the other is a traveler and author of a travel memoir. It is not clear if they are the same person or two different people with the same name.
22 | * SOURCES: 1, 3
23 | *
24 | */
25 | public class MapAnswerWithSourcesChain implements Chain {
26 |
27 | /**
28 | * this {@link Pattern} is used to retrieve sources from a qa result string
29 | */
30 | private final Pattern retrieveSourcesPattern;
31 |
32 | /**
33 | * @param retrieveSourcesPattern {@link #retrieveSourcesPattern}
34 | */
35 | public MapAnswerWithSourcesChain(final Pattern retrieveSourcesPattern) {
36 | this.retrieveSourcesPattern = retrieveSourcesPattern;
37 | }
38 |
39 | /**
40 | * @param retrieveSourcesRegex used to create the
41 | * {@link #retrieveSourcesPattern}
42 | */
43 | public MapAnswerWithSourcesChain(final String retrieveSourcesRegex) {
44 | this.retrieveSourcesPattern = Pattern.compile(retrieveSourcesRegex, Pattern.CASE_INSENSITIVE | Pattern.DOTALL);
45 | }
46 |
47 | /**
48 | * creates an instance of {@link MapAnswerWithSourcesChain} with a default regex
49 | * to retrieve sources
50 | */
51 | public MapAnswerWithSourcesChain() {
52 | this("(.*?)(?:Source(?:s)?:\\s*)(.*)");
53 | }
54 |
55 | @Override
56 | public AnswerWithSources run(final String input) {
57 | final Matcher matcher = retrieveSourcesPattern.matcher(input);
58 |
59 | if (matcher.find()) {
60 | final String content = matcher.group(1).trim();
61 | final String sources = matcher.group(2).trim();
62 | return new AnswerWithSources(content,
63 | Arrays.stream(sources.split(",")).map(String::trim).distinct().collect(Collectors.toList()));
64 | } else {
65 | return new AnswerWithSources(input);
66 | }
67 | }
68 | }
69 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/qa/ModifyDocumentsContentChain.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.qa;
2 |
3 | import java.util.HashMap;
4 | import java.util.Map;
5 | import java.util.stream.Stream;
6 |
7 | import org.apache.logging.log4j.LogManager;
8 |
9 | import io.github.cupybara.javalangchains.chains.Chain;
10 | import io.github.cupybara.javalangchains.util.PromptConstants;
11 |
12 | /**
13 | * {@link Chain} that takes documents as input and modifies their
14 | * {@link PromptConstants#CONTENT} entry using a llm chain that is passed as a
15 | * constructor param.
16 | */
17 | public class ModifyDocumentsContentChain implements Chain>, Stream>> {
18 |
19 | /**
20 | * this {@link Chain} is applied each document (a LLM Chain for example)
21 | */
22 | private final Chain, String> documentChain;
23 |
24 | /**
25 | * if true the {@link #documentChain} is called for each document on another
26 | * thread to increase overall performance
27 | */
28 | private final boolean parallel;
29 |
30 | /**
31 | * @param documentChain {@link #documentChain}
32 | * @param parallel {@link #parallel}
33 | */
34 | public ModifyDocumentsContentChain(final Chain, String> documentChain, final boolean parallel) {
35 | this.documentChain = documentChain;
36 | this.parallel = parallel;
37 | }
38 |
39 | /**
40 | * @param documentChain {@link #documentChain}
41 | */
42 | public ModifyDocumentsContentChain(final Chain, String> documentChain) {
43 | this(documentChain, true);
44 | }
45 |
46 | @Override
47 | public Stream> run(final Stream> input) {
48 | final Stream> stream = input.map(document -> {
49 | LogManager.getLogger(getClass()).trace("pre modification: {}", document);
50 | final String mappedContent = documentChain.run(document);
51 | LogManager.getLogger(getClass()).trace("post modification: {}", mappedContent);
52 |
53 | final Map mappedDocument = new HashMap<>(document);
54 | mappedDocument.put(PromptConstants.CONTENT, mappedContent);
55 | return mappedDocument;
56 | });
57 |
58 | if (parallel) {
59 | return stream.parallel();
60 | }
61 |
62 | return stream;
63 | }
64 | }
65 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/qa/split/JtokkitTextSplitter.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.qa.split;
2 |
3 | import com.knuddels.jtokkit.api.Encoding;
4 |
5 | /**
6 | * This {@link TextSplitter} splits documents based on their token count. For
7 | * that purpose jtokkit is
8 | * utilized.
9 | */
10 | public final class JtokkitTextSplitter extends MaxLengthBasedTextSplitter {
11 |
12 | /**
13 | * the {@link Encoding} used for token counting
14 | */
15 | private final Encoding encoding;
16 |
17 | /**
18 | * creates an instance of {@link JtokkitTextSplitter}
19 | *
20 | * @param encoding {@link #encoding}
21 | * @param maxTokens max amount of tokens for each chunk
22 | * @param textStreamer the {@link TextStreamer} used for streaming the base text
23 | */
24 | public JtokkitTextSplitter(final Encoding encoding, final int maxTokens, final TextStreamer textStreamer) {
25 | super(maxTokens, textStreamer);
26 | this.encoding = encoding;
27 | }
28 |
29 | /**
30 | * creates an instance of {@link JtokkitTextSplitter} with sentence based text
31 | * streaming
32 | *
33 | * @param encoding {@link #encoding}
34 | * @param maxTokens max amount of tokens for each chunk
35 | */
36 | public JtokkitTextSplitter(final Encoding encoding, final int maxTokens) {
37 | this(encoding, maxTokens, new TextStreamer());
38 | }
39 |
40 | @Override
41 | protected int getLength(final String textPart) {
42 | return encoding.countTokens(textPart);
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/qa/split/MaxLengthBasedTextSplitter.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.qa.split;
2 |
3 | import java.util.LinkedList;
4 | import java.util.List;
5 | import java.util.concurrent.atomic.AtomicReference;
6 |
7 | /**
8 | * abstract base class for {@link TextSplitter} implementations that use a max
9 | * length for deciding when to split
10 | */
11 | public abstract class MaxLengthBasedTextSplitter implements TextSplitter {
12 |
13 | /**
14 | * max length for each chunk in the split
15 | */
16 | private final int maxLength;
17 |
18 | /**
19 | * the {@link TextStreamer} used for streaming the base text (sentence by
20 | * sentence is the default)
21 | */
22 | private final TextStreamer textStreamer;
23 |
24 | /**
25 | * @param maxLength {@link #maxLength}
26 | * @param textStreamer {@link #textStreamer}
27 | */
28 | protected MaxLengthBasedTextSplitter(final int maxLength, final TextStreamer textStreamer) {
29 | this.maxLength = maxLength;
30 | this.textStreamer = textStreamer;
31 | }
32 |
33 | /**
34 | * creates a {@link MaxLengthBasedTextSplitter} using sentence wise text
35 | * streaming
36 | *
37 | * @param maxLength {@link #maxLength}
38 | */
39 | protected MaxLengthBasedTextSplitter(final int maxLength) {
40 | this(maxLength, new TextStreamer());
41 | }
42 |
43 | /**
44 | * provide the length value for a text part
45 | *
46 | * @param textPart the text part which needs to be measured
47 | * @return the length for the passed textPart
48 | */
49 | protected abstract int getLength(String textPart);
50 |
51 | @Override
52 | public final List split(final String text) {
53 | final List split = new LinkedList<>();
54 |
55 | final AtomicReference partition = new AtomicReference<>("");
56 |
57 | this.textStreamer.stream(text).forEach(textPart -> {
58 | final String newPartition = partition.get() + textPart;
59 |
60 | final int newPartitionLength = getLength(newPartition);
61 | if (newPartitionLength > maxLength) {
62 |
63 | // the current textPart must be part of the next chunk
64 | if (textPart.length() == newPartition.length()) {
65 | throw new IllegalStateException(
66 | "Text partition " + textPart + " is too long. Try to use another TextStreamer.");
67 | }
68 | split.add(partition.get());
69 | partition.set(textPart);
70 |
71 | } else if (newPartitionLength == maxLength) {
72 |
73 | // the current textPart is part of the current chunk but max length is reached
74 | split.add(newPartition);
75 | partition.set("");
76 |
77 | } else {
78 | // the current textPart is part of the current chunk
79 | partition.set(newPartition);
80 | }
81 | });
82 |
83 | final String trailingText = partition.get();
84 | if (trailingText.length() > 0) {
85 | split.add(trailingText);
86 | }
87 |
88 | return split;
89 | }
90 |
91 | }
92 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/qa/split/SplitDocumentsChain.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.qa.split;
2 |
3 | import java.util.HashMap;
4 | import java.util.Map;
5 | import java.util.stream.Stream;
6 |
7 | import io.github.cupybara.javalangchains.chains.Chain;
8 | import io.github.cupybara.javalangchains.util.PromptConstants;
9 |
10 | /**
11 | * This {@link Chain} is used to split long documents into chunks. All document
12 | * keys are copied except for the {@link PromptConstants#CONTENT} which is
13 | * split.
14 | */
15 | public class SplitDocumentsChain implements Chain>, Stream>> {
16 |
17 | /**
18 | * This {@link TextSplitter} is used to create one or more documents from an
19 | * input document based on the {@link PromptConstants#CONTENT} key.
20 | */
21 | private final TextSplitter textSplitter;
22 |
23 | /**
24 | * creates an instance of the {@link SplitDocumentsChain}
25 | *
26 | * @param textSplitter {@link #textSplitter}
27 | */
28 | public SplitDocumentsChain(final TextSplitter textSplitter) {
29 | this.textSplitter = textSplitter;
30 | }
31 |
32 | @Override
33 | public Stream> run(final Stream> input) {
34 | return input.flatMap(this::splitDocument);
35 | }
36 |
37 | private Stream> splitDocument(final Map document) {
38 | final String content = document.get(PromptConstants.CONTENT);
39 |
40 | return this.textSplitter.split(content).stream().map(contentPart -> {
41 | final Map documentPart = new HashMap<>(document);
42 | documentPart.put(PromptConstants.CONTENT, contentPart);
43 | return documentPart;
44 | });
45 | }
46 | }
47 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/qa/split/TextSplitter.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.qa.split;
2 |
3 | import java.util.List;
4 |
5 | /**
6 | * Implementations are used by the {@link SplitDocumentsChain}. A
7 | * {@link TextSplitter} takes an input text and creates a {@link List} with one
8 | * or more result strings based on the original text.
9 | */
10 | @FunctionalInterface
11 | public interface TextSplitter {
12 |
13 | /**
14 | * Splits a text into one or more subtexts
15 | *
16 | * @param text text to split
17 | * @return {@link List} with text partitions
18 | */
19 | List split(String text);
20 | }
21 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/chains/qa/split/TextStreamer.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.qa.split;
2 |
3 | import java.text.BreakIterator;
4 | import java.util.Iterator;
5 | import java.util.NoSuchElementException;
6 | import java.util.Spliterator;
7 | import java.util.Spliterators;
8 | import java.util.function.Supplier;
9 | import java.util.stream.Stream;
10 | import java.util.stream.StreamSupport;
11 |
12 | /**
13 | * streams a text using a {@link BreakIterator}
14 | */
15 | public class TextStreamer {
16 |
17 | /**
18 | * creates the {@link BreakIterator} used for streaming
19 | */
20 | private final Supplier breakIteratorSupplier;
21 |
22 | /**
23 | * creates a {@link TextStreamer} using a custom {@link BreakIterator}
24 | *
25 | * @param breakIteratorSupplier {@link #breakIteratorSupplier}
26 | */
27 | public TextStreamer(final Supplier breakIteratorSupplier) {
28 | this.breakIteratorSupplier = breakIteratorSupplier;
29 | }
30 |
31 | /**
32 | * creates a {@link TextStreamer} which streams sentences
33 | */
34 | public TextStreamer() {
35 | this(BreakIterator::getSentenceInstance);
36 | }
37 |
38 | /**
39 | * creates a stream of text partitions
40 | *
41 | * @param text partitionized text
42 | * @return {@link Stream} of text partitions
43 | */
44 | public Stream stream(final String text) {
45 | final BreakIterator breakIterator = breakIteratorSupplier.get();
46 | breakIterator.setText(text);
47 |
48 | final Iterator breakIteratorAdapter = new Iterator() {
49 | int start = breakIterator.first();
50 | int end = breakIterator.next();
51 |
52 | @Override
53 | public boolean hasNext() {
54 | return end != BreakIterator.DONE;
55 | }
56 |
57 | @Override
58 | public String next() {
59 | if (end == BreakIterator.DONE) {
60 | throw new NoSuchElementException("No more words");
61 | }
62 |
63 | final String textPartition = text.substring(start, end);
64 | start = end;
65 | end = breakIterator.next();
66 | return textPartition;
67 | }
68 | };
69 |
70 | return StreamSupport.stream(Spliterators.spliteratorUnknownSize(breakIteratorAdapter, Spliterator.ORDERED),
71 | false);
72 | }
73 | }
74 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/util/PromptConstants.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.util;
2 |
3 | /**
4 | * Utility Class which holds constants for prompt placeholders
5 | */
6 | public final class PromptConstants {
7 |
8 | /**
9 | * placeholder for the question in qa context
10 | */
11 | public static final String QUESTION = "question";
12 |
13 | /**
14 | * placeholder for text content in qa context
15 | */
16 | public static final String CONTENT = "content";
17 |
18 | /**
19 | * placeholder for sources in qa context
20 | */
21 | public static final String SOURCE = "source";
22 |
23 | private PromptConstants() {
24 | // not instantiated
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/src/main/java/io/github/cupybara/javalangchains/util/PromptTemplates.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.util;
2 |
3 | // @formatter:off
4 |
5 | /**
6 | * this utility class holds templates for various prompts
7 | */
8 | public final class PromptTemplates {
9 |
10 | /**
11 | * https://github.com/hwchase17/langchain/blob/master/langchain/chains/qa_with_sources/map_reduce_prompt.py#L4
12 | */
13 | public static final String QA_SUMMARIZE = String.format(
14 | "Use the following portion of a long document to see if any of the text is relevant to answer the question.\n"
15 | + "Return any relevant text verbatim.\n"
16 | + "${content}\n"
17 | + "Question: ${%s}\n"
18 | + "Relevant text, if any:",
19 | PromptConstants.QUESTION);
20 |
21 | /**
22 | * https://github.com/hwchase17/langchain/blob/master/langchain/chains/qa_with_sources/stuff_prompt.py#LL4C15-L38C13
23 | */
24 | public static final String QA_COMBINE = String.format(
25 | "Given the following extracted parts of a long document and a question, create a final answer with references (\"SOURCES\").\n"
26 | + "If you don't know the answer, just say that you don't know. Don't try to make up an answer.\n"
27 | + "ALWAYS return a \"SOURCES\" part in your answer.\n\n"
28 | + "QUESTION: Which state/country's law governs the interpretation of the contract?\n"
29 | + "=========\n"
30 | + "Content: This Agreement is governed by English law and the parties submit to the exclusive jurisdiction of the English courts in relation to any dispute (contractual or non-contractual) concerning this Agreement save that either party may apply to any court for an injunction or other relief to protect its Intellectual Property Rights.\n"
31 | + "Source: 28-pl\n"
32 | + "Content: No Waiver. Failure or delay in exercising any right or remedy under this Agreement shall not constitute a waiver of such (or any other) right or remedy.\n\n11.7 Severability. The invalidity, illegality or unenforceability of any term (or part of a term) of this Agreement shall not affect the continuation in force of the remainder of the term (if any) and this Agreement.\n\n11.8 No Agency. Except as expressly stated otherwise, nothing in this Agreement shall create an agency, partnership or joint venture of any kind between the parties.\n\n11.9 No Third-Party Beneficiaries.\n"
33 | + "Source: 30-pl\n"
34 | + "Content: (b) if Google believes, in good faith, that the Distributor has violated or caused Google to violate any Anti-Bribery Laws (as defined in Clause 8.5) or that such a violation is reasonably likely to occur,\n"
35 | + "Source: 4-pl\n"
36 | + "=========\n"
37 | + "FINAL ANSWER: This Agreement is governed by English law.\n"
38 | + "SOURCES: 28-pl\n\n"
39 | + "QUESTION: What did the president say about Michael Jackson?\n"
40 | + "=========\n"
41 | + "Content: Madam Speaker, Madam Vice President, our First Lady and Second Gentleman. Members of Congress and the Cabinet. Justices of the Supreme Court. My fellow Americans. \n\nLast year COVID-19 kept us apart. This year we are finally together again. \n\nTonight, we meet as Democrats Republicans and Independents. But most importantly as Americans. \n\nWith a duty to one another to the American people to the Constitution. \n\nAnd with an unwavering resolve that freedom will always triumph over tyranny. \n\nSix days ago, Russia’s Vladimir Putin sought to shake the foundations of the free world thinking he could make it bend to his menacing ways. But he badly miscalculated. \n\nHe thought he could roll into Ukraine and the world would roll over. Instead he met a wall of strength he never imagined. \n\nHe met the Ukrainian people. \n\nFrom President Zelenskyy to every Ukrainian, their fearlessness, their courage, their determination, inspires the world. \n\nGroups of citizens blocking tanks with their bodies. Everyone from students to retirees teachers turned soldiers defending their homeland.\n"
42 | + "Source: 0-pl\n"
43 | + "Content: And we won’t stop. \n\nWe have lost so much to COVID-19. Time with one another. And worst of all, so much loss of life. \n\nLet’s use this moment to reset. Let’s stop looking at COVID-19 as a partisan dividing line and see it for what it is: A God-awful disease. \n\nLet’s stop seeing each other as enemies, and start seeing each other for who we really are: Fellow Americans. \n\nWe can’t change how divided we’ve been. But we can change how we move forward—on COVID-19 and other issues we must face together. \n\nI recently visited the New York City Police Department days after the funerals of Officer Wilbert Mora and his partner, Officer Jason Rivera. \n\nThey were responding to a 9-1-1 call when a man shot and killed them with a stolen gun. \n\nOfficer Mora was 27 years old. \n\nOfficer Rivera was 22. \n\nBoth Dominican Americans who’d grown up on the same streets they later chose to patrol as police officers. \n\nI spoke with their families and told them that we are forever in debt for their sacrifice, and we will carry on their mission to restore the trust and safety every community deserves.\n"
44 | + "Source: 24-pl\n"
45 | + "Content: And a proud Ukrainian people, who have known 30 years of independence, have repeatedly shown that they will not tolerate anyone who tries to take their country backwards. \n\nTo all Americans, I will be honest with you, as I’ve always promised. A Russian dictator, invading a foreign country, has costs around the world. \n\nAnd I’m taking robust action to make sure the pain of our sanctions is targeted at Russia’s economy. And I will use every tool at our disposal to protect American businesses and consumers. \n\nTonight, I can announce that the United States has worked with 30 other countries to release 60 Million barrels of oil from reserves around the world. \n\nAmerica will lead that effort, releasing 30 Million barrels from our own Strategic Petroleum Reserve. And we stand ready to do more if necessary, unified with our allies. \n\nThese steps will help blunt gas prices here at home. And I know the news about what’s happening can seem alarming. \n\nBut I want you to know that we are going to be okay.\n"
46 | + "Source: 5-pl\n"
47 | + "Content: More support for patients and families. \n\nTo get there, I call on Congress to fund ARPA-H, the Advanced Research Projects Agency for Health. \n\nIt’s based on DARPA—the Defense Department project that led to the Internet, GPS, and so much more. \n\nARPA-H will have a singular purpose—to drive breakthroughs in cancer, Alzheimer’s, diabetes, and more. \n\nA unity agenda for the nation. \n\nWe can do this. \n\nMy fellow Americans—tonight , we have gathered in a sacred space—the citadel of our democracy. \n\nIn this Capitol, generation after generation, Americans have debated great questions amid great strife, and have done great things. \n\nWe have fought for freedom, expanded liberty, defeated totalitarianism and terror. \n\nAnd built the strongest, freest, and most prosperous nation the world has ever known. \n\nNow is the hour. \n\nOur moment of responsibility. \n\nOur test of resolve and conscience, of history itself. \n\nIt is in this moment that our character is formed. Our purpose is found. Our future is forged. \n\nWell I know this nation.\n"
48 | + "Source: 34-pl\n"
49 | + "=========\n"
50 | + "FINAL ANSWER: The president did not mention Michael Jackson.\n"
51 | + "SOURCES:\n\n"
52 | + "QUESTION: ${%s}\n"
53 | + "=========\n"
54 | + "${%s}\n"
55 | + "=========\n"
56 | + "FINAL ANSWER:",
57 | PromptConstants.QUESTION, PromptConstants.CONTENT);
58 |
59 | /**
60 | * https://github.com/hwchase17/langchain/blob/master/langchain/chains/qa_with_sources/stuff_prompt.py#L41
61 | */
62 | public static final String QA_DOCUMENT = String.format("Content: ${%s}\nSource: ${%s}", PromptConstants.CONTENT, PromptConstants.SOURCE);
63 |
64 |
65 | /**
66 | * Based on {@link #QA_COMBINE} instructs an LLM to create information snippets used for document comparison
67 | */
68 | public static final String QA_COMPARE = String.format(
69 | "Given the following extracted parts of a long document and a question, create a final answer which provides information about the question or criterion in the extracted document parts.\n"
70 | + "Your answer will be used for document comparison, so do not leave out potentially interesting key points.\n"
71 | + "If you don't know the answer, just say that you don't know. Don't try to make up an answer.\n"
72 | + "=========\n"
73 | + "QUESTION: ${%s}\n"
74 | + "=========\n"
75 | + "${%s}",
76 | PromptConstants.QUESTION, PromptConstants.CONTENT);
77 |
78 | /**
79 | * Instructs an LLM to compare a set of documents
80 | */
81 | public static final String COMPARE_MULTIPLE_DOCUMENTS = String.format(
82 | "${%s}\n"
83 | + "\n"
84 | + "Compare the provided content and sources based on the given question: ${%s}."
85 | + "\n"
86 | + "Line out differences and similarities between the different sources.\n"
87 | + "Name the source names in your comparison.",
88 | PromptConstants.CONTENT, PromptConstants.QUESTION);
89 |
90 | private PromptTemplates() {
91 | // not instantiated
92 | }
93 | }
94 |
--------------------------------------------------------------------------------
/src/main/resources/log4j2.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/src/test/java/io/github/cupybara/javalangchains/chains/data/read/ReadDocumentsFromInMemoryPdfChainTest.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.data.read;
2 |
3 | import static org.junit.jupiter.api.Assertions.assertEquals;
4 | import static org.junit.jupiter.api.Assertions.assertNotNull;
5 |
6 | import java.io.IOException;
7 | import java.net.URISyntaxException;
8 | import java.util.List;
9 | import java.util.Map;
10 | import java.util.stream.Collectors;
11 |
12 | import org.apache.pdfbox.io.IOUtils;
13 | import org.junit.jupiter.api.BeforeAll;
14 | import org.junit.jupiter.api.Test;
15 |
16 | import io.github.cupybara.javalangchains.chains.data.reader.ReadDocumentsFromInMemoryPdfChain;
17 | import io.github.cupybara.javalangchains.chains.data.reader.ReadDocumentsFromInMemoryPdfChain.InMemoryPdf;
18 | import io.github.cupybara.javalangchains.chains.data.reader.ReadDocumentsFromPdfChainBase.PdfReadMode;
19 | import io.github.cupybara.javalangchains.util.PromptConstants;
20 |
21 | /**
22 | * Unit Tests for the {@link ReadDocumentsFromInMemoryPdfChainTest}
23 | */
24 | class ReadDocumentsFromInMemoryPdfChainTest {
25 |
26 | private static InMemoryPdf inMemoryPdf;
27 |
28 | @BeforeAll
29 | static void setupBeforeAll() throws URISyntaxException, IOException {
30 | inMemoryPdf = new InMemoryPdf(
31 | IOUtils.toByteArray(
32 | ReadDocumentsFromInMemoryPdfChainTest.class.getResourceAsStream("/pdf/qa/book-of-john-3.pdf")),
33 | "my-in-memory.pdf");
34 | }
35 |
36 | @Test
37 | void testReadWhole() {
38 | final List> documents = new ReadDocumentsFromInMemoryPdfChain(PdfReadMode.WHOLE)
39 | .run(inMemoryPdf).collect(Collectors.toList());
40 | assertEquals(1, documents.size(), "incorrect number of read documents");
41 |
42 | final Map doc = documents.get(0);
43 | assertNotNull(doc.get(PromptConstants.CONTENT), "got no content for doc");
44 | assertEquals("my-in-memory.pdf", doc.get(PromptConstants.SOURCE), "got wrong source for doc");
45 | }
46 |
47 | @Test
48 | void testReadPages() {
49 | final List> documents = new ReadDocumentsFromInMemoryPdfChain(PdfReadMode.PAGES)
50 | .run(inMemoryPdf).collect(Collectors.toList());
51 | assertEquals(2, documents.size(), "incorrect number of read document pages");
52 |
53 | final Map doc1 = documents.get(0);
54 | assertNotNull(doc1.get(PromptConstants.CONTENT), "got no content for doc1");
55 | assertEquals("my-in-memory.pdf p.1", doc1.get(PromptConstants.SOURCE), "got wrong source for doc1");
56 |
57 | final Map doc2 = documents.get(1);
58 | assertNotNull(doc2.get(PromptConstants.CONTENT), "got no content for doc2");
59 | assertEquals("my-in-memory.pdf p.2", doc2.get(PromptConstants.SOURCE), "got wrong source for doc2");
60 | }
61 | }
62 |
--------------------------------------------------------------------------------
/src/test/java/io/github/cupybara/javalangchains/chains/data/read/ReadDocumentsFromPdfChainTest.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.data.read;
2 |
3 | import static org.junit.jupiter.api.Assertions.assertEquals;
4 | import static org.junit.jupiter.api.Assertions.assertFalse;
5 | import static org.junit.jupiter.api.Assertions.assertNotNull;
6 |
7 | import java.net.URISyntaxException;
8 | import java.nio.file.Path;
9 | import java.nio.file.Paths;
10 | import java.util.List;
11 | import java.util.Map;
12 | import java.util.stream.Collectors;
13 |
14 | import org.junit.jupiter.api.BeforeAll;
15 | import org.junit.jupiter.api.Test;
16 |
17 | import io.github.cupybara.javalangchains.chains.data.reader.ReadDocumentsFromPdfChain;
18 | import io.github.cupybara.javalangchains.chains.data.reader.ReadDocumentsFromPdfChainBase.PdfReadMode;
19 | import io.github.cupybara.javalangchains.util.PromptConstants;
20 |
21 | /**
22 | * Unit Tests for the {@link ReadDocumentsFromPdfChainTest}
23 | */
24 | class ReadDocumentsFromPdfChainTest {
25 |
26 | private static Path pdfDirectory;
27 |
28 | @BeforeAll
29 | static void setupBeforeAll() throws URISyntaxException {
30 | pdfDirectory = Paths.get(ReadDocumentsFromPdfChainTest.class.getResource("/pdf/qa").toURI());
31 | }
32 |
33 | @Test
34 | void testReadWhole() {
35 | final List> documents = new ReadDocumentsFromPdfChain(PdfReadMode.WHOLE).run(pdfDirectory)
36 | .collect(Collectors.toList());
37 | assertEquals(3, documents.size(), "incorrect number of read documents");
38 |
39 | final Map doc1 = documents.get(0);
40 | assertNotNull(doc1.get(PromptConstants.CONTENT), "got no content for doc1");
41 | assertEquals("book-of-john-1.pdf", doc1.get(PromptConstants.SOURCE), "got wrong source for doc1");
42 |
43 | final Map doc2 = documents.get(1);
44 | assertNotNull(doc2.get(PromptConstants.CONTENT), "got no content for doc2");
45 | assertEquals("book-of-john-2.pdf", doc2.get(PromptConstants.SOURCE), "got wrong source for doc2");
46 |
47 | final Map doc3 = documents.get(2);
48 | assertNotNull(doc3.get(PromptConstants.CONTENT), "got no content for doc3");
49 | assertEquals("book-of-john-3.pdf", doc3.get(PromptConstants.SOURCE), "got wrong source for doc3");
50 | }
51 |
52 | @Test
53 | void testReadPages() {
54 | final List> documents = new ReadDocumentsFromPdfChain(PdfReadMode.PAGES).run(pdfDirectory)
55 | .collect(Collectors.toList());
56 | assertEquals(4, documents.size(), "incorrect number of read document pages");
57 |
58 | final Map doc1 = documents.get(0);
59 | assertNotNull(doc1.get(PromptConstants.CONTENT), "got no content for doc1");
60 | assertFalse(doc1.get(PromptConstants.CONTENT).trim().isEmpty(), "got empty content for doc1");
61 | assertEquals("book-of-john-1.pdf p.1", doc1.get(PromptConstants.SOURCE), "got wrong source for doc1");
62 |
63 | final Map doc2 = documents.get(1);
64 | assertNotNull(doc2.get(PromptConstants.CONTENT), "got no content for doc2");
65 | assertFalse(doc2.get(PromptConstants.CONTENT).trim().isEmpty(), "got empty content for doc2");
66 | assertEquals("book-of-john-2.pdf p.1", doc2.get(PromptConstants.SOURCE), "got wrong source for doc2");
67 |
68 | final Map doc3 = documents.get(2);
69 | assertNotNull(doc3.get(PromptConstants.CONTENT), "got no content for doc3");
70 | assertFalse(doc3.get(PromptConstants.CONTENT).trim().isEmpty(), "got empty content for doc3");
71 | assertEquals("book-of-john-3.pdf p.1", doc3.get(PromptConstants.SOURCE), "got wrong source for doc3");
72 |
73 | final Map doc4 = documents.get(3);
74 | assertNotNull(doc4.get(PromptConstants.CONTENT), "got no content for doc4");
75 | assertFalse(doc4.get(PromptConstants.CONTENT).trim().isEmpty(), "got empty content for doc4");
76 | assertEquals("book-of-john-3.pdf p.2", doc4.get(PromptConstants.SOURCE), "got wrong source for doc4");
77 | }
78 | }
79 |
--------------------------------------------------------------------------------
/src/test/java/io/github/cupybara/javalangchains/chains/data/retrieval/DocumentTestUtil.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.data.retrieval;
2 |
3 | import java.util.Arrays;
4 | import java.util.List;
5 |
6 | public class DocumentTestUtil {
7 | // @formatter:off
8 | public static final String DOCUMENT_1 =
9 | "Subject: John Doe's Biography\n"
10 | + "Dear Reader,\n"
11 | + "I am delighted to present to you the biography of John Doe, a remarkable individual who has left an indelible mark on society. Born and raised in a small town, John displayed an insatiable curiosity and a thirst for knowledge from a young age. He excelled academically, earning scholarships that allowed him to attend prestigious universities and pursue his passion for scientific research.\n"
12 | + "Throughout his career, John made groundbreaking discoveries in the field of medicine, revolutionizing treatment options for previously incurable diseases. His relentless dedication and tireless efforts have saved countless lives and earned him numerous accolades, including the Nobel Prize in Medicine.\n"
13 | + "However, John's impact extends far beyond his professional accomplishments. He is known for his philanthropic endeavors, establishing charitable foundations that provide support and opportunities to underprivileged communities. John's compassion and commitment to social justice have inspired many to follow in his footsteps.\n"
14 | + "In his personal life, John is a devoted family man. He cherishes the time spent with his loving wife and children, always prioritizing their well-being amidst his demanding schedule. Despite his remarkable success, John remains humble and grounded, never forgetting his roots and always seeking ways to uplift those around him.\n"
15 | + "In conclusion, John Doe is not only a brilliant scientist and humanitarian but also a role model for future generations. His unwavering determination, kindness, and pursuit of excellence make him a true legend.\n"
16 | + "Sincerely,\n"
17 | + "Jane Doe";
18 |
19 | public static final String DOCUMENT_2 =
20 | "Subject: Invitation to John Doe's Art Exhibition\n"
21 | + "Dear Art Enthusiast,\n"
22 | + "We are pleased to invite you to a remarkable art exhibition featuring the mesmerizing works of John Doe. Renowned for his unique style and ability to capture the essence of emotions on canvas, John has curated a collection that will leave you awe-struck.\n"
23 | + "Drawing inspiration from his diverse life experiences, John's art tells compelling stories and invites viewers to delve into the depths of their imagination. Each stroke of the brush reveals a glimpse into his creative mind, conveying a range of emotions that resonate with the observer.\n"
24 | + "The exhibition will be held at the prestigious XYZ Art Gallery on [date] at [time]. It promises to be an evening filled with artistic brilliance, where you will have the opportunity to meet John Doe in person and gain insights into his creative process. Light refreshments will be served, providing a delightful ambiance for engaging discussions with fellow art enthusiasts.\n"
25 | + "Kindly RSVP by [RSVP date] to ensure your attendance at this exclusive event. We look forward to your presence and sharing this unforgettable artistic journey with you.\n"
26 | + "Yours sincerely,\n"
27 | + "Jane Doe";
28 |
29 | public static final String DOCUMENT_3 =
30 | "Subject: John Doe's Travel Memoir - Exploring the Unknown\n"
31 | + "Dear Adventurers,\n"
32 | + "Prepare to embark on an extraordinary journey as we delve into the captivating travel memoir of John Doe. Throughout his life, John has traversed the globe, seeking out the hidden gems and immersing himself in diverse cultures. His memoir is a testament to the transformative power of travel and the profound impact it can have on one's perspective.\n"
33 | + "From the bustling streets of Tokyo to the serene beaches of Bali, John's vivid descriptions transport readers to each destination, allowing them to experience the sights, sounds, and flavors firsthand. With a keen eye for detail and a genuine curiosity for the world, he uncovers the untold stories that lie beneath the surface, providing a fresh and unique perspective.\n"
34 | + "Through his encounters with locals, John unearths the beauty of human connection and the universal language of kindness. He shares anecdotes that will make you laugh, moments that will leave you in awe, and reflections that will inspire you to embark on your own adventures.\n"
35 | + "This travel memoir not only serves as a guide to off-the-beaten-path destinations but also as a reminder of the inherent beauty and diversity of our planet. It encourages readers to step out of their comfort zones, embrace new experiences, and celebrate the richness of different cultures.\n"
36 | + "Whether you are an avid traveler or an armchair explorer, John Doe's memoir is a captivating read that will ignite your wanderlust and leave you yearning for new horizons. Join him on this literary expedition and discover the world through his eyes.\n"
37 | + "Happy reading,\n"
38 | + "Jane Doe";
39 |
40 | public static final List DOCUMENTS = Arrays.asList(DocumentTestUtil.DOCUMENT_1, DocumentTestUtil.DOCUMENT_2, DocumentTestUtil.DOCUMENT_3);
41 | // @formatter:on
42 |
43 | private DocumentTestUtil() {
44 |
45 | }
46 | }
47 |
--------------------------------------------------------------------------------
/src/test/java/io/github/cupybara/javalangchains/chains/data/retrieval/ElasticsearchRetrievalChainIT.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.data.retrieval;
2 |
3 | import static org.junit.jupiter.api.Assertions.assertEquals;
4 | import static org.junit.jupiter.api.Assertions.assertTrue;
5 |
6 | import java.io.IOException;
7 | import java.net.URISyntaxException;
8 | import java.nio.file.Path;
9 | import java.nio.file.Paths;
10 | import java.util.List;
11 | import java.util.Map;
12 | import java.util.stream.Collectors;
13 |
14 | import org.apache.http.HttpHost;
15 | import org.elasticsearch.client.RestClient;
16 | import org.elasticsearch.client.RestClientBuilder;
17 | import org.junit.jupiter.api.BeforeAll;
18 | import org.junit.jupiter.api.Disabled;
19 | import org.junit.jupiter.api.Test;
20 |
21 | import io.github.cupybara.javalangchains.chains.Chain;
22 | import io.github.cupybara.javalangchains.chains.data.reader.ReadDocumentsFromPdfChain;
23 | import io.github.cupybara.javalangchains.chains.data.writer.WriteDocumentsToElasticsearchIndexChain;
24 | import io.github.cupybara.javalangchains.util.PromptConstants;
25 |
26 | /**
27 | * Tests for the {@link ElasticsearchRetrievalChain}
28 | */
29 | @Disabled
30 | class ElasticsearchRetrievalChainIT {
31 |
32 | private static RestClientBuilder restClientBuilder;
33 |
34 | @BeforeAll
35 | static void beforeAll() throws URISyntaxException {
36 | restClientBuilder = RestClient.builder(new HttpHost("localhost", 9200));
37 |
38 | final Chain createElasticsearchIndexChain = new ReadDocumentsFromPdfChain()
39 | .chain(new WriteDocumentsToElasticsearchIndexChain("my-index", restClientBuilder));
40 |
41 | final Path pdfDirectoryPath = Paths.get(ElasticsearchRetrievalChainIT.class.getResource("/pdf/qa").toURI());
42 |
43 | // creates and fills the elasticsearch index "my-index"
44 | createElasticsearchIndexChain.run(pdfDirectoryPath);
45 | }
46 |
47 | @Test
48 | void testRun() throws IOException {
49 | try (final RestClient restClient = restClientBuilder.build();
50 | final ElasticsearchRetrievalChain retrievalChain = new ElasticsearchRetrievalChain("my-index",
51 | restClient, 1)) {
52 |
53 | final List> retrievedDocuments = retrievalChain.run("who is john doe?")
54 | .collect(Collectors.toList());
55 | assertEquals(1, retrievedDocuments.size(), "incorrect number of retrieved documents");
56 |
57 | final Map document = retrievedDocuments.get(0);
58 |
59 | assertTrue(document.containsKey(PromptConstants.QUESTION), "document does not contain question key");
60 | assertTrue(document.containsKey(PromptConstants.SOURCE), "document does not contain source key");
61 | assertTrue(document.containsKey(PromptConstants.CONTENT), "document does not contain content key");
62 |
63 | assertEquals("who is john doe?", document.get(PromptConstants.QUESTION), "wrong question in document");
64 | }
65 | }
66 | }
67 |
--------------------------------------------------------------------------------
/src/test/java/io/github/cupybara/javalangchains/chains/data/retrieval/JdbcRetrievalChainIT.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.data.retrieval;
2 |
3 | import static org.junit.jupiter.api.Assertions.assertEquals;
4 |
5 | import java.sql.Connection;
6 | import java.sql.DriverManager;
7 | import java.sql.PreparedStatement;
8 | import java.sql.ResultSet;
9 | import java.sql.SQLException;
10 | import java.sql.Statement;
11 | import java.util.List;
12 | import java.util.Map;
13 | import java.util.function.Supplier;
14 | import java.util.stream.Collectors;
15 |
16 | import org.junit.jupiter.api.BeforeAll;
17 | import org.junit.jupiter.api.Disabled;
18 | import org.junit.jupiter.api.Test;
19 |
20 | import io.github.cupybara.javalangchains.util.PromptConstants;
21 |
22 | @Disabled
23 | public class JdbcRetrievalChainIT {
24 | private static Supplier connectionSupplier;
25 |
26 | @BeforeAll
27 | static void setup() throws SQLException {
28 | final String connectionString = "jdbc:postgresql://localhost:5432/";
29 | final String username = "postgres";
30 | final String password = "admin";
31 |
32 | Connection connection = DriverManager.getConnection(connectionString, username, password);
33 |
34 | Statement setupStatement = connection.createStatement();
35 |
36 | ResultSet dbResult = setupStatement
37 | .executeQuery("SELECT datname FROM pg_catalog.pg_database WHERE datname='langchain_test'");
38 | if (dbResult.next()) {
39 | setupStatement.execute("DROP DATABASE langchain_test");
40 | }
41 |
42 | setupStatement.execute("CREATE DATABASE langchain_test");
43 |
44 | setupStatement.close();
45 |
46 | connection.setCatalog("langchain_test");
47 |
48 | Statement createTableStatement = connection.createStatement();
49 | if (connection.getMetaData().getTables("langchain_test", null, null, new String[] { "TABLE" }).next()) {
50 | createTableStatement.execute("DROP TABLE Documents");
51 | }
52 | createTableStatement.execute(
53 | "CREATE TABLE Documents (source VARCHAR PRIMARY KEY, content VARCHAR, additional_attribute INTEGER)");
54 | createTableStatement.close();
55 | for (int i = 0; i < DocumentTestUtil.DOCUMENTS.size(); i++) {
56 | String content = DocumentTestUtil.DOCUMENTS.get(i);
57 | PreparedStatement seedStatement = connection
58 | .prepareStatement("INSERT INTO Documents(source, content, additional_attribute) VALUES (?, ?, 1)");
59 | seedStatement.setString(1, Integer.toString(i));
60 | seedStatement.setString(2, content);
61 | seedStatement.execute();
62 | seedStatement.close();
63 | }
64 |
65 | connectionSupplier = () -> connection;
66 | }
67 |
68 | @Test
69 | void testRun() throws SQLException {
70 | JdbcRetrievalChain jdbcRetrievalChain = new JdbcRetrievalChain(connectionSupplier, 1);
71 |
72 | final List> retrievedDocuments = jdbcRetrievalChain.run("who is john doe?")
73 | .collect(Collectors.toList());
74 | assertEquals(1, retrievedDocuments.size(), "incorrect number of retrieved documents");
75 |
76 | Map document = retrievedDocuments.get(0);
77 | assertEquals("0", document.get("source"));
78 | assertEquals("1", document.get("additional_attribute"));
79 | assertEquals(DocumentTestUtil.DOCUMENT_1, document.get(PromptConstants.CONTENT));
80 | assertEquals("who is john doe?", document.get(PromptConstants.QUESTION));
81 | }
82 | }
83 |
--------------------------------------------------------------------------------
/src/test/java/io/github/cupybara/javalangchains/chains/data/retrieval/LuceneRetrievalChainTest.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.data.retrieval;
2 |
3 | import static org.junit.jupiter.api.Assertions.assertEquals;
4 | import static org.junit.jupiter.api.Assertions.assertFalse;
5 | import static org.junit.jupiter.api.Assertions.assertTrue;
6 |
7 | import java.io.File;
8 | import java.io.IOException;
9 | import java.nio.file.Files;
10 | import java.nio.file.Path;
11 | import java.util.Comparator;
12 | import java.util.List;
13 | import java.util.Map;
14 | import java.util.stream.Collectors;
15 |
16 | import org.apache.lucene.analysis.standard.StandardAnalyzer;
17 | import org.apache.lucene.document.Document;
18 | import org.apache.lucene.document.Field;
19 | import org.apache.lucene.document.StringField;
20 | import org.apache.lucene.document.TextField;
21 | import org.apache.lucene.index.IndexWriter;
22 | import org.apache.lucene.index.IndexWriterConfig;
23 | import org.apache.lucene.store.Directory;
24 | import org.apache.lucene.store.MMapDirectory;
25 | import org.junit.jupiter.api.AfterAll;
26 | import org.junit.jupiter.api.BeforeAll;
27 | import org.junit.jupiter.api.Test;
28 |
29 | import io.github.cupybara.javalangchains.util.PromptConstants;
30 |
31 | /**
32 | * Tests for the {@link LuceneRetrievalChain}
33 | */
34 | class LuceneRetrievalChainTest {
35 |
36 | private static Path tempDirPath;
37 | private static Directory directory;
38 |
39 | @BeforeAll
40 | static void beforeAll() throws IOException {
41 | tempDirPath = Files.createTempDirectory("lucene");
42 | directory = new MMapDirectory(tempDirPath);
43 | fillDirectory(directory);
44 | }
45 |
46 | static void fillDirectory(final Directory indexDirectory) throws IOException {
47 | final StandardAnalyzer analyzer = new StandardAnalyzer();
48 | final IndexWriterConfig config = new IndexWriterConfig(analyzer);
49 | try (final IndexWriter indexWriter = new IndexWriter(indexDirectory, config)) {
50 | for (final String content : DocumentTestUtil.DOCUMENTS) {
51 | final Document doc = new Document();
52 | doc.add(new TextField(PromptConstants.CONTENT, content, Field.Store.YES));
53 | doc.add(new StringField(PromptConstants.SOURCE,
54 | String.valueOf(DocumentTestUtil.DOCUMENTS.indexOf(content) + 1), Field.Store.YES));
55 | indexWriter.addDocument(doc);
56 | }
57 |
58 | indexWriter.commit();
59 | }
60 | }
61 |
62 | @AfterAll
63 | static void afterAll() throws IOException {
64 | directory.close();
65 | Files.walk(tempDirPath).sorted(Comparator.reverseOrder()).map(Path::toFile).forEach(File::delete);
66 | }
67 |
68 | @Test
69 | void testRun() throws IOException {
70 | try (final LuceneRetrievalChain retrievalChain = new LuceneRetrievalChain(directory, 2)) {
71 | final String question = "what kind of art does john make?";
72 |
73 | final List> documents = retrievalChain.run(question).collect(Collectors.toList());
74 | assertFalse(documents.isEmpty(), "no documents retrieved");
75 |
76 | final Map mostRelevantDocument = documents.get(0);
77 | assertTrue(mostRelevantDocument.containsKey(PromptConstants.SOURCE), "source key is missing");
78 | assertEquals("2", mostRelevantDocument.get(PromptConstants.SOURCE), "invalid source");
79 |
80 | assertTrue(mostRelevantDocument.containsKey(PromptConstants.CONTENT), "content key is missing");
81 | assertEquals(DocumentTestUtil.DOCUMENT_2, mostRelevantDocument.get(PromptConstants.CONTENT),
82 | "invalid content");
83 | }
84 | }
85 | }
86 |
--------------------------------------------------------------------------------
/src/test/java/io/github/cupybara/javalangchains/chains/data/writer/WriteDocumentsToElasticsearchIndexChainIT.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.data.writer;
2 |
3 | import java.net.URISyntaxException;
4 | import java.nio.file.Path;
5 | import java.nio.file.Paths;
6 | import java.util.Base64;
7 |
8 | import org.apache.http.HttpHost;
9 | import org.elasticsearch.client.RestClient;
10 | import org.junit.jupiter.api.Test;
11 |
12 | import com.fasterxml.jackson.databind.ObjectMapper;
13 |
14 | import io.github.cupybara.javalangchains.chains.Chain;
15 | import io.github.cupybara.javalangchains.chains.data.reader.ReadDocumentsFromPdfChain;
16 | import io.github.cupybara.javalangchains.util.PromptConstants;
17 |
18 | /**
19 | * tests for the {@link WriteDocumentsToElasticsearchIndexChain}
20 | */
21 | class WriteDocumentsToElasticsearchIndexChainIT {
22 |
23 | @Test
24 | void testRun() throws URISyntaxException {
25 | Chain fillElasticsearchIndexChain = new ReadDocumentsFromPdfChain()
26 | .chain(new WriteDocumentsToElasticsearchIndexChain("my-index"));
27 |
28 | Path pdfDirectoryPath = Paths
29 | .get(WriteDocumentsToElasticsearchIndexChainIT.class.getResource("/pdf/qa").toURI());
30 |
31 | fillElasticsearchIndexChain.run(pdfDirectoryPath);
32 | }
33 |
34 | @Test
35 | void testRunSpecificId() throws URISyntaxException {
36 | WriteDocumentsToElasticsearchIndexChain writeChain = new WriteDocumentsToElasticsearchIndexChain("my-index",
37 | RestClient.builder(new HttpHost("localhost", 9200)), new ObjectMapper(),
38 | doc -> Base64.getEncoder().encodeToString(doc.get(PromptConstants.SOURCE).getBytes()));
39 |
40 | Chain fillElasticsearchIndexChain = new ReadDocumentsFromPdfChain().chain(writeChain);
41 |
42 | Path pdfDirectoryPath = Paths
43 | .get(WriteDocumentsToElasticsearchIndexChainIT.class.getResource("/pdf/qa").toURI());
44 |
45 | fillElasticsearchIndexChain.run(pdfDirectoryPath);
46 | }
47 | }
48 |
--------------------------------------------------------------------------------
/src/test/java/io/github/cupybara/javalangchains/chains/llm/azure/chat/AzureOpenAiChatCompletionsChainIT.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.azure.chat;
2 |
3 | import static org.junit.jupiter.api.Assertions.assertNotNull;
4 | import static org.junit.jupiter.api.Assertions.assertTrue;
5 |
6 | import java.util.Collections;
7 | import java.util.Map;
8 |
9 | import org.apache.logging.log4j.LogManager;
10 | import org.apache.logging.log4j.Logger;
11 | import org.junit.jupiter.api.Test;
12 |
13 | import io.github.cupybara.javalangchains.chains.Chain;
14 | import io.github.cupybara.javalangchains.chains.llm.openai.chat.OpenAiChatCompletionsParameters;
15 |
16 | /**
17 | * Integration Tests for the {@link AzureOpenAiChatCompletionsChain}
18 | */
19 | class AzureOpenAiChatCompletionsChainIT {
20 |
21 | private static final Logger LOGGER = LogManager.getLogger();
22 |
23 | @Test
24 | void testRun() {
25 | final AzureOpenAiChatCompletionsChain chain = new AzureOpenAiChatCompletionsChain(
26 | "my-azure-resource-name", "gpt-35-turbo", "2023-05-15",
27 | "Hello, this is ${name}. What was my name again?",
28 | new OpenAiChatCompletionsParameters(), System.getenv("AZURE_OPENAI_API_KEY"));
29 |
30 | final String name = "Manuel";
31 | final String result = chain.run(Collections.singletonMap("name", name));
32 | LOGGER.info(result);
33 |
34 | assertNotNull(result, "got no result from OpenAiChatCompletionsChain");
35 | assertTrue(result.contains(name), "The answer did not contain the name");
36 | }
37 |
38 | @Test
39 | void testChainedRun() {
40 | final OpenAiChatCompletionsParameters parameters = new OpenAiChatCompletionsParameters();
41 |
42 | final Chain, String> chain = new AzureOpenAiChatCompletionsChain(
43 | "my-azure-resource-name", "gpt-35-turbo", "2023-05-15",
44 | "Hello, this is ${name}. What was my name again?",
45 | parameters, System.getenv("AZURE_OPENAI_API_KEY"))
46 | .chain(prev -> Collections.singletonMap("result", prev))
47 | .chain(new AzureOpenAiChatCompletionsChain(
48 | "my-azure-resource-name", "gpt-35-turbo", "2023-05-15",
49 | "What was the question for the following answer: ${result}",
50 | parameters, System.getenv("AZURE_OPENAI_API_KEY")));
51 |
52 | final String result = chain.run(Collections.singletonMap("name", "Manuel"));
53 | LOGGER.info(result);
54 |
55 | assertNotNull(result, "got no result from chain");
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/src/test/java/io/github/cupybara/javalangchains/chains/llm/openai/chat/OpenAiChatCompletionsChainIT.java:
--------------------------------------------------------------------------------
1 | package io.github.cupybara.javalangchains.chains.llm.openai.chat;
2 |
3 | import static org.junit.jupiter.api.Assertions.assertNotNull;
4 | import static org.junit.jupiter.api.Assertions.assertTrue;
5 |
6 | import java.util.Collections;
7 | import java.util.Map;
8 |
9 | import org.apache.logging.log4j.LogManager;
10 | import org.apache.logging.log4j.Logger;
11 | import org.junit.jupiter.api.Test;
12 |
13 | import io.github.cupybara.javalangchains.chains.Chain;
14 |
15 | /**
16 | * Integration Tests for the {@link OpenAiChatCompletionsChain}
17 | */
18 | class OpenAiChatCompletionsChainIT {
19 |
20 | private static final Logger LOGGER = LogManager.getLogger();
21 |
22 | @Test
23 | void testRun() {
24 | final OpenAiChatCompletionsParameters parameters = new OpenAiChatCompletionsParameters();
25 | parameters.setModel("gpt-3.5-turbo");
26 | parameters.setTemperature(0D);
27 |
28 | final OpenAiChatCompletionsChain chain = new OpenAiChatCompletionsChain(
29 | "Hello, this is ${name}. What was my name again?", parameters, System.getenv("OPENAI_API_KEY"),
30 | "You are a helpful assistant who answers questions to ${name}");
31 |
32 | final String name = "Manuel";
33 | final String result = chain.run(Collections.singletonMap("name", name));
34 | LOGGER.info(result);
35 |
36 | assertNotNull(result, "got no result from OpenAiChatCompletionsChain");
37 | assertTrue(result.contains(name), "The answer did not contain the name");
38 | }
39 |
40 | @Test
41 | void testChainedRun() {
42 | final OpenAiChatCompletionsParameters parameters = new OpenAiChatCompletionsParameters();
43 | parameters.setModel("gpt-3.5-turbo");
44 |
45 | final Chain