Documentation
¶
Overview ¶
Package models provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version 2.5.1 DO NOT EDIT.
Index ¶
- type BoundingBox
- type Collection
- type CreateCollectionJSONRequestBody
- type CreateLabelJSONRequestBody
- type Error
- type Image
- type ImageIngestionResponse
- type IngestImageJSONRequestBody
- type Label
- type ListCollectionsParams
- type ListCollectionsResponse
- type ListImagesParams
- type ListImagesResponse
- type ListLabelsParams
- type ListLabelsResponse
- type NewBoundingBox
- type NewCollection
- type NewImage
- type NewLabel
- type Pagination
- type UpdateCollection
- type UpdateCollectionByNameJSONRequestBody
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BoundingBox ¶
type BoundingBox struct {
// Height height of the bounding box
Height float32 `json:"height"`
// Id ID of the bounding box
Id string `json:"id"`
// Label label
Label string `json:"label"`
// Width width of the bounding box
Width float32 `json:"width"`
// Xc x coordinate of the center point
Xc float32 `json:"xc"`
// Yc y coordinate of the center point
Yc float32 `json:"yc"`
}
BoundingBox defines model for BoundingBox.
type Collection ¶
type Collection struct {
// Description Description of the collection
Description *string `json:"description,omitempty"`
// Name Name of the collection
Name *string `json:"name,omitempty"`
}
Collection defines model for Collection.
type CreateCollectionJSONRequestBody ¶
type CreateCollectionJSONRequestBody = NewCollection
CreateCollectionJSONRequestBody defines body for CreateCollection for application/json ContentType.
type CreateLabelJSONRequestBody ¶
type CreateLabelJSONRequestBody = NewLabel
CreateLabelJSONRequestBody defines body for CreateLabel for application/json ContentType.
type Error ¶
type Error struct {
// Code Error code
Code int32 `json:"code"`
// Message Error message
Message string `json:"message"`
}
Error defines model for Error.
type Image ¶
type Image struct {
BoundingBoxes *[]BoundingBox `json:"bounding_boxes,omitempty"`
// Collection name of collection in which the image belongs
Collection string `json:"collection"`
// Id ID of the image
Id string `json:"id"`
Labels *[]string `json:"labels,omitempty"`
}
Image defines model for Image.
type ImageIngestionResponse ¶
type ImageIngestionResponse struct {
// Id ID of ingested image
Id *string `json:"id,omitempty"`
}
ImageIngestionResponse defines model for ImageIngestionResponse.
type IngestImageJSONRequestBody ¶
type IngestImageJSONRequestBody = NewImage
IngestImageJSONRequestBody defines body for IngestImage for application/json ContentType.
type Label ¶
type Label struct {
// Description Description of the label
Description *string `json:"description,omitempty"`
// Name Name of the label
Name *string `json:"name,omitempty"`
}
Label defines model for Label.
type ListCollectionsParams ¶
type ListCollectionsParams struct {
// Page page number
Page *int64 `form:"page,omitempty" json:"page,omitempty"`
// PageSize maximum number of collections to return
PageSize *int `form:"page_size,omitempty" json:"page_size,omitempty"`
}
ListCollectionsParams defines parameters for ListCollections.
type ListCollectionsResponse ¶
type ListCollectionsResponse struct {
Data *[]Collection `json:"data,omitempty"`
Pagination Pagination `json:"pagination"`
}
ListCollectionsResponse defines model for ListCollectionsResponse.
type ListImagesParams ¶
type ListImagesParams struct {
// Page page number
Page *int64 `form:"page,omitempty" json:"page,omitempty"`
// PageSize maximum number of collections to return
PageSize *int `form:"page_size,omitempty" json:"page_size,omitempty"`
// Collection name of collection
Collection *string `form:"collection,omitempty" json:"collection,omitempty"`
}
ListImagesParams defines parameters for ListImages.
type ListImagesResponse ¶
type ListImagesResponse struct {
Images []Image `json:"images"`
Pagination Pagination `json:"pagination"`
}
ListImagesResponse defines model for ListImagesResponse.
type ListLabelsParams ¶
type ListLabelsParams struct {
// Page page number
Page *int64 `form:"page,omitempty" json:"page,omitempty"`
// PageSize maximum number of labels to return
PageSize *int `form:"page_size,omitempty" json:"page_size,omitempty"`
}
ListLabelsParams defines parameters for ListLabels.
type ListLabelsResponse ¶
type ListLabelsResponse struct {
Data *[]Label `json:"data,omitempty"`
Pagination Pagination `json:"pagination"`
}
ListLabelsResponse defines model for ListLabelsResponse.
type NewBoundingBox ¶
type NewBoundingBox struct {
// Height height of the bounding box
Height float32 `json:"height"`
// Label label
Label string `json:"label"`
// Width width of the bounding box
Width float32 `json:"width"`
// Xc x coordinate of the center point
Xc float32 `json:"xc"`
// Yc y coordinate of the center point
Yc float32 `json:"yc"`
}
NewBoundingBox defines model for NewBoundingBox.
type NewCollection ¶
type NewCollection struct {
// Description Description of the collection
Description *string `json:"description,omitempty"`
// Name Name of the collection
Name string `json:"name"`
}
NewCollection defines model for NewCollection.
type NewImage ¶
type NewImage struct {
BoundingBoxes *[]NewBoundingBox `json:"bounding_boxes,omitempty"`
// Collection name of collection in which to add the image
Collection string `json:"collection"`
// Data base64 encoded image raw bytes
Data string `json:"data"`
Labels *[]string `json:"labels,omitempty"`
}
NewImage defines model for NewImage.
type NewLabel ¶
type NewLabel struct {
// Description Description of the label
Description *string `json:"description,omitempty"`
// Name Name of the label
Name string `json:"name"`
}
NewLabel defines model for NewLabel.
type Pagination ¶
type Pagination struct {
// Page current page number
Page int64 `json:"page"`
// PageSize maximum number of items per page
PageSize int `json:"page_size"`
// TotalItems total number of items
TotalItems int64 `json:"total_items"`
// TotalPages total number of pages
TotalPages int64 `json:"total_pages"`
}
Pagination defines model for Pagination.
type UpdateCollection ¶
type UpdateCollection struct {
// Description New description of the collection
Description string `json:"description"`
// Name New name of the collection
Name string `json:"name"`
}
UpdateCollection defines model for UpdateCollection.
type UpdateCollectionByNameJSONRequestBody ¶
type UpdateCollectionByNameJSONRequestBody = UpdateCollection
UpdateCollectionByNameJSONRequestBody defines body for UpdateCollectionByName for application/json ContentType.