C# Class Systran.NlpClientLib.Api.NerApi

Represents a collection of functions to interact with the API endpoints
Inheritance: INerApi
显示文件 Open project: SYSTRAN/nlp-api-csharp-client Class Usage Examples

Public Methods

Method Description
GetBasePath ( String basePath ) : String

Gets the base path of the API client.
NerApi ( ApiClient apiClient = null ) : System

Initializes a new instance of the NerApi class.
NerApi ( String basePath ) : System

Initializes a new instance of the NerApi class.
NlpNerExtractAnnotationsGet ( string InputFile, string Input, string Lang, int Profile, string Callback ) : NerExtractAnnotationsResponse

Get entity annotations\n Get the list of entity annotations given an input text.\nAn entity annotation is an entity associated with its position in the text.\n
NlpNerExtractAnnotationsGetAsync ( string InputFile, string Input, string Lang, int Profile, string Callback ) : Task

Get entity annotations\n Get the list of entity annotations given an input text.\nAn entity annotation is an entity associated with its position in the text.\n
NlpNerExtractEntitiesGet ( string InputFile, string Input, string Lang, int Profile, string Callback ) : NerExtractEntitiesResponse

Get list of entities\n Get the list of different entities given an input text.\n
NlpNerExtractEntitiesGetAsync ( string InputFile, string Input, string Lang, int Profile, string Callback ) : Task

Get list of entities\n Get the list of different entities given an input text.\n
NlpNerSupportedLanguagesGet ( string Callback ) : SupportedLanguagesResponse

Supported Languages List of languages in which NER is supported.
NlpNerSupportedLanguagesGetAsync ( string Callback ) : Task

Supported Languages List of languages in which NER is supported.
SetBasePath ( String basePath ) : void

Sets the base path of the API client.

Method Details

GetBasePath() public method

Gets the base path of the API client.
public GetBasePath ( String basePath ) : String
basePath String
return String

NerApi() public method

Initializes a new instance of the NerApi class.
public NerApi ( ApiClient apiClient = null ) : System
apiClient Systran.NlpClientLib.Client.ApiClient
return System

NerApi() public method

Initializes a new instance of the NerApi class.
public NerApi ( String basePath ) : System
basePath String
return System

NlpNerExtractAnnotationsGet() public method

Get entity annotations\n Get the list of entity annotations given an input text.\nAn entity annotation is an entity associated with its position in the text.\n
public NlpNerExtractAnnotationsGet ( string InputFile, string Input, string Lang, int Profile, string Callback ) : NerExtractAnnotationsResponse
InputFile string input text\n\n**Either `input` or `inputFile` is required**\n
Input string input text\n\n**Either `input` or `inputFile` is required**\n
Lang string Language code of the input ([details](#description_langage_code_values))
Profile int Profile id\n
Callback string Javascript callback function name for JSONP Support\n
return Systran.NlpClientLib.Model.NerExtractAnnotationsResponse

NlpNerExtractAnnotationsGetAsync() public method

Get entity annotations\n Get the list of entity annotations given an input text.\nAn entity annotation is an entity associated with its position in the text.\n
public NlpNerExtractAnnotationsGetAsync ( string InputFile, string Input, string Lang, int Profile, string Callback ) : Task
InputFile string input text\n\n**Either `input` or `inputFile` is required**\n
Input string input text\n\n**Either `input` or `inputFile` is required**\n
Lang string Language code of the input ([details](#description_langage_code_values))
Profile int Profile id\n
Callback string Javascript callback function name for JSONP Support\n
return Task

NlpNerExtractEntitiesGet() public method

Get list of entities\n Get the list of different entities given an input text.\n
public NlpNerExtractEntitiesGet ( string InputFile, string Input, string Lang, int Profile, string Callback ) : NerExtractEntitiesResponse
InputFile string input text\n\n**Either `input` or `inputFile` is required**\n
Input string input text\n\n**Either `input` or `inputFile` is required**\n
Lang string Language code of the input ([details](#description_langage_code_values))
Profile int Profile id\n
Callback string Javascript callback function name for JSONP Support\n
return Systran.NlpClientLib.Model.NerExtractEntitiesResponse

NlpNerExtractEntitiesGetAsync() public method

Get list of entities\n Get the list of different entities given an input text.\n
public NlpNerExtractEntitiesGetAsync ( string InputFile, string Input, string Lang, int Profile, string Callback ) : Task
InputFile string input text\n\n**Either `input` or `inputFile` is required**\n
Input string input text\n\n**Either `input` or `inputFile` is required**\n
Lang string Language code of the input ([details](#description_langage_code_values))
Profile int Profile id\n
Callback string Javascript callback function name for JSONP Support\n
return Task

NlpNerSupportedLanguagesGet() public method

Supported Languages List of languages in which NER is supported.
public NlpNerSupportedLanguagesGet ( string Callback ) : SupportedLanguagesResponse
Callback string Javascript callback function name for JSONP Support\n
return Systran.NlpClientLib.Model.SupportedLanguagesResponse

NlpNerSupportedLanguagesGetAsync() public method

Supported Languages List of languages in which NER is supported.
public NlpNerSupportedLanguagesGetAsync ( string Callback ) : Task
Callback string Javascript callback function name for JSONP Support\n
return Task

SetBasePath() public method

Sets the base path of the API client.
public SetBasePath ( String basePath ) : void
basePath String
return void