Click or drag to resize

DiscoveryAddDocument Method (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.

Namespace:  IBM.Watson.DeveloperCloud.Services.Discovery.v1
Assembly:  unity-documentation (in unity-documentation.exe) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
Copy
public bool AddDocument(
	DiscoverySuccessCallback<DocumentAccepted> successCallback,
	DiscoveryFailCallback failCallback,
	string environmentID,
	string collectionID,
	byte[] contentData,
	string contentMimeType,
	string configurationID = null,
	string configuration = null,
	string metadata = null,
	Dictionary<string, Object> customData = null
)

Parameters

successCallback
Type: IBM.Watson.DeveloperCloud.Services.Discovery.v1DiscoverySuccessCallbackDocumentAccepted
The success callback.
failCallback
Type: IBM.Watson.DeveloperCloud.Services.Discovery.v1DiscoveryFailCallback
The fail callback.
environmentID
Type: SystemString
The environment identifier.
collectionID
Type: SystemString
The collection identifier.
contentData
Type: SystemByte
A byte array of content to be ingested.
contentMimeType
Type: SystemString
The mimeType of the content data to be ingested.
configurationID (Optional)
Type: SystemString
The configuration identifier. If this is specified, do not specify a configuration.
configuration (Optional)
Type: SystemString
A json string of the configuration to test. If this is specified, do not specify a configurationID.
metadata (Optional)
Type: SystemString
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)
Type: System.Collections.GenericDictionaryString, Object
Optional custom data.

Return Value

Type: Boolean
True if the call succeeds, false if the call is unsuccessful.
See Also