C# Class Systran.ResourcesClientLib.Api.CorpusApi

Represents a collection of functions to interact with the API endpoints
Inheritance: ICorpusApi
Datei anzeigen Open project: SYSTRAN/resources-api-csharp-client Class Usage Examples

Public Methods

Method Description
CorpusApi ( ApiClient apiClient = null ) : System

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

Initializes a new instance of the CorpusApi class.
GetBasePath ( String basePath ) : String

Gets the base path of the API client.
ResourcesCorpusAddPost ( string Name, string Lang, List Tag, string Callback ) : CorpusAddResponse

Add a new corpus Add a new empty corpus.\n
ResourcesCorpusAddPostAsync ( string Name, string Lang, List Tag, string Callback ) : Task

Add a new corpus Add a new empty corpus.\n
ResourcesCorpusDeletePost ( List CorpusId, string Callback ) : CorpusDeleteResponse

Delete corpus Delete a corpus.\n
ResourcesCorpusDeletePostAsync ( List CorpusId, string Callback ) : Task

Delete corpus Delete a corpus.\n
ResourcesCorpusDetailsGet ( string CorpusId, string Callback ) : CorpusDetailResponse

Detail corpus Get detailed information about a corpus.\n
ResourcesCorpusDetailsGetAsync ( string CorpusId, string Callback ) : Task

Detail corpus Get detailed information about a corpus.\n
ResourcesCorpusExistsGet ( string Name, string Callback ) : CorpusExistsResponse

Corpus Exists Check if a corpus exists\n
ResourcesCorpusExistsGetAsync ( string Name, string Callback ) : Task

Corpus Exists Check if a corpus exists\n
ResourcesCorpusExportGet ( string CorpusId, string Format, string Callback ) : string

Export corpus Download a corpus in an expected format.\n
ResourcesCorpusExportGetAsync ( string CorpusId, string Format, string Callback ) : Task

Export corpus Download a corpus in an expected format.\n
ResourcesCorpusImportPost ( string Name, string Input, string InputFile, string Format, List Tag, string Callback ) : CorpusImportResponse

Import corpus Add a new corpus from an existing corpus.\n
ResourcesCorpusImportPostAsync ( string Name, string Input, string InputFile, string Format, List Tag, string Callback ) : Task

Import corpus Add a new corpus from an existing corpus.\n
ResourcesCorpusListGet ( string SourceLang, string TargetLang, bool WithoutPending, bool WithoutError, string Prefix, string Directory, string Callback ) : CorpusListResponse

List corpora List available corpora. Parameters can be used to restrict the list of returned corpora.\n
ResourcesCorpusListGetAsync ( string SourceLang, string TargetLang, bool WithoutPending, bool WithoutError, string Prefix, string Directory, string Callback ) : Task

List corpora List available corpora. Parameters can be used to restrict the list of returned corpora.\n
ResourcesCorpusMatchGet ( List CorpusId, List Input, string SourceLang, string TargetLang, double Threshold, int Limit, string Callback ) : CorpusMatchResponse

Corpus Match Find sentences in the corpus that match the input text from a given threshold.\n
ResourcesCorpusMatchGetAsync ( List CorpusId, List Input, string SourceLang, string TargetLang, double Threshold, int Limit, string Callback ) : Task

Corpus Match Find sentences in the corpus that match the input text from a given threshold.\n
ResourcesCorpusSegmentAddPost ( CorpusSegmentAddRequest Body, string Callback ) : CorpusSegmentAddResponse

Add corpus segments Add segments in a corpus.\n
ResourcesCorpusSegmentAddPostAsync ( CorpusSegmentAddRequest Body, string Callback ) : Task

Add corpus segments Add segments in a corpus.\n
ResourcesCorpusSegmentDeletePost ( string CorpusId, List SegId, string Callback ) : CorpusSegmentDeleteResponse

Delete corpus segments Delete segments in a corpus.\n
ResourcesCorpusSegmentDeletePostAsync ( string CorpusId, List SegId, string Callback ) : Task

Delete corpus segments Delete segments in a corpus.\n
ResourcesCorpusSegmentListGet ( string CorpusId, int Skip, int Limit, string Callback ) : CorpusSegmentListResponse

List corpus segments List segments in a corpus.\n
ResourcesCorpusSegmentListGetAsync ( string CorpusId, int Skip, int Limit, string Callback ) : Task

List corpus segments List segments in a corpus.\n
ResourcesCorpusSegmentTargetAddPost ( CorpusSegmentAddTargetRequest Body, string Callback ) : CorpusSegmentAddTargetResponse

Add corpus segment targets Add targets to a segment in a corpus.\n
ResourcesCorpusSegmentTargetAddPostAsync ( CorpusSegmentAddTargetRequest Body, string Callback ) : Task

Add corpus segment targets Add targets to a segment in a corpus.\n
ResourcesCorpusSegmentTargetDeletePost ( string CorpusId, string SegId, List TargetId, string Callback ) : CorpusSegmentDeleteTargetResponse

Delete corpus segment targets Delete segment targets in a corpus.\n
ResourcesCorpusSegmentTargetDeletePostAsync ( string CorpusId, string SegId, List TargetId, string Callback ) : Task

Delete corpus segment targets Delete segment targets in a corpus.\n
ResourcesCorpusSegmentUpdatePost ( string CorpusId, string SegId, string Source, string TargetId, string Target, string TargetLang, string Callback ) : CorpusSegmentUpdateResponse

Update corpus segment Update a segment in a corpus.\n
ResourcesCorpusSegmentUpdatePostAsync ( string CorpusId, string SegId, string Source, string TargetId, string Target, string TargetLang, string Callback ) : Task

Update corpus segment Update a segment in a corpus.\n
ResourcesCorpusUpdatePost ( string CorpusId, string Name, List Tag, string Callback ) : CorpusUpdateResponse

Update corpus properties Update properties of a corpus.\n
ResourcesCorpusUpdatePostAsync ( string CorpusId, string Name, List Tag, string Callback ) : Task

Update corpus properties Update properties of a corpus.\n
SetBasePath ( String basePath ) : void

Sets the base path of the API client.

Method Details

CorpusApi() public method

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

CorpusApi() public method

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

GetBasePath() public method

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

ResourcesCorpusAddPost() public method

Add a new corpus Add a new empty corpus.\n
public ResourcesCorpusAddPost ( string Name, string Lang, List Tag, string Callback ) : CorpusAddResponse
Name string Corpus name. The name also contains the directories (ex: \"/myproject/firstPass/PersonalCorpus\")
Lang string Language code ([details](#description_langage_code_values))
Tag List Tag for the the corpus (this parameter can be repeated)
Callback string Javascript callback function name for JSONP Support\n
return Systran.ResourcesClientLib.Model.CorpusAddResponse

ResourcesCorpusAddPostAsync() public method

Add a new corpus Add a new empty corpus.\n
public ResourcesCorpusAddPostAsync ( string Name, string Lang, List Tag, string Callback ) : Task
Name string Corpus name. The name also contains the directories (ex: \"/myproject/firstPass/PersonalCorpus\")
Lang string Language code ([details](#description_langage_code_values))
Tag List Tag for the the corpus (this parameter can be repeated)
Callback string Javascript callback function name for JSONP Support\n
return Task

ResourcesCorpusDeletePost() public method

Delete corpus Delete a corpus.\n
public ResourcesCorpusDeletePost ( List CorpusId, string Callback ) : CorpusDeleteResponse
CorpusId List Corpus identifier (this parameter can be repeated)
Callback string Javascript callback function name for JSONP Support\n
return CorpusDeleteResponse

ResourcesCorpusDeletePostAsync() public method

Delete corpus Delete a corpus.\n
public ResourcesCorpusDeletePostAsync ( List CorpusId, string Callback ) : Task
CorpusId List Corpus identifier (this parameter can be repeated)
Callback string Javascript callback function name for JSONP Support\n
return Task

ResourcesCorpusDetailsGet() public method

Detail corpus Get detailed information about a corpus.\n
public ResourcesCorpusDetailsGet ( string CorpusId, string Callback ) : CorpusDetailResponse
CorpusId string Corpus identifier
Callback string Javascript callback function name for JSONP Support\n
return Systran.ResourcesClientLib.Model.CorpusDetailResponse

ResourcesCorpusDetailsGetAsync() public method

Detail corpus Get detailed information about a corpus.\n
public ResourcesCorpusDetailsGetAsync ( string CorpusId, string Callback ) : Task
CorpusId string Corpus identifier
Callback string Javascript callback function name for JSONP Support\n
return Task

ResourcesCorpusExistsGet() public method

Corpus Exists Check if a corpus exists\n
public ResourcesCorpusExistsGet ( string Name, string Callback ) : CorpusExistsResponse
Name string Corpus name. The name also contains the directories (ex: \"/myproject/firstPass/PersonalCorpus\")
Callback string Javascript callback function name for JSONP Support\n
return Systran.ResourcesClientLib.Model.CorpusExistsResponse

ResourcesCorpusExistsGetAsync() public method

Corpus Exists Check if a corpus exists\n
public ResourcesCorpusExistsGetAsync ( string Name, string Callback ) : Task
Name string Corpus name. The name also contains the directories (ex: \"/myproject/firstPass/PersonalCorpus\")
Callback string Javascript callback function name for JSONP Support\n
return Task

ResourcesCorpusExportGet() public method

Export corpus Download a corpus in an expected format.\n
public ResourcesCorpusExportGet ( string CorpusId, string Format, string Callback ) : string
CorpusId string Corpus identifier
Format string The expected corpus format\n
Callback string Javascript callback function name for JSONP Support\n
return string

ResourcesCorpusExportGetAsync() public method

Export corpus Download a corpus in an expected format.\n
public ResourcesCorpusExportGetAsync ( string CorpusId, string Format, string Callback ) : Task
CorpusId string Corpus identifier
Format string The expected corpus format\n
Callback string Javascript callback function name for JSONP Support\n
return Task

ResourcesCorpusImportPost() public method

Import corpus Add a new corpus from an existing corpus.\n
public ResourcesCorpusImportPost ( string Name, string Input, string InputFile, string Format, List Tag, string Callback ) : CorpusImportResponse
Name string Corpus name. The name also contains the directories (ex: \"/myproject/firstPass/PersonalCorpus\")
Input string Content of the existing corpus\n\n**Either `input` or `inputFile` is required**\n
InputFile string Content of the existing corpus\n\n**Either `input` or `inputFile` is required**\n
Format string Format of the input corpus.\n
Tag List Tag for the the corpus (this parameter can be repeated)
Callback string Javascript callback function name for JSONP Support\n
return CorpusImportResponse

ResourcesCorpusImportPostAsync() public method

Import corpus Add a new corpus from an existing corpus.\n
public ResourcesCorpusImportPostAsync ( string Name, string Input, string InputFile, string Format, List Tag, string Callback ) : Task
Name string Corpus name. The name also contains the directories (ex: \"/myproject/firstPass/PersonalCorpus\")
Input string Content of the existing corpus\n\n**Either `input` or `inputFile` is required**\n
InputFile string Content of the existing corpus\n\n**Either `input` or `inputFile` is required**\n
Format string Format of the input corpus.\n
Tag List Tag for the the corpus (this parameter can be repeated)
Callback string Javascript callback function name for JSONP Support\n
return Task

ResourcesCorpusListGet() public method

List corpora List available corpora. Parameters can be used to restrict the list of returned corpora.\n
public ResourcesCorpusListGet ( string SourceLang, string TargetLang, bool WithoutPending, bool WithoutError, string Prefix, string Directory, string Callback ) : CorpusListResponse
SourceLang string Source language code ([details](#description_langage_code_values))
TargetLang string Target language code ([details](#description_langage_code_values))
WithoutPending bool Filter out corpora in \"pending\" status\n
WithoutError bool Filter out corpora in \"error\" status\n
Prefix string Prefix of the corpus name\n
Directory string If specified, response will return the content of this directory, including corpora and directories. This list can can also be filtered by the prefix parameter.\n
Callback string Javascript callback function name for JSONP Support\n
return Systran.ResourcesClientLib.Model.CorpusListResponse

ResourcesCorpusListGetAsync() public method

List corpora List available corpora. Parameters can be used to restrict the list of returned corpora.\n
public ResourcesCorpusListGetAsync ( string SourceLang, string TargetLang, bool WithoutPending, bool WithoutError, string Prefix, string Directory, string Callback ) : Task
SourceLang string Source language code ([details](#description_langage_code_values))
TargetLang string Target language code ([details](#description_langage_code_values))
WithoutPending bool Filter out corpora in \"pending\" status\n
WithoutError bool Filter out corpora in \"error\" status\n
Prefix string Prefix of the corpus name\n
Directory string If specified, response will return the content of this directory, including corpora and directories. This list can can also be filtered by the prefix parameter.\n
Callback string Javascript callback function name for JSONP Support\n
return Task

ResourcesCorpusMatchGet() public method

Corpus Match Find sentences in the corpus that match the input text from a given threshold.\n
public ResourcesCorpusMatchGet ( List CorpusId, List Input, string SourceLang, string TargetLang, double Threshold, int Limit, string Callback ) : CorpusMatchResponse
CorpusId List Corpus identifier (this parameter can be repeated)
Input List Text is used to perform the match operation (this parameter can be repeated)\n
SourceLang string Source language code ([details](#description_langage_code_values))
TargetLang string Target language code ([details](#description_langage_code_values))
Threshold double The fuzzy match threshold from which a sentence will be considered as a match result\n
Limit int Limit the number of returned matches. Only first matches within the \"limit\" will be returned\n
Callback string Javascript callback function name for JSONP Support\n
return Systran.ResourcesClientLib.Model.CorpusMatchResponse

ResourcesCorpusMatchGetAsync() public method

Corpus Match Find sentences in the corpus that match the input text from a given threshold.\n
public ResourcesCorpusMatchGetAsync ( List CorpusId, List Input, string SourceLang, string TargetLang, double Threshold, int Limit, string Callback ) : Task
CorpusId List Corpus identifier (this parameter can be repeated)
Input List Text is used to perform the match operation (this parameter can be repeated)\n
SourceLang string Source language code ([details](#description_langage_code_values))
TargetLang string Target language code ([details](#description_langage_code_values))
Threshold double The fuzzy match threshold from which a sentence will be considered as a match result\n
Limit int Limit the number of returned matches. Only first matches within the \"limit\" will be returned\n
Callback string Javascript callback function name for JSONP Support\n
return Task

ResourcesCorpusSegmentAddPost() public method

Add corpus segments Add segments in a corpus.\n
public ResourcesCorpusSegmentAddPost ( CorpusSegmentAddRequest Body, string Callback ) : CorpusSegmentAddResponse
Body Systran.ResourcesClientLib.Model.CorpusSegmentAddRequest List of segments to add
Callback string Javascript callback function name for JSONP Support\n
return Systran.ResourcesClientLib.Model.CorpusSegmentAddResponse

ResourcesCorpusSegmentAddPostAsync() public method

Add corpus segments Add segments in a corpus.\n
public ResourcesCorpusSegmentAddPostAsync ( CorpusSegmentAddRequest Body, string Callback ) : Task
Body Systran.ResourcesClientLib.Model.CorpusSegmentAddRequest List of segments to add
Callback string Javascript callback function name for JSONP Support\n
return Task

ResourcesCorpusSegmentDeletePost() public method

Delete corpus segments Delete segments in a corpus.\n
public ResourcesCorpusSegmentDeletePost ( string CorpusId, List SegId, string Callback ) : CorpusSegmentDeleteResponse
CorpusId string Corpus identifier
SegId List Segment Id (this parameter can be repeated)
Callback string Javascript callback function name for JSONP Support\n
return Systran.ResourcesClientLib.Model.CorpusSegmentDeleteResponse

ResourcesCorpusSegmentDeletePostAsync() public method

Delete corpus segments Delete segments in a corpus.\n
public ResourcesCorpusSegmentDeletePostAsync ( string CorpusId, List SegId, string Callback ) : Task
CorpusId string Corpus identifier
SegId List Segment Id (this parameter can be repeated)
Callback string Javascript callback function name for JSONP Support\n
return Task

ResourcesCorpusSegmentListGet() public method

List corpus segments List segments in a corpus.\n
public ResourcesCorpusSegmentListGet ( string CorpusId, int Skip, int Limit, string Callback ) : CorpusSegmentListResponse
CorpusId string Corpus identifier
Skip int Skip first found segments in the response\n
Limit int Limit the number of returned segments\n
Callback string Javascript callback function name for JSONP Support\n
return Systran.ResourcesClientLib.Model.CorpusSegmentListResponse

ResourcesCorpusSegmentListGetAsync() public method

List corpus segments List segments in a corpus.\n
public ResourcesCorpusSegmentListGetAsync ( string CorpusId, int Skip, int Limit, string Callback ) : Task
CorpusId string Corpus identifier
Skip int Skip first found segments in the response\n
Limit int Limit the number of returned segments\n
Callback string Javascript callback function name for JSONP Support\n
return Task

ResourcesCorpusSegmentTargetAddPost() public method

Add corpus segment targets Add targets to a segment in a corpus.\n
public ResourcesCorpusSegmentTargetAddPost ( CorpusSegmentAddTargetRequest Body, string Callback ) : CorpusSegmentAddTargetResponse
Body Systran.ResourcesClientLib.Model.CorpusSegmentAddTargetRequest List of targets to add
Callback string Javascript callback function name for JSONP Support\n
return Systran.ResourcesClientLib.Model.CorpusSegmentAddTargetResponse

ResourcesCorpusSegmentTargetAddPostAsync() public method

Add corpus segment targets Add targets to a segment in a corpus.\n
public ResourcesCorpusSegmentTargetAddPostAsync ( CorpusSegmentAddTargetRequest Body, string Callback ) : Task
Body Systran.ResourcesClientLib.Model.CorpusSegmentAddTargetRequest List of targets to add
Callback string Javascript callback function name for JSONP Support\n
return Task

ResourcesCorpusSegmentTargetDeletePost() public method

Delete corpus segment targets Delete segment targets in a corpus.\n
public ResourcesCorpusSegmentTargetDeletePost ( string CorpusId, string SegId, List TargetId, string Callback ) : CorpusSegmentDeleteTargetResponse
CorpusId string Corpus identifier
SegId string Segment Id
TargetId List Target id (this parameter can be repeated)
Callback string Javascript callback function name for JSONP Support\n
return Systran.ResourcesClientLib.Model.CorpusSegmentDeleteTargetResponse

ResourcesCorpusSegmentTargetDeletePostAsync() public method

Delete corpus segment targets Delete segment targets in a corpus.\n
public ResourcesCorpusSegmentTargetDeletePostAsync ( string CorpusId, string SegId, List TargetId, string Callback ) : Task
CorpusId string Corpus identifier
SegId string Segment Id
TargetId List Target id (this parameter can be repeated)
Callback string Javascript callback function name for JSONP Support\n
return Task

ResourcesCorpusSegmentUpdatePost() public method

Update corpus segment Update a segment in a corpus.\n
public ResourcesCorpusSegmentUpdatePost ( string CorpusId, string SegId, string Source, string TargetId, string Target, string TargetLang, string Callback ) : CorpusSegmentUpdateResponse
CorpusId string Corpus identifier
SegId string Segment Id
Source string Source text
TargetId string Target id
Target string Target text. `targetId` is required if `target` is specified.
TargetLang string Target language. `targetId` is required if `targetLang` is specified.
Callback string Javascript callback function name for JSONP Support\n
return Systran.ResourcesClientLib.Model.CorpusSegmentUpdateResponse

ResourcesCorpusSegmentUpdatePostAsync() public method

Update corpus segment Update a segment in a corpus.\n
public ResourcesCorpusSegmentUpdatePostAsync ( string CorpusId, string SegId, string Source, string TargetId, string Target, string TargetLang, string Callback ) : Task
CorpusId string Corpus identifier
SegId string Segment Id
Source string Source text
TargetId string Target id
Target string Target text. `targetId` is required if `target` is specified.
TargetLang string Target language. `targetId` is required if `targetLang` is specified.
Callback string Javascript callback function name for JSONP Support\n
return Task

ResourcesCorpusUpdatePost() public method

Update corpus properties Update properties of a corpus.\n
public ResourcesCorpusUpdatePost ( string CorpusId, string Name, List Tag, string Callback ) : CorpusUpdateResponse
CorpusId string Corpus identifier
Name string Corpus name. The name also contains the directories (ex: \"/myproject/firstPass/PersonalCorpus\")
Tag List Tag for the the corpus (this parameter can be repeated)
Callback string Javascript callback function name for JSONP Support\n
return Systran.ResourcesClientLib.Model.CorpusUpdateResponse

ResourcesCorpusUpdatePostAsync() public method

Update corpus properties Update properties of a corpus.\n
public ResourcesCorpusUpdatePostAsync ( string CorpusId, string Name, List Tag, string Callback ) : Task
CorpusId string Corpus identifier
Name string Corpus name. The name also contains the directories (ex: \"/myproject/firstPass/PersonalCorpus\")
Tag List Tag for the the corpus (this parameter can be repeated)
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