Package com.ibm.watson.discovery.v1.model

Interface Summary

Interface	Description
Collection.Status	The status of the collection.
CreateCollectionOptions.Language	The language of the documents stored in the collection, in the form of an ISO 639-1 language code.
CreateCredentialsOptions.SourceType	The source that this credentials object connects to.
CreateEnvironmentOptions.Size	Size of the environment.
CreateEventOptions.Type	The event type to be created.
CreateEventResponse.Type	The event type that was created.
CredentialDetails.CredentialType	The authentication method for this credentials definition.
CredentialDetails.SourceVersion	The type of Sharepoint repository to connect to.
Credentials.SourceType	The source that this credentials object connects to.
DeleteCollectionResponse.Status	The status of the collection.
DeleteConfigurationResponse.Status	Status of the configuration.
DeleteCredentials.Status	The status of the deletion request.
DeleteDocumentResponse.Status	Status of the document.
DeleteEnvironmentResponse.Status	Status of the environment.
DocumentAccepted.Status	Status of the document in the ingestion process.
DocumentStatus.FileType	The type of the original source file.
DocumentStatus.Status	Status of the document in the ingestion process.
EnrichmentOptions.Language	ISO 639-1 code indicating the language to use for the analysis.
Environment.Size	Current size of the environment.
Environment.Status	Current status of the environment.
Field.Type	The type of the field.
Gateway.Status	The current status of the gateway.
GetMetricsEventRateOptions.ResultType	The type of result to consider when calculating the metric.
GetMetricsQueryEventOptions.ResultType	The type of result to consider when calculating the metric.
GetMetricsQueryNoResultsOptions.ResultType	The type of result to consider when calculating the metric.
GetMetricsQueryOptions.ResultType	The type of result to consider when calculating the metric.
LogQueryResponseResult.DocumentType	The type of log entry returned.
LogQueryResponseResult.EventType	The type of event that this object respresents.
LogQueryResponseResult.ResultType	The type of result that this **event** is associated with.
NormalizationOperation.Operation	Identifies what type of operation to perform.
Notice.Severity	Severity level of the notice.
QueryNoticesResult.FileType	The type of the original source file.
RetrievalDetails.DocumentRetrievalStrategy	Indentifies the document retrieval strategy used for this query.
SearchStatus.Status	The current status of Continuous Relevancy Training for this environment.
Source.Type	The type of source to connect to.
SourceOptionsWebCrawl.CrawlSpeed	The number of concurrent URLs to fetch.
SourceSchedule.Frequency	The crawl schedule in the specified **time_zone**.
SourceStatus.Status	The current status of the source crawl for this collection.
TokenDictStatusResponse.Status	Current wordlist status for the specified collection.
UpdateCredentialsOptions.SourceType	The source that this credentials object connects to.
UpdateEnvironmentOptions.Size	Size to change the environment to.

Class Summary

Class	Description
AddDocumentOptions	The addDocument options.
AddDocumentOptions.Builder	Builder.
AddTrainingDataOptions	The addTrainingData options.
AddTrainingDataOptions.Builder	Builder.
AggregationResult	Aggregation results for the specified query.
Collection	A collection for storing documents.
CollectionCrawlStatus	Object containing information about the crawl status of this collection.
CollectionDiskUsage	Summary of the disk usage statistics for this collection.
CollectionUsage	Summary of the collection usage in the environment.
Completions	An object containing an array of autocompletion suggestions.
Configuration	A custom configuration for the environment.
Configuration.Builder	Builder.
Conversions	Document conversion settings.
Conversions.Builder	Builder.
CreateCollectionOptions	The createCollection options.
CreateCollectionOptions.Builder	Builder.
CreateConfigurationOptions	The createConfiguration options.
CreateConfigurationOptions.Builder	Builder.
CreateCredentialsOptions	The createCredentials options.
CreateCredentialsOptions.Builder	Builder.
CreateEnvironmentOptions	The createEnvironment options.
CreateEnvironmentOptions.Builder	Builder.
CreateEventOptions	The createEvent options.
CreateEventOptions.Builder	Builder.
CreateEventResponse	An object defining the event being created.
CreateExpansionsOptions	The createExpansions options.
CreateExpansionsOptions.Builder	Builder.
CreateGatewayOptions	The createGateway options.
CreateGatewayOptions.Builder	Builder.
CreateStopwordListOptions	The createStopwordList options.
CreateStopwordListOptions.Builder	Builder.
CreateTokenizationDictionaryOptions	The createTokenizationDictionary options.
CreateTokenizationDictionaryOptions.Builder	Builder.
CreateTrainingExampleOptions	The createTrainingExample options.
CreateTrainingExampleOptions.Builder	Builder.
CredentialDetails	Object containing details of the stored credentials.
CredentialDetails.Builder	Builder.
Credentials	Object containing credential information.
Credentials.Builder	Builder.
CredentialsList	Object containing array of credential definitions.
DeleteAllTrainingDataOptions	The deleteAllTrainingData options.
DeleteAllTrainingDataOptions.Builder	Builder.
DeleteCollectionOptions	The deleteCollection options.
DeleteCollectionOptions.Builder	Builder.
DeleteCollectionResponse	Response object returned when deleting a colleciton.
DeleteConfigurationOptions	The deleteConfiguration options.
DeleteConfigurationOptions.Builder	Builder.
DeleteConfigurationResponse	Information returned when a configuration is deleted.
DeleteCredentials	Object returned after credentials are deleted.
DeleteCredentialsOptions	The deleteCredentials options.
DeleteCredentialsOptions.Builder	Builder.
DeleteDocumentOptions	The deleteDocument options.
DeleteDocumentOptions.Builder	Builder.
DeleteDocumentResponse	Information returned when a document is deleted.
DeleteEnvironmentOptions	The deleteEnvironment options.
DeleteEnvironmentOptions.Builder	Builder.
DeleteEnvironmentResponse	Response object returned when deleting an environment.
DeleteExpansionsOptions	The deleteExpansions options.
DeleteExpansionsOptions.Builder	Builder.
DeleteGatewayOptions	The deleteGateway options.
DeleteGatewayOptions.Builder	Builder.
DeleteStopwordListOptions	The deleteStopwordList options.
DeleteStopwordListOptions.Builder	Builder.
DeleteTokenizationDictionaryOptions	The deleteTokenizationDictionary options.
DeleteTokenizationDictionaryOptions.Builder	Builder.
DeleteTrainingDataOptions	The deleteTrainingData options.
DeleteTrainingDataOptions.Builder	Builder.
DeleteTrainingExampleOptions	The deleteTrainingExample options.
DeleteTrainingExampleOptions.Builder	Builder.
DeleteUserDataOptions	The deleteUserData options.
DeleteUserDataOptions.Builder	Builder.
DiskUsage	Summary of the disk usage statistics for the environment.
DocumentAccepted	Information returned after an uploaded document is accepted.
DocumentCounts	Object containing collection document count information.
DocumentStatus	Status information about a submitted document.
Enrichment	Enrichment step to perform on the document.
Enrichment.Builder	Builder.
EnrichmentOptions	Options that are specific to a particular enrichment.
EnrichmentOptions.Builder	Builder.
Environment	Details about an environment.
EnvironmentDocuments	Summary of the document usage statistics for the environment.
EventData	Query event data object.
EventData.Builder	Builder.
Expansion	An expansion definition.
Expansion.Builder	Builder.
Expansions	The query expansion definitions for the specified collection.
Expansions.Builder	Builder.
FederatedQueryNoticesOptions	The federatedQueryNotices options.
FederatedQueryNoticesOptions.Builder	Builder.
FederatedQueryOptions	The federatedQuery options.
FederatedQueryOptions.Builder	Builder.
Field	Object containing field details.
FontSetting	Font matching configuration.
FontSetting.Builder	Builder.
Gateway	Object describing a specific gateway.
GatewayDelete	Gatway deletion confirmation.
GatewayList	Object containing gateways array.
GetAutocompletionOptions	The getAutocompletion options.
GetAutocompletionOptions.Builder	Builder.
GetCollectionOptions	The getCollection options.
GetCollectionOptions.Builder	Builder.
GetConfigurationOptions	The getConfiguration options.
GetConfigurationOptions.Builder	Builder.
GetCredentialsOptions	The getCredentials options.
GetCredentialsOptions.Builder	Builder.
GetDocumentStatusOptions	The getDocumentStatus options.
GetDocumentStatusOptions.Builder	Builder.
GetEnvironmentOptions	The getEnvironment options.
GetEnvironmentOptions.Builder	Builder.
GetGatewayOptions	The getGateway options.
GetGatewayOptions.Builder	Builder.
GetMetricsEventRateOptions	The getMetricsEventRate options.
GetMetricsEventRateOptions.Builder	Builder.
GetMetricsQueryEventOptions	The getMetricsQueryEvent options.
GetMetricsQueryEventOptions.Builder	Builder.
GetMetricsQueryNoResultsOptions	The getMetricsQueryNoResults options.
GetMetricsQueryNoResultsOptions.Builder	Builder.
GetMetricsQueryOptions	The getMetricsQuery options.
GetMetricsQueryOptions.Builder	Builder.
GetMetricsQueryTokenEventOptions	The getMetricsQueryTokenEvent options.
GetMetricsQueryTokenEventOptions.Builder	Builder.
GetStopwordListStatusOptions	The getStopwordListStatus options.
GetStopwordListStatusOptions.Builder	Builder.
GetTokenizationDictionaryStatusOptions	The getTokenizationDictionaryStatus options.
GetTokenizationDictionaryStatusOptions.Builder	Builder.
GetTrainingDataOptions	The getTrainingData options.
GetTrainingDataOptions.Builder	Builder.
GetTrainingExampleOptions	The getTrainingExample options.
GetTrainingExampleOptions.Builder	Builder.
HtmlSettings	A list of HTML conversion settings.
HtmlSettings.Builder	Builder.
IndexCapacity	Details about the resource usage and capacity of the environment.
ListCollectionFieldsOptions	The listCollectionFields options.
ListCollectionFieldsOptions.Builder	Builder.
ListCollectionFieldsResponse	The list of fetched fields.
ListCollectionsOptions	The listCollections options.
ListCollectionsOptions.Builder	Builder.
ListCollectionsResponse	Response object containing an array of collection details.
ListConfigurationsOptions	The listConfigurations options.
ListConfigurationsOptions.Builder	Builder.
ListConfigurationsResponse	Object containing an array of available configurations.
ListCredentialsOptions	The listCredentials options.
ListCredentialsOptions.Builder	Builder.
ListEnvironmentsOptions	The listEnvironments options.
ListEnvironmentsOptions.Builder	Builder.
ListEnvironmentsResponse	Response object containing an array of configured environments.
ListExpansionsOptions	The listExpansions options.
ListExpansionsOptions.Builder	Builder.
ListFieldsOptions	The listFields options.
ListFieldsOptions.Builder	Builder.
ListGatewaysOptions	The listGateways options.
ListGatewaysOptions.Builder	Builder.
ListTrainingDataOptions	The listTrainingData options.
ListTrainingDataOptions.Builder	Builder.
ListTrainingExamplesOptions	The listTrainingExamples options.
ListTrainingExamplesOptions.Builder	Builder.
LogQueryResponse	Object containing results that match the requested **logs** query.
LogQueryResponseResult	Individual result object for a **logs** query.
LogQueryResponseResultDocuments	Object containing result information that was returned by the query used to create this log entry.
LogQueryResponseResultDocumentsResult	Each object in the **results** array corresponds to an individual document returned by the original query.
MetricAggregation	An aggregation analyzing log information for queries and events.
MetricAggregationResult	Aggregation result data for the requested metric.
MetricResponse	The response generated from a call to a **metrics** method.
MetricTokenAggregation	An aggregation analyzing log information for queries and events.
MetricTokenAggregationResult	Aggregation result data for the requested metric.
MetricTokenResponse	The response generated from a call to a **metrics** method that evaluates tokens.
NluEnrichmentConcepts	An object specifiying the concepts enrichment and related parameters.
NluEnrichmentConcepts.Builder	Builder.
NluEnrichmentEmotion	An object specifying the emotion detection enrichment and related parameters.
NluEnrichmentEmotion.Builder	Builder.
NluEnrichmentEntities	An object speficying the Entities enrichment and related parameters.
NluEnrichmentEntities.Builder	Builder.
NluEnrichmentFeatures	Object containing Natural Language Understanding features to be used.
NluEnrichmentFeatures.Builder	Builder.
NluEnrichmentKeywords	An object specifying the Keyword enrichment and related parameters.
NluEnrichmentKeywords.Builder	Builder.
NluEnrichmentRelations	An object specifying the relations enrichment and related parameters.
NluEnrichmentRelations.Builder	Builder.
NluEnrichmentSemanticRoles	An object specifiying the semantic roles enrichment and related parameters.
NluEnrichmentSemanticRoles.Builder	Builder.
NluEnrichmentSentiment	An object specifying the sentiment extraction enrichment and related parameters.
NluEnrichmentSentiment.Builder	Builder.
NormalizationOperation	Object containing normalization operations.
NormalizationOperation.Builder	Builder.
Notice	A notice produced for the collection.
PdfHeadingDetection	Object containing heading detection conversion settings for PDF documents.
PdfHeadingDetection.Builder	Builder.
PdfSettings	A list of PDF conversion settings.
PdfSettings.Builder	Builder.
QueryAggregation	An aggregation produced by Discovery to analyze the input provided.
QueryCalculationAggregation	Returns a scalar calculation across all documents for the field specified.
QueryFilterAggregation	A modifier that narrows the document set of the sub-aggregations it precedes.
QueryHistogramAggregation	Numeric interval segments to categorize documents by using field values from a single numeric field to describe the category.
QueryHistogramAggregationResult	Histogram numeric interval result.
QueryLogOptions	The queryLog options.
QueryLogOptions.Builder	Builder.
QueryNestedAggregation	A restriction that alters the document set that is used for sub-aggregations it precedes to nested documents found in the field specified.
QueryNoticesOptions	The queryNotices options.
QueryNoticesOptions.Builder	Builder.
QueryNoticesResponse	Object containing notice query results.
QueryNoticesResult	Query result object.
QueryOptions	The query options.
QueryOptions.Builder	Builder.
QueryPassages	A passage query result.
QueryResponse	A response containing the documents and aggregations for the query.
QueryResult	Query result object.
QueryResultMetadata	Metadata of a query result.
QueryTermAggregation	Returns the top values for the field specified.
QueryTermAggregationResult	Top value result for the term aggregation.
QueryTimesliceAggregation	A specialized histogram aggregation that uses dates to create interval segments.
QueryTimesliceAggregationResult	A timeslice interval segment.
QueryTopHitsAggregation	Returns the top documents ranked by the score of the query.
QueryTopHitsAggregationResult	A query response that contains the matching documents for the preceding aggregations.
RetrievalDetails	An object contain retrieval type information.
SduStatus	Object containing smart document understanding information for this collection.
SduStatusCustomFields	Information about custom smart document understanding fields that exist in this collection.
SearchStatus	Information about the Continuous Relevancy Training for this environment.
SegmentSettings	A list of Document Segmentation settings.
SegmentSettings.Builder	Builder.
Source	Object containing source parameters for the configuration.
Source.Builder	Builder.
SourceOptions	The **options** object defines which items to crawl from the source system.
SourceOptions.Builder	Builder.
SourceOptionsBuckets	Object defining a cloud object store bucket to crawl.
SourceOptionsBuckets.Builder	Builder.
SourceOptionsFolder	Object that defines a box folder to crawl with this configuration.
SourceOptionsFolder.Builder	Builder.
SourceOptionsObject	Object that defines a Salesforce document object type crawl with this configuration.
SourceOptionsObject.Builder	Builder.
SourceOptionsSiteColl	Object that defines a Microsoft SharePoint site collection to crawl with this configuration.
SourceOptionsSiteColl.Builder	Builder.
SourceOptionsWebCrawl	Object defining which URL to crawl and how to crawl it.
SourceOptionsWebCrawl.Builder	Builder.
SourceSchedule	Object containing the schedule information for the source.
SourceSchedule.Builder	Builder.
SourceStatus	Object containing source crawl status information.
StatusDetails	Object that contains details about the status of the authentication process.
StatusDetails.Builder	Builder.
TokenDictRule	An object defining a single tokenizaion rule.
TokenDictRule.Builder	Builder.
TokenDictStatusResponse	Object describing the current status of the wordlist.
TopHitsResults	Top hit information for this query.
TrainingDataSet	Training information for a specific collection.
TrainingExample	Training example details.
TrainingExample.Builder	Builder.
TrainingExampleList	Object containing an array of training examples.
TrainingQuery	Training query details.
TrainingStatus	Training status details.
UpdateCollectionOptions	The updateCollection options.
UpdateCollectionOptions.Builder	Builder.
UpdateConfigurationOptions	The updateConfiguration options.
UpdateConfigurationOptions.Builder	Builder.
UpdateCredentialsOptions	The updateCredentials options.
UpdateCredentialsOptions.Builder	Builder.
UpdateDocumentOptions	The updateDocument options.
UpdateDocumentOptions.Builder	Builder.
UpdateEnvironmentOptions	The updateEnvironment options.
UpdateEnvironmentOptions.Builder	Builder.
UpdateTrainingExampleOptions	The updateTrainingExample options.
UpdateTrainingExampleOptions.Builder	Builder.
WordHeadingDetection	Object containing heading detection conversion settings for Microsoft Word documents.
WordHeadingDetection.Builder	Builder.
WordSettings	A list of Word conversion settings.
WordSettings.Builder	Builder.
WordStyle	Microsoft Word styles to convert into a specified HTML head level.
WordStyle.Builder	Builder.
XPathPatterns	Object containing an array of XPaths.
XPathPatterns.Builder	Builder.