pax_global_header00006660000000000000000000000064135635102770014523gustar00rootroot0000000000000052 comment=e130a802217ddb138647df0aa8b0b01ef211f002 Google-PerspectiveAPI-Java-Client-0.0.5/000077500000000000000000000000001356351027700176555ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/.gitignore000066400000000000000000000001331356351027700216420ustar00rootroot00000000000000.settings/ .classpath .project target/ src/au/com/origma/perspectiveapi/v1alpha1/Main.java Google-PerspectiveAPI-Java-Client-0.0.5/LICENSE000066400000000000000000000250071356351027700206660ustar00rootroot00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS Copyright 2019 Origma Pty Ltd Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Google-PerspectiveAPI-Java-Client-0.0.5/README.md000066400000000000000000000022651356351027700211410ustar00rootroot00000000000000# Google-PerspectiveAPI-Java-Client A Java client for Google's PerspectiveAPI ## Usage First create a new PerspectiveAPI instance: ```java PerspectiveAPI pAPI = PerspectiveAPI.create(key); ``` Then build an analysis request using the builder: ```java pAPI.analyze(new AnalyzeCommentRequest.Builder() .addRequestedAttribute(AttributeType.TOXICITY, null) .comment(new Entry.Builder() .type(ContentType.PLAIN_TEXT) .text(comment) .build()) .build()); ``` or do a simple request ```java pAPI.analyze(comment); ``` To understand the models and their functions, see https://github.com/conversationai/perspectiveapi/blob/master/2-api/models.md and https://github.com/conversationai/perspectiveapi/blob/master/2-api/methods.md ## Maven ``` com.github.origma Google-PerspectiveAPI-Java-Client 0.0.5 ``` ... ``` jitpack.io https://jitpack.io ``` ## See Also * [Google API Reference](https://github.com/conversationai/perspectiveapi/tree/master/2-api) * [JavaDoc](https://origma.com.au/docs/perspectiveapi) Google-PerspectiveAPI-Java-Client-0.0.5/pom.xml000066400000000000000000000014421356351027700211730ustar00rootroot00000000000000 4.0.0 au.com.origma PerspectiveAPI 0.0.5 src maven-compiler-plugin 3.3 1.8 1.8 com.konghq unirest-java 3.1.02 Google-PerspectiveAPI-Java-Client-0.0.5/src/000077500000000000000000000000001356351027700204445ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/000077500000000000000000000000001356351027700210515ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/000077500000000000000000000000001356351027700216275ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/000077500000000000000000000000001356351027700231055ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/000077500000000000000000000000001356351027700261305ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/v1alpha1/000077500000000000000000000000001356351027700275455ustar00rootroot00000000000000PerspectiveAPI.java000066400000000000000000000047531356351027700331650ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/v1alpha1/* * Copyright 2019 Origma Pty Ltd (ACN 629 381 184) and contributors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * Written by Ben McLean , November 2019 */ package au.com.origma.perspectiveapi.v1alpha1; import au.com.origma.perspectiveapi.v1alpha1.models.AnalyzeCommentRequest; import au.com.origma.perspectiveapi.v1alpha1.models.AnalyzeCommentResponse; import au.com.origma.perspectiveapi.v1alpha1.models.SuggestScoreRequest; import au.com.origma.perspectiveapi.v1alpha1.models.SuggestScoreResponse; /** * Interact with Google's PerspectiveAPI to analyze comments and content.
* See the API documentation * here * * @author Ben McLean <ben@origma.com.au> */ public interface PerspectiveAPI { /** * The endpoint to which analysis requests are sent */ public static final String ANALYZE_ENDPOINT = "https://commentanalyzer.googleapis.com/v1alpha1/comments:analyze"; /** * The endpoint to which suggestion requests are sent */ public static final String SUGGEST_ENDPOINT = "https://commentanalyzer.googleapis.com/v1alpha1/comments:suggestscore"; /** * Analyze a comment * @param request The request * @return The analysis of the request */ public AnalyzeCommentResponse analyze(AnalyzeCommentRequest request); /** * Analyze a comment with the default settings * @param comment The comment to analyze * @return The analysis of the request */ public AnalyzeCommentResponse analyze(String comment); /** * Suggest a score for a comment * @param request The request * @return The response */ public SuggestScoreResponse suggestScore(SuggestScoreRequest request); /** * Instantiate the default implementation of the PerspectiveAPI * @param apiKey The Google API key * @return The default implementation of the PerspectiveAPI */ public static PerspectiveAPI create(String apiKey) { return new UnirestPerspectiveAPI(apiKey); } } UnirestPerspectiveAPI.java000066400000000000000000000061121356351027700345260ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/v1alpha1/* * Copyright 2019 Origma Pty Ltd (ACN 629 381 184) and contributors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * Written by Ben McLean , November 2019 */ package au.com.origma.perspectiveapi.v1alpha1; import au.com.origma.perspectiveapi.v1alpha1.models.AnalyzeCommentRequest; import au.com.origma.perspectiveapi.v1alpha1.models.AnalyzeCommentResponse; import au.com.origma.perspectiveapi.v1alpha1.models.AttributeType; import au.com.origma.perspectiveapi.v1alpha1.models.ContentType; import au.com.origma.perspectiveapi.v1alpha1.models.Entry; import au.com.origma.perspectiveapi.v1alpha1.models.SuggestScoreRequest; import au.com.origma.perspectiveapi.v1alpha1.models.SuggestScoreResponse; import kong.unirest.HttpResponse; import kong.unirest.Unirest; /** * The default implementation of the PerspectiveAPI client, made using the Unirest library * * @author Ben McLean <ben@origma.com.au> */ public class UnirestPerspectiveAPI implements PerspectiveAPI { String apiKey; boolean doNotStore = true; /** * Create a new instance of UnirestPerspectiveAPI * @param apiKey Your Google API Key */ public UnirestPerspectiveAPI(String apiKey) { super(); this.apiKey = apiKey; } @Override public AnalyzeCommentResponse analyze(AnalyzeCommentRequest request) { HttpResponse response = Unirest.post(ANALYZE_ENDPOINT) .queryString("key", apiKey) .body(request) .asObject(AnalyzeCommentResponse.class); if(!response.isSuccess()){ return null; } return response.getBody(); } @Override public AnalyzeCommentResponse analyze(String comment) { return analyze(new AnalyzeCommentRequest.Builder() .addRequestedAttribute(AttributeType.TOXICITY, null) .comment(new Entry.Builder() .type(ContentType.PLAIN_TEXT) .text(comment) .build()) .doNotStore(doNotStore) .build()); } @Override public SuggestScoreResponse suggestScore(SuggestScoreRequest request) { HttpResponse response = Unirest.post(SUGGEST_ENDPOINT) .queryString("key", apiKey) .body(request) .asObject(SuggestScoreResponse.class); if(!response.isSuccess()){ return null; } return response.getBody(); } /** * If the simple analysis will default to do not store * @return the simple analysis will default to do not store */ public boolean isDoNotStore() { return doNotStore; } /** * The default do not store setting * @param doNotStore The default do not store setting */ public void setDoNotStore(boolean doNotStore) { this.doNotStore = doNotStore; } } Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/v1alpha1/models/000077500000000000000000000000001356351027700310305ustar00rootroot00000000000000AnalyzeCommentRequest.java000066400000000000000000000151111356351027700361120ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/v1alpha1/models/* * Copyright 2019 Origma Pty Ltd (ACN 629 381 184) and contributors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * Written by Ben McLean , November 2019 */ package au.com.origma.perspectiveapi.v1alpha1.models; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; /** * A request to analyze a string of text for attributes * @author Ben McLean <ben@origma.com.au> */ public class AnalyzeCommentRequest { Entry comment; Context context; Map requestedAttributes; List languages; Boolean doNotStore; String clientToken; String sessionId; Double suggestCommentScore; /** * Returns the comment to be analyzed by the request * @return */ public Entry getComment() { return comment; } /** * Returns the content of the request * @return the content of the request */ public Context getContext() { return context; } /** * Returns the attributes that will be requested * @return the attributes that will be requested */ public Map getRequestedAttributes() { return requestedAttributes; } /** * Returns the set languages for the request * @return the set languages for the request */ public List getLanguages() { return languages; } /** * Returns whether the comment will be stored for analysis or not * @return whether the comment will be stored for analysis or not */ public Boolean getDoNotStore() { return doNotStore; } /** * Returns the client token of the request * @return the client token of the request */ public String getClientToken() { return clientToken; } /** * Returns the session ID of the request * @return the session ID of the request */ public String getSessionId() { return sessionId; } /** * Returns the comment score suggested to the analyzer * @return the comment score suggested to the analyzer */ public Double getSuggestCommentScore() { return suggestCommentScore; } /** * Builds an AnalyzeCommentRequest * * @author Ben McLean <ben@origma.com.au> * */ public static class Builder { private Entry comment; private Context context; private Map requestedAttributes = new HashMap<>(); private List languages = new ArrayList<>(); private Boolean doNotStore; private String clientToken; private String sessionId; private Double suggestCommentScore; /** * Set the comment of the future AnalyzeCommentRequest * @param comment the comment of the future AnalyzeCommentRequest * @return The builder */ public Builder comment(Entry comment) { this.comment = comment; return this; } /** * Set the context of the future AnalyzeCommentRequest * @param context the context of the future AnalyzeCommentRequest * @return The builder */ public Builder context(Context context) { this.context = context; return this; } /** * Set the requested attributes of the future AnalyzeCommentRequest * @param requestedAttributes the requested attributes of the future AnalyzeCommentRequest * @return The builder */ public Builder requestedAttributes(Map requestedAttributes) { this.requestedAttributes = requestedAttributes; return this; } /** * Add a requested attribute to the future AnalyzeCommentRequest * @param type The type of the requested attribute * @param requestedAttribute The parameters of the requested attribute * @return The builder */ public Builder addRequestedAttribute(AttributeType type, RequestedAttribute requestedAttribute) { if(requestedAttribute != null){ requestedAttributes.put(type, requestedAttribute); }else{ requestedAttributes.put(type, new RequestedAttribute.Builder().build()); } return this; } /** * Set the languages of the future AnalyzeCommentRequest * @param languages the languages of the future AnalyzeCommentRequest in ISO 639-1 * @return The builder */ public Builder languages(List languages) { this.languages = languages; return this; } /** * Add a language to the future AnalyzeCommentRequest * @param language The language in ISO 639-1 * @return The builder */ public Builder addLanguage(String language){ languages.add(language); return this; } /** * Set the do not store of the future AnalyzeCommentRequest * @param doNotStore the do not store of the future AnalyzeCommentRequest * @return The builder */ public Builder doNotStore(Boolean doNotStore) { this.doNotStore = doNotStore; return this; } /** * Set the client token of the future AnalyzeCommentRequest * @param clientToken the clientToken of the future AnalyzeCommentRequest * @return The builder */ public Builder clientToken(String clientToken) { this.clientToken = clientToken; return this; } /** * Set the session ID of the future AnalyzeCommentRequest * @param sessionId the sessionId of the future AnalyzeCommentRequest * @return The builder */ public Builder sessionId(String sessionId) { this.sessionId = sessionId; return this; } /** * Set the suggested comment score of the future AnalyzeCommentRequest * @param suggestCommentScore the suggested comment score of the future AnalyzeCommentRequest * @return The builder */ public Builder suggestCommentScore(Double suggestCommentScore) { this.suggestCommentScore = suggestCommentScore; return this; } /** * Build and create a new instance of AnalyzeCommentRequest * @return The builder */ public AnalyzeCommentRequest build() { return new AnalyzeCommentRequest(this); } } private AnalyzeCommentRequest(Builder builder) { this.comment = builder.comment; this.context = builder.context; this.requestedAttributes = builder.requestedAttributes; this.languages = builder.languages; this.doNotStore = builder.doNotStore; this.clientToken = builder.clientToken; this.sessionId = builder.sessionId; this.suggestCommentScore = builder.suggestCommentScore; } } AnalyzeCommentResponse.java000066400000000000000000000052661356351027700362720ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/v1alpha1/models/* * Copyright 2019 Origma Pty Ltd (ACN 629 381 184) and contributors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * Written by Ben McLean , November 2019 */ package au.com.origma.perspectiveapi.v1alpha1.models; import java.util.List; import java.util.Map; /** * The response of an analysis * * @author Ben McLean <ben@origma.com.au> * */ public class AnalyzeCommentResponse { Map attributeScores; List languages; String clientToken; /** * Create a new empty instance */ public AnalyzeCommentResponse() { super(); } /** * Create a new instance */ public AnalyzeCommentResponse(Map attributeScores, List languages, String clientToken) { super(); this.attributeScores = attributeScores; this.languages = languages; this.clientToken = clientToken; } /** * Returns the scores of the requested attributes * @return the scores of the requested attributes */ public Map getAttributeScores() { return attributeScores; } /** * Returns a specific attribute score * @param type The attribute for which a score should be returned * @return a specific attribute score */ public AttributeScore getAttributeScore(AttributeType type){ return attributeScores.get(type); } /** * Sets the attribute scores * @param attributeScores the attribute scores */ public void setAttributeScores(Map attributeScores) { this.attributeScores = attributeScores; } /** * Gets the languages the request was in * @return the languages the request was in */ public List getLanguages() { return languages; } /** * Sets the languages the request was in * @param languages the languages the request was in */ public void setLanguages(List languages) { this.languages = languages; } /** * Gets the client token * @return the client token */ public String getClientToken() { return clientToken; } /** * Sets the client token * @param clientToken the client token */ public void setClientToken(String clientToken) { this.clientToken = clientToken; } } AttributeScore.java000066400000000000000000000035441356351027700345610ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/v1alpha1/models/* * Copyright 2019 Origma Pty Ltd (ACN 629 381 184) and contributors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * Written by Ben McLean , November 2019 */ package au.com.origma.perspectiveapi.v1alpha1.models; import java.util.List; /** * The score of an attribute * * @author Ben McLean <ben@origma.com.au> * */ public class AttributeScore { Score summaryScore; List spanScores; /** * Create an empty instance */ public AttributeScore() { super(); } /** * Create an instance */ public AttributeScore(Score summaryScore, List spanScores) { super(); this.summaryScore = summaryScore; this.spanScores = spanScores; } /** * Returns the summary of all span scores * @return the summary of all span scores */ public Score getSummaryScore() { return summaryScore; } /** * Sets the summary of all span scores * @param summaryScore the summary of all span scores */ public void setSummaryScore(Score summaryScore) { this.summaryScore = summaryScore; } /** * Returns the scores of spans * @return the scores of spans */ public List getSpanScores() { return spanScores; } /** * Sets the scores of spans * @param spanScores the scores of spans */ public void setSpanScores(List spanScores) { this.spanScores = spanScores; } } AttributeType.java000066400000000000000000000025331356351027700344240ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/v1alpha1/models/* * Copyright 2019 Origma Pty Ltd (ACN 629 381 184) and contributors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * Written by Ben McLean , November 2019 */ package au.com.origma.perspectiveapi.v1alpha1.models; /** * Represents the types of attributes that can be analysed in any given request * * @author Ben McLean <ben@origma.com.au> * */ public enum AttributeType { TOXICITY, TOXICITY_EXPERIMENTAL, SEVERE_TOXICITY, SEVERE_TOXICITY_EXPERIMENTAL, TOXICITY_FAST, IDENTITY_ATTACK, IDENTITY_ATTACK_EXPERIMENTAL, INSULT, INSULT_EXPERIMENTAL, PROFANITY, PROFANITY_EXPERIMENTAL, THREAT, THREAT_EXPERIMENTAL, SEXUALLY_EXPLICIT, FLIRTATION, /* New York Times models below */ ATTACK_ON_AUTHOR, ATTACK_ON_COMMENTER, INCOHERENT, INFLAMMATORY, LIKELY_TO_REJECT, OBSCENE, SPAM, UNSUBSTANTIAL; } ContentType.java000066400000000000000000000017411356351027700340730ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/v1alpha1/models/* * Copyright 2019 Origma Pty Ltd (ACN 629 381 184) and contributors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * Written by Ben McLean , November 2019 */ package au.com.origma.perspectiveapi.v1alpha1.models; /** * The format the content is in * * @author Ben McLean <ben@origma.com.au> * */ public enum ContentType { /** * The content is in plain text */ PLAIN_TEXT, /** * Not currently supported */ @Deprecated HTML; } Context.java000066400000000000000000000031411356351027700332370ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/v1alpha1/models/* * Copyright 2019 Origma Pty Ltd (ACN 629 381 184) and contributors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * Written by Ben McLean , November 2019 */ package au.com.origma.perspectiveapi.v1alpha1.models; import java.util.List; /** * Context surrounding the request * * @author Ben McLean <ben@origma.com.au> */ public class Context { List entries; /** * Returns the context entries * @return the context entries */ public List getEntries() { return entries; } /** * Builds a Context * * @author Ben McLean <ben@origma.com.au> * */ public static class Builder { private List entries; /** * Sets the context entries * @param entries the context entries * @return The builder */ public Builder entries(List entries) { this.entries = entries; return this; } /** * Returns a new instance of Context * @return a new instance of Context */ public Context build() { return new Context(this); } } private Context(Builder builder) { this.entries = builder.entries; } } Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/v1alpha1/models/Entry.java000066400000000000000000000044121356351027700327750ustar00rootroot00000000000000/* * Copyright 2019 Origma Pty Ltd (ACN 629 381 184) and contributors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * Written by Ben McLean , November 2019 */ package au.com.origma.perspectiveapi.v1alpha1.models; /** * A representation of some content or context as a String * * @author Ben McLean <ben@origma.com.au> * */ public class Entry { String text; ContentType type; /** * Create an empty instance */ public Entry() { } /** * Returns the text of the entry * @return the text of the entry */ public String getText() { return text; } /** * Sets the text of the entry * @param text the text of the entry */ public void setText(String text) { this.text = text; } /** * Returns the type of the entry * @return the type of the entry */ public ContentType getType() { return type; } /** * Sets the type of the entry * @param type the type of the entry */ public void setType(ContentType type) { this.type = type; } /** * Builds an entry * * @author Ben McLean <ben@origma.com.au> */ public static class Builder { private String text; private ContentType type; /** * Sets the text of the entry * @param text the text of the entry * @return The builder */ public Builder text(String text) { this.text = text; return this; } /** * Sets the type of the entry * @param type the type of the entry * @return The builder */ public Builder type(ContentType type) { this.type = type; return this; } /** * Returns a new instance of Entry * @return a new instance of Entry */ public Entry build() { return new Entry(this); } } private Entry(Builder builder) { this.text = builder.text; this.type = builder.type; } } RequestedAttribute.java000066400000000000000000000044071356351027700354460ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/v1alpha1/models/* * Copyright 2019 Origma Pty Ltd (ACN 629 381 184) and contributors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * Written by Ben McLean , November 2019 */ package au.com.origma.perspectiveapi.v1alpha1.models; /** * Represents the parameters of a requested attribute * * @author Ben McLean <ben@origma.com.au> * */ public class RequestedAttribute { ScoreType scoreType; Double scoreThreshold; /** * Returns the score type of the attribute * @return the score type of the attribute */ public ScoreType getScoreType() { return scoreType; } /** * Returns the score threshold of the attribute * @return the score threshold of the attribute */ public Double getScoreThreshold() { return scoreThreshold; } /** * Builds a RequestedAttribute * * @author Ben McLean <ben@origma.com.au> */ public static class Builder { private ScoreType scoreType; private Double scoreThreshold; /** * Sets the score type of the attribute * @param scoreType the score type of the attribute * @return The builder */ public Builder scoreType(ScoreType scoreType) { this.scoreType = scoreType; return this; } /** * Sets the score threshold of the attribute * @param scoreThreshold the score threshold of the attribute * @return The builder */ public Builder scoreThreshold(Double scoreThreshold) { this.scoreThreshold = scoreThreshold; return this; } /** * Builds a new instance of RequestedAttribute * @return a new instance of RequestedAttribute */ public RequestedAttribute build() { return new RequestedAttribute(this); } } private RequestedAttribute(Builder builder) { this.scoreType = builder.scoreType; this.scoreThreshold = builder.scoreThreshold; } } Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/v1alpha1/models/Score.java000066400000000000000000000031461356351027700327520ustar00rootroot00000000000000/* * Copyright 2019 Origma Pty Ltd (ACN 629 381 184) and contributors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * Written by Ben McLean , November 2019 */ package au.com.origma.perspectiveapi.v1alpha1.models; /** * Represents the value of an analysis attribute * * @author Ben McLean <ben@origma.com.au> */ public class Score { float value; ScoreType type; /** * Create an empty instance */ public Score(){} /** * Create an instance */ public Score(float value, ScoreType type) { super(); this.value = value; this.type = type; } /** * Returns the value of a score * @return the value of a score */ public float getValue() { return value; } /** * Sets the value of a score * @param value the value of a score */ public void setValue(float value) { this.value = value; } /** * Returns the type of a score * @return the type of a score */ public ScoreType getType() { return type; } /** * Sets the type of a score * @param type the type of a score */ public void setType(ScoreType type) { this.type = type; } } ScoreType.java000066400000000000000000000015601356351027700335330ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/v1alpha1/models/* * Copyright 2019 Origma Pty Ltd (ACN 629 381 184) and contributors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * Written by Ben McLean , November 2019 */ package au.com.origma.perspectiveapi.v1alpha1.models; /** * The form a score takes * * @author Ben McLean <ben@origma.com.au> * */ public enum ScoreType { PROBABILITY } SpanScore.java000066400000000000000000000037631356351027700335220ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/v1alpha1/models/* * Copyright 2019 Origma Pty Ltd (ACN 629 381 184) and contributors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * Written by Ben McLean , November 2019 */ package au.com.origma.perspectiveapi.v1alpha1.models; /** * A score representing a span of the analyzed comment * * @author Ben McLean <ben@origma.com.au> * */ public class SpanScore { int begin; int end; Score score; /** * Create an empty instance */ public SpanScore(){} /** * Create an instance */ public SpanScore(int begin, int end, Score score) { super(); this.begin = begin; this.end = end; this.score = score; } /** * Returns the beginning position of the span * @return the beginning position of the span */ public int getBegin() { return begin; } /** * Sets the beginning position of the span * @param begin the beginning position of the span */ public void setBegin(int begin) { this.begin = begin; } /** * Returns the ending position of the span * @return the ending position of the span */ public int getEnd() { return end; } /** * Sets the ending position of the span * @param end the ending position of the span */ public void setEnd(int end) { this.end = end; } /** * Returns the score of the span * @return the score of the span */ public Score getScore() { return score; } /** * Sets the score of the span * @param score the score of the span */ public void setScore(Score score) { this.score = score; } } SuggestScoreRequest.java000066400000000000000000000123051356351027700356030ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/v1alpha1/models/* * Copyright 2019 Origma Pty Ltd (ACN 629 381 184) and contributors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * Written by Ben McLean , November 2019 */ package au.com.origma.perspectiveapi.v1alpha1.models; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; /** * Send a suggested score for a request * * @author Ben McLean <ben@origma.com.au> * */ public class SuggestScoreRequest { Entry comment; Context context; Map attributeScores; List languages; String communityId; String clientToken; /** * Same as AnalyzeComment request. * * @return the comment for which the score is being suggested */ public Entry getComment() { return comment; } /** * Same as AnalyzeComment request. * * @return the context of the request */ public Context getContext() { return context; } /** * Similar to AnalyzeComment response. This holds the attribute scores that the * client believes the comment should have. It has the same format as the * attributeScores field in the AnalyzeComment response, as it's what the client * believes is the correct "answer" for what this comment should be scored as. * The client can specify just summary scores, just span scores, or both. * * @return the attribute scores of the request */ public Map getAttributeScores() { return attributeScores; } /** * Returns the languages of the request * * @return the languages of the request */ public List getLanguages() { return languages; } /** * Opaque identifier associating this score suggestion with a particular * community. If set, this field allows us to differentiate suggestions from * different communities, as each community may have different norms. * * @return the community id */ public String getCommunityId() { return communityId; } /** * An opaque token that is echoed back in the response. * * @return the client token */ public String getClientToken() { return clientToken; } /** * Builds a SuggestScoreRequest * * @author Ben McLean <ben@origma.com.au> * */ public static class Builder { private Entry comment; private Context context; private Map attributeScores = new HashMap<>(); private List languages = new ArrayList<>(); private String communityId; private String clientToken; /** * Set the comment for a suggestion * @param comment the comment * @return The builder */ public Builder comment(Entry comment) { this.comment = comment; return this; } /** * Set the context for a suggestion * @param context the context * @return The builder */ public Builder context(Context context) { this.context = context; return this; } /** * Set the attribute scores for a suggestion * @param attributeScores the attribute scores * @return The builder */ public Builder attributeScores(Map attributeScores) { this.attributeScores = attributeScores; return this; } /** * Add an attribute score * @param type The attribute type * @param score The attribute score * @return The builder */ public Builder addAttributeScore(AttributeType type, AttributeScore score) { this.attributeScores.put(type, score); return this; } /** * Set the languages for a suggestion * @param languages the languages * @return The builder */ public Builder languages(List languages) { this.languages = languages; return this; } /** * Add a language * @param language the language * @return The builder */ public Builder addLanugage(String language) { this.languages.add(language); return this; } /** * Set the community id * @param communityId the community id * @return The builder */ public Builder communityId(String communityId) { this.communityId = communityId; return this; } /** * Set the client token * @param clientToken the client token * @return The builder */ public Builder clientToken(String clientToken) { this.clientToken = clientToken; return this; } /** * Build a new SuggestScoreRequest instance * @return a new SuggestScoreRequest instance */ public SuggestScoreRequest build() { return new SuggestScoreRequest(this); } } private SuggestScoreRequest(Builder builder) { this.comment = builder.comment; this.context = builder.context; this.attributeScores = builder.attributeScores; this.languages = builder.languages; this.communityId = builder.communityId; this.clientToken = builder.clientToken; } } SuggestScoreResponse.java000066400000000000000000000026211356351027700357510ustar00rootroot00000000000000Google-PerspectiveAPI-Java-Client-0.0.5/src/au/com/origma/perspectiveapi/v1alpha1/models/* /* * Copyright 2019 Origma Pty Ltd (ACN 629 381 184) and contributors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * Written by Ben McLean , November 2019 */ package au.com.origma.perspectiveapi.v1alpha1.models; /** * A SuggestScoreRequest response * * @author Ben McLean <ben@origma.com.au> * */ public class SuggestScoreResponse { String clientToken; /** * Create an empty instance */ public SuggestScoreResponse() {} /** * Create an instance */ public SuggestScoreResponse(String clientToken) { super(); this.clientToken = clientToken; } /** * Mirrors the request's clientToken * @return the client token */ public String getClientToken() { return clientToken; } /** * Sets the client token * @param clientToken the client token */ public void setClientToken(String clientToken) { this.clientToken = clientToken; } }