knowlapi

type Citation struct {
	Kind      CitationKind `json:"kind"`
	PageId    *string      `json:"page_id,omitempty"`
	Path      *string      `json:"path,omitempty"`
	Reference string       `json:"reference"`
	SourceRef *string      `json:"source_ref,omitempty"`
	Untrusted bool         `json:"untrusted"`
}

type CitationKind string

type ErrorResponse struct {
	Error string `json:"error"`
}

type EvidenceItem struct {
	DocumentId      *string           `json:"document_id,omitempty"`
	Okf             *OKFMetadata      `json:"okf,omitempty"`
	PageId          string            `json:"page_id"`
	Revision        *string           `json:"revision,omitempty"`
	Snippet         string            `json:"snippet"`
	SourceDocuments *[]SourceDocument `json:"source_documents,omitempty"`
	SourceId        *string           `json:"source_id,omitempty"`
	SourceRefs      *[]string         `json:"source_refs,omitempty"`
	Title           string            `json:"title"`
	Untrusted       bool              `json:"untrusted"`
	Uri             *string           `json:"uri,omitempty"`
}

type Failure struct {
	Class       string `json:"class"`
	OperationId string `json:"operation_id"`
}

type GetHealth200JSONResponse HealthResponse

type GetHealthRequestObject struct {
}

type GetHealthResponseObject interface {
	VisitGetHealthResponse(w http.ResponseWriter) error
}

type GetOperation200JSONResponse OperationResult

type GetOperation400JSONResponse struct {
	OperationIDBadRequestJSONResponse
}

type GetOperation401JSONResponse struct{ UnauthorizedJSONResponse }

type GetOperation403JSONResponse struct {
	ScopeOverrideForbiddenJSONResponse
}

type GetOperation404JSONResponse struct{ NotFoundJSONResponse }

type GetOperation422JSONResponse struct{ OperationFailedJSONResponse }

type GetOperation503JSONResponse struct{ UnavailableErrorJSONResponse }

type GetOperationRequestObject struct {
	OperationId OperationID `json:"operation_id"`
}

type GetOperationResponseObject interface {
	VisitGetOperationResponse(w http.ResponseWriter) error
}

type GetReady200JSONResponse ReadyResponse

type GetReady503JSONResponse ReadyResponse

type GetReadyRequestObject struct {
}

type GetReadyResponseObject interface {
	VisitGetReadyResponse(w http.ResponseWriter) error
}

type HealthResponse struct {
	Service string               `json:"service"`
	Status  HealthResponseStatus `json:"status"`
}

type HealthResponseStatus string

type IngestKnowledge200JSONResponse IngestResult

type IngestKnowledge400JSONResponse struct{ JSONBodyBadRequestJSONResponse }

type IngestKnowledge401JSONResponse struct{ UnauthorizedJSONResponse }

type IngestKnowledge403JSONResponse struct {
	ScopeOverrideForbiddenJSONResponse
}

type IngestKnowledge422JSONResponse struct{ OperationFailedJSONResponse }

type IngestKnowledge503JSONResponse struct{ UnavailableErrorJSONResponse }

type IngestKnowledgeJSONRequestBody = IngestRequest

type IngestKnowledgeRequestObject struct {
	Body *IngestKnowledgeJSONRequestBody
}

type IngestKnowledgeResponseObject interface {
	VisitIngestKnowledgeResponse(w http.ResponseWriter) error
}

type IngestRequest struct {
	// Content Raw source content.
	Content        *string `json:"content,omitempty"`
	IdempotencyKey *string `json:"idempotency_key,omitempty"`
	MediaType      *string `json:"media_type,omitempty"`
	Origin         *string `json:"origin,omitempty"`

	// Uri External source URI.
	Uri *string `json:"uri,omitempty"`
}

type IngestResult struct {
	OperationId string             `json:"operation_id"`
	Status      IngestResultStatus `json:"status"`
}

type IngestResultStatus string

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

type JSONBodyBadRequest = ErrorResponse

type JSONBodyBadRequestJSONResponse ErrorResponse

type MiddlewareFunc func(http.Handler) http.Handler

type NotFound = ErrorResponse

type NotFoundJSONResponse ErrorResponse

type OKFAttester struct {
	Extensions *OKFExtensions `json:"extensions,omitempty"`
	Resource   string         `json:"resource"`
}

type OKFExecutor struct {
	Extensions *OKFExtensions `json:"extensions,omitempty"`
	Receipt    *[]string      `json:"receipt,omitempty"`
	Resource   string         `json:"resource"`
}

type OKFExtensions map[string]interface{}

type OKFGeneration struct {
	At         *time.Time     `json:"at,omitempty"`
	By         string         `json:"by"`
	Extensions *OKFExtensions `json:"extensions,omitempty"`
}

type OKFMetadata struct {
	Attester        *OKFAttester                `json:"attester,omitempty"`
	Computation     *string                     `json:"computation,omitempty"`
	Description     *string                     `json:"description,omitempty"`
	EffectiveStatus *OKFMetadataEffectiveStatus `json:"effective_status,omitempty"`
	Executor        *OKFExecutor                `json:"executor,omitempty"`
	Extensions      *OKFExtensions              `json:"extensions,omitempty"`
	Generated       *OKFGeneration              `json:"generated,omitempty"`
	Parameters      *[]OKFParameter             `json:"parameters,omitempty"`
	Resource        *string                     `json:"resource,omitempty"`
	Runtime         *string                     `json:"runtime,omitempty"`
	Sources         *[]OKFSource                `json:"sources,omitempty"`
	Stale           *bool                       `json:"stale,omitempty"`
	StaleAfter      *time.Time                  `json:"stale_after,omitempty"`
	Status          *OKFMetadataStatus          `json:"status,omitempty"`
	Tags            *[]string                   `json:"tags,omitempty"`
	Title           *string                     `json:"title,omitempty"`
	TrustTier       *OKFMetadataTrustTier       `json:"trust_tier,omitempty"`
	Type            string                      `json:"type"`
	UsageWindow     *OKFUsageWindow             `json:"usage_window,omitempty"`
	Verified        *[]OKFVerification          `json:"verified,omitempty"`
}

type OKFMetadataEffectiveStatus string

type OKFMetadataStatus string

type OKFMetadataTrustTier string

type OKFParameter struct {
	Extensions *OKFExtensions `json:"extensions,omitempty"`
	Name       string         `json:"name"`
	Required   bool           `json:"required"`
	Type       string         `json:"type"`
}

type OKFSource struct {
	Author       *string         `json:"author,omitempty"`
	Extensions   *OKFExtensions  `json:"extensions,omitempty"`
	Id           *string         `json:"id,omitempty"`
	LastModified *time.Time      `json:"last_modified,omitempty"`
	Resource     string          `json:"resource"`
	Title        *string         `json:"title,omitempty"`
	UsageCount   *uint64         `json:"usage_count,omitempty"`
	UsageWindow  *OKFUsageWindow `json:"usage_window,omitempty"`
}

type OKFUsageWindow struct {
	Extensions *OKFExtensions `json:"extensions,omitempty"`
	From       time.Time      `json:"from"`
	To         time.Time      `json:"to"`
}

type OKFVerification struct {
	At         time.Time      `json:"at"`
	By         string         `json:"by"`
	Extensions *OKFExtensions `json:"extensions,omitempty"`
}

type OperationFailed = ErrorResponse

type OperationFailedJSONResponse ErrorResponse

type OperationID = string

type OperationIDBadRequest = ErrorResponse

type OperationIDBadRequestJSONResponse ErrorResponse

type OperationResult struct {
	Failure   *Failure              `json:"failure,omitempty"`
	Id        string                `json:"id"`
	Status    OperationResultStatus `json:"status"`
	UpdatedAt time.Time             `json:"updated_at"`
}

type OperationResultStatus string

type QueryStringBadRequest = ErrorResponse

type QueryStringBadRequestJSONResponse ErrorResponse

type ReadyResponse struct {
	// Scope Trusted scope reported only when the host is ready.
	Scope   *string             `json:"scope,omitempty"`
	Service string              `json:"service"`
	Status  ReadyResponseStatus `json:"status"`
}

type ReadyResponseStatus string

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

type RequiredParamError struct {
	ParamName string
}

type RetrieveKnowledge200JSONResponse RetrieveResult

type RetrieveKnowledge400JSONResponse struct {
	QueryStringBadRequestJSONResponse
}

type RetrieveKnowledge401JSONResponse struct{ UnauthorizedJSONResponse }

type RetrieveKnowledge403JSONResponse struct {
	ScopeOverrideForbiddenJSONResponse
}

type RetrieveKnowledge422JSONResponse struct{ OperationFailedJSONResponse }

type RetrieveKnowledge503JSONResponse struct{ UnavailableErrorJSONResponse }

type RetrieveKnowledgeParams struct {
	// Query Free-text retrieval query.
	Query RetrieveQuery `form:"query" json:"query"`

	// Source Optional repeatable source identity filter. Empty means all sources and curated pages.
	Source *RetrieveSource `form:"source,omitempty" json:"source,omitempty"`
}

type RetrieveKnowledgeRequestObject struct {
	Params RetrieveKnowledgeParams
}

type RetrieveKnowledgeResponseObject interface {
	VisitRetrieveKnowledgeResponse(w http.ResponseWriter) error
}

type RetrieveQuery = string

type RetrieveResult struct {
	Citations *[]Citation    `json:"citations,omitempty"`
	Evidence  []EvidenceItem `json:"evidence"`
	Query     string         `json:"query"`
}

type RetrieveSource = []string

type ScopeOverrideForbidden = ErrorResponse

type ScopeOverrideForbiddenJSONResponse ErrorResponse

type ServeMux interface {
	HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))
	ServeHTTP(w http.ResponseWriter, r *http.Request)
}

type ServerInterface interface {
	// Liveness probe
	// (GET /healthz)
	GetHealth(w http.ResponseWriter, r *http.Request)
	// Readiness probe
	// (GET /readyz)
	GetReady(w http.ResponseWriter, r *http.Request)
	// Submit one bounded source to the trusted Knowl ingest pipeline
	// (POST /v1/ingest)
	IngestKnowledge(w http.ResponseWriter, r *http.Request)
	// Read one durable Knowl operation status
	// (GET /v1/operations/{operation_id})
	GetOperation(w http.ResponseWriter, r *http.Request, operationId OperationID)
	// Retrieve bounded evidence from the trusted Knowl scope
	// (GET /v1/retrieve)
	RetrieveKnowledge(w http.ResponseWriter, r *http.Request, params RetrieveKnowledgeParams)
}

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandlerFunc   func(w http.ResponseWriter, r *http.Request, err error)
}

type SourceDocument struct {
	DocumentId string `json:"document_id"`
	Revision   string `json:"revision"`
	SourceId   string `json:"source_id"`
	Uri        string `json:"uri"`
}

type StdHTTPServerOptions struct {
	BaseURL          string
	BaseRouter       ServeMux
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type StrictHTTPServerOptions struct {
	RequestErrorHandlerFunc  func(w http.ResponseWriter, r *http.Request, err error)
	ResponseErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type StrictHandlerFunc = strictnethttp.StrictHTTPHandlerFunc

type StrictMiddlewareFunc = strictnethttp.StrictHTTPMiddlewareFunc

type StrictServerInterface interface {
	// Liveness probe
	// (GET /healthz)
	GetHealth(ctx context.Context, request GetHealthRequestObject) (GetHealthResponseObject, error)
	// Readiness probe
	// (GET /readyz)
	GetReady(ctx context.Context, request GetReadyRequestObject) (GetReadyResponseObject, error)
	// Submit one bounded source to the trusted Knowl ingest pipeline
	// (POST /v1/ingest)
	IngestKnowledge(ctx context.Context, request IngestKnowledgeRequestObject) (IngestKnowledgeResponseObject, error)
	// Read one durable Knowl operation status
	// (GET /v1/operations/{operation_id})
	GetOperation(ctx context.Context, request GetOperationRequestObject) (GetOperationResponseObject, error)
	// Retrieve bounded evidence from the trusted Knowl scope
	// (GET /v1/retrieve)
	RetrieveKnowledge(ctx context.Context, request RetrieveKnowledgeRequestObject) (RetrieveKnowledgeResponseObject, error)
}

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

type Unauthorized = ErrorResponse

type UnauthorizedJSONResponse struct {
	Body ErrorResponse

	Headers UnauthorizedResponseHeaders
}

type UnauthorizedResponseHeaders struct {
	WWWAuthenticate string
}

type UnavailableError = ErrorResponse

type UnavailableErrorJSONResponse ErrorResponse

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}