Click or drag to resize

Discovery Methods

The Discovery type exposes the following members.

Methods
  NameDescription
Public methodAddCollection(DiscoverySuccessCallbackCollectionRef, DiscoveryFailCallback, String, Byte, DictionaryString, Object)
Adds a collection to a specified environment.
Public methodAddCollection(DiscoverySuccessCallbackCollectionRef, DiscoveryFailCallback, String, String, String, String, DictionaryString, Object)
Adds a collection to a specified environment.
Public methodAddConfiguration(DiscoverySuccessCallbackConfiguration, DiscoveryFailCallback, String, Byte, DictionaryString, Object)
Adds a configuration via json byte data.
Public methodAddConfiguration(DiscoverySuccessCallbackConfiguration, DiscoveryFailCallback, String, String, DictionaryString, Object)
Adds a configuration via external json file.
Public methodAddDocument(DiscoverySuccessCallbackDocumentAccepted, DiscoveryFailCallback, String, String, String, String, String, String, DictionaryString, Object)
Add a document to a collection with optional metadata and optional configuration. The configuration to use to process the document can be provided using the configuration_id argument. Returns immediately after the system has accepted the document for processing. The user must provide document content, metadata, or both. If the request is missing both document content and metadata, then it will be rejected.
Public methodAddDocument(DiscoverySuccessCallbackDocumentAccepted, DiscoveryFailCallback, String, String, Byte, String, String, String, String, DictionaryString, Object)
Add a document to a collection with optional metadata and optional configuration. The configuration to use to process the document can be provided using the configuration_id argument. Returns immediately after the system has accepted the document for processing. The user must provide document content, metadata, or both. If the request is missing both document content and metadata, then it will be rejected.
Public methodAddDocumentUsingConfigFile
Add a document to a collection with optional metadata and optional configuration. The configuration to use to process the document can be provided using the configuration_id argument. Returns immediately after the system has accepted the document for processing. The user must provide document content, metadata, or both. If the request is missing both document content and metadata, then it will be rejected.
Public methodAddDocumentUsingConfigID
Add a document to a collection with optional metadata and optional configuration. The configuration to use to process the document can be provided using the configuration_id argument. Returns immediately after the system has accepted the document for processing. The user must provide document content, metadata, or both. If the request is missing both document content and metadata, then it will be rejected.
Public methodAddEnvironment(DiscoverySuccessCallbackEnvironment, DiscoveryFailCallback, DictionaryString, Object, DictionaryString, Object)
Creates a new environment. You can only create one environment per service instance.An attempt to create another environment will result in an error. The size of the new environment can be controlled by specifying the size parameter.
Public methodAddEnvironment(DiscoverySuccessCallbackEnvironment, DiscoveryFailCallback, String, String, Int32, DictionaryString, Object)
Creates a new environment. You can only create one environment per service instance.An attempt to create another environment will result in an error. The size of the new environment can be controlled by specifying the size parameter.
Public methodDeleteCollection
Deletes a specified collection.
Public methodDeleteConfiguration
Deletes an environments specified configuration.
Public methodDeleteDocument
Public methodDeleteEnvironment
Deletes the specified environment.
Public methodGetCollection
Lists a specified collecton's details.
Public methodGetCollections
Lists a specified environment's collections.
Public methodGetConfiguration
Gets details of an environment's configuration.
Public methodGetConfigurations
Lists an environment's configurations.
Public methodGetDocument
Lists a specified document's details.
Public methodGetEnvironment
Returns specified environment data.
Public methodGetEnvironments
This class lists environments in a discovery instance. There are two environments returned: A read-only environment with the News collection (IBM Managed) and a user-created environment that the user can utilize to analyze and query their own data.
Public methodGetFields
Gets a list of the the unique fields (and their types) stored in the index.
Public methodPreviewConfiguration(DiscoverySuccessCallbackTestDocument, DiscoveryFailCallback, String, String, String, String, String, DictionaryString, Object)
Runs a sample document through the default or your configuration and returns diagnostic information designed to help you understand how the document was processed. The document is not added to the index.
Public methodPreviewConfiguration(DiscoverySuccessCallbackTestDocument, DiscoveryFailCallback, String, String, String, Byte, String, String, DictionaryString, Object)
Runs a sample document through the default or your configuration and returns diagnostic information designed to help you understand how the document was processed. The document is not added to the index.
Public methodQuery
Query the discovery instance.
Public methodUpdateDocument(DiscoverySuccessCallbackDocumentAccepted, DiscoveryFailCallback, String, String, String, String, String, String, String, DictionaryString, Object)
Updates a specified document.
Public methodUpdateDocument(DiscoverySuccessCallbackDocumentAccepted, DiscoveryFailCallback, String, String, String, Byte, String, String, String, String, DictionaryString, Object)
Updates a specified document.
Public methodUpdateDocumentUsingConfigFile
Updates a specified document using a configuration file path.
Public methodUpdateDocumentUsingConfigID
Updates a specified document using ConfigID.
Top
See Also