1 unstable release
new 0.0.1 | Apr 9, 2025 |
---|
#8 in #observation
198 downloads per month
375KB
9K
SLoC
Rust API client for langfuse_openapi
Authentication
Authenticate with the API using Basic Auth, get API keys in the project settings:
- username: Langfuse Public Key
- password: Langfuse Secret Key
Exports
- OpenAPI spec: https://cloud.langfuse.com/generated/api/openapi.yml
- Postman collection: https://cloud.langfuse.com/generated/postman/collection.json
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:
- Package version: 0.0.1
- Generator version: 7.11.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named langfuse_openapi
and add the following to Cargo.toml
under [dependencies]
:
langfuse_openapi = { path = "./langfuse_openapi" }
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
CommentsApi | comments_create | POST /api/public/comments | |
CommentsApi | comments_get | GET /api/public/comments | |
CommentsApi | comments_get_by_id | GET /api/public/comments/{commentId} | |
DatasetItemsApi | dataset_items_create | POST /api/public/dataset-items | |
DatasetItemsApi | dataset_items_get | GET /api/public/dataset-items/{id} | |
DatasetItemsApi | dataset_items_list | GET /api/public/dataset-items | |
DatasetRunItemsApi | dataset_run_items_create | POST /api/public/dataset-run-items | |
DatasetsApi | datasets_create | POST /api/public/v2/datasets | |
DatasetsApi | datasets_get | GET /api/public/v2/datasets/{datasetName} | |
DatasetsApi | datasets_get_run | GET /api/public/datasets/{datasetName}/runs/{runName} | |
DatasetsApi | datasets_get_runs | GET /api/public/datasets/{datasetName}/runs | |
DatasetsApi | datasets_list | GET /api/public/v2/datasets | |
HealthApi | health_health | GET /api/public/health | |
IngestionApi | ingestion_batch | POST /api/public/ingestion | |
MediaApi | media_get | GET /api/public/media/{mediaId} | |
MediaApi | media_get_upload_url | POST /api/public/media | |
MediaApi | media_patch | PATCH /api/public/media/{mediaId} | |
MetricsApi | metrics_daily | GET /api/public/metrics/daily | |
ModelsApi | models_create | POST /api/public/models | |
ModelsApi | models_delete | DELETE /api/public/models/{id} | |
ModelsApi | models_get | GET /api/public/models/{id} | |
ModelsApi | models_list | GET /api/public/models | |
ObservationsApi | observations_get | GET /api/public/observations/{observationId} | |
ObservationsApi | observations_get_many | GET /api/public/observations | |
ProjectsApi | projects_get | GET /api/public/projects | |
PromptVersionApi | prompt_version_update | PATCH /api/public/v2/prompts/{promptName}/version/{version} | |
PromptsApi | prompts_create | POST /api/public/v2/prompts | |
PromptsApi | prompts_get | GET /api/public/v2/prompts/{promptName} | |
PromptsApi | prompts_list | GET /api/public/v2/prompts | |
ScoreApi | score_create | POST /api/public/scores | |
ScoreApi | score_delete | DELETE /api/public/scores/{scoreId} | |
ScoreApi | score_get | GET /api/public/scores | |
ScoreApi | score_get_by_id | GET /api/public/scores/{scoreId} | |
ScoreConfigsApi | score_configs_create | POST /api/public/score-configs | |
ScoreConfigsApi | score_configs_get | GET /api/public/score-configs | |
ScoreConfigsApi | score_configs_get_by_id | GET /api/public/score-configs/{configId} | |
SessionsApi | sessions_get | GET /api/public/sessions/{sessionId} | |
SessionsApi | sessions_list | GET /api/public/sessions | |
TraceApi | trace_get | GET /api/public/traces/{traceId} | |
TraceApi | trace_list | GET /api/public/traces |
Documentation For Models
- BaseEvent
- BasePrompt
- BaseScore
- BooleanScore
- CategoricalScore
- ChatMessage
- ChatPrompt
- Comment
- CommentObjectType
- ConfigCategory
- CreateChatPromptRequest
- CreateCommentRequest
- CreateCommentResponse
- CreateDatasetItemRequest
- CreateDatasetRequest
- CreateDatasetRunItemRequest
- CreateEventBody
- CreateEventEvent
- CreateGenerationBody
- CreateGenerationEvent
- CreateModelRequest
- CreateObservationEvent
- CreatePromptRequest
- CreatePromptRequestOneOf
- CreatePromptRequestOneOf1
- CreateScoreConfigRequest
- CreateScoreRequest
- CreateScoreResponse
- CreateScoreValue
- CreateSpanBody
- CreateSpanEvent
- CreateTextPromptRequest
- DailyMetrics
- DailyMetricsDetails
- Dataset
- DatasetItem
- DatasetRun
- DatasetRunItem
- DatasetRunWithItems
- DatasetStatus
- GetCommentsResponse
- GetMediaResponse
- GetMediaUploadUrlRequest
- GetMediaUploadUrlResponse
- GetScoresResponse
- GetScoresResponseData
- GetScoresResponseDataBoolean
- GetScoresResponseDataCategorical
- GetScoresResponseDataNumeric
- GetScoresResponseDataOneOf
- GetScoresResponseDataOneOf1
- GetScoresResponseDataOneOf2
- GetScoresResponseTraceData
- HealthResponse
- IngestionBatchRequest
- IngestionError
- IngestionEvent
- IngestionEventOneOf
- IngestionEventOneOf1
- IngestionEventOneOf2
- IngestionEventOneOf3
- IngestionEventOneOf4
- IngestionEventOneOf5
- IngestionEventOneOf6
- IngestionEventOneOf7
- IngestionEventOneOf8
- IngestionEventOneOf9
- IngestionResponse
- IngestionSuccess
- IngestionUsage
- MapValue
- MediaContentType
- Model
- ModelUsageUnit
- NumericScore
- Observation
- ObservationBody
- ObservationLevel
- ObservationType
- Observations
- ObservationsView
- ObservationsViews
- OpenAiUsage
- OpenAiUsageSchema
- OptionalObservationBody
- PaginatedDatasetItems
- PaginatedDatasetRuns
- PaginatedDatasets
- PaginatedModels
- PaginatedSessions
- PatchMediaBody
- Project
- Projects
- Prompt
- PromptMeta
- PromptMetaListResponse
- PromptOneOf
- PromptOneOf1
- PromptVersionUpdateRequest
- Score
- ScoreBody
- ScoreConfig
- ScoreConfigs
- ScoreDataType
- ScoreEvent
- ScoreOneOf
- ScoreOneOf1
- ScoreOneOf2
- ScoreSource
- SdkLogBody
- SdkLogEvent
- Session
- SessionWithTraces
- Sort
- TextPrompt
- Trace
- TraceBody
- TraceEvent
- TraceWithDetails
- TraceWithFullDetails
- Traces
- UpdateEventBody
- UpdateGenerationBody
- UpdateGenerationEvent
- UpdateObservationEvent
- UpdateSpanBody
- UpdateSpanEvent
- Usage
- UsageByModel
- UsageDetails
- UtilsMetaResponse
To get access to the crate's generated documentation, use:
cargo doc --open
Author
Dependencies
~8–20MB
~276K SLoC