/
GCloudNaturalLanguageAssetAutoTaggerCompanyConfiguration.java
101 lines (90 loc) · 3.18 KB
/
GCloudNaturalLanguageAssetAutoTaggerCompanyConfiguration.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/**
* SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
* SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
*/
package com.liferay.asset.auto.tagger.google.cloud.natural.language.internal.configuration;
import aQute.bnd.annotation.metatype.Meta;
import com.liferay.asset.auto.tagger.google.cloud.natural.language.internal.constants.GCloudNaturalLanguageDocumentAssetAutoTaggerConstants;
import com.liferay.portal.configuration.metatype.annotations.ExtendedAttributeDefinition;
import com.liferay.portal.configuration.metatype.annotations.ExtendedObjectClassDefinition;
/**
* Models a Google Cloud Natural Language Document Asset Auto Tagger Company
* Configuration.
*
* @author Cristina González
* @author Alicia García
* @review
*/
@ExtendedObjectClassDefinition(
category = "assets", scope = ExtendedObjectClassDefinition.Scope.COMPANY
)
@Meta.OCD(
description = "google-cloud-natural-language-asset-auto-tag-configuration-description",
id = "com.liferay.asset.auto.tagger.google.cloud.natural.language.internal.configuration.GCloudNaturalLanguageAssetAutoTaggerCompanyConfiguration",
localization = "content/Language",
name = "google-cloud-natural-language-asset-auto-tag-configuration-name"
)
public interface GCloudNaturalLanguageAssetAutoTaggerCompanyConfiguration {
/**
* Sets the API key for the Google Cloud Vision API.
*/
@ExtendedAttributeDefinition(
descriptionArguments = GCloudNaturalLanguageDocumentAssetAutoTaggerConstants.API_KEY_DOCS_URL,
requiredInput = true
)
@Meta.AD(
description = "set-the-api-key-for-the-google-cloud-natural-language-api",
name = "api-key", required = false
)
public String apiKey();
/**
* Enables auto tagging of documents using the Google Cloud Natural Language
* API.
*/
@Meta.AD(
description = "classification-endpoint-enabled-description",
name = "classification-endpoint-enabled", required = false
)
public boolean classificationEndpointEnabled();
/**
* Sets the classifier's confidence of the category. This number represents
* how certain the classifier is that this category represents the given
* text.
*/
@Meta.AD(
deflt = "0.5", description = "confidence-description",
name = "confidence", required = false
)
public float confidence();
/**
* Enables auto tagging of documents using the Google Cloud Natural Language
* API.
*/
@Meta.AD(
description = "entity-endpoint-enabled-description",
name = "entity-endpoint-enabled", required = false
)
public boolean entityEndpointEnabled();
/**
* Sets the salience score for an entity. The salience provides information
* about the importance or centrality of that entity to the entire document
* text. Scores closer to 0 are less salient, while scores closer to 1.0 are
* highly salient
*/
@Meta.AD(
deflt = "0.02", description = "salience-description", name = "salience",
required = false
)
public float salience();
/**
* Sets the class names to enable auto tagging of documents using the Google
* Cloud Natural Language API.
*
* @review
*/
@Meta.AD(
deflt = "", name = "enabled-class-names[google-cloud-natural-language]",
required = false
)
public String[] enabledClassNames();
}