This class wraps the Discovery service Discovery Service More...

Inheritance diagram for IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery:

Public Member Functions
	Discovery (Credentials credentials)

delegate void	OnGetEnvironments (GetEnvironmentsResponse resp, string customData)
	The callback used by GetEnvironments(). More...

bool	GetEnvironments (OnGetEnvironments callback, string customData=default(string))
	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. More...

delegate void	OnAddEnvironment (Environment resp, string customData)
	The callback used by AddEnvironment(). More...

bool	AddEnvironment (OnAddEnvironment callback, string name=default(string), string description=default(string), int size=0, string customData=default(string))
	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. More...

bool	AddEnvironment (OnAddEnvironment callback, Dictionary< string, object > addEnvironmentData, string customData=default(string))
	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. More...

delegate void	OnGetEnvironment (Environment resp, string customData)
	The callback used by GetEnvironment(). More...

bool	GetEnvironment (OnGetEnvironment callback, string environmentID, string customData=default(string))
	Returns specified environment data. More...

delegate void	OnDeleteEnvironment (bool success, string customData)
	The callback used by DeleteEnvironment(). More...

bool	DeleteEnvironment (OnDeleteEnvironment callback, string environmentID, string customData=default(string))
	Deletes the specified environment. More...

delegate void	OnGetConfigurations (GetConfigurationsResponse resp, string customData)
	The callback used by GetConfigurations(). More...

bool	GetConfigurations (OnGetConfigurations callback, string environmentID, string name=default(string), string customData=default(string))
	Lists an environment's configurations. More...

delegate void	OnAddConfiguration (Configuration resp, string customData)
	The callback used by AddConfiguration(). More...

bool	AddConfiguration (OnAddConfiguration callback, string environmentID, string configurationJsonPath, string customData=default(string))
	Adds a configuration via external json file. More...

bool	AddConfiguration (OnAddConfiguration callback, string environmentID, byte[] configurationJsonData, string customData=default(string))
	Adds a configuration via json byte data. More...

delegate void	OnGetConfiguration (Configuration resp, string customData)
	The callback uesd by GetConfiguration(). More...

bool	GetConfiguration (OnGetConfiguration callback, string environmentID, string configurationID, string customData=default(string))

delegate void	OnDeleteConfiguration (bool success, string customData)
	The callback used by DeleteConfiguration(). More...

bool	DeleteConfiguration (OnDeleteConfiguration callback, string environmentID, string configurationID, string customData=default(string))
	Deletes an environments specified configuration. More...

delegate void	OnPreviewConfiguration (TestDocument resp, string customData)
	The callback used by PreviewConfiguration(). More...

bool	PreviewConfiguration (OnPreviewConfiguration callback, string environmentID, string configurationID, string configurationFilePath, string contentFilePath, string metadata=default(string), string customData=default(string))
	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. More...

bool	PreviewConfiguration (OnPreviewConfiguration callback, string environmentID, string configurationID, string configurationFilePath, byte[] contentData, string contentMimeType, string metadata=default(string), string customData=default(string))
	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. More...

delegate void	OnGetCollections (GetCollectionsResponse resp, string customData)
	The callback used by GetCollections(). More...

bool	GetCollections (OnGetCollections callback, string environmentID, string name=default(string), string customData=default(string))
	Lists a specified environment's collections. More...

delegate void	OnAddCollection (CollectionRef resp, string customData)
	The callback used by OnAddCollection More...

bool	AddCollection (OnAddCollection callback, string environmentID, string name, string description=default(string), string configurationID=default(string), string customData=default(string))
	Adds a collection to a specified environment. More...

bool	AddCollection (OnAddCollection callback, string environmentID, byte[] collectionData, string customData=default(string))
	Adds a collection to a specified environment. More...

delegate void	OnGetCollection (Collection resp, string customData)
	The callback used by GetCollection(). More...

bool	GetCollection (OnGetCollection callback, string environmentID, string collectionID, string customData=default(string))
	Lists a specified collecton's details. More...

delegate void	OnDeleteCollection (bool success, string customData)
	The callback used by DeleteCollection(). More...

bool	DeleteCollection (OnDeleteCollection callback, string environmentID, string collectionID, string customData=default(string))
	Deletes a specified collection. More...

delegate void	OnGetFields (GetFieldsResponse resp, string customData)
	The callback used by GetFields(). More...

bool	GetFields (OnGetFields callback, string environmentID, string collectionID, string customData=default(string))
	Gets a list of the the unique fields (and their types) stored in the index. More...

delegate void	OnAddDocument (DocumentAccepted resp, string customData)
	The callbackused by AddDocument(). More...

bool	AddDocument (OnAddDocument callback, string environmentID, string collectionID, string contentFilePath, string configurationID=default(string), string configurationFilePath=default(string), string metadata=default(string), string customData=default(string))
	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. More...

bool	AddDocumentUsingConfigID (OnAddDocument callback, string environmentID, string collectionID, byte[] contentData, string contentMimeType, string configurationID, string metadata=default(string), string customData=default(string))
	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. More...

bool	AddDocumentUsingConfigFile (OnAddDocument callback, string environmentID, string collectionID, byte[] contentData, string contentMimeType, string configurationFilePath, string metadata=default(string), string customData=default(string))
	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. More...

bool	AddDocument (OnAddDocument callback, string environmentID, string collectionID, byte[] contentData, string contentMimeType, string configurationID=default(string), string configuration=default(string), string metadata=default(string), string customData=default(string))
	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. More...

delegate void	OnDeleteDocument (bool success, string customData)
	The callback used by DeleteDocument(). More...

bool	DeleteDocument (OnDeleteDocument callback, string environmentID, string collectionID, string documentID, string customData=default(string))

delegate void	OnGetDocument (DocumentStatus resp, string customData)
	The callback used by GetDocument(). More...

bool	GetDocument (OnGetDocument callback, string environmentID, string collectionID, string documentID, string customData=default(string))
	Lists a specified document's details. More...

delegate void	OnUpdateDocument (DocumentAccepted resp, string customData)
	The callback used by UpdateDocument(). More...

bool	UpdateDocument (OnUpdateDocument callback, string environmentID, string collectionID, string documentID, string contentFilePath, string configurationID=default(string), string configurationFilePath=default(string), string metadata=default(string), string customData=default(string))
	Updates a specified document. More...

bool	UpdateDocumentUsingConfigID (OnUpdateDocument callback, string environmentID, string collectionID, string documentID, byte[] contentData, string contentMimeType, string configurationID, string metadata=default(string), string customData=default(string))
	Updates a specified document using ConfigID. More...

bool	UpdateDocumentUsingConfigFile (OnUpdateDocument callback, string environmentID, string collectionID, string documentID, byte[] contentData, string contentMimeType, string configurationFilePath, string metadata=default(string), string customData=default(string))
	Updates a specified document using a configuration file path. More...

bool	UpdateDocument (OnUpdateDocument callback, string environmentID, string collectionID, string documentID, byte[] contentData, string contentMimeType, string configurationID=default(string), string configuration=default(string), string metadata=default(string), string customData=default(string))
	Updates a specified document. More...

delegate void	OnQuery (QueryResponse resp, string customData)
	The callback used by Query(). More...

bool	Query (OnQuery callback, string environmentID, string collectionID, string filter, string query, string aggregation, int count, string _return, int offset, string customData=default(string))
	Query the discovery instance. More...

string	GetServiceID ()
	<exclude> More...

Properties
string	Url `[get, set]`
	Gets and sets the endpoint URL for the service. More...

string	VersionDate `[get, set]`
	Gets and sets the versionDate of the service. More...

Credentials	Credentials `[get, set]`
	Gets and sets the credentials of the service. Replace the default endpoint if endpoint is defined. More...

Detailed Description

This class wraps the Discovery service Discovery Service

Constructor & Destructor Documentation

IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.Discovery ( Credentials credentials )

inline

Member Function Documentation

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.AddCollection	(	OnAddCollection	callback,
		string	environmentID,
		string	name,
		string	description = `default(string)`,
		string	configurationID = `default(string)`,
		string	customData = `default(string)`
	)

inline

Adds a collection to a specified environment.

Parameters

callback	The OnAddCollection callback.
environmentID	The environment identifier.
name	The name of the collection to be created.
description	The description of the collection to be created.
configurationID	The configuration identifier.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.AddCollection	(	OnAddCollection	callback,
		string	environmentID,
		byte[]	collectionData,
		string	customData = `default(string)`
	)

inline

Adds a collection to a specified environment.

Parameters

callback	The OnAddCollection callback.
environmentID	The environment identifier.
collectionData	A byte array of json collection data.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.AddConfiguration	(	OnAddConfiguration	callback,
		string	environmentID,
		string	configurationJsonPath,
		string	customData = `default(string)`
	)

inline

Adds a configuration via external json file.

Parameters

callback	The OnAddConfiguration callback.
environmentID	The environment identifier.
configurationJsonPath	The path to the configuration json file.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.AddConfiguration	(	OnAddConfiguration	callback,
		string	environmentID,
		byte[]	configurationJsonData,
		string	customData = `default(string)`
	)

inline

Adds a configuration via json byte data.

Parameters

callback	The OnAddConfiguration callback.
environmentID	The environment identifier.
configurationJsonData	A byte array of configuration json data.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.AddDocument	(	OnAddDocument	callback,
		string	environmentID,
		string	collectionID,
		string	contentFilePath,
		string	configurationID = `default(string)`,
		string	configurationFilePath = `default(string)`,
		string	metadata = `default(string)`,
		string	customData = `default(string)`
	)

inline

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.

Parameters

callback	The callback.
environmentID	The environment identifier.
collectionID	The collection identifier.
contentFilePath	The path to content file to be added.
configurationID	The ID of the configuration to use to process the document. If the configuration form part is also provided (both are present at the same time), then request will be rejected.
configurationFilePath	The content of the document to ingest.The maximum supported file size is 50 megabytes. Files larger than 50 megabytes is rejected.
metadata	If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.AddDocument	(	OnAddDocument	callback,
		string	environmentID,
		string	collectionID,
		byte[]	contentData,
		string	contentMimeType,
		string	configurationID = `default(string)`,
		string	configuration = `default(string)`,
		string	metadata = `default(string)`,
		string	customData = `default(string)`
	)

inline

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.

Parameters

callback The OnAddDocument callback.

environmentID The environment identifier.

collectionID The collection identifier.

contentData A byte array of content to be ingested.

contentMimeType

The mimeType of the content data to be ingested./param>

Parameters

configurationID	The configuration identifier. If this is specified, do not specify a configuration.
configuration	A json string of the configuration to test. If this is specified, do not specify a configurationID.
metadata	If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.AddDocumentUsingConfigFile	(	OnAddDocument	callback,
		string	environmentID,
		string	collectionID,
		byte[]	contentData,
		string	contentMimeType,
		string	configurationFilePath,
		string	metadata = `default(string)`,
		string	customData = `default(string)`
	)

inline

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.

Parameters

callback The OnAddDocument callback.

environmentID The environment identifier.

collectionID The collection identifier.

contentData A byte array of content to be ingested.

contentMimeType

The mimeType of the content data to be ingested./param>

Parameters

configurationFilePath	The file path to the configuration to use to process the document.
metadata	If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.AddDocumentUsingConfigID	(	OnAddDocument	callback,
		string	environmentID,
		string	collectionID,
		byte[]	contentData,
		string	contentMimeType,
		string	configurationID,
		string	metadata = `default(string)`,
		string	customData = `default(string)`
	)

inline

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.

Parameters

callback	The OnAddDocument callback.
environmentID	The environment identifier.
collectionID	The collection identifier.
contentData	A byte array of content to be ingested.
contentMimeType	The mimeType of the content data to be ingested.
configurationID	The identifier of the configuration to use to process the document.
metadata	If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.AddEnvironment	(	OnAddEnvironment	callback,
		string	name = `default(string)`,
		string	description = `default(string)`,
		int	size = `0`,
		string	customData = `default(string)`
	)

inline

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.

Parameters

callback	The OnAddEnvironment callback.
name	The name of the environment to be created.
description	The description of the environment to be created.
size	The size of the environment to be created. See pricing.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.AddEnvironment	(	OnAddEnvironment	callback,
		Dictionary< string, object >	addEnvironmentData,
		string	customData = `default(string)`
	)

inline

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.

Parameters

callback	The OnAddEnvironment callback.
addEnvironmentData	The AddEnvironmentData.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.DeleteCollection	(	OnDeleteCollection	callback,
		string	environmentID,
		string	collectionID,
		string	customData = `default(string)`
	)

inline

Deletes a specified collection.

Parameters

callback	The callback.
environmentID	The environment identifier.
collectionID	The collection identifier.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.DeleteConfiguration	(	OnDeleteConfiguration	callback,
		string	environmentID,
		string	configurationID,
		string	customData = `default(string)`
	)

inline

Deletes an environments specified configuration.

Parameters

callback	The OnDeleteConfiguration callback.
environmentID	The environment identifier.
configurationID	The configuration identifier.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.DeleteDocument	(	OnDeleteDocument	callback,
		string	environmentID,
		string	collectionID,
		string	documentID,
		string	customData = `default(string)`
	)

inline

Parameters

callback	The OnDeleteDocument callback.
environmentID	The environment identifier.
collectionID	The collection identifier.
documentID	The document identifier.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.DeleteEnvironment	(	OnDeleteEnvironment	callback,
		string	environmentID,
		string	customData = `default(string)`
	)

inline

Deletes the specified environment.

Parameters

callback	The callback.
environmentID	The environment identifier.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.GetCollection	(	OnGetCollection	callback,
		string	environmentID,
		string	collectionID,
		string	customData = `default(string)`
	)

inline

Lists a specified collecton's details.

Parameters

callback	The OnGetCollection callback.
environmentID	The environment identifier.
collectionID	The collection identifier.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.GetCollections	(	OnGetCollections	callback,
		string	environmentID,
		string	name = `default(string)`,
		string	customData = `default(string)`
	)

inline

Lists a specified environment's collections.

Parameters

callback	The OnGetCollections callback.
environmentID	The environment identifier.
name	Find collections with the given name.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.GetConfiguration	(	OnGetConfiguration	callback,
		string	environmentID,
		string	configurationID,
		string	customData = `default(string)`
	)

inline

Parameters

callback	The OnGetConfiguration callback.
environmentID	The environment identifier.
configurationID	The configuration identifier.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.GetConfigurations	(	OnGetConfigurations	callback,
		string	environmentID,
		string	name = `default(string)`,
		string	customData = `default(string)`
	)

inline

Lists an environment's configurations.

Parameters

callback	The OnGetConfigurations callback.
environmentID	The environment identifier.
name	An optional configuration name to search.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.GetDocument	(	OnGetDocument	callback,
		string	environmentID,
		string	collectionID,
		string	documentID,
		string	customData = `default(string)`
	)

inline

Lists a specified document's details.

Parameters

callback	The OnGetDocument callback.
environmentID	The environment identifier.
collectionID	The collection identifier.
documentID	The document identifier.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.GetEnvironment	(	OnGetEnvironment	callback,
		string	environmentID,
		string	customData = `default(string)`
	)

inline

Returns specified environment data.

Parameters

callback	The OnGetEnvironment callback.
environmentID	The environment identifier requested.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.GetEnvironments	(	OnGetEnvironments	callback,
		string	customData = `default(string)`
	)

inline

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.

Parameters

callback	The OnGetEnvironments callback.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.GetFields	(	OnGetFields	callback,
		string	environmentID,
		string	collectionID,
		string	customData = `default(string)`
	)

inline

Gets a list of the the unique fields (and their types) stored in the index.

Parameters

callback	The OnGetFields callback.
environmentID	The environment identifier.
collectionID	The collection identifier.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

string IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.GetServiceID ( )

inline

Implements IBM.Watson.DeveloperCloud.Services.IWatsonService.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnAddCollection	(	CollectionRef	resp,
		string	customData
	)

The callback used by OnAddCollection

Parameters

resp	The CollectionRef response.
customData	Optional custom data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnAddConfiguration	(	Configuration	resp,
		string	customData
	)

The callback used by AddConfiguration().

Parameters

resp	The Configuration response.
customData	Optional custom data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnAddDocument	(	DocumentAccepted	resp,
		string	customData
	)

The callbackused by AddDocument().

Parameters

resp	The DocumentAccepted response.
customData	Optional custom data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnAddEnvironment	(	Environment	resp,
		string	customData
	)

The callback used by AddEnvironment().

Parameters

resp	The Environment response.
customData	Optional custom data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnDeleteCollection	(	bool	success,
		string	customData
	)

The callback used by DeleteCollection().

Parameters

success	The success of the call.
customData	Optional custom data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnDeleteConfiguration	(	bool	success,
		string	customData
	)

The callback used by DeleteConfiguration().

Parameters

success	The success of the call.
customData	Optional custom data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnDeleteDocument	(	bool	success,
		string	customData
	)

The callback used by DeleteDocument().

Parameters

success	The success of the call.
customData	Optional custom data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnDeleteEnvironment	(	bool	success,
		string	customData
	)

The callback used by DeleteEnvironment().

Parameters

success	The success of the call.
customData	Optional custom data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnGetCollection	(	Collection	resp,
		string	customData
	)

The callback used by GetCollection().

Parameters

resp	The Collection response.
customData	Optional custom data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnGetCollections	(	GetCollectionsResponse	resp,
		string	customData
	)

The callback used by GetCollections().

Parameters

resp	The GetCollectionsResponse.
customData	Optional custom data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnGetConfiguration	(	Configuration	resp,
		string	customData
	)

The callback uesd by GetConfiguration().

Parameters

resp	The Configuration response.
customData	Optional custom data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnGetConfigurations	(	GetConfigurationsResponse	resp,
		string	customData
	)

The callback used by GetConfigurations().

Parameters

resp	The GetConfigurationsResponse.
customData	Optional custom data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnGetDocument	(	DocumentStatus	resp,
		string	customData
	)

The callback used by GetDocument().

Parameters

resp	The DocumentStatus response.
customData	Optional custom data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnGetEnvironment	(	Environment	resp,
		string	customData
	)

The callback used by GetEnvironment().

Parameters

resp	The Environment response.
customData	Optional custom data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnGetEnvironments	(	GetEnvironmentsResponse	resp,
		string	customData
	)

The callback used by GetEnvironments().

Parameters

resp	The GetEnvironments response.
customData	Optional data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnGetFields	(	GetFieldsResponse	resp,
		string	customData
	)

The callback used by GetFields().

Parameters

resp	The GetFieldsResponse.
customData	Optional custom data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnPreviewConfiguration	(	TestDocument	resp,
		string	customData
	)

The callback used by PreviewConfiguration().

Parameters

resp	The response.
customData	Optional custom data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnQuery	(	QueryResponse	resp,
		string	customData
	)

The callback used by Query().

Parameters

resp	The QueryResponse.
customData	Optional custom data.

delegate void IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.OnUpdateDocument	(	DocumentAccepted	resp,
		string	customData
	)

The callback used by UpdateDocument().

Parameters

resp	The DocumentAccepted response.
customData	Optional custom data.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.PreviewConfiguration	(	OnPreviewConfiguration	callback,
		string	environmentID,
		string	configurationID,
		string	configurationFilePath,
		string	contentFilePath,
		string	metadata = `default(string)`,
		string	customData = `default(string)`
	)

inline

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.

Parameters

callback	The OnPreviewConfiguration callback.
environmentID	The environment identifier.
configurationID	The ID of the configuration to use to process the document. If the configurationFilePath is also provided (both are present at the same time), then request will be rejected.
configurationFilePath	The configuration to use to process the document. If this part is provided, then the provided configuration is used to process the document. If the configuration_id is also provided (both are present at the same time), then request is rejected. The maximum supported configuration size is 1 MB. Configuration parts larger than 1 MB are rejected. See the GET /configurations/{configuration_id} operation for an example configuration.
contentFilePath	The file path to document to ingest.The maximum supported file size is 50 megabytes. Files larger than 50 megabytes is rejected.
metadata	If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.PreviewConfiguration	(	OnPreviewConfiguration	callback,
		string	environmentID,
		string	configurationID,
		string	configurationFilePath,
		byte[]	contentData,
		string	contentMimeType,
		string	metadata = `default(string)`,
		string	customData = `default(string)`
	)

inline

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.

Parameters

callback	The OnPreviewConfiguration callback.
environmentID	The environment identifier.
configurationID	The ID of the configuration to use to process the document. If the configurationFilePath is also provided (both are present at the same time), then request will be rejected.
configurationFilePath	The configuration to use to process the document. If this part is provided, then the provided configuration is used to process the document. If the configuration_id is also provided (both are present at the same time), then request is rejected. The maximum supported configuration size is 1 MB. Configuration parts larger than 1 MB are rejected. See the GET /configurations/{configuration_id} operation for an example configuration.
contentData	The byte array data of the document to ingest.The maximum supported file size is 50 megabytes. Files larger than 50 megabytes is rejected.
contentMimeType	The mimeType of the document to ingest.
metadata	If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.Query	(	OnQuery	callback,
		string	environmentID,
		string	collectionID,
		string	filter,
		string	query,
		string	aggregation,
		int	count,
		string	_return,
		int	offset,
		string	customData = `default(string)`
	)

inline

Query the discovery instance.

Parameters

callback	The OnQuery callback.
environmentID	The environment identifier.
collectionID	The collection identifier.
filter	A cacheable query that limits the documents returned to exclude any documents that don't mention the query content. Filter searches are better for metadata type searches and when you are trying to get a sense of concepts in the data set.
query	A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first. Use a query search when you want to find the most relevant search results.
aggregation	An aggregation search uses combinations of filters and query search to return an exact answer. Aggregations are useful for building applications, because you can use them to build lists, tables, and time series. For a full list of possible aggregrations, see the Query reference.
count	Number of documents to return.
_return	A comma separated list of the portion of the document hierarchy to return.
offset	The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10, and the offset is 8, it returns the last two results.
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.UpdateDocument	(	OnUpdateDocument	callback,
		string	environmentID,
		string	collectionID,
		string	documentID,
		string	contentFilePath,
		string	configurationID = `default(string)`,
		string	configurationFilePath = `default(string)`,
		string	metadata = `default(string)`,
		string	customData = `default(string)`
	)

inline

Updates a specified document.

Parameters

callback	The callback.
environmentID	The environment identifier.
collectionID	The collection identifier.
documentID	The document identifier.
contentFilePath	The file path to the updated document to be ingested.
configurationID	The configuration identifier to use for ingestion. If this is specified, do not specify configurationFilePath.
configurationFilePath	The path to a configuration file to use for ingestion. If this is specified, do not specify configurationID.
metadata	If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.UpdateDocument	(	OnUpdateDocument	callback,
		string	environmentID,
		string	collectionID,
		string	documentID,
		byte[]	contentData,
		string	contentMimeType,
		string	configurationID = `default(string)`,
		string	configuration = `default(string)`,
		string	metadata = `default(string)`,
		string	customData = `default(string)`
	)

inline

Updates a specified document.

Parameters

callback	The OnUpdateDocument callback.
environmentID	The environment identifier.
collectionID	The collection identifier.
documentID	The document identifier.
contentData	A byte array of content to be updated.
contentMimeType	The mimeType of the content data to be updated.
configurationID	The configuration identifier. If this is specified, do not specify a configuration.
configuration	A json string of the configuration to test. If this is specified, do not specify a configurationID.
metadata	If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.UpdateDocumentUsingConfigFile	(	OnUpdateDocument	callback,
		string	environmentID,
		string	collectionID,
		string	documentID,
		byte[]	contentData,
		string	contentMimeType,
		string	configurationFilePath,
		string	metadata = `default(string)`,
		string	customData = `default(string)`
	)

inline

Updates a specified document using a configuration file path.

Parameters

callback The OnUpdateDocument callback.

environmentID The environment identifier.

collectionID The collection identifier.

documentID The document identifier.

contentData A byte array of content to be ingested.

contentMimeType

The mimeType of the content data to be ingested./param>

Parameters

configurationFilePath	The file path to the configuration to use to process
metadata	If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

bool IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.UpdateDocumentUsingConfigID	(	OnUpdateDocument	callback,
		string	environmentID,
		string	collectionID,
		string	documentID,
		byte[]	contentData,
		string	contentMimeType,
		string	configurationID,
		string	metadata = `default(string)`,
		string	customData = `default(string)`
	)

inline

Updates a specified document using ConfigID.

Parameters

callback The OnUpdateDocument callback.

environmentID The environment identifier.

collectionID The collection identifier.

documentID The document identifier.

contentData A byte array of content to be ingested.

contentMimeType

The mimeType of the content data to be ingested./param>

Parameters

configurationID	The identifier of the configuration to use to process the document.
metadata	If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }
customData	Optional custom data.

Returns: True if the call succeeds, false if the call is unsuccessful.

Property Documentation

Credentials IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.Credentials

getset

Gets and sets the credentials of the service. Replace the default endpoint if endpoint is defined.

string IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.Url

getset

Gets and sets the endpoint URL for the service.

string IBM.Watson.DeveloperCloud.Services.Discovery.v1.Discovery.VersionDate

getset

Gets and sets the versionDate of the service.

The documentation for this class was generated from the following file:

Scripts/Services/Discovery/v1/Discovery.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation