Package com.ibm.watson.discovery.v2.model

Interface Summary

Interface	Description
CollectionDetailsSmartDocumentUnderstanding.Model	Specifies the type of Smart Document Understanding (SDU) model that is enabled for the collection.
ComponentSettingsAggregation.VisualizationType	Type of visualization to use when rendering the aggregation.
CreateEnrichment.Type	The type of this enrichment.
CreateProjectOptions.Type	The type of project.
DeleteDocumentResponse.Status	Status of the document.
DocumentAccepted.Status	Status of the document in the ingestion process.
DocumentClassifierModel.Status	The status of the training run.
DocumentDetails.Status	The status of the ingestion of the document.
Enrichment.Type	The type of this enrichment.
Field.Type	The type of the field.
Notice.Severity	Severity level of the notice.
ProjectDetails.Type	The type of project.
ProjectListDetails.Type	The type of project.
QueryResultMetadata.DocumentRetrievalSource	The document retrieval source that produced this search result.
RetrievalDetails.DocumentRetrievalStrategy	Identifies the document retrieval strategy used for this query.

Class Summary

Class	Description
AddDocumentOptions	The addDocument options.
AddDocumentOptions.Builder	Builder.
AnalyzedDocument	An object that contains the converted document and any identified enrichments.
AnalyzeDocumentOptions	The analyzeDocument options.
AnalyzeDocumentOptions.Builder	Builder.
AnalyzedResult	Result of the document analysis.
ClassifierFederatedModel	An object with details for creating federated document classifier models.
ClassifierFederatedModel.Builder	Builder.
ClassifierModelEvaluation	An object that contains information about a trained document classifier model.
Collection	A collection for storing documents.
CollectionDetails	A collection for storing documents.
CollectionDetails.Builder	Builder.
CollectionDetailsSmartDocumentUnderstanding	An object that describes the Smart Document Understanding model for a collection.
CollectionDetailsSmartDocumentUnderstanding.Builder	Builder.
CollectionEnrichment	An object describing an enrichment for a collection.
CollectionEnrichment.Builder	Builder.
Completions	An object that contains an array of autocompletion suggestions.
ComponentSettingsAggregation	Display settings for aggregations.
ComponentSettingsFieldsShown	Fields shown in the results section of the UI.
ComponentSettingsFieldsShownBody	Body label.
ComponentSettingsFieldsShownTitle	Title label.
ComponentSettingsResponse	The default component settings for this project.
CreateCollectionOptions	The createCollection options.
CreateCollectionOptions.Builder	Builder.
CreateDocumentClassifier	An object that manages the settings and data that is required to train a document classification model.
CreateDocumentClassifier.Builder	Builder.
CreateDocumentClassifierModelOptions	The createDocumentClassifierModel options.
CreateDocumentClassifierModelOptions.Builder	Builder.
CreateDocumentClassifierOptions	The createDocumentClassifier options.
CreateDocumentClassifierOptions.Builder	Builder.
CreateEnrichment	Information about a specific enrichment.
CreateEnrichment.Builder	Builder.
CreateEnrichmentOptions	The createEnrichment options.
CreateEnrichmentOptions.Builder	Builder.
CreateExpansionsOptions	The createExpansions options.
CreateExpansionsOptions.Builder	Builder.
CreateProjectOptions	The createProject options.
CreateProjectOptions.Builder	Builder.
CreateStopwordListOptions	The createStopwordList options.
CreateStopwordListOptions.Builder	Builder.
CreateTrainingQueryOptions	The createTrainingQuery options.
CreateTrainingQueryOptions.Builder	Builder.
DefaultQueryParams	Default query parameters for this project.
DefaultQueryParams.Builder	Builder.
DefaultQueryParamsPassages	Default settings configuration for passage search options.
DefaultQueryParamsPassages.Builder	Builder.
DefaultQueryParamsSuggestedRefinements	Object that contains suggested refinement settings.
DefaultQueryParamsSuggestedRefinements.Builder	Builder.
DefaultQueryParamsTableResults	Default project query settings for table results.
DefaultQueryParamsTableResults.Builder	Builder.
DeleteCollectionOptions	The deleteCollection options.
DeleteCollectionOptions.Builder	Builder.
DeleteDocumentClassifierModelOptions	The deleteDocumentClassifierModel options.
DeleteDocumentClassifierModelOptions.Builder	Builder.
DeleteDocumentClassifierOptions	The deleteDocumentClassifier options.
DeleteDocumentClassifierOptions.Builder	Builder.
DeleteDocumentOptions	The deleteDocument options.
DeleteDocumentOptions.Builder	Builder.
DeleteDocumentResponse	Information returned when a document is deleted.
DeleteEnrichmentOptions	The deleteEnrichment options.
DeleteEnrichmentOptions.Builder	Builder.
DeleteExpansionsOptions	The deleteExpansions options.
DeleteExpansionsOptions.Builder	Builder.
DeleteProjectOptions	The deleteProject options.
DeleteProjectOptions.Builder	Builder.
DeleteStopwordListOptions	The deleteStopwordList options.
DeleteStopwordListOptions.Builder	Builder.
DeleteTrainingQueriesOptions	The deleteTrainingQueries options.
DeleteTrainingQueriesOptions.Builder	Builder.
DeleteTrainingQueryOptions	The deleteTrainingQuery options.
DeleteTrainingQueryOptions.Builder	Builder.
DeleteUserDataOptions	The deleteUserData options.
DeleteUserDataOptions.Builder	Builder.
DocumentAccepted	Information returned after an uploaded document is accepted.
DocumentAttribute	List of document attributes.
DocumentClassifier	Information about a document classifier.
DocumentClassifierEnrichment	An object that describes enrichments that are applied to the training and test data that is used by the document classifier.
DocumentClassifierEnrichment.Builder	Builder.
DocumentClassifierModel	Information about a document classifier model.
DocumentClassifierModels	An object that contains a list of document classifier model definitions.
DocumentClassifiers	An object that contains a list of document classifier definitions.
DocumentDetails	Information about a document.
DocumentDetailsChildren	Information about the child documents that are generated from a single document during ingestion or other processing.
Enrichment	Information about a specific enrichment.
EnrichmentOptions	An object that contains options for the current enrichment.
EnrichmentOptions.Builder	Builder.
Enrichments	An object that contains an array of enrichment definitions.
Expansion	An expansion definition.
Expansion.Builder	Builder.
Expansions	The query expansion definitions for the specified collection.
Expansions.Builder	Builder.
Field	Object that contains field details.
GetAutocompletionOptions	The getAutocompletion options.
GetAutocompletionOptions.Builder	Builder.
GetCollectionOptions	The getCollection options.
GetCollectionOptions.Builder	Builder.
GetComponentSettingsOptions	The getComponentSettings options.
GetComponentSettingsOptions.Builder	Builder.
GetDocumentClassifierModelOptions	The getDocumentClassifierModel options.
GetDocumentClassifierModelOptions.Builder	Builder.
GetDocumentClassifierOptions	The getDocumentClassifier options.
GetDocumentClassifierOptions.Builder	Builder.
GetDocumentOptions	The getDocument options.
GetDocumentOptions.Builder	Builder.
GetEnrichmentOptions	The getEnrichment options.
GetEnrichmentOptions.Builder	Builder.
GetProjectOptions	The getProject options.
GetProjectOptions.Builder	Builder.
GetStopwordListOptions	The getStopwordList options.
GetStopwordListOptions.Builder	Builder.
GetTrainingQueryOptions	The getTrainingQuery options.
GetTrainingQueryOptions.Builder	Builder.
ListCollectionsOptions	The listCollections options.
ListCollectionsOptions.Builder	Builder.
ListCollectionsResponse	Response object that contains an array of collection details.
ListDocumentClassifierModelsOptions	The listDocumentClassifierModels options.
ListDocumentClassifierModelsOptions.Builder	Builder.
ListDocumentClassifiersOptions	The listDocumentClassifiers options.
ListDocumentClassifiersOptions.Builder	Builder.
ListDocumentsOptions	The listDocuments options.
ListDocumentsOptions.Builder	Builder.
ListDocumentsResponse	Response object that contains an array of documents.
ListEnrichmentsOptions	The listEnrichments options.
ListEnrichmentsOptions.Builder	Builder.
ListExpansionsOptions	The listExpansions options.
ListExpansionsOptions.Builder	Builder.
ListFieldsOptions	The listFields options.
ListFieldsOptions.Builder	Builder.
ListFieldsResponse	The list of fetched fields.
ListProjectsOptions	The listProjects options.
ListProjectsResponse	A list of projects in this instance.
ListTrainingQueriesOptions	The listTrainingQueries options.
ListTrainingQueriesOptions.Builder	Builder.
ModelEvaluationMacroAverage	A macro-average computes metric independently for each class and then takes the average.
ModelEvaluationMicroAverage	A micro-average aggregates the contributions of all classes to compute the average metric.
Notice	A notice produced for the collection.
PerClassModelEvaluation	An object that measures the metrics from a training run for each classification label separately.
ProjectDetails	Detailed information about the specified project.
ProjectListDetails	Details about a specific project.
ProjectListDetailsRelevancyTrainingStatus	Relevancy training status information for this project.
QueryAggregation	An object that defines how to aggregate query results.
QueryAggregationQueryCalculationAggregation	Returns a scalar calculation across all documents for the field specified.
QueryAggregationQueryFilterAggregation	A modifier that narrows the document set of the subaggregations it precedes.
QueryAggregationQueryGroupByAggregation	Separates document results into groups that meet the conditions you specify.
QueryAggregationQueryHistogramAggregation	Numeric interval segments to categorize documents by using field values from a single numeric field to describe the category.
QueryAggregationQueryNestedAggregation	A restriction that alters the document set that is used by the aggregations that it precedes.
QueryAggregationQueryPairAggregation	Calculates relevancy values using combinations of document sets from results of the specified pair of aggregations.
QueryAggregationQueryTermAggregation	Returns results from the field that is specified.
QueryAggregationQueryTimesliceAggregation	A specialized histogram aggregation that uses dates to create interval segments.
QueryAggregationQueryTopHitsAggregation	Returns the top documents ranked by the score of the query.
QueryAggregationQueryTopicAggregation	Detects how much the frequency of a given facet value deviates from the expected average for the given time period.
QueryAggregationQueryTrendAggregation	Detects sharp and unexpected changes in the frequency of a facet or facet value over time based on the past history of frequency changes of the facet value.
QueryCollectionNoticesOptions	The queryCollectionNotices options.
QueryCollectionNoticesOptions.Builder	Builder.
QueryGroupByAggregationResult	Result group for the `group_by` aggregation.
QueryHistogramAggregationResult	Histogram numeric interval result.
QueryLargePassages	Configuration for passage retrieval.
QueryLargePassages.Builder	Builder.
QueryLargeSimilar	Finds results from documents that are similar to documents of interest.
QueryLargeSimilar.Builder	Builder.
QueryLargeSuggestedRefinements	Configuration for suggested refinements.
QueryLargeSuggestedRefinements.Builder	Builder.
QueryLargeTableResults	Configuration for table retrieval.
QueryLargeTableResults.Builder	Builder.
QueryNoticesOptions	The queryNotices options.
QueryNoticesOptions.Builder	Builder.
QueryNoticesResponse	Object that contains notice query results.
QueryOptions	The query options.
QueryOptions.Builder	Builder.
QueryPairAggregationResult	Result for the `pair` aggregation.
QueryResponse	A response that contains the documents and aggregations for the query.
QueryResponsePassage	A passage query response.
QueryResult	Result document for the specified query.
QueryResultMetadata	Metadata of a query result.
QueryResultPassage	A passage query result.
QuerySuggestedRefinement	A suggested additional query term or terms user to filter results.
QueryTableResult	A tables whose content or context match a search query.
QueryTermAggregationResult	Top value result for the `term` aggregation.
QueryTimesliceAggregationResult	A timeslice interval segment.
QueryTopHitsAggregationResult	A query response that contains the matching documents for the preceding aggregations.
QueryTopicAggregationResult	Result for the `topic` aggregation.
QueryTrendAggregationResult	Result for the `trend` aggregation.
ResultPassageAnswer	Object that contains a potential answer to the specified query.
RetrievalDetails	An object contain retrieval type information.
StopWordList	List of words to filter out of text that is submitted in queries.
StopWordList.Builder	Builder.
TableBodyCells	Cells that are not table header, column header, or row header cells.
TableCellKey	A key in a key-value pair.
TableCellValues	A value in a key-value pair.
TableColumnHeaderIds	An array of values, each being the `id` value of a column header that is applicable to the current cell.
TableColumnHeaders	Column-level cells, each applicable as a header to other cells in the same column as itself, of the current table.
TableColumnHeaderTexts	An array of values, each being the `text` value of a column header that is applicable to the current cell.
TableColumnHeaderTextsNormalized	If you provide customization input, the normalized version of the column header texts according to the customization; otherwise, the same value as `column_header_texts`.
TableElementLocation	The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`.
TableHeaders	The contents of the current table's header.
TableKeyValuePairs	Key-value pairs detected across cell boundaries.
TableResultTable	Full table object retrieved from Table Understanding Enrichment.
TableRowHeaderIds	An array of values, each being the `id` value of a row header that is applicable to this body cell.
TableRowHeaders	Row-level cells, each applicable as a header to other cells in the same row as itself, of the current table.
TableRowHeaderTexts	An array of values, each being the `text` value of a row header that is applicable to this body cell.
TableRowHeaderTextsNormalized	If you provide customization input, the normalized version of the row header texts according to the customization; otherwise, the same value as `row_header_texts`.
TableTextLocation	Text and associated location within a table.
TrainingExample	Object that contains example response details for a training query.
TrainingExample.Builder	Builder.
TrainingQuery	Object that contains training query details.
TrainingQuery.Builder	Builder.
TrainingQuerySet	Object specifying the training queries contained in the identified training set.
UpdateCollectionOptions	The updateCollection options.
UpdateCollectionOptions.Builder	Builder.
UpdateDocumentClassifier	An object that contains a new name or description for a document classifier, updated training data, or new or updated test data.
UpdateDocumentClassifier.Builder	Builder.
UpdateDocumentClassifierModelOptions	The updateDocumentClassifierModel options.
UpdateDocumentClassifierModelOptions.Builder	Builder.
UpdateDocumentClassifierOptions	The updateDocumentClassifier options.
UpdateDocumentClassifierOptions.Builder	Builder.
UpdateDocumentOptions	The updateDocument options.
UpdateDocumentOptions.Builder	Builder.
UpdateEnrichmentOptions	The updateEnrichment options.
UpdateEnrichmentOptions.Builder	Builder.
UpdateProjectOptions	The updateProject options.
UpdateProjectOptions.Builder	Builder.
UpdateTrainingQueryOptions	The updateTrainingQuery options.
UpdateTrainingQueryOptions.Builder	Builder.
WebhookHeader	An array of headers to pass with the HTTP request.
WebhookHeader.Builder	Builder.