C# Class BuildIt.CognitiveServices.WebLanguageModelAPIExtensions

Extension methods for WebLanguageModelAPI.

Public Methods

Method	Description
BreakIntoWords ( this operations, string model, string text, double order = default(double?), double maxNumOfCandidatesReturned = default(double?), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void	Insert spaces into a string of words lacking spaces, like a hashtag or part of a URL. Punctuation or exotic characters can prevent a string from being broken, so it’s best to limit input strings to lower-case, alpha-numeric characters.
BreakIntoWordsAsync ( this operations, string model, string text, double order = default(double?), double maxNumOfCandidatesReturned = default(double?), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task	Insert spaces into a string of words lacking spaces, like a hashtag or part of a URL. Punctuation or exotic characters can prevent a string from being broken, so it’s best to limit input strings to lower-case, alpha-numeric characters.
CalculateConditionalProbability ( this operations, string model, double order = default(double?), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void	Calculate the conditional probability that a particular word will follow a given sequence of words.
CalculateConditionalProbabilityAsync ( this operations, string model, double order = default(double?), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task	Calculate the conditional probability that a particular word will follow a given sequence of words.
CalculateJointProbability ( this operations, string model, double order = default(double?), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void	Calculate the joint probability that a particular sequence of words will appear together.
CalculateJointProbabilityAsync ( this operations, string model, double order = default(double?), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task	Calculate the joint probability that a particular sequence of words will appear together.
GenerateNextWords ( this operations, string model, string words, double order = default(double?), double maxNumOfCandidatesReturned = default(double?), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void	Get the list of words (completions) most likely to follow a given sequence of words.
GenerateNextWordsAsync ( this operations, string model, string words, double order = default(double?), double maxNumOfCandidatesReturned = default(double?), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task	Get the list of words (completions) most likely to follow a given sequence of words.
ListAvailableModels ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void	List models available currently.
ListAvailableModelsAsync ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task	List models available currently.

Method Details

BreakIntoWords() public static method

Insert spaces into a string of words lacking spaces, like a hashtag or part of a URL. Punctuation or exotic characters can prevent a string from being broken, so it’s best to limit input strings to lower-case, alpha-numeric characters.

public static BreakIntoWords ( this operations, string model, string text, double order = default(double?), double maxNumOfCandidatesReturned = default(double?), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void
operations	this	/// The operations group for this extension method. ///
model	string	/// Which model to use, supported value: title/anchor/query/body ///
text	string	/// The line of text to break into words. If spaces are present, they will be /// interpreted as hard breaks and maintained, except for leading or trailing /// spaces, which will be trimmed. ///
order	double	/// The order of N-gram. If not specified, use default value 5 .Supported /// value: 1, 2, 3, 4, 5. ///
maxNumOfCandidatesReturned	double	/// Max number of candidates would be returned. If not specified, use default /// value 5. ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
return	void

BreakIntoWordsAsync() public static method

public static BreakIntoWordsAsync ( this operations, string model, string text, double order = default(double?), double maxNumOfCandidatesReturned = default(double?), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task
operations	this	/// The operations group for this extension method. ///
model	string	/// Which model to use, supported value: title/anchor/query/body ///
text	string	/// The line of text to break into words. If spaces are present, they will be /// interpreted as hard breaks and maintained, except for leading or trailing /// spaces, which will be trimmed. ///
order	double	/// The order of N-gram. If not specified, use default value 5 .Supported /// value: 1, 2, 3, 4, 5. ///
maxNumOfCandidatesReturned	double	/// Max number of candidates would be returned. If not specified, use default /// value 5. ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
cancellationToken	System	/// The cancellation token. ///
return	System.Threading.Tasks.Task

CalculateConditionalProbability() public static method

Calculate the conditional probability that a particular word will follow a given sequence of words.

public static CalculateConditionalProbability ( this operations, string model, double order = default(double?), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void
operations	this	/// The operations group for this extension method. ///
model	string	/// Which model to use, supported value: title/anchor/query/body ///
order	double	/// The order of N-gram. If not specified, use default value 5 .Supported /// value: 1, 2, 3, 4, 5. ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
return	void

CalculateConditionalProbabilityAsync() public static method

Calculate the conditional probability that a particular word will follow a given sequence of words.

public static CalculateConditionalProbabilityAsync ( this operations, string model, double order = default(double?), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task
operations	this	/// The operations group for this extension method. ///
model	string	/// Which model to use, supported value: title/anchor/query/body ///
order	double	/// The order of N-gram. If not specified, use default value 5 .Supported /// value: 1, 2, 3, 4, 5. ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
cancellationToken	System	/// The cancellation token. ///
return	System.Threading.Tasks.Task

CalculateJointProbability() public static method

Calculate the joint probability that a particular sequence of words will appear together.

public static CalculateJointProbability ( this operations, string model, double order = default(double?), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void
operations	this	/// The operations group for this extension method. ///
model	string	/// Which model to use, supported value: title/anchor/query/body ///
order	double	/// The order of N-gram. If not specified, use default value 5 .Supported /// value: 1, 2, 3, 4, 5. ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
return	void

CalculateJointProbabilityAsync() public static method

Calculate the joint probability that a particular sequence of words will appear together.

public static CalculateJointProbabilityAsync ( this operations, string model, double order = default(double?), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task
operations	this	/// The operations group for this extension method. ///
model	string	/// Which model to use, supported value: title/anchor/query/body ///
order	double	/// The order of N-gram. If not specified, use default value 5 .Supported /// value: 1, 2, 3, 4, 5. ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
cancellationToken	System	/// The cancellation token. ///
return	System.Threading.Tasks.Task

GenerateNextWords() public static method

Get the list of words (completions) most likely to follow a given sequence of words.

public static GenerateNextWords ( this operations, string model, string words, double order = default(double?), double maxNumOfCandidatesReturned = default(double?), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void
operations	this	/// The operations group for this extension method. ///
model	string	/// Which model to use, supported value: title/anchor/query/body ///
words	string	/// A string containing a sequence of words from which to generate the list of /// words likely to follow. The words should be separated by spaces. ///
order	double	/// The order of N-gram. If not specified, use default value 5 .Supported /// value: 1, 2, 3, 4, 5. ///
maxNumOfCandidatesReturned	double	/// Max number of candidates would be returned. If not specified, use default /// value 5. ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
return	void

GenerateNextWordsAsync() public static method

Get the list of words (completions) most likely to follow a given sequence of words.

public static GenerateNextWordsAsync ( this operations, string model, string words, double order = default(double?), double maxNumOfCandidatesReturned = default(double?), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task
operations	this	/// The operations group for this extension method. ///
model	string	/// Which model to use, supported value: title/anchor/query/body ///
words	string	/// A string containing a sequence of words from which to generate the list of /// words likely to follow. The words should be separated by spaces. ///
order	double	/// The order of N-gram. If not specified, use default value 5 .Supported /// value: 1, 2, 3, 4, 5. ///
maxNumOfCandidatesReturned	double	/// Max number of candidates would be returned. If not specified, use default /// value 5. ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
cancellationToken	System	/// The cancellation token. ///
return	System.Threading.Tasks.Task

ListAvailableModels() public static method

List models available currently.

public static ListAvailableModels ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void
operations	this	/// The operations group for this extension method. ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
return	void

ListAvailableModelsAsync() public static method

List models available currently.

public static ListAvailableModelsAsync ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task
operations	this	/// The operations group for this extension method. ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
cancellationToken	System	/// The cancellation token. ///
return	System.Threading.Tasks.Task