AddDocuments implements AddDocuments More...

Inheritance diagram for Synapse.ML.Services.Search.AddDocuments:

[legend]

Collaboration diagram for Synapse.ML.Services.Search.AddDocuments:

[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	SetAADToken (string value)
	Sets value for AADToken More...

AddDocuments	SetAADTokenCol (string value)
	Sets value for AADToken column More...

AddDocuments	SetCustomAuthHeader (string value)
	Sets value for CustomAuthHeader More...

AddDocuments	SetCustomAuthHeaderCol (string value)
	Sets value for CustomAuthHeader column 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	GetAADToken ()
	Gets AADToken value More...

string	GetCustomAuthHeader ()
	Gets CustomAuthHeader value 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< AddDocuments >	Read ()
	Get the corresponding JavaMLReader instance. More...

AddDocuments	SetCustomServiceName (string value)
	Sets value for service name More...

AddDocuments	SetEndpoint (string value)
	Sets value for endpoint 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.Services.Search.AddDocuments.AddDocuments ( )

inline

Creates a AddDocuments without any parameters.

◆ AddDocuments() [2/2]

Synapse.ML.Services.Search.AddDocuments.AddDocuments ( string uid )

inline

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

Parameters

uid	An immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetAADToken()

string Synapse.ML.Services.Search.AddDocuments.GetAADToken ( )

Gets AADToken value

Returns: AADToken: AAD Token used for authentication

◆ GetActionCol()

string Synapse.ML.Services.Search.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.Services.Search.AddDocuments.GetBatchSize ( )

Gets batchSize value

Returns: batchSize: The max size of the buffer

◆ GetConcurrency()

int Synapse.ML.Services.Search.AddDocuments.GetConcurrency ( )

Gets concurrency value

Returns: concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

double Synapse.ML.Services.Search.AddDocuments.GetConcurrentTimeout ( )

Gets concurrentTimeout value

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

◆ GetCustomAuthHeader()

string Synapse.ML.Services.Search.AddDocuments.GetCustomAuthHeader ( )

Gets CustomAuthHeader value

Returns: CustomAuthHeader: A Custom Value for Authorization Header

◆ GetErrorCol()

string Synapse.ML.Services.Search.AddDocuments.GetErrorCol ( )

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetHandler()

object Synapse.ML.Services.Search.AddDocuments.GetHandler ( )

Gets handler value

Returns: handler: Which strategy to use when handling requests

◆ GetIndexName()

string Synapse.ML.Services.Search.AddDocuments.GetIndexName ( )

Gets indexName value

Returns: indexName:

◆ GetOutputCol()

string Synapse.ML.Services.Search.AddDocuments.GetOutputCol ( )

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetServiceName()

string Synapse.ML.Services.Search.AddDocuments.GetServiceName ( )

Gets serviceName value

Returns: serviceName:

◆ GetSubscriptionKey()

string Synapse.ML.Services.Search.AddDocuments.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetTimeout()

double Synapse.ML.Services.Search.AddDocuments.GetTimeout ( )

Gets timeout value

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

◆ GetUrl()

string Synapse.ML.Services.Search.AddDocuments.GetUrl ( )

Gets url value

Returns: url: Url of the service

◆ Load()

static AddDocuments Synapse.ML.Services.Search.AddDocuments.Load ( string path )

static

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

Parameters

path	The path the previous AddDocuments was saved to

Returns: New AddDocuments object, loaded from path.

◆ Read()

JavaMLReader<AddDocuments> Synapse.ML.Services.Search.AddDocuments.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Services.Search.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

path	The path to save the object to

◆ SetAADToken()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetAADToken ( string value )

Sets value for AADToken

Parameters

value AAD Token used for authentication

Returns: New AddDocuments object

◆ SetAADTokenCol()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetAADTokenCol ( string value )

Sets value for AADToken column

Parameters

value AAD Token used for authentication

Returns: New AddDocuments object

◆ SetActionCol()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetActionCol ( string value )

Sets value for actionCol

Parameters

value 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.

Returns: New AddDocuments object

◆ SetBatchSize()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetBatchSize ( int value )

Sets value for batchSize

Parameters

value The max size of the buffer

Returns: New AddDocuments object

◆ SetConcurrency()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetConcurrency ( int value )

Sets value for concurrency

Parameters

value max number of concurrent calls

Returns: New AddDocuments object

◆ SetConcurrentTimeout()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetConcurrentTimeout ( double value )

Sets value for concurrentTimeout

Parameters

value max number seconds to wait on futures if concurrency >= 1

Returns: New AddDocuments object

◆ SetCustomAuthHeader()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetCustomAuthHeader ( string value )

Sets value for CustomAuthHeader

Parameters

value A Custom Value for Authorization Header

Returns: New AddDocuments object

◆ SetCustomAuthHeaderCol()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetCustomAuthHeaderCol ( string value )

Sets value for CustomAuthHeader column

Parameters

value A Custom Value for Authorization Header

Returns: New AddDocuments object

◆ SetCustomServiceName()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetCustomServiceName ( string value )

Sets value for service name

Parameters

value Service name of the cognitive service if it's custom domain

Returns: New AddDocuments object

◆ SetEndpoint()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetEndpoint ( string value )

Sets value for endpoint

Parameters

value Endpoint of the cognitive service

Returns: New AddDocuments object

◆ SetErrorCol()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetErrorCol ( string value )

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New AddDocuments object

◆ SetHandler()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetHandler ( object value )

Sets value for handler

Parameters

value Which strategy to use when handling requests

Returns: New AddDocuments object

◆ SetIndexName()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetIndexName ( string value )

Sets value for indexName

Parameters

value

Returns: New AddDocuments object

◆ SetOutputCol()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetOutputCol ( string value )

Sets value for outputCol

Parameters

value The name of the output column

Returns: New AddDocuments object

◆ SetServiceName()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetServiceName ( string value )

Sets value for serviceName

Parameters

value

Returns: New AddDocuments object

◆ SetSubscriptionKey()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetSubscriptionKey ( string value )

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New AddDocuments object

◆ SetSubscriptionKeyCol()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetSubscriptionKeyCol ( string value )

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New AddDocuments object

◆ SetTimeout()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetTimeout ( double value )

Sets value for timeout

Parameters

value number of seconds to wait before closing the connection

Returns: New AddDocuments object

◆ SetUrl()

AddDocuments Synapse.ML.Services.Search.AddDocuments.SetUrl ( string value )

Sets value for url

Parameters

value Url of the service

Returns: New AddDocuments object

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

synapse/ml/services/search/AddDocuments.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AddDocuments() [1/2]

◆ AddDocuments() [2/2]

Member Function Documentation

◆ GetAADToken()

◆ GetActionCol()

◆ GetBatchSize()

◆ GetConcurrency()

◆ GetConcurrentTimeout()

◆ GetCustomAuthHeader()

◆ GetErrorCol()

◆ GetHandler()

◆ GetIndexName()

◆ GetOutputCol()

◆ GetServiceName()

◆ GetSubscriptionKey()

◆ GetTimeout()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetAADToken()

◆ SetAADTokenCol()

◆ SetActionCol()

◆ SetBatchSize()

◆ SetConcurrency()

◆ SetConcurrentTimeout()

◆ SetCustomAuthHeader()

◆ SetCustomAuthHeaderCol()

◆ SetCustomServiceName()

◆ SetEndpoint()

◆ SetErrorCol()

◆ SetHandler()

◆ SetIndexName()

◆ SetOutputCol()

◆ SetServiceName()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetTimeout()

◆ SetUrl()