OpenAIEmbedding implements OpenAIEmbedding More...

Inheritance diagram for Synapse.ML.Services.Openai.OpenAIEmbedding:

[legend]

Collaboration diagram for Synapse.ML.Services.Openai.OpenAIEmbedding:

[legend]

Public Member Functions
	OpenAIEmbedding ()
	Creates a OpenAIEmbedding without any parameters. More...

	OpenAIEmbedding (string uid)
	Creates a OpenAIEmbedding with a UID that is used to give the OpenAIEmbedding a unique ID. More...

OpenAIEmbedding	SetAADToken (string value)
	Sets value for AADToken More...

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

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

OpenAIEmbedding	SetCustomAuthHeaderCol (string value)
	Sets value for CustomAuthHeader column More...

OpenAIEmbedding	SetApiVersion (string value)
	Sets value for apiVersion More...

OpenAIEmbedding	SetApiVersionCol (string value)
	Sets value for apiVersion column More...

OpenAIEmbedding	SetConcurrency (int value)
	Sets value for concurrency More...

OpenAIEmbedding	SetConcurrentTimeout (double value)
	Sets value for concurrentTimeout More...

OpenAIEmbedding	SetDeploymentName (string value)
	Sets value for deploymentName More...

OpenAIEmbedding	SetDeploymentNameCol (string value)
	Sets value for deploymentName column More...

OpenAIEmbedding	SetErrorCol (string value)
	Sets value for errorCol More...

OpenAIEmbedding	SetHandler (object value)
	Sets value for handler More...

OpenAIEmbedding	SetOutputCol (string value)
	Sets value for outputCol More...

OpenAIEmbedding	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...

OpenAIEmbedding	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...

OpenAIEmbedding	SetText (string value)
	Sets value for text More...

OpenAIEmbedding	SetTextCol (string value)
	Sets value for text column More...

OpenAIEmbedding	SetTimeout (double value)
	Sets value for timeout More...

OpenAIEmbedding	SetUrl (string value)
	Sets value for url More...

OpenAIEmbedding	SetUser (string value)
	Sets value for user More...

OpenAIEmbedding	SetUserCol (string value)
	Sets value for user column More...

string	GetAADToken ()
	Gets AADToken value More...

string	GetCustomAuthHeader ()
	Gets CustomAuthHeader value More...

string	GetApiVersion ()
	Gets apiVersion value More...

int	GetConcurrency ()
	Gets concurrency value More...

double	GetConcurrentTimeout ()
	Gets concurrentTimeout value More...

string	GetDeploymentName ()
	Gets deploymentName value More...

string	GetErrorCol ()
	Gets errorCol value More...

object	GetHandler ()
	Gets handler value More...

string	GetOutputCol ()
	Gets outputCol value More...

string	GetSubscriptionKey ()
	Gets subscriptionKey value More...

string	GetText ()
	Gets text value More...

double	GetTimeout ()
	Gets timeout value More...

string	GetUrl ()
	Gets url value More...

string	GetUser ()
	Gets user 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< OpenAIEmbedding >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

OpenAIEmbedding	SetEndpoint (string value)
	Sets value for endpoint More...

Static Public Member Functions
static OpenAIEmbedding	Load (string path)
	Loads the OpenAIEmbedding that was previously saved using Save(string). More...

Detailed Description

OpenAIEmbedding implements OpenAIEmbedding

Constructor & Destructor Documentation

◆ OpenAIEmbedding() [1/2]

Synapse.ML.Services.Openai.OpenAIEmbedding.OpenAIEmbedding ( )

inline

Creates a OpenAIEmbedding without any parameters.

◆ OpenAIEmbedding() [2/2]

Synapse.ML.Services.Openai.OpenAIEmbedding.OpenAIEmbedding ( string uid )

inline

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

Parameters

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

Member Function Documentation

◆ GetAADToken()

string Synapse.ML.Services.Openai.OpenAIEmbedding.GetAADToken ( )

Gets AADToken value

Returns: AADToken: AAD Token used for authentication

◆ GetApiVersion()

string Synapse.ML.Services.Openai.OpenAIEmbedding.GetApiVersion ( )

Gets apiVersion value

Returns: apiVersion: version of the api

◆ GetConcurrency()

int Synapse.ML.Services.Openai.OpenAIEmbedding.GetConcurrency ( )

Gets concurrency value

Returns: concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

double Synapse.ML.Services.Openai.OpenAIEmbedding.GetConcurrentTimeout ( )

Gets concurrentTimeout value

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

◆ GetCustomAuthHeader()

string Synapse.ML.Services.Openai.OpenAIEmbedding.GetCustomAuthHeader ( )

Gets CustomAuthHeader value

Returns: CustomAuthHeader: A Custom Value for Authorization Header

◆ GetDeploymentName()

string Synapse.ML.Services.Openai.OpenAIEmbedding.GetDeploymentName ( )

Gets deploymentName value

Returns: deploymentName: The name of the deployment

◆ GetErrorCol()

string Synapse.ML.Services.Openai.OpenAIEmbedding.GetErrorCol ( )

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetHandler()

object Synapse.ML.Services.Openai.OpenAIEmbedding.GetHandler ( )

Gets handler value

Returns: handler: Which strategy to use when handling requests

◆ GetOutputCol()

string Synapse.ML.Services.Openai.OpenAIEmbedding.GetOutputCol ( )

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetSubscriptionKey()

string Synapse.ML.Services.Openai.OpenAIEmbedding.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetText()

string Synapse.ML.Services.Openai.OpenAIEmbedding.GetText ( )

Gets text value

Returns: text: Input text to get embeddings for.

◆ GetTimeout()

double Synapse.ML.Services.Openai.OpenAIEmbedding.GetTimeout ( )

Gets timeout value

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

◆ GetUrl()

string Synapse.ML.Services.Openai.OpenAIEmbedding.GetUrl ( )

Gets url value

Returns: url: Url of the service

◆ GetUser()

string Synapse.ML.Services.Openai.OpenAIEmbedding.GetUser ( )

Gets user value

Returns: user: The ID of the end-user, for use in tracking and rate-limiting.

◆ Load()

static OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.Load ( string path )

static

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

Parameters

path	The path the previous OpenAIEmbedding was saved to

Returns: New OpenAIEmbedding object, loaded from path.

◆ Read()

JavaMLReader<OpenAIEmbedding> Synapse.ML.Services.Openai.OpenAIEmbedding.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Services.Openai.OpenAIEmbedding.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()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetAADToken ( string value )

Sets value for AADToken

Parameters

value AAD Token used for authentication

Returns: New OpenAIEmbedding object

◆ SetAADTokenCol()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetAADTokenCol ( string value )

Sets value for AADToken column

Parameters

value AAD Token used for authentication

Returns: New OpenAIEmbedding object

◆ SetApiVersion()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetApiVersion ( string value )

Sets value for apiVersion

Parameters

value version of the api

Returns: New OpenAIEmbedding object

◆ SetApiVersionCol()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetApiVersionCol ( string value )

Sets value for apiVersion column

Parameters

value version of the api

Returns: New OpenAIEmbedding object

◆ SetConcurrency()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetConcurrency ( int value )

Sets value for concurrency

Parameters

value max number of concurrent calls

Returns: New OpenAIEmbedding object

◆ SetConcurrentTimeout()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetConcurrentTimeout ( double value )

Sets value for concurrentTimeout

Parameters

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

Returns: New OpenAIEmbedding object

◆ SetCustomAuthHeader()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetCustomAuthHeader ( string value )

Sets value for CustomAuthHeader

Parameters

value A Custom Value for Authorization Header

Returns: New OpenAIEmbedding object

◆ SetCustomAuthHeaderCol()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetCustomAuthHeaderCol ( string value )

Sets value for CustomAuthHeader column

Parameters

value A Custom Value for Authorization Header

Returns: New OpenAIEmbedding object

◆ SetCustomServiceName()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetCustomServiceName ( string value )

Sets value for service name

Parameters

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

Returns: New OpenAIEmbedding object

◆ SetDeploymentName()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetDeploymentName ( string value )

Sets value for deploymentName

Parameters

value The name of the deployment

Returns: New OpenAIEmbedding object

◆ SetDeploymentNameCol()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetDeploymentNameCol ( string value )

Sets value for deploymentName column

Parameters

value The name of the deployment

Returns: New OpenAIEmbedding object

◆ SetEndpoint()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetEndpoint ( string value )

Sets value for endpoint

Parameters

value Endpoint of the cognitive service

Returns: New OpenAIEmbedding object

◆ SetErrorCol()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetErrorCol ( string value )

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New OpenAIEmbedding object

◆ SetHandler()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetHandler ( object value )

Sets value for handler

Parameters

value Which strategy to use when handling requests

Returns: New OpenAIEmbedding object

◆ SetOutputCol()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetOutputCol ( string value )

Sets value for outputCol

Parameters

value The name of the output column

Returns: New OpenAIEmbedding object

◆ SetSubscriptionKey()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetSubscriptionKey ( string value )

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New OpenAIEmbedding object

◆ SetSubscriptionKeyCol()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetSubscriptionKeyCol ( string value )

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New OpenAIEmbedding object

◆ SetText()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetText ( string value )

Sets value for text

Parameters

value Input text to get embeddings for.

Returns: New OpenAIEmbedding object

◆ SetTextCol()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetTextCol ( string value )

Sets value for text column

Parameters

value Input text to get embeddings for.

Returns: New OpenAIEmbedding object

◆ SetTimeout()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetTimeout ( double value )

Sets value for timeout

Parameters

value number of seconds to wait before closing the connection

Returns: New OpenAIEmbedding object

◆ SetUrl()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetUrl ( string value )

Sets value for url

Parameters

value Url of the service

Returns: New OpenAIEmbedding object

◆ SetUser()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetUser ( string value )

Sets value for user

Parameters

value The ID of the end-user, for use in tracking and rate-limiting.

Returns: New OpenAIEmbedding object

◆ SetUserCol()

OpenAIEmbedding Synapse.ML.Services.Openai.OpenAIEmbedding.SetUserCol ( string value )

Sets value for user column

Parameters

value The ID of the end-user, for use in tracking and rate-limiting.

Returns: New OpenAIEmbedding object

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

synapse/ml/services/openai/OpenAIEmbedding.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ OpenAIEmbedding() [1/2]

◆ OpenAIEmbedding() [2/2]

Member Function Documentation

◆ GetAADToken()

◆ GetApiVersion()

◆ GetConcurrency()

◆ GetConcurrentTimeout()

◆ GetCustomAuthHeader()

◆ GetDeploymentName()

◆ GetErrorCol()

◆ GetHandler()

◆ GetOutputCol()

◆ GetSubscriptionKey()

◆ GetText()

◆ GetTimeout()

◆ GetUrl()

◆ GetUser()

◆ Load()

◆ Read()

◆ Save()

◆ SetAADToken()

◆ SetAADTokenCol()

◆ SetApiVersion()

◆ SetApiVersionCol()

◆ SetConcurrency()

◆ SetConcurrentTimeout()

◆ SetCustomAuthHeader()

◆ SetCustomAuthHeaderCol()

◆ SetCustomServiceName()

◆ SetDeploymentName()

◆ SetDeploymentNameCol()

◆ SetEndpoint()

◆ SetErrorCol()

◆ SetHandler()

◆ SetOutputCol()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetText()

◆ SetTextCol()

◆ SetTimeout()

◆ SetUrl()

◆ SetUser()

◆ SetUserCol()