Generated API documentation
The code is generated by the OpenAPI generator with the Julia plugin.
GptSearchPlugin.AppServer.GptPluginServer — ModuleEncapsulates generated server code for GptPluginServer
The following server methods must be implemented:
- delete_docs
- invocation: DELETE /delete
- signature: deletedocs(req::HTTP.Request, deleterequest::DeleteRequest;) -> DeleteResponse
- query_post
- invocation: POST /query
- signature: querypost(req::HTTP.Request, queryrequest::QueryRequest;) -> QueryResponse
- upsert_post
- invocation: POST /upsert
- signature: upsertpost(req::HTTP.Request, upsertrequest::UpsertRequest;) -> UpsertResponse
GptSearchPlugin.AppServer.GptPluginServer.DeleteRequest — TypeDeleteRequest
DeleteRequest(;
+ ids=nothing,
+ filter=nothing,
+ delete_all=false,
+)
+
+- ids::Vector{String}
+- filter::Vector{DocumentMetadataFilter}
+- delete_all::BoolGptSearchPlugin.AppServer.GptPluginServer.DeleteResponse — TypeDeleteResponse
DeleteResponse(;
+ success=nothing,
+)
+
+- success::BoolGptSearchPlugin.AppServer.GptPluginServer.Document — TypeDocument
Document(;
+ id=nothing,
+ text=nothing,
+ metadata=nothing,
+)
+
+- id::String
+- text::String
+- metadata::DocumentMetadataGptSearchPlugin.AppServer.GptPluginServer.DocumentChunk — TypeDocumentChunk
DocumentChunk(;
+ id=nothing,
+ text=nothing,
+ metadata=nothing,
+ embedding=nothing,
+ score=nothing,
+)
+
+- id::String
+- text::String
+- metadata::DocumentChunkMetadata
+- embedding::Vector{Float64}
+- score::Float64GptSearchPlugin.AppServer.GptPluginServer.DocumentChunkMetadata — TypeDocumentChunkMetadata
DocumentChunkMetadata(;
+ source=nothing,
+ source_id=nothing,
+ url=nothing,
+ created_at=nothing,
+ author=nothing,
+ document_id=nothing,
+)
+
+- source::Source
+- source_id::String
+- url::String
+- created_at::String
+- author::String
+- document_id::StringGptSearchPlugin.AppServer.GptPluginServer.DocumentChunkWithScore — TypeDocumentChunkWithScore
DocumentChunkWithScore(;
+ id=nothing,
+ text=nothing,
+ metadata=nothing,
+ embedding=nothing,
+ score=nothing,
+)
+
+- id::String
+- text::String
+- metadata::DocumentChunkMetadata
+- embedding::Vector{Float64}
+- score::Float64GptSearchPlugin.AppServer.GptPluginServer.DocumentMetadata — TypeDocumentMetadata
DocumentMetadata(;
+ source=nothing,
+ source_id=nothing,
+ url=nothing,
+ created_at=nothing,
+ author=nothing,
+)
+
+- source::Source
+- source_id::String
+- url::String
+- created_at::String
+- author::StringGptSearchPlugin.AppServer.GptPluginServer.DocumentMetadataFilter — TypeDocumentMetadataFilter
DocumentMetadataFilter(;
+ document_id=nothing,
+ source=nothing,
+ source_id=nothing,
+ author=nothing,
+ start_date=nothing,
+ end_date=nothing,
+)
+
+- document_id::String
+- source::Source
+- source_id::String
+- author::String
+- start_date::String
+- end_date::StringGptSearchPlugin.AppServer.GptPluginServer.HTTPValidationError — TypeHTTPValidationError
HTTPValidationError(;
+ detail=nothing,
+)
+
+- detail::Vector{ValidationError}GptSearchPlugin.AppServer.GptPluginServer.LocationInner — TypeLocation_inner
LocationInner(; value=nothing)GptSearchPlugin.AppServer.GptPluginServer.Query — TypeQuery
Query(;
+ query=nothing,
+ filter=nothing,
+ top_k=3,
+)
+
+- query::String
+- filter::DocumentMetadataFilter
+- top_k::Int64GptSearchPlugin.AppServer.GptPluginServer.QueryRequest — TypeQueryRequest
QueryRequest(;
+ queries=nothing,
+)
+
+- queries::Vector{Query}GptSearchPlugin.AppServer.GptPluginServer.QueryResponse — TypeQueryResponse
QueryResponse(;
+ results=nothing,
+)
+
+- results::Vector{QueryResult}GptSearchPlugin.AppServer.GptPluginServer.QueryResult — TypeQueryResult
QueryResult(;
+ query=nothing,
+ results=nothing,
+)
+
+- query::String
+- results::Vector{DocumentChunkWithScore}GptSearchPlugin.AppServer.GptPluginServer.QueryWithEmbedding — TypeQueryWithEmbedding
QueryWithEmbedding(;
+ query=nothing,
+ filter=nothing,
+ top_k=3,
+ embedding=nothing,
+)
+
+- query::String
+- filter::DocumentMetadataFilter
+- top_k::Int64
+- embedding::Vector{Float64}GptSearchPlugin.AppServer.GptPluginServer.UpsertRequest — TypeUpsertRequest
UpsertRequest(;
+ documents=nothing,
+)
+
+- documents::Vector{Document}GptSearchPlugin.AppServer.GptPluginServer.UpsertResponse — TypeUpsertResponse
UpsertResponse(;
+ ids=nothing,
+)
+
+- ids::Vector{String}GptSearchPlugin.AppServer.GptPluginServer.ValidationError — TypeValidationError
ValidationError(;
+ loc=nothing,
+ msg=nothing,
+ type=nothing,
+)
+
+- loc::Vector{LocationInner}
+- msg::String
+- type::StringGptSearchPlugin.AppServer.GptPluginServer.register — MethodRegister handlers for all APIs in this module in the supplied Router instance.
Paramerets:
router: Router to register handlers inimpl: module that implements the server methods
Optional parameters:
path_prefix: prefix to be applied to all pathsoptional_middlewares: Register one or more optional middlewares to be applied to all requests.
Optional middlewares can be one or more of: - init: called before the request is processed - pre_validation: called after the request is parsed but before validation - pre_invoke: called after validation but before the handler is invoked - post_invoke: called after the handler is invoked but before the response is sent
The order in which middlewares are invoked are: init |> read |> pre_validation |> validate |> pre_invoke |> invoke |> post_invoke