Click or drag to resize

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

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 PreviewConfiguration(
	DiscoverySuccessCallback<TestDocument> successCallback,
	DiscoveryFailCallback failCallback,
	string environmentID,
	string configurationID,
	string configurationFilePath,
	string contentFilePath,
	string metadata = null,
	Dictionary<string, Object> customData = null
)

Parameters

successCallback
Type: IBM.Watson.DeveloperCloud.Services.Discovery.v1DiscoverySuccessCallbackTestDocument
The success callback.
failCallback
Type: IBM.Watson.DeveloperCloud.Services.Discovery.v1DiscoveryFailCallback
The fail callback.
environmentID
Type: SystemString
The environment identifier.
configurationID
Type: SystemString
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
Type: SystemString
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
Type: SystemString
The file path to document to ingest.The maximum supported file size is 50 megabytes. Files larger than 50 megabytes is rejected.
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