Synapseml  0.10.0
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Cognitive.AddDocuments Class Reference

AddDocuments implements AddDocuments More...

Inheritance diagram for Synapse.ML.Cognitive.AddDocuments:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Cognitive.AddDocuments:
Collaboration graph
[legend]

Public Member Functions

 AddDocuments ()
 Creates a AddDocuments without any parameters. More...
 
 AddDocuments (string uid)
 Creates a AddDocuments with a UID that is used to give the AddDocuments a unique ID. More...
 
AddDocuments SetActionCol (string value)
 Sets value for actionCol More...
 
AddDocuments SetBatchSize (int value)
 Sets value for batchSize More...
 
AddDocuments SetConcurrency (int value)
 Sets value for concurrency More...
 
AddDocuments SetConcurrentTimeout (double value)
 Sets value for concurrentTimeout More...
 
AddDocuments SetErrorCol (string value)
 Sets value for errorCol More...
 
AddDocuments SetHandler (object value)
 Sets value for handler More...
 
AddDocuments SetIndexName (string value)
 Sets value for indexName More...
 
AddDocuments SetOutputCol (string value)
 Sets value for outputCol More...
 
AddDocuments SetServiceName (string value)
 Sets value for serviceName More...
 
AddDocuments SetSubscriptionKey (string value)
 Sets value for subscriptionKey More...
 
AddDocuments SetSubscriptionKeyCol (string value)
 Sets value for subscriptionKey column More...
 
AddDocuments SetTimeout (double value)
 Sets value for timeout More...
 
AddDocuments SetUrl (string value)
 Sets value for url More...
 
string GetActionCol ()
 Gets actionCol value More...
 
int GetBatchSize ()
 Gets batchSize value More...
 
int GetConcurrency ()
 Gets concurrency value More...
 
double GetConcurrentTimeout ()
 Gets concurrentTimeout value More...
 
string GetErrorCol ()
 Gets errorCol value More...
 
object GetHandler ()
 Gets handler value More...
 
string GetIndexName ()
 Gets indexName value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
string GetServiceName ()
 Gets serviceName value More...
 
string GetSubscriptionKey ()
 Gets subscriptionKey value More...
 
double GetTimeout ()
 Gets timeout value More...
 
string GetUrl ()
 Gets url value More...
 
void Save (string path)
 Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala. More...
 
JavaMLWriter Write ()
 
Returns
a JavaMLWriter instance for this ML instance.

 
JavaMLReader< AddDocumentsRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

static AddDocuments Load (string path)
 Loads the AddDocuments that was previously saved using Save(string). More...
 

Detailed Description

AddDocuments implements AddDocuments

Constructor & Destructor Documentation

◆ AddDocuments() [1/2]

Synapse.ML.Cognitive.AddDocuments.AddDocuments ( )
inline

Creates a AddDocuments without any parameters.

◆ AddDocuments() [2/2]

Synapse.ML.Cognitive.AddDocuments.AddDocuments ( string  uid)
inline

Creates a AddDocuments with a UID that is used to give the AddDocuments a unique ID.

Parameters
uidAn immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetActionCol()

string Synapse.ML.Cognitive.AddDocuments.GetActionCol ( )

Gets actionCol value

Returns
actionCol: You can combine actions, such as an upload and a delete, in the same batch. upload: An upload action is similar to an 'upsert' where the document will be inserted if it is new and updated/replaced if it exists. Note that all fields are replaced in the update case. merge: Merge updates an existing document with the specified fields. If the document doesn't exist, the merge will fail. Any field you specify in a merge will replace the existing field in the document. This includes fields of type Collection(Edm.String). For example, if the document contains a field 'tags' with value ['budget'] and you execute a merge with value ['economy', 'pool'] for 'tags', the final value of the 'tags' field will be ['economy', 'pool']. It will not be ['budget', 'economy', 'pool']. mergeOrUpload: This action behaves like merge if a document with the given key already exists in the index. If the document does not exist, it behaves like upload with a new document. delete: Delete removes the specified document from the index. Note that any field you specify in a delete operation, other than the key field, will be ignored. If you want to remove an individual field from a document, use merge instead and simply set the field explicitly to null.

◆ GetBatchSize()

int Synapse.ML.Cognitive.AddDocuments.GetBatchSize ( )

Gets batchSize value

Returns
batchSize: The max size of the buffer

◆ GetConcurrency()

int Synapse.ML.Cognitive.AddDocuments.GetConcurrency ( )

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

double Synapse.ML.Cognitive.AddDocuments.GetConcurrentTimeout ( )

Gets concurrentTimeout value

Returns
concurrentTimeout: max number seconds to wait on futures if concurrency >= 1

◆ GetErrorCol()

string Synapse.ML.Cognitive.AddDocuments.GetErrorCol ( )

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetHandler()

object Synapse.ML.Cognitive.AddDocuments.GetHandler ( )

Gets handler value

Returns
handler: Which strategy to use when handling requests

◆ GetIndexName()

string Synapse.ML.Cognitive.AddDocuments.GetIndexName ( )

Gets indexName value

Returns
indexName:

◆ GetOutputCol()

string Synapse.ML.Cognitive.AddDocuments.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetServiceName()

string Synapse.ML.Cognitive.AddDocuments.GetServiceName ( )

Gets serviceName value

Returns
serviceName:

◆ GetSubscriptionKey()

string Synapse.ML.Cognitive.AddDocuments.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetTimeout()

double Synapse.ML.Cognitive.AddDocuments.GetTimeout ( )

Gets timeout value

Returns
timeout: number of seconds to wait before closing the connection

◆ GetUrl()

string Synapse.ML.Cognitive.AddDocuments.GetUrl ( )

Gets url value

Returns
url: Url of the service

◆ Load()

static AddDocuments Synapse.ML.Cognitive.AddDocuments.Load ( string  path)
static

Loads the AddDocuments that was previously saved using Save(string).

Parameters
pathThe path the previous AddDocuments was saved to
Returns
New AddDocuments object, loaded from path.

◆ Read()

JavaMLReader<AddDocuments> Synapse.ML.Cognitive.AddDocuments.Read ( )

Get the corresponding JavaMLReader instance.

Returns
an JavaMLReader<AddDocuments> instance for this ML instance.

◆ Save()

void Synapse.ML.Cognitive.AddDocuments.Save ( string  path)

Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala.

Parameters
pathThe path to save the object to

◆ SetActionCol()

AddDocuments Synapse.ML.Cognitive.AddDocuments.SetActionCol ( string  value)

Sets value for actionCol

Parameters
valueYou can combine actions, such as an upload and a delete, in the same batch. upload: An upload action is similar to an 'upsert' where the document will be inserted if it is new and updated/replaced if it exists. Note that all fields are replaced in the update case. merge: Merge updates an existing document with the specified fields. If the document doesn't exist, the merge will fail. Any field you specify in a merge will replace the existing field in the document. This includes fields of type Collection(Edm.String). For example, if the document contains a field 'tags' with value ['budget'] and you execute a merge with value ['economy', 'pool'] for 'tags', the final value of the 'tags' field will be ['economy', 'pool']. It will not be ['budget', 'economy', 'pool']. mergeOrUpload: This action behaves like merge if a document with the given key already exists in the index. If the document does not exist, it behaves like upload with a new document. delete: Delete removes the specified document from the index. Note that any field you specify in a delete operation, other than the key field, will be ignored. If you want to remove an individual field from a document, use merge instead and simply set the field explicitly to null.
Returns
New AddDocuments object

◆ SetBatchSize()

AddDocuments Synapse.ML.Cognitive.AddDocuments.SetBatchSize ( int  value)

Sets value for batchSize

Parameters
valueThe max size of the buffer
Returns
New AddDocuments object

◆ SetConcurrency()

AddDocuments Synapse.ML.Cognitive.AddDocuments.SetConcurrency ( int  value)

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New AddDocuments object

◆ SetConcurrentTimeout()

AddDocuments Synapse.ML.Cognitive.AddDocuments.SetConcurrentTimeout ( double  value)

Sets value for concurrentTimeout

Parameters
valuemax number seconds to wait on futures if concurrency >= 1
Returns
New AddDocuments object

◆ SetErrorCol()

AddDocuments Synapse.ML.Cognitive.AddDocuments.SetErrorCol ( string  value)

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New AddDocuments object

◆ SetHandler()

AddDocuments Synapse.ML.Cognitive.AddDocuments.SetHandler ( object  value)

Sets value for handler

Parameters
valueWhich strategy to use when handling requests
Returns
New AddDocuments object

◆ SetIndexName()

AddDocuments Synapse.ML.Cognitive.AddDocuments.SetIndexName ( string  value)

Sets value for indexName

Parameters
value
Returns
New AddDocuments object

◆ SetOutputCol()

AddDocuments Synapse.ML.Cognitive.AddDocuments.SetOutputCol ( string  value)

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New AddDocuments object

◆ SetServiceName()

AddDocuments Synapse.ML.Cognitive.AddDocuments.SetServiceName ( string  value)

Sets value for serviceName

Parameters
value
Returns
New AddDocuments object

◆ SetSubscriptionKey()

AddDocuments Synapse.ML.Cognitive.AddDocuments.SetSubscriptionKey ( string  value)

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New AddDocuments object

◆ SetSubscriptionKeyCol()

AddDocuments Synapse.ML.Cognitive.AddDocuments.SetSubscriptionKeyCol ( string  value)

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New AddDocuments object

◆ SetTimeout()

AddDocuments Synapse.ML.Cognitive.AddDocuments.SetTimeout ( double  value)

Sets value for timeout

Parameters
valuenumber of seconds to wait before closing the connection
Returns
New AddDocuments object

◆ SetUrl()

AddDocuments Synapse.ML.Cognitive.AddDocuments.SetUrl ( string  value)

Sets value for url

Parameters
valueUrl of the service
Returns
New AddDocuments object

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