/
com.azure.ai.formrecognizer.training.models.TrainingOptions.yml
109 lines (109 loc) · 7.9 KB
/
com.azure.ai.formrecognizer.training.models.TrainingOptions.yml
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
102
103
104
105
106
107
108
109
### YamlMime:JavaType
uid: "com.azure.ai.formrecognizer.training.models.TrainingOptions"
fullName: "com.azure.ai.formrecognizer.training.models.TrainingOptions"
name: "TrainingOptions"
nameWithType: "TrainingOptions"
summary: "Options that may be passed when using training APIs on Form Training client."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **TrainingOptions**"
constructors:
- uid: "com.azure.ai.formrecognizer.training.models.TrainingOptions.TrainingOptions()"
fullName: "com.azure.ai.formrecognizer.training.models.TrainingOptions.TrainingOptions()"
name: "TrainingOptions()"
nameWithType: "TrainingOptions.TrainingOptions()"
summary: "Create a `TrainingOptions` object."
syntax: "public TrainingOptions()"
desc: "Create a `TrainingOptions` object."
methods:
- uid: "com.azure.ai.formrecognizer.training.models.TrainingOptions.getModelName()"
fullName: "com.azure.ai.formrecognizer.training.models.TrainingOptions.getModelName()"
name: "getModelName()"
nameWithType: "TrainingOptions.getModelName()"
summary: "Get the optional model name defined by the user."
syntax: "public String getModelName()"
desc: "Get the optional model name defined by the user."
returns:
description: "the modelName."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.formrecognizer.training.models.TrainingOptions.getPollInterval()"
fullName: "com.azure.ai.formrecognizer.training.models.TrainingOptions.getPollInterval()"
name: "getPollInterval()"
nameWithType: "TrainingOptions.getPollInterval()"
summary: "Get the duration between each poll for the operation status."
syntax: "public Duration getPollInterval()"
desc: "Get the duration between each poll for the operation status. If none is specified, a default of 5 seconds is used."
returns:
description: "the <code>pollInterval</code> value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.ai.formrecognizer.training.models.TrainingOptions.getTrainingFileFilter()"
fullName: "com.azure.ai.formrecognizer.training.models.TrainingOptions.getTrainingFileFilter()"
name: "getTrainingFileFilter()"
nameWithType: "TrainingOptions.getTrainingFileFilter()"
summary: "Get the filter to apply to the documents in the source path for training."
syntax: "public TrainingFileFilter getTrainingFileFilter()"
desc: "Get the filter to apply to the documents in the source path for training."
returns:
description: "the filter to apply to the documents in the source path for training."
type: "<xref href=\"com.azure.ai.formrecognizer.training.models.TrainingFileFilter?alt=com.azure.ai.formrecognizer.training.models.TrainingFileFilter&text=TrainingFileFilter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.training.models.TrainingOptions.setModelName(java.lang.String)"
fullName: "com.azure.ai.formrecognizer.training.models.TrainingOptions.setModelName(String modelName)"
name: "setModelName(String modelName)"
nameWithType: "TrainingOptions.setModelName(String modelName)"
summary: "Set the optional model name defined by the user."
parameters:
- description: "the user defined model name to set."
name: "modelName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public TrainingOptions setModelName(String modelName)"
desc: "Set the optional model name defined by the user."
returns:
description: "the updated <code>TrainingOptions</code> value."
type: "<xref href=\"com.azure.ai.formrecognizer.training.models.TrainingOptions?alt=com.azure.ai.formrecognizer.training.models.TrainingOptions&text=TrainingOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.training.models.TrainingOptions.setPollInterval(java.time.Duration)"
fullName: "com.azure.ai.formrecognizer.training.models.TrainingOptions.setPollInterval(Duration pollInterval)"
name: "setPollInterval(Duration pollInterval)"
nameWithType: "TrainingOptions.setPollInterval(Duration pollInterval)"
summary: "Set the duration between each poll for the operation status."
parameters:
- description: "the duration to specify between each poll for the operation status."
name: "pollInterval"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
syntax: "public TrainingOptions setPollInterval(Duration pollInterval)"
desc: "Set the duration between each poll for the operation status. If none is specified, a default of 5 seconds is used."
returns:
description: "the updated <code>TrainingOptions</code> value."
type: "<xref href=\"com.azure.ai.formrecognizer.training.models.TrainingOptions?alt=com.azure.ai.formrecognizer.training.models.TrainingOptions&text=TrainingOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.training.models.TrainingOptions.setTrainingFileFilter(com.azure.ai.formrecognizer.training.models.TrainingFileFilter)"
fullName: "com.azure.ai.formrecognizer.training.models.TrainingOptions.setTrainingFileFilter(TrainingFileFilter trainingFileFilter)"
name: "setTrainingFileFilter(TrainingFileFilter trainingFileFilter)"
nameWithType: "TrainingOptions.setTrainingFileFilter(TrainingFileFilter trainingFileFilter)"
summary: "Set the filter to apply to the documents in the source path for training."
parameters:
- description: "the <xref uid=\"com.azure.ai.formrecognizer.training.models.TrainingFileFilter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"filter\"></xref> to apply to the documents\n in the source path for training."
name: "trainingFileFilter"
type: "<xref href=\"com.azure.ai.formrecognizer.training.models.TrainingFileFilter?alt=com.azure.ai.formrecognizer.training.models.TrainingFileFilter&text=TrainingFileFilter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public TrainingOptions setTrainingFileFilter(TrainingFileFilter trainingFileFilter)"
desc: "Set the filter to apply to the documents in the source path for training."
returns:
description: "the updated <code>TrainingOptions</code> value."
type: "<xref href=\"com.azure.ai.formrecognizer.training.models.TrainingOptions?alt=com.azure.ai.formrecognizer.training.models.TrainingOptions&text=TrainingOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Options that may be passed when using training APIs on Form Training client."
metadata: {}
package: "com.azure.ai.formrecognizer.training.models"
artifact: com.azure:azure-ai-formrecognizer:4.1.7