Skip to content

Commit

Permalink
Update models (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
@samvaity
samvaity authored Dec 18, 2019
1 parent fc4d338 commit 1600d24
Show file tree
Hide file tree
Showing 18 changed files with 645 additions and 476 deletions.
720 changes: 425 additions & 295 deletions ...e-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsAsyncClient.java
View file

Large diffs are not rendered by default.

102 changes: 51 additions & 51 deletions .../azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsClient.java
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions ...xtanalytics/src/main/java/com/azure/ai/textanalytics/models/DocumentResultCollection.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
public class DocumentResultCollection<T> extends IterableStream<T> {

private final String modelVersion;
private final TextBatchStatistics statistics;
private final TextDocumentBatchStatistics statistics;

/**
* Create a document result collection
Expand All @@ -24,7 +24,7 @@ public class DocumentResultCollection<T> extends IterableStream<T> {
* @param modelVersion model version
* @param statistics Text batch statistics
*/
public DocumentResultCollection(Iterable<T> iterable, String modelVersion, TextBatchStatistics statistics) {
public DocumentResultCollection(Iterable<T> iterable, String modelVersion, TextDocumentBatchStatistics statistics) {
super(iterable);
this.modelVersion = modelVersion;
this.statistics = statistics;
Expand All @@ -44,7 +44,7 @@ public String getModelVersion() {
*
* @return the statistics of the batch documents
*/
public TextBatchStatistics getStatistics() {
public TextDocumentBatchStatistics getStatistics() {
return statistics;
}
}
12 changes: 6 additions & 6 deletions ...alytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/Error.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public final class Error {
* Inner error contains more specific information.
*/
@JsonProperty(value = "innererror")
private InnerError innererror;
private InnerError innerError;

/*
* Details about specific errors that led to this reported error.
Expand Down Expand Up @@ -115,19 +115,19 @@ public Error setTarget(String target) {
*
* @return the innererror value.
*/
public InnerError getInnererror() {
return this.innererror;
public InnerError getInnerError() {
return this.innerError;
}

/**
* Set the innererror property: Inner error contains more specific
* information.
*
* @param innererror the innererror value to set.
* @param innerError the innererror value to set.
* @return the Error object itself.
*/
public Error setInnererror(InnerError innererror) {
this.innererror = innererror;
public Error setInnerError(InnerError innerError) {
this.innerError = innerError;
return this;
}

Expand Down
6 changes: 3 additions & 3 deletions ...textanalytics/models/KeyPhraseResult.java → ...lytics/models/ExtractKeyPhraseResult.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
import java.util.List;

/**
* The KeyPhraseResult model.
* The ExtractKeyPhraseResult model.
*/
@Immutable
public final class KeyPhraseResult extends DocumentResult {
public final class ExtractKeyPhraseResult extends DocumentResult {
private final List<String> keyPhrases;

/**
Expand All @@ -22,7 +22,7 @@ public final class KeyPhraseResult extends DocumentResult {
* @param error the document error.
* @param keyPhrases a list of key phrases string
*/
public KeyPhraseResult(String id, TextDocumentStatistics textDocumentStatistics, Error error,
public ExtractKeyPhraseResult(String id, TextDocumentStatistics textDocumentStatistics, Error error,
List<String> keyPhrases) {
super(id, textDocumentStatistics, error);
this.keyPhrases = keyPhrases;
Expand Down
8 changes: 4 additions & 4 deletions ...xtanalytics/models/NamedEntityResult.java → ...ytics/models/RecognizeEntitiesResult.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@
import java.util.List;

/**
* The NamedEntityResult model.
* The RecognizeEntitiesResult model.
*/
@Immutable
public final class NamedEntityResult extends DocumentResult {
public final class RecognizeEntitiesResult extends DocumentResult {
private final List<NamedEntity> namedEntities;

/**
* Creates a {@code NamedEntityResult} model that describes recognized entities result
* Creates a {@code RecognizeEntitiesResult} model that describes recognized entities result
*
* @param id unique, non-empty document identifier
* @param textDocumentStatistics text document statistics
* @param error the document error
* @param namedEntities a list of {@link NamedEntity}
*/
public NamedEntityResult(String id, TextDocumentStatistics textDocumentStatistics, Error error,
public RecognizeEntitiesResult(String id, TextDocumentStatistics textDocumentStatistics, Error error,
List<NamedEntity> namedEntities) {
super(id, textDocumentStatistics, error);
this.namedEntities = namedEntities;
Expand Down
8 changes: 4 additions & 4 deletions ...tanalytics/models/LinkedEntityResult.java → ...models/RecognizeLinkedEntitiesResult.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@
import java.util.List;

/**
* The LinkedEntityResult model.
* The RecognizeLinkedEntitiesResult model.
*/
@Immutable
public final class LinkedEntityResult extends DocumentResult {
public final class RecognizeLinkedEntitiesResult extends DocumentResult {
private final List<LinkedEntity> linkedEntities;

/**
* Creates a {@code LinkedEntityResult} model that describes recognized linked entities result
* Creates a {@code RecognizeLinkedEntitiesResult} model that describes recognized linked entities result
*
* @param id unique, non-empty document identifier
* @param textDocumentStatistics text document statistics
* @param error the document error
* @param linkedEntities a list of linked entities
*/
public LinkedEntityResult(String id, TextDocumentStatistics textDocumentStatistics, Error error,
public RecognizeLinkedEntitiesResult(String id, TextDocumentStatistics textDocumentStatistics, Error error,
List<LinkedEntity> linkedEntities) {
super(id, textDocumentStatistics, error);
this.linkedEntities = linkedEntities;
Expand Down
39 changes: 39 additions & 0 deletions ...analytics/src/main/java/com/azure/ai/textanalytics/models/RecognizePiiEntitiesResult.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.ai.textanalytics.models;

import com.azure.core.annotation.Immutable;

import java.util.List;

/**
* The RecognizePiiEntitiesResult model.
*/
@Immutable
public final class RecognizePiiEntitiesResult extends DocumentResult {
private final List<NamedEntity> namedEntities;

/**
* Creates a {@code RecognizePiiEntitiesResult} model that describes recognized entities result
*
* @param id unique, non-empty document identifier
* @param textDocumentStatistics text document statistics
* @param error the document error
* @param namedEntities a list of {@link NamedEntity}
*/
public RecognizePiiEntitiesResult(String id, TextDocumentStatistics textDocumentStatistics, Error error,
List<NamedEntity> namedEntities) {
super(id, textDocumentStatistics, error);
this.namedEntities = namedEntities;
}

/**
* Get a list of named entities string
*
* @return a list of {@link NamedEntity}
*/
public List<NamedEntity> getNamedEntities() {
return namedEntities;
}
}
10 changes: 5 additions & 5 deletions ...analytics/models/TextBatchStatistics.java → ...s/models/TextDocumentBatchStatistics.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
* information about the request payload.
*/
@Fluent
public final class TextBatchStatistics {
public final class TextDocumentBatchStatistics {
/*
* Number of documents submitted in the request.
*/
Expand Down Expand Up @@ -56,7 +56,7 @@ public int getDocumentCount() {
* @param documentCount the documentCount value to set.
* @return the TextBatchStatistics object itself.
*/
public TextBatchStatistics setDocumentCount(int documentCount) {
public TextDocumentBatchStatistics setDocumentCount(int documentCount) {
this.documentCount = documentCount;
return this;
}
Expand All @@ -78,7 +78,7 @@ public int getValidDocumentCount() {
* @param validDocumentCount the validDocumentCount value to set.
* @return the TextBatchStatistics object itself.
*/
public TextBatchStatistics setValidDocumentCount(int validDocumentCount) {
public TextDocumentBatchStatistics setValidDocumentCount(int validDocumentCount) {
this.validDocumentCount = validDocumentCount;
return this;
}
Expand All @@ -102,7 +102,7 @@ public int getErroneousDocumentCount() {
* @param erroneousDocumentCount the erroneousDocumentCount value to set.
* @return the TextBatchStatistics object itself.
*/
public TextBatchStatistics setErroneousDocumentCount(int erroneousDocumentCount) {
public TextDocumentBatchStatistics setErroneousDocumentCount(int erroneousDocumentCount) {
this.erroneousDocumentCount = erroneousDocumentCount;
return this;
}
Expand All @@ -124,7 +124,7 @@ public long getTransactionCount() {
* @param transactionCount the transactionCount value to set.
* @return the TextBatchStatistics object itself.
*/
public TextBatchStatistics setTransactionCount(long transactionCount) {
public TextDocumentBatchStatistics setTransactionCount(long transactionCount) {
this.transactionCount = transactionCount;
return this;
}
Expand Down
4 changes: 2 additions & 2 deletions ...ics/src/samples/java/com/azure/ai/textanalytics/batch/AnalyzeSentimentBatchDocuments.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import com.azure.ai.textanalytics.TextAnalyticsClientBuilder;
import com.azure.ai.textanalytics.models.DocumentResultCollection;
import com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions;
import com.azure.ai.textanalytics.models.TextBatchStatistics;
import com.azure.ai.textanalytics.models.TextDocumentBatchStatistics;
import com.azure.ai.textanalytics.models.TextDocumentInput;
import com.azure.ai.textanalytics.models.TextSentiment;
import com.azure.ai.textanalytics.models.TextSentimentResult;
Expand Down Expand Up @@ -42,7 +42,7 @@ public static void main(String[] args) {
DocumentResultCollection<TextSentimentResult> detectedBatchResult = client.analyzeBatchSentimentWithResponse(inputs, requestOptions, Context.NONE).getValue();
System.out.printf("Model version: %s%n", detectedBatchResult.getModelVersion());

final TextBatchStatistics batchStatistics = detectedBatchResult.getStatistics();
final TextDocumentBatchStatistics batchStatistics = detectedBatchResult.getStatistics();
System.out.printf("A batch of document statistics, document count: %s, erroneous document count: %s, transaction count: %s, valid document count: %s.%n",
batchStatistics.getDocumentCount(),
batchStatistics.getErroneousDocumentCount(),
Expand Down
4 changes: 2 additions & 2 deletions ...ytics/src/samples/java/com/azure/ai/textanalytics/batch/DetectLanguageBatchDocuments.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import com.azure.ai.textanalytics.models.DetectedLanguage;
import com.azure.ai.textanalytics.models.DocumentResultCollection;
import com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions;
import com.azure.ai.textanalytics.models.TextBatchStatistics;
import com.azure.ai.textanalytics.models.TextDocumentBatchStatistics;
import com.azure.core.util.Context;

import java.util.Arrays;
Expand Down Expand Up @@ -42,7 +42,7 @@ public static void main(String[] args) {
final DocumentResultCollection<DetectLanguageResult> detectedBatchResult = client.detectBatchLanguagesWithResponse(inputs, requestOptions, Context.NONE).getValue();
System.out.printf("Model version: %s%n", detectedBatchResult.getModelVersion());

final TextBatchStatistics batchStatistics = detectedBatchResult.getStatistics();
final TextDocumentBatchStatistics batchStatistics = detectedBatchResult.getStatistics();
System.out.printf("Batch statistics, document count: %s, erroneous document count: %s, transaction count: %s, valid document count: %s.%n",
batchStatistics.getDocumentCount(),
batchStatistics.getErroneousDocumentCount(),
Expand Down
12 changes: 6 additions & 6 deletions ...cs/src/samples/java/com/azure/ai/textanalytics/batch/ExtractKeyPhrasesBatchDocuments.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
import com.azure.ai.textanalytics.TextAnalyticsClient;
import com.azure.ai.textanalytics.TextAnalyticsClientBuilder;
import com.azure.ai.textanalytics.models.DocumentResultCollection;
import com.azure.ai.textanalytics.models.KeyPhraseResult;
import com.azure.ai.textanalytics.models.ExtractKeyPhraseResult;
import com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions;
import com.azure.ai.textanalytics.models.TextBatchStatistics;
import com.azure.ai.textanalytics.models.TextDocumentBatchStatistics;
import com.azure.ai.textanalytics.models.TextDocumentInput;
import com.azure.core.util.Context;

Expand Down Expand Up @@ -38,19 +38,19 @@ public static void main(String[] args) {
);

final TextAnalyticsRequestOptions requestOptions = new TextAnalyticsRequestOptions().setShowStatistics(true);
final DocumentResultCollection<KeyPhraseResult> detectedBatchResult = client.extractBatchKeyPhrasesWithResponse(inputs, requestOptions, Context.NONE).getValue();
final DocumentResultCollection<ExtractKeyPhraseResult> detectedBatchResult = client.extractBatchKeyPhrasesWithResponse(inputs, requestOptions, Context.NONE).getValue();
System.out.printf("Model version: %s%n", detectedBatchResult.getModelVersion());

final TextBatchStatistics batchStatistics = detectedBatchResult.getStatistics();
final TextDocumentBatchStatistics batchStatistics = detectedBatchResult.getStatistics();
System.out.printf("A batch of document statistics, document count: %s, erroneous document count: %s, transaction count: %s, valid document count: %s.%n",
batchStatistics.getDocumentCount(),
batchStatistics.getErroneousDocumentCount(),
batchStatistics.getTransactionCount(),
batchStatistics.getValidDocumentCount());

// Detecting key phrase for each of document from a batch of documents
for (KeyPhraseResult keyPhraseResult: detectedBatchResult) {
for (String keyPhrases : keyPhraseResult.getKeyPhrases()) {
for (ExtractKeyPhraseResult extractKeyPhraseResult : detectedBatchResult) {
for (String keyPhrases : extractKeyPhraseResult.getKeyPhrases()) {
System.out.printf("Recognized Phrases: %s.%n", keyPhrases);
}
}
Expand Down
12 changes: 6 additions & 6 deletions ...cs/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeEntitiesBatchDocuments.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
import com.azure.ai.textanalytics.TextAnalyticsClientBuilder;
import com.azure.ai.textanalytics.models.DocumentResultCollection;
import com.azure.ai.textanalytics.models.NamedEntity;
import com.azure.ai.textanalytics.models.NamedEntityResult;
import com.azure.ai.textanalytics.models.RecognizeEntitiesResult;
import com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions;
import com.azure.ai.textanalytics.models.TextBatchStatistics;
import com.azure.ai.textanalytics.models.TextDocumentBatchStatistics;
import com.azure.ai.textanalytics.models.TextDocumentInput;
import com.azure.core.util.Context;

Expand Down Expand Up @@ -39,19 +39,19 @@ public static void main(String[] args) {
);

final TextAnalyticsRequestOptions requestOptions = new TextAnalyticsRequestOptions().setShowStatistics(true);
final DocumentResultCollection<NamedEntityResult> detectedBatchResult =
final DocumentResultCollection<RecognizeEntitiesResult> detectedBatchResult =
client.recognizeBatchEntitiesWithResponse(inputs, requestOptions, Context.NONE).getValue();
System.out.printf("Model version: %s%n", detectedBatchResult.getModelVersion());

final TextBatchStatistics batchStatistics = detectedBatchResult.getStatistics();
final TextDocumentBatchStatistics batchStatistics = detectedBatchResult.getStatistics();
System.out.printf("A batch of document statistics, document count: %s, erroneous document count: %s, transaction count: %s, valid document count: %s.%n",
batchStatistics.getDocumentCount(),
batchStatistics.getErroneousDocumentCount(),
batchStatistics.getTransactionCount(),
batchStatistics.getValidDocumentCount());

for (NamedEntityResult namedEntityResult : detectedBatchResult) {
for (NamedEntity entity : namedEntityResult.getNamedEntities()) {
for (RecognizeEntitiesResult recognizeEntitiesResult : detectedBatchResult) {
for (NamedEntity entity : recognizeEntitiesResult.getNamedEntities()) {
System.out.printf("Recognized NamedEntity: %s, NamedEntity Type: %s, NamedEntity Subtype: %s, Offset: %s, Length: %s, Score: %s.%n",
entity.getText(),
entity.getType(),
Expand Down
10 changes: 5 additions & 5 deletions .../samples/java/com/azure/ai/textanalytics/batch/RecognizeLinkedEntitiesBatchDocuments.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
import com.azure.ai.textanalytics.TextAnalyticsClientBuilder;
import com.azure.ai.textanalytics.models.DocumentResultCollection;
import com.azure.ai.textanalytics.models.LinkedEntity;
import com.azure.ai.textanalytics.models.LinkedEntityResult;
import com.azure.ai.textanalytics.models.RecognizeLinkedEntitiesResult;
import com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions;
import com.azure.ai.textanalytics.models.TextBatchStatistics;
import com.azure.ai.textanalytics.models.TextDocumentBatchStatistics;
import com.azure.ai.textanalytics.models.TextDocumentInput;
import com.azure.core.util.Context;

Expand Down Expand Up @@ -39,18 +39,18 @@ public static void main(String[] args) {
);

final TextAnalyticsRequestOptions requestOptions = new TextAnalyticsRequestOptions().setShowStatistics(true);
final DocumentResultCollection<LinkedEntityResult> detectedBatchResult = client.recognizeBatchLinkedEntitiesWithResponse(inputs, requestOptions, Context.NONE).getValue();
final DocumentResultCollection<RecognizeLinkedEntitiesResult> detectedBatchResult = client.recognizeBatchLinkedEntitiesWithResponse(inputs, requestOptions, Context.NONE).getValue();
System.out.printf("Model version: %s%n", detectedBatchResult.getModelVersion());

final TextBatchStatistics batchStatistics = detectedBatchResult.getStatistics();
final TextDocumentBatchStatistics batchStatistics = detectedBatchResult.getStatistics();
System.out.printf("A batch of document statistics, document count: %s, erroneous document count: %s, transaction count: %s, valid document count: %s.%n",
batchStatistics.getDocumentCount(),
batchStatistics.getErroneousDocumentCount(),
batchStatistics.getTransactionCount(),
batchStatistics.getValidDocumentCount());

// Detecting linked entities from a batch of documents
for (LinkedEntityResult linkedEntityDocumentResult : detectedBatchResult) {
for (RecognizeLinkedEntitiesResult linkedEntityDocumentResult : detectedBatchResult) {
for (LinkedEntity linkedEntity : linkedEntityDocumentResult.getLinkedEntities()) {
System.out.printf("Recognized Linked NamedEntity: %s, URL: %s, Data Source: %s%n",
linkedEntity.getName(), linkedEntity.getUri(), linkedEntity.getDataSource());
Expand Down
8 changes: 4 additions & 4 deletions ...alytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizePiiBatchDocuments.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
import com.azure.ai.textanalytics.TextAnalyticsClient;
import com.azure.ai.textanalytics.TextAnalyticsClientBuilder;
import com.azure.ai.textanalytics.models.DocumentResultCollection;
import com.azure.ai.textanalytics.models.NamedEntityResult;
import com.azure.ai.textanalytics.models.RecognizeEntitiesResult;
import com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions;
import com.azure.ai.textanalytics.models.TextBatchStatistics;
import com.azure.ai.textanalytics.models.TextDocumentBatchStatistics;
import com.azure.ai.textanalytics.models.TextDocumentInput;
import com.azure.core.util.Context;

Expand Down Expand Up @@ -38,10 +38,10 @@ public static void main(String[] args) {
);

final TextAnalyticsRequestOptions requestOptions = new TextAnalyticsRequestOptions().setShowStatistics(true);
final DocumentResultCollection<NamedEntityResult> detectedBatchResult = client.recognizeBatchPiiEntitiesWithResponse(inputs, requestOptions, Context.NONE).getValue();
final DocumentResultCollection<RecognizeEntitiesResult> detectedBatchResult = client.recognizeBatchPiiEntitiesWithResponse(inputs, requestOptions, Context.NONE).getValue();
System.out.printf("Model version: %s%n", detectedBatchResult.getModelVersion());

final TextBatchStatistics batchStatistics = detectedBatchResult.getStatistics();
final TextDocumentBatchStatistics batchStatistics = detectedBatchResult.getStatistics();
System.out.printf("A batch of document statistics, document count: %s, erroneous document count: %s, transaction count: %s, valid document count: %s.%n",
batchStatistics.getDocumentCount(),
batchStatistics.getErroneousDocumentCount(),
Expand Down
Loading

0 comments on commit 1600d24

Please sign in to comment.