com.tencentcloudapi.ims.v20201229.models.OcrResult Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-intl-en Show documentation
Show all versions of tencentcloud-sdk-java-intl-en Show documentation
Tencent Cloud API SDK for Java
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* 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.
*/
package com.tencentcloudapi.ims.v20201229.models;
import com.tencentcloudapi.common.AbstractModel;
import com.tencentcloudapi.common.SSEResponseModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class OcrResult extends AbstractModel {
/**
* This field indicates the recognition scenario. Default value: OCR (image OCR).
*/
@SerializedName("Scene")
@Expose
private String Scene;
/**
* This field is used to return the operation suggestion for the maliciousness tag with the highest priority. When you get the determination result, the returned value indicates the operation suggested by the system. We recommend you handle different types of violations and suggestions according to your business needs.
Returned values: **Block**, **Review**, **Pass**.
*/
@SerializedName("Suggestion")
@Expose
private String Suggestion;
/**
* This field is used to return the maliciousness tag with the highest priority in the OCR detection result, which represents the moderation result suggested by the model. We recommend you handle different types of violations and suggestions according to your business needs.
Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
*/
@SerializedName("Label")
@Expose
private String Label;
/**
* This field is used to return the detection result for a subtag under the current tag (Label), such as *Porn-SexBehavior*.
*/
@SerializedName("SubLabel")
@Expose
private String SubLabel;
/**
* This field is used to return the confidence under the current tag (Label). Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn 99* indicates that the text is highly likely to be pornographic, while *Porn 0* indicates that the text is not pornographic.
*/
@SerializedName("Score")
@Expose
private Long Score;
/**
* This field is used to return the details of the OCR recognition result, such as text content, tag, and recognition frame position.
Note: this field may return null, indicating that no valid values can be obtained.
*/
@SerializedName("Details")
@Expose
private OcrTextDetail [] Details;
/**
* This field is used to return the text information recognized by OCR.
*/
@SerializedName("Text")
@Expose
private String Text;
/**
* Get This field indicates the recognition scenario. Default value: OCR (image OCR).
* @return Scene This field indicates the recognition scenario. Default value: OCR (image OCR).
*/
public String getScene() {
return this.Scene;
}
/**
* Set This field indicates the recognition scenario. Default value: OCR (image OCR).
* @param Scene This field indicates the recognition scenario. Default value: OCR (image OCR).
*/
public void setScene(String Scene) {
this.Scene = Scene;
}
/**
* Get This field is used to return the operation suggestion for the maliciousness tag with the highest priority. When you get the determination result, the returned value indicates the operation suggested by the system. We recommend you handle different types of violations and suggestions according to your business needs.
Returned values: **Block**, **Review**, **Pass**.
* @return Suggestion This field is used to return the operation suggestion for the maliciousness tag with the highest priority. When you get the determination result, the returned value indicates the operation suggested by the system. We recommend you handle different types of violations and suggestions according to your business needs.
Returned values: **Block**, **Review**, **Pass**.
*/
public String getSuggestion() {
return this.Suggestion;
}
/**
* Set This field is used to return the operation suggestion for the maliciousness tag with the highest priority. When you get the determination result, the returned value indicates the operation suggested by the system. We recommend you handle different types of violations and suggestions according to your business needs.
Returned values: **Block**, **Review**, **Pass**.
* @param Suggestion This field is used to return the operation suggestion for the maliciousness tag with the highest priority. When you get the determination result, the returned value indicates the operation suggested by the system. We recommend you handle different types of violations and suggestions according to your business needs.
Returned values: **Block**, **Review**, **Pass**.
*/
public void setSuggestion(String Suggestion) {
this.Suggestion = Suggestion;
}
/**
* Get This field is used to return the maliciousness tag with the highest priority in the OCR detection result, which represents the moderation result suggested by the model. We recommend you handle different types of violations and suggestions according to your business needs.
Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
* @return Label This field is used to return the maliciousness tag with the highest priority in the OCR detection result, which represents the moderation result suggested by the model. We recommend you handle different types of violations and suggestions according to your business needs.
Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
*/
public String getLabel() {
return this.Label;
}
/**
* Set This field is used to return the maliciousness tag with the highest priority in the OCR detection result, which represents the moderation result suggested by the model. We recommend you handle different types of violations and suggestions according to your business needs.
Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
* @param Label This field is used to return the maliciousness tag with the highest priority in the OCR detection result, which represents the moderation result suggested by the model. We recommend you handle different types of violations and suggestions according to your business needs.
Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
*/
public void setLabel(String Label) {
this.Label = Label;
}
/**
* Get This field is used to return the detection result for a subtag under the current tag (Label), such as *Porn-SexBehavior*.
* @return SubLabel This field is used to return the detection result for a subtag under the current tag (Label), such as *Porn-SexBehavior*.
*/
public String getSubLabel() {
return this.SubLabel;
}
/**
* Set This field is used to return the detection result for a subtag under the current tag (Label), such as *Porn-SexBehavior*.
* @param SubLabel This field is used to return the detection result for a subtag under the current tag (Label), such as *Porn-SexBehavior*.
*/
public void setSubLabel(String SubLabel) {
this.SubLabel = SubLabel;
}
/**
* Get This field is used to return the confidence under the current tag (Label). Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn 99* indicates that the text is highly likely to be pornographic, while *Porn 0* indicates that the text is not pornographic.
* @return Score This field is used to return the confidence under the current tag (Label). Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn 99* indicates that the text is highly likely to be pornographic, while *Porn 0* indicates that the text is not pornographic.
*/
public Long getScore() {
return this.Score;
}
/**
* Set This field is used to return the confidence under the current tag (Label). Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn 99* indicates that the text is highly likely to be pornographic, while *Porn 0* indicates that the text is not pornographic.
* @param Score This field is used to return the confidence under the current tag (Label). Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn 99* indicates that the text is highly likely to be pornographic, while *Porn 0* indicates that the text is not pornographic.
*/
public void setScore(Long Score) {
this.Score = Score;
}
/**
* Get This field is used to return the details of the OCR recognition result, such as text content, tag, and recognition frame position.
Note: this field may return null, indicating that no valid values can be obtained.
* @return Details This field is used to return the details of the OCR recognition result, such as text content, tag, and recognition frame position.
Note: this field may return null, indicating that no valid values can be obtained.
*/
public OcrTextDetail [] getDetails() {
return this.Details;
}
/**
* Set This field is used to return the details of the OCR recognition result, such as text content, tag, and recognition frame position.
Note: this field may return null, indicating that no valid values can be obtained.
* @param Details This field is used to return the details of the OCR recognition result, such as text content, tag, and recognition frame position.
Note: this field may return null, indicating that no valid values can be obtained.
*/
public void setDetails(OcrTextDetail [] Details) {
this.Details = Details;
}
/**
* Get This field is used to return the text information recognized by OCR.
* @return Text This field is used to return the text information recognized by OCR.
*/
public String getText() {
return this.Text;
}
/**
* Set This field is used to return the text information recognized by OCR.
* @param Text This field is used to return the text information recognized by OCR.
*/
public void setText(String Text) {
this.Text = Text;
}
public OcrResult() {
}
/**
* NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
* and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
*/
public OcrResult(OcrResult source) {
if (source.Scene != null) {
this.Scene = new String(source.Scene);
}
if (source.Suggestion != null) {
this.Suggestion = new String(source.Suggestion);
}
if (source.Label != null) {
this.Label = new String(source.Label);
}
if (source.SubLabel != null) {
this.SubLabel = new String(source.SubLabel);
}
if (source.Score != null) {
this.Score = new Long(source.Score);
}
if (source.Details != null) {
this.Details = new OcrTextDetail[source.Details.length];
for (int i = 0; i < source.Details.length; i++) {
this.Details[i] = new OcrTextDetail(source.Details[i]);
}
}
if (source.Text != null) {
this.Text = new String(source.Text);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamSimple(map, prefix + "Scene", this.Scene);
this.setParamSimple(map, prefix + "Suggestion", this.Suggestion);
this.setParamSimple(map, prefix + "Label", this.Label);
this.setParamSimple(map, prefix + "SubLabel", this.SubLabel);
this.setParamSimple(map, prefix + "Score", this.Score);
this.setParamArrayObj(map, prefix + "Details.", this.Details);
this.setParamSimple(map, prefix + "Text", this.Text);
}
}