Skip to content

README.md

Latest commit

 

History

History
177 lines (144 loc) · 10.4 KB

README.md

File metadata and controls

177 lines (144 loc) · 10.4 KB
Raw

R API client for cmsClient

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI spec from a remote server, you can easily generate an API client.

  • API version: 0.1.0
  • Package version: 0.1.0
  • Generator version: 7.19.0
  • Build package: org.openapitools.codegen.languages.RClientCodegen

Installation

Prerequisites

Install the dependencies

install.packages("jsonlite")
install.packages("httr")
install.packages("base64enc")

Build the package

git clone https://github.com/GIT_USER_ID/GIT_REPO_ID
cd GIT_REPO_ID
R CMD build .
R CMD check cmsClient_0.1.0.tar.gz --no-manual
R CMD INSTALL --preclean cmsClient_0.1.0.tar.gz

Install the package

install.packages("cmsClient")

To install directly from Github, use devtools:

install.packages("devtools")
library(devtools)
install_github("GIT_USER_ID/GIT_REPO_ID")

To install the package from a local file:

install.packages("cmsClient_0.1.0.tar.gz", repos = NULL, type = "source")

Usage

library(cmsClient)

Reformat code

To reformat code using styler, please run the following in the R console:

install.packages("remotes")
remotes::install_github("r-lib/styler@v1.7.0.9003")
library("styler")
style_dir()

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AnnotationsApi ExtractEntitiesFromMultiTextFile POST /process_bulk_file Extract Entities From Multi Text File
AnnotationsApi GetEntitiesFromJsonlinesText POST /process_jsonl Get Entities From Jsonlines Text
AnnotationsApi GetEntitiesFromMultipleTexts POST /process_bulk Get Entities From Multiple Texts
AnnotationsApi GetEntitiesFromText POST /process Get Entities From Text
AnnotationsApi GetEntitiesStreamFromJsonlinesStream POST /stream/process Get Entities Stream From Jsonlines Stream
AnnotationsApi GetEntitiesStreamFromSse GET /stream/sse/events Get Entities Stream From Sse
AnnotationsApi GetInlineEntitiesFromWebsocketInfo GET /stream/ws Get Inline Entities From Websocket Info
AnnotationsApi SendTextJsonlinesForProcessing POST /stream/sse/process Send Text Jsonlines For Processing
AuthenticationApi AuthCookieLogin POST /auth/cookie/login Auth:Cookie.Login
AuthenticationApi AuthCookieLogout POST /auth/cookie/logout Auth:Cookie.Logout
AuthenticationApi AuthJwtLogin POST /auth/jwt/login Auth:Jwt.Login
AuthenticationApi AuthJwtLogout POST /auth/jwt/logout Auth:Jwt.Logout
EmbeddingsApi GetTextEmbeddings POST /embeddings Get Text Embeddings
EvaluatingApi GetAnnotationStats POST /annotation-stats Get Annotation Stats
EvaluatingApi GetConcatenatedTrainerExports POST /concat_trainer_exports Get Concatenated Trainer Exports
EvaluatingApi GetInterAnnotatorAgreementScores POST /iaa-scores Get Inter Annotator Agreement Scores
EvaluatingApi GetSanityCheckWithTrainerExport POST /sanity-check Get Sanity Check With Trainer Export
GenerateTextBasedOnTheInputPromptApi GenerateText POST /generate Generate Text
GenerateTextBasedOnTheInputPromptApi GenerateTextStream POST /stream/generate Generate Text Stream
MetadataApi GetModelCard GET /info Get Model Card
OperationsCompatibleWithOllamaAPIsApi OllamaChat POST /ollama/api/chat Ollama Chat
OperationsCompatibleWithOllamaAPIsApi OllamaEmbed POST /ollama/api/embed Ollama Embed
OperationsCompatibleWithOllamaAPIsApi OllamaGenerate POST /ollama/api/generate Ollama Generate
OperationsCompatibleWithOllamaAPIsApi OllamaHealthGet GET /ollama/ Ollama Health Get
OperationsCompatibleWithOllamaAPIsApi OllamaHealthHead HEAD /ollama/ Ollama Health Head
OperationsCompatibleWithOllamaAPIsApi OllamaListTags GET /ollama/api/tags Ollama List Tags
OperationsCompatibleWithOllamaAPIsApi OllamaShowModel POST /ollama/api/show Ollama Show Model
OperationsCompatibleWithOllamaAPIsApi OllamaVersion GET /ollama/api/version Ollama Version
OperationsCompatibleWithOpenAIAPIsApi EmbedTexts POST /openai/v1/embeddings Embed Texts
OperationsCompatibleWithOpenAIAPIsApi GenerateChatCompletions POST /openai/v1/chat/completions Generate Chat Completions
OperationsCompatibleWithOpenAIAPIsApi GenerateTextCompletions POST /openai/v1/completions Generate Text Completions
OperationsCompatibleWithOpenAIAPIsApi GetModel GET /openai/v1/models/{model_name} Get Model
OperationsCompatibleWithOpenAIAPIsApi ListModels GET /openai/v1/models List Models
RedactionApi GetRedactedText POST /redact Get Redacted Text
RedactionApi GetRedactedTextWithEncryption POST /redact_with_encryption Get Redacted Text With Encryption
RenderingApi GetRenderedEntitiesFromText POST /preview Get Rendered Entities From Text
RenderingApi GetRenderedEntitiesFromTrainerExport POST /preview_trainer_export Get Rendered Entities From Trainer Export
TrainingApi CancelTraining POST /cancel_training Cancel Training
TrainingApi GetEvaluationWithTrainerExport POST /evaluate Get Evaluation With Trainer Export
TrainingApi TrainEvalInfo GET /train_eval_info Train Eval Info
TrainingApi TrainEvalMetrics GET /train_eval_metrics Train Eval Metrics
TrainingApi TrainMetacat POST /train_metacat Train Metacat
TrainingApi TrainSupervised POST /train_supervised Train Supervised
TrainingApi TrainUnsupervised POST /train_unsupervised Train Unsupervised
TrainingApi TrainUnsupervisedWithHfDataset POST /train_unsupervised_with_hf_hub_dataset Train Unsupervised With Hf Dataset

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

OAuth2PasswordBearer

  • Type: OAuth
  • Flow: password
  • Token URL: auth/jwt/login
  • Scopes: N/A

APIKeyCookie

  • Type: API key
  • API key parameter name: fastapiusersauth
  • Location: