Discovery Class

This class wraps the Discovery service Discovery Service

Inheritance Hierarchy

SystemObject
IBM.Watson.DeveloperCloud.Services.Discovery.v1Discovery

Namespace: IBM.Watson.DeveloperCloud.Services.Discovery.v1
Assembly: unity-documentation (in unity-documentation.exe) Version: 1.0.0.0 (1.0.0.0)

Syntax

Copy

public class Discovery : IWatsonService

The Discovery type exposes the following members.

Constructors

	Name	Description
	Discovery	Discovery constructor.

Top

Properties

	Name	Description
	Credentials	Gets and sets the credentials of the service. Replace the default endpoint if endpoint is defined.
	Url	Gets and sets the endpoint URL for the service.
	VersionDate	Gets and sets the versionDate of the service.

Top

Methods

	Name	Description
	AddCollection(DiscoverySuccessCallbackCollectionRef, DiscoveryFailCallback, String, Byte, DictionaryString, Object)	Adds a collection to a specified environment.
	AddCollection(DiscoverySuccessCallbackCollectionRef, DiscoveryFailCallback, String, String, String, String, DictionaryString, Object)	Adds a collection to a specified environment.
	AddConfiguration(DiscoverySuccessCallbackConfiguration, DiscoveryFailCallback, String, Byte, DictionaryString, Object)	Adds a configuration via json byte data.
	AddConfiguration(DiscoverySuccessCallbackConfiguration, DiscoveryFailCallback, String, String, DictionaryString, Object)	Adds a configuration via external json file.
	AddDocument(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.
	AddDocument(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.
	AddDocumentUsingConfigFile	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.
	AddDocumentUsingConfigID	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.
	AddEnvironment(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.
	AddEnvironment(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.
	DeleteCollection	Deletes a specified collection.
	DeleteConfiguration	Deletes an environments specified configuration.
	DeleteDocument
	DeleteEnvironment	Deletes the specified environment.
	GetCollection	Lists a specified collecton's details.
	GetCollections	Lists a specified environment's collections.
	GetConfiguration	Gets details of an environment's configuration.
	GetConfigurations	Lists an environment's configurations.
	GetDocument	Lists a specified document's details.
	GetEnvironment	Returns specified environment data.
	GetEnvironments	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.
	GetFields	Gets a list of the the unique fields (and their types) stored in the index.
	PreviewConfiguration(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.
	PreviewConfiguration(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.
	Query	Query the discovery instance.
	UpdateDocument(DiscoverySuccessCallbackDocumentAccepted, DiscoveryFailCallback, String, String, String, String, String, String, String, DictionaryString, Object)	Updates a specified document.
	UpdateDocument(DiscoverySuccessCallbackDocumentAccepted, DiscoveryFailCallback, String, String, String, Byte, String, String, String, String, DictionaryString, Object)	Updates a specified document.
	UpdateDocumentUsingConfigFile	Updates a specified document using a configuration file path.
	UpdateDocumentUsingConfigID	Updates a specified document using ConfigID.

Top

Reference

IBM.Watson.DeveloperCloud.Services.Discovery.v1 Namespace