C# Class Systran.MultimodalClientLib.Api.FileApi

Represents a collection of functions to interact with the API endpoints
Inheritance: IFileApi
Exibir arquivo Open project: SYSTRAN/multimodal-api-csharp-client Class Usage Examples

Public Methods

Method Description
FileApi ( ApiClient apiClient = null ) : System

Initializes a new instance of the FileApi class.

FileApi ( String basePath ) : System

Initializes a new instance of the FileApi class.

GetBasePath ( String basePath ) : String

Gets the base path of the API client.

MultimodalFileExtractTextGet ( string InputFile, string Lang, string Format, int Profile, string Callback ) : FileExtractTextResponse

Extract text from a file Extract text from a file.\n

MultimodalFileExtractTextGetAsync ( string InputFile, string Lang, string Format, int Profile, string Callback ) : Task

Extract text from a file Extract text from a file.\n

MultimodalFileSupportedFormatsGet ( int Profile, string Callback ) : FileSupportedFormatsResponse

Supported file formats Get a list of supported file formats.\n

MultimodalFileSupportedFormatsGetAsync ( int Profile, string Callback ) : Task

Supported file formats Get a list of supported file formats.\n

SetBasePath ( String basePath ) : void

Sets the base path of the API client.

Method Details

FileApi() public method

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

FileApi() public method

Initializes a new instance of the FileApi class.
public FileApi ( 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

MultimodalFileExtractTextGet() public method

Extract text from a file Extract text from a file.\n
public MultimodalFileExtractTextGet ( string InputFile, string Lang, string Format, int Profile, string Callback ) : FileExtractTextResponse
InputFile string Input File
Lang string Language code of the input ([details](#description_langage_code_values)) or `auto` for automatic detection
Format string Format of the input file.\n\nValid values are the mimetypes returned by the supportedFormats service.\n
Profile int Profile id\n
Callback string Javascript callback function name for JSONP Support\n
return Systran.MultimodalClientLib.Model.FileExtractTextResponse

MultimodalFileExtractTextGetAsync() public method

Extract text from a file Extract text from a file.\n
public MultimodalFileExtractTextGetAsync ( string InputFile, string Lang, string Format, int Profile, string Callback ) : Task
InputFile string Input File
Lang string Language code of the input ([details](#description_langage_code_values)) or `auto` for automatic detection
Format string Format of the input file.\n\nValid values are the mimetypes returned by the supportedFormats service.\n
Profile int Profile id\n
Callback string Javascript callback function name for JSONP Support\n
return Task

MultimodalFileSupportedFormatsGet() public method

Supported file formats Get a list of supported file formats.\n
public MultimodalFileSupportedFormatsGet ( int Profile, string Callback ) : FileSupportedFormatsResponse
Profile int Profile id\n
Callback string Javascript callback function name for JSONP Support\n
return Systran.MultimodalClientLib.Model.FileSupportedFormatsResponse

MultimodalFileSupportedFormatsGetAsync() public method

Supported file formats Get a list of supported file formats.\n
public MultimodalFileSupportedFormatsGetAsync ( int Profile, string Callback ) : Task
Profile int Profile id\n
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