Windows>> flexudy-client-java>> 返回
项目作者： flexudy

项目描述 ：
Flexudy Java REST API Client
高级语言： Java
项目地址: git://github.com/flexudy/flexudy-client-java.git
创建时间： 2020-07-05T05:56:13Z
项目社区：https://github.com/flexudy/flexudy-client-java
开源协议：
下载


Flexudy API Java Client Library

Build Status
codecov
contributions welcome

The official Flexudy Java client library.

Installation

Requirements

  • Java 1.9 or later

Gradle users

Add this dependency to your project’s build file:

  1. implementation "com.flexudy.education:flexudy-client:1.0"

Maven users

Add this dependency to your project’s POM:

  1. <dependency>
  2.   <groupId>com.flexudy.education</groupId>
  3.   <artifactId>flexudy-client</artifactId>
  4.   <version>1.0</version>
  5. </dependency>

Others

You’ll need to manually install the following JARs:

Documentation

Please see the REST API Docs - Production or REST API Docs - Sandbox for the most
up-to-date documentation.

Usage

The main interface to the API is via the FlexudyClient Facade Object as shown below.

Configuring Environment

By default the Gateway connects to the PRODUCTION server at Gateway API Server - Production In order, to
switch to another environment set it during the FlexudyClient object construction.

Configuring Timeouts

Connect, write and read timeouts can be configured using the HttpClientConfig object when creating the Gateway client
object. It would default to the following if no custom client config is provided:

  • Connect timeout: 1 minute
  • Write timeout: 3 minutes
  • Read timeout: 3 minutes
  2. import com.flexudy.education.client.service.FlexudyClient;
  3. import com.flexudy.education.client.service.HttpClientConfig;
  4. import com.flexudy.education.client.service.network.Environment;
  6. public class Driver {
  8.     public static void main(String[] args) {
  9.         final HttpClientConfig httpConfig = HttpClientConfig.builder()
  10.                                                             .connectTimeoutSeconds(60)
  11.                                                             .readTimeoutSeconds(30)
  12.                                                             .writeTimeoutSeconds(20)
  13.                                                             .build();
  15.         final FlexudyClient client = FlexudyClient.builder().licenseKey(licenseKey)
  16.                                                             .httpClientConfig(httpConfig)
  17.                                                             .environment(Environment.PRODUCTION)
  18.                                                             .build();
  21.     }
  22. }

FlexudyClientExample.java

  2. import com.flexudy.education.client.data.common.AsyncRequestData;
  3. import com.flexudy.education.client.data.common.CommonRequestData;
  4. import com.flexudy.education.client.data.common.CommonRequestData.SimpleAsyncRequestData;
  5. import com.flexudy.education.client.data.common.CommonRequestData.SimpleCommonRequestData;
  6. import com.flexudy.education.client.data.quiz.ClozeQuestion;
  7. import com.flexudy.education.client.data.quiz.OpenQuestion;
  8. import com.flexudy.education.client.data.quiz.WHQuestion;
  9. import com.flexudy.education.client.data.summary.Summary;
  10. import com.flexudy.education.client.service.FlexudyClient;
  12. import java.io.File;
  13. import java.io.FileInputStream;
  14. import java.io.IOException;
  15. import java.io.InputStream;
  16. import java.util.List;
  17. import java.util.concurrent.ExecutionException;
  18. import java.util.concurrent.Future;
  19. import java.util.concurrent.TimeoutException;
  21. import static com.flexudy.education.client.data.common.CommonRequestData.SimpleAsyncRequestData.fromCommonRequestData;
  22. import static java.util.concurrent.TimeUnit.MINUTES;
  24. public class Driver {
  26.     public static void main(String[] args) throws InterruptedException, ExecutionException, TimeoutException, IOException {
  27.         final InputStream sampleFile = new FileInputStream(new File("README.md"));
  28.         final String sampleText = "The capital of the UAE is Abu Dhabi. The capital of France is Paris";
  29.         final String licenseKey = "715d26f5-260a-43c9-838f-82c9664ca701";
  31.         final CommonRequestData fileData = SimpleCommonRequestData.builder().files(List.of(sampleFile)).build();
  32.         final CommonRequestData urlData = SimpleCommonRequestData.builder().contentUrls(List.of("https://flexudy.com"))
  33.                                                                  .build();
  34.         final AsyncRequestData textData = SimpleAsyncRequestData.builder().textContent(sampleText).build();
  36.         final FlexudyClient client = FlexudyClient.builder().licenseKey(licenseKey).build();
  38.         System.out.println("\n*********** Generating Cloze Questions for a URL source ***********\n");
  39.         System.out.println(String.format("Cloze Quiz: %s", client.generateClozeQuiz(urlData)));
  41.         System.out.println("\n*********** Generating WH Questions for a File source ***********\n");
  42.         System.out.println(String.format("WH Quiz: %s", client.generateWHQuiz(fileData)));
  44.         System.out.println("\n*********** Generating Open Questions for a URL source ***********\n");
  45.         System.out.println(String.format("Open Quiz: %s", client.generateOpenQuiz(urlData)));
  47.         System.out.println("\n*********** Generating Summary for a URL source ***********\n");
  48.         System.out.println(client.generateSummary(urlData).getFacts());
  50.         System.out.println("\n*********** Generating Cloze Questions for an Asynchronous URL Content ***********\n");
  51.         final Future<List<ClozeQuestion>> futureClozeQuiz = client.submitClozeQuizJob(fromCommonRequestData(urlData));
  52.         System.out.println(String.format("Async Cloze Quiz: %s", futureClozeQuiz.get(5, MINUTES)));
  54.         System.out.println("\n*********** Generating WH Questions for an Asynchronous File Content ***********\n");
  55.         final Future<List<WHQuestion>> futureWHQuestions = client.submitWHQuizJob(fromCommonRequestData(urlData));
  56.         System.out.println(String.format("Async WH Quiz: %s", futureWHQuestions.get(5, MINUTES)));
  58.         System.out.println("\n*********** Generating Open Questions for an Asynchronous File Content ***********\n");
  59.         final Future<List<OpenQuestion>> futureOpenQuestions = client.submitOpenQuizJob(fromCommonRequestData(urlData));
  60.         System.out.println(String.format("Async Open Quiz: %s", futureOpenQuestions.get(5, MINUTES)));
  62.         System.out.println("\n*********** Generating Summary for an Asynchronous Text source  ***********\n");
  63.         final Future<Summary> futureSummary = client.submitSummaryJob(fromCommonRequestData(textData));
  64.         System.out.println("Async Summary: " + futureSummary.get(5, MINUTES).getFacts());
  66.         System.exit(0);
  67.     }
  68. }

Please take care to set conservative read timeouts. Some API requests can take
some time, and a short timeout increases the likelihood of a problem within our
servers.

Development

To run the tests:

  1. mvn test

The library uses Project Lombok. While it is not a requirement, you
might want to install a plugin for your favorite IDE to
facilitate development.

License

  1. Copyright 2020 Flexudy
  3. Licensed under the Apache License, Version 2.0 (the "License"); you may not
  4. use this file except in compliance with the License. You may obtain a copy of
  5. the License at
  7.     http://www.apache.org/licenses/LICENSE-2.0
  9. Unless required by applicable law or agreed to in writing, software
  10. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  11. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  12. License for the specific language governing permissions and limitations under
  13. the License.