C# Класс BuildIt.CognitiveServices.AcademicSearchAPIExtensions

Extension methods for AcademicSearchAPI.
Показать файл Открыть проект

Открытые методы

Метод Описание
CalcHistogram ( this operations, string expr, string model = "latest", string attributes = default(string), double count = 10, double offset, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void

The calchistogram REST API is used to calculate the distribution of attribute values for a set of paper entities.
CalcHistogramAsync ( this operations, string expr, string model = "latest", string attributes = default(string), double count = 10, double offset, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task

The calchistogram REST API is used to calculate the distribution of attribute values for a set of paper entities.
Evaluate ( this operations, string expr, string model = "latest", double count = 10, double offset, string orderby = default(string), string attributes = "Id", string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void

The evaluate REST API is used to return a set of academic entities based on a query expression.
EvaluateAsync ( this operations, string expr, string model = "latest", double count = 10, double offset, string orderby = default(string), string attributes = "Id", string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task

The evaluate REST API is used to return a set of academic entities based on a query expression.
GraphSearch ( this operations, string mode, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void

Welcome to the Microsoft Cognitive Service Academic Search API, a web service for retrieving paths and subgraphs from Microsoft Academic Graph. The graph query interface powered by Graph Engine allows us to not only query entities that meet certain criteria (e.g. find a paper with a given title), but also perform pattern matching via graph exploration (e.g. detect co-authorship).
GraphSearchAsync ( this operations, string mode, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task

Welcome to the Microsoft Cognitive Service Academic Search API, a web service for retrieving paths and subgraphs from Microsoft Academic Graph. The graph query interface powered by Graph Engine allows us to not only query entities that meet certain criteria (e.g. find a paper with a given title), but also perform pattern matching via graph exploration (e.g. detect co-authorship).
Interpret ( this operations, string query, bool complete, double count = 10, double offset = default(double?), double timeout = default(double?), string model = "latest", string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void

The interpret REST API takes an end user query string (i.e., a query entered by a user of your application) and returns formatted interpretations of user intent based on the Academic Graph data and the Academic Grammar. To provide an interactive experience, you can call this method repeatedly after each character entered by the user. In that case, you should set the complete parameter to 1 to enable auto-complete suggestions. If your application does not want auto-completion, you should set the complete parameter to 0.
InterpretAsync ( this operations, string query, bool complete, double count = 10, double offset = default(double?), double timeout = default(double?), string model = "latest", string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task

The interpret REST API takes an end user query string (i.e., a query entered by a user of your application) and returns formatted interpretations of user intent based on the Academic Graph data and the Academic Grammar. To provide an interactive experience, you can call this method repeatedly after each character entered by the user. In that case, you should set the complete parameter to 1 to enable auto-complete suggestions. If your application does not want auto-completion, you should set the complete parameter to 0.

Описание методов

CalcHistogram() публичный статический Метод

The calchistogram REST API is used to calculate the distribution of attribute values for a set of paper entities.
public static CalcHistogram ( this operations, string expr, string model = "latest", string attributes = default(string), double count = 10, double offset, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void
operations this /// The operations group for this extension method. ///
expr string /// A query expression that specifies the entities over which to calculate /// histograms. ///
model string /// Name of the model that you wish to query. Currently, the value defaults to /// "latest". /// . Possible values include: 'beta-2015', 'latest' ///
attributes string /// A comma delimited list that specifies the attribute values that are /// included in the response. Attribute names are case-sensitive. ///
count double /// Number of results to return. ///
offset double /// Index of the first result to return. ///
subscriptionKey string /// subscription key in url ///
ocpApimSubscriptionKey string /// subscription key in header ///
Результат void

CalcHistogramAsync() публичный статический Метод

The calchistogram REST API is used to calculate the distribution of attribute values for a set of paper entities.
public static CalcHistogramAsync ( this operations, string expr, string model = "latest", string attributes = default(string), double count = 10, double offset, 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. ///
expr string /// A query expression that specifies the entities over which to calculate /// histograms. ///
model string /// Name of the model that you wish to query. Currently, the value defaults to /// "latest". /// . Possible values include: 'beta-2015', 'latest' ///
attributes string /// A comma delimited list that specifies the attribute values that are /// included in the response. Attribute names are case-sensitive. ///
count double /// Number of results to return. ///
offset double /// Index of the first result to return. ///
subscriptionKey string /// subscription key in url ///
ocpApimSubscriptionKey string /// subscription key in header ///
cancellationToken System /// The cancellation token. ///
Результат System.Threading.Tasks.Task

Evaluate() публичный статический Метод

The evaluate REST API is used to return a set of academic entities based on a query expression.
public static Evaluate ( this operations, string expr, string model = "latest", double count = 10, double offset, string orderby = default(string), string attributes = "Id", string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void
operations this /// The operations group for this extension method. ///
expr string /// A query expression that specifies which entities should be returned. ///
model string /// Name of the model that you wish to query. Currently, the value defaults to /// "latest". /// . Possible values include: 'beta-2015', 'latest' ///
count double /// Number of results to return. ///
offset double /// Index of the first result to return. ///
orderby string /// Name of an attribute that is used for sorting the entities. Optionally, /// ascending/descending can be specified. The format is: name:asc or /// name:desc. ///
attributes string /// A comma delimited list that specifies the attribute values that are /// included in the response. Attribute names are case-sensitive. Possible /// values include: 'Id' ///
subscriptionKey string /// subscription key in url ///
ocpApimSubscriptionKey string /// subscription key in header ///
Результат void

EvaluateAsync() публичный статический Метод

The evaluate REST API is used to return a set of academic entities based on a query expression.
public static EvaluateAsync ( this operations, string expr, string model = "latest", double count = 10, double offset, string orderby = default(string), string attributes = "Id", 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. ///
expr string /// A query expression that specifies which entities should be returned. ///
model string /// Name of the model that you wish to query. Currently, the value defaults to /// "latest". /// . Possible values include: 'beta-2015', 'latest' ///
count double /// Number of results to return. ///
offset double /// Index of the first result to return. ///
orderby string /// Name of an attribute that is used for sorting the entities. Optionally, /// ascending/descending can be specified. The format is: name:asc or /// name:desc. ///
attributes string /// A comma delimited list that specifies the attribute values that are /// included in the response. Attribute names are case-sensitive. Possible /// values include: 'Id' ///
subscriptionKey string /// subscription key in url ///
ocpApimSubscriptionKey string /// subscription key in header ///
cancellationToken System /// The cancellation token. ///
Результат System.Threading.Tasks.Task

GraphSearch() публичный статический Метод

Welcome to the Microsoft Cognitive Service Academic Search API, a web service for retrieving paths and subgraphs from Microsoft Academic Graph. The graph query interface powered by Graph Engine allows us to not only query entities that meet certain criteria (e.g. find a paper with a given title), but also perform pattern matching via graph exploration (e.g. detect co-authorship).
public static GraphSearch ( this operations, string mode, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void
operations this /// The operations group for this extension method. ///
mode string /// Request type of query. Should be "json" or "lambda". Possible values /// include: 'json', 'lambda' ///
subscriptionKey string /// subscription key in url ///
ocpApimSubscriptionKey string /// subscription key in header ///
Результат void

GraphSearchAsync() публичный статический Метод

Welcome to the Microsoft Cognitive Service Academic Search API, a web service for retrieving paths and subgraphs from Microsoft Academic Graph. The graph query interface powered by Graph Engine allows us to not only query entities that meet certain criteria (e.g. find a paper with a given title), but also perform pattern matching via graph exploration (e.g. detect co-authorship).
public static GraphSearchAsync ( this operations, string mode, 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. ///
mode string /// Request type of query. Should be "json" or "lambda". Possible values /// include: 'json', 'lambda' ///
subscriptionKey string /// subscription key in url ///
ocpApimSubscriptionKey string /// subscription key in header ///
cancellationToken System /// The cancellation token. ///
Результат System.Threading.Tasks.Task

Interpret() публичный статический Метод

The interpret REST API takes an end user query string (i.e., a query entered by a user of your application) and returns formatted interpretations of user intent based on the Academic Graph data and the Academic Grammar. To provide an interactive experience, you can call this method repeatedly after each character entered by the user. In that case, you should set the complete parameter to 1 to enable auto-complete suggestions. If your application does not want auto-completion, you should set the complete parameter to 0.
public static Interpret ( this operations, string query, bool complete, double count = 10, double offset = default(double?), double timeout = default(double?), string model = "latest", string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void
operations this /// The operations group for this extension method. ///
query string /// Query entered by user. If complete is set to 1, query will be interpreted /// as a prefix for generating query auto-completion suggestions. ///
complete bool /// 1 means that auto-completion suggestions are generated based on the /// grammar and graph data. ///
count double /// Maximum number of interpretations to return. ///
offset double /// Index of the first interpretation to return. For example, /// count=2&offset=0 returns interpretations 0 and 1. /// count=2&offset=2 returns interpretations 2 and 3. ///
timeout double /// Timeout in milliseconds. Only interpretations found before the timeout has /// elapsed are returned. ///
model string /// Name of the model that you wish to query. Currently, the value defaults to /// "latest". /// . Possible values include: 'beta-2015', 'latest' ///
subscriptionKey string /// subscription key in url ///
ocpApimSubscriptionKey string /// subscription key in header ///
Результат void

InterpretAsync() публичный статический Метод

The interpret REST API takes an end user query string (i.e., a query entered by a user of your application) and returns formatted interpretations of user intent based on the Academic Graph data and the Academic Grammar. To provide an interactive experience, you can call this method repeatedly after each character entered by the user. In that case, you should set the complete parameter to 1 to enable auto-complete suggestions. If your application does not want auto-completion, you should set the complete parameter to 0.
public static InterpretAsync ( this operations, string query, bool complete, double count = 10, double offset = default(double?), double timeout = default(double?), string model = "latest", 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. ///
query string /// Query entered by user. If complete is set to 1, query will be interpreted /// as a prefix for generating query auto-completion suggestions. ///
complete bool /// 1 means that auto-completion suggestions are generated based on the /// grammar and graph data. ///
count double /// Maximum number of interpretations to return. ///
offset double /// Index of the first interpretation to return. For example, /// count=2&offset=0 returns interpretations 0 and 1. /// count=2&offset=2 returns interpretations 2 and 3. ///
timeout double /// Timeout in milliseconds. Only interpretations found before the timeout has /// elapsed are returned. ///
model string /// Name of the model that you wish to query. Currently, the value defaults to /// "latest". /// . Possible values include: 'beta-2015', 'latest' ///
subscriptionKey string /// subscription key in url ///
ocpApimSubscriptionKey string /// subscription key in header ///
cancellationToken System /// The cancellation token. ///
Результат System.Threading.Tasks.Task