swagger

package
v0.0.0-...-cbe96fd Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 22, 2024 License: Apache-2.0 Imports: 21 Imported by: 0

README

Go API client for swagger

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

Overview

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

  • API version: v1.11.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.GoClientCodegen For more information, please visit https://labelstud.io

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to http://api.labelstud.io

Class Method HTTP request Description
AnnotationsApi ApiAnnotationsDelete Delete /api/annotations/{id}/ Delete annotation
AnnotationsApi ApiAnnotationsPartialUpdate Patch /api/annotations/{id}/ Update annotation
AnnotationsApi ApiAnnotationsRead Get /api/annotations/{id}/ Get annotation by its ID
AnnotationsApi ApiTasksAnnotationsCreate Post /api/tasks/{id}/annotations/ Create annotation
AnnotationsApi ApiTasksAnnotationsList Get /api/tasks/{id}/annotations/ Get all task annotations
DataManagerApi ApiDmActionsCreate Post /api/dm/actions/ Post actions
DataManagerApi ApiDmActionsList Get /api/dm/actions/ Get actions
DataManagerApi ApiDmColumnsList Get /api/dm/columns/ Get data manager columns
DataManagerApi ApiDmProjectList Get /api/dm/project/ Get project state
DataManagerApi ApiDmViewsCreate Post /api/dm/views/ Create view
DataManagerApi ApiDmViewsDelete Delete /api/dm/views/{id}/ Delete view
DataManagerApi ApiDmViewsList Get /api/dm/views/ List views
DataManagerApi ApiDmViewsPartialUpdate Patch /api/dm/views/{id}/ Update view
DataManagerApi ApiDmViewsRead Get /api/dm/views/{id}/ Get view details
DataManagerApi ApiDmViewsReset Delete /api/dm/views/reset/ Reset project views
DataManagerApi ApiDmViewsUpdate Put /api/dm/views/{id}/ Put view
ExportApi ApiProjectsExportFormatsRead Get /api/projects/{id}/export/formats Get export formats
ExportApi ApiProjectsExportRead Get /api/projects/{id}/export Easy export of tasks and annotations
ExportApi ApiProjectsExportsConvertCreate Post /api/projects/{id}/exports/{export_pk}/convert Export conversion
ExportApi ApiProjectsExportsCreate Post /api/projects/{id}/exports/ Create new export snapshot
ExportApi ApiProjectsExportsDelete Delete /api/projects/{id}/exports/{export_pk} Delete export snapshot
ExportApi ApiProjectsExportsDownloadRead Get /api/projects/{id}/exports/{export_pk}/download Download export snapshot as file in specified format
ExportApi ApiProjectsExportsList Get /api/projects/{id}/exports/ List all export snapshots
ExportApi ApiProjectsExportsRead Get /api/projects/{id}/exports/{export_pk} Get export snapshot by ID
ImportApi ApiImportFileUploadDelete Delete /api/import/file-upload/{id} Delete file upload
ImportApi ApiImportFileUploadPartialUpdate Patch /api/import/file-upload/{id} Update file upload
ImportApi ApiImportFileUploadRead Get /api/import/file-upload/{id} Get file upload
ImportApi ApiProjectsFileUploadsDelete Delete /api/projects/{id}/file-uploads Delete files
ImportApi ApiProjectsFileUploadsList Get /api/projects/{id}/file-uploads Get files list
ImportApi ApiProjectsImportCreate Post /api/projects/{id}/import Import tasks
InvitesApi ApiInviteRead Get /api/invite Get organization invite link
InvitesApi ApiInviteResetTokenCreate Post /api/invite/reset-token Reset organization token
LabelsApi ApiLabelLinksCreate Post /api/label_links/ Create label links
LabelsApi ApiLabelLinksDelete Delete /api/label_links/{id}/ Remove label link
LabelsApi ApiLabelLinksList Get /api/label_links/ List label links
LabelsApi ApiLabelLinksPartialUpdate Patch /api/label_links/{id}/ Update label link
LabelsApi ApiLabelLinksRead Get /api/label_links/{id}/ Get label link
LabelsApi ApiLabelsBulkCreate Post /api/labels/bulk Bulk update labels
LabelsApi ApiLabelsCreate Post /api/labels/ Create labels
LabelsApi ApiLabelsDelete Delete /api/labels/{id}/ Remove labels
LabelsApi ApiLabelsList Get /api/labels/ List labels
LabelsApi ApiLabelsPartialUpdate Patch /api/labels/{id}/ Update labels
LabelsApi ApiLabelsRead Get /api/labels/{id}/ Get label
MachineLearningApi ApiMlCreate Post /api/ml/ Add ML Backend
MachineLearningApi ApiMlDelete Delete /api/ml/{id} Remove ML Backend
MachineLearningApi ApiMlInteractiveAnnotatingCreate Post /api/ml/{id}/interactive-annotating Request Interactive Annotation
MachineLearningApi ApiMlList Get /api/ml/ List ML backends
MachineLearningApi ApiMlPartialUpdate Patch /api/ml/{id} Update ML Backend
MachineLearningApi ApiMlRead Get /api/ml/{id} Get ML Backend
MachineLearningApi ApiMlTrainCreate Post /api/ml/{id}/train Train
MachineLearningApi ApiMlVersionsRead Get /api/ml/{id}/versions Get model versions
OrganizationsApi ApiOrganizationsList Get /api/organizations/ List your organizations
OrganizationsApi ApiOrganizationsMembershipsDelete Delete /api/organizations/{id}/memberships/{user_pk}/ Soft delete an organization member
OrganizationsApi ApiOrganizationsMembershipsList Get /api/organizations/{id}/memberships Get organization members list
OrganizationsApi ApiOrganizationsPartialUpdate Patch /api/organizations/{id} Update organization settings
OrganizationsApi ApiOrganizationsRead Get /api/organizations/{id} Get organization settings
PredictionsApi ApiPredictionsCreate Post /api/predictions/ Create prediction
PredictionsApi ApiPredictionsDelete Delete /api/predictions/{id}/ Delete prediction
PredictionsApi ApiPredictionsList Get /api/predictions/ List predictions
PredictionsApi ApiPredictionsPartialUpdate Patch /api/predictions/{id}/ Update prediction
PredictionsApi ApiPredictionsRead Get /api/predictions/{id}/ Get prediction details
PredictionsApi ApiPredictionsUpdate Put /api/predictions/{id}/ Put prediction
ProjectsApi ApiProjectsCreate Post /api/projects/ Create new project
ProjectsApi ApiProjectsDelete Delete /api/projects/{id}/ Delete project
ProjectsApi ApiProjectsImportsRead Get /api/projects/{id}/imports/{import_pk}/ Get project import info
ProjectsApi ApiProjectsList Get /api/projects/ List your projects
ProjectsApi ApiProjectsPartialUpdate Patch /api/projects/{id}/ Update project
ProjectsApi ApiProjectsRead Get /api/projects/{id}/ Get project by ID
ProjectsApi ApiProjectsReimportsRead Get /api/projects/{id}/reimports/{reimport_pk}/ Get project reimport info
ProjectsApi ApiProjectsTasksDelete Delete /api/projects/{id}/tasks/ Delete all tasks
ProjectsApi ApiProjectsTasksList Get /api/projects/{id}/tasks/ List project tasks
ProjectsApi ApiProjectsValidateCreate Post /api/projects/validate/ Validate label config
ProjectsApi ApiProjectsValidateCreate_0 Post /api/projects/{id}/validate/ Validate project label config
StorageApi ApiStoragesExportList Get /api/storages/export List all export storages from the project
StorageApi ApiStoragesExportTypesList Get /api/storages/export/types List all export storages types
StorageApi ApiStoragesList Get /api/storages/ List all import storages from the project
StorageApi ApiStoragesTypesList Get /api/storages/types List all import storages types
StorageAzureApi ApiStoragesAzureCreate Post /api/storages/azure/ Create new storage
StorageAzureApi ApiStoragesAzureDelete Delete /api/storages/azure/{id} Delete import storage
StorageAzureApi ApiStoragesAzureList Get /api/storages/azure/ Get all import storage
StorageAzureApi ApiStoragesAzurePartialUpdate Patch /api/storages/azure/{id} Update import storage
StorageAzureApi ApiStoragesAzureRead Get /api/storages/azure/{id} Get import storage
StorageAzureApi ApiStoragesAzureSyncCreate Post /api/storages/azure/{id}/sync Sync import storage
StorageAzureApi ApiStoragesAzureValidateCreate Post /api/storages/azure/validate Validate import storage
StorageAzureApi ApiStoragesExportAzureCreate Post /api/storages/export/azure Create export storage
StorageAzureApi ApiStoragesExportAzureDelete Delete /api/storages/export/azure/{id} Delete export storage
StorageAzureApi ApiStoragesExportAzureList Get /api/storages/export/azure Get all export storage
StorageAzureApi ApiStoragesExportAzurePartialUpdate Patch /api/storages/export/azure/{id} Update export storage
StorageAzureApi ApiStoragesExportAzureRead Get /api/storages/export/azure/{id} Get export storage
StorageAzureApi ApiStoragesExportAzureSyncCreate Post /api/storages/export/azure/{id}/sync Sync export storage
StorageAzureApi ApiStoragesExportAzureValidateCreate Post /api/storages/export/azure/validate Validate export storage
StorageGCSApi ApiStoragesExportGcsCreate Post /api/storages/export/gcs Create export storage
StorageGCSApi ApiStoragesExportGcsDelete Delete /api/storages/export/gcs/{id} Delete export storage
StorageGCSApi ApiStoragesExportGcsList Get /api/storages/export/gcs Get all export storage
StorageGCSApi ApiStoragesExportGcsPartialUpdate Patch /api/storages/export/gcs/{id} Update export storage
StorageGCSApi ApiStoragesExportGcsRead Get /api/storages/export/gcs/{id} Get export storage
StorageGCSApi ApiStoragesExportGcsSyncCreate Post /api/storages/export/gcs/{id}/sync Sync export storage
StorageGCSApi ApiStoragesExportGcsValidateCreate Post /api/storages/export/gcs/validate Validate export storage
StorageGCSApi ApiStoragesGcsCreate Post /api/storages/gcs/ Create import storage
StorageGCSApi ApiStoragesGcsDelete Delete /api/storages/gcs/{id} Delete import storage
StorageGCSApi ApiStoragesGcsList Get /api/storages/gcs/ Get all import storage
StorageGCSApi ApiStoragesGcsPartialUpdate Patch /api/storages/gcs/{id} Update import storage
StorageGCSApi ApiStoragesGcsRead Get /api/storages/gcs/{id} Get import storage
StorageGCSApi ApiStoragesGcsSyncCreate Post /api/storages/gcs/{id}/sync Sync import storage
StorageGCSApi ApiStoragesGcsValidateCreate Post /api/storages/gcs/validate Validate import storage
StorageLocalApi ApiStoragesExportLocalfilesCreate Post /api/storages/export/localfiles Create export storage
StorageLocalApi ApiStoragesExportLocalfilesDelete Delete /api/storages/export/localfiles/{id} Delete export storage
StorageLocalApi ApiStoragesExportLocalfilesList Get /api/storages/export/localfiles Get all export storage
StorageLocalApi ApiStoragesExportLocalfilesPartialUpdate Patch /api/storages/export/localfiles/{id} Update export storage
StorageLocalApi ApiStoragesExportLocalfilesRead Get /api/storages/export/localfiles/{id} Get export storage
StorageLocalApi ApiStoragesExportLocalfilesSyncCreate Post /api/storages/export/localfiles/{id}/sync Sync export storage
StorageLocalApi ApiStoragesExportLocalfilesValidateCreate Post /api/storages/export/localfiles/validate Validate export storage
StorageLocalApi ApiStoragesLocalfilesCreate Post /api/storages/localfiles/ Create import storage
StorageLocalApi ApiStoragesLocalfilesDelete Delete /api/storages/localfiles/{id} Delete import storage
StorageLocalApi ApiStoragesLocalfilesList Get /api/storages/localfiles/ Get all import storage
StorageLocalApi ApiStoragesLocalfilesPartialUpdate Patch /api/storages/localfiles/{id} Update import storage
StorageLocalApi ApiStoragesLocalfilesRead Get /api/storages/localfiles/{id} Get import storage
StorageLocalApi ApiStoragesLocalfilesSyncCreate Post /api/storages/localfiles/{id}/sync Sync import storage
StorageLocalApi ApiStoragesLocalfilesValidateCreate Post /api/storages/localfiles/validate Validate import storage
StorageRedisApi ApiStoragesExportRedisCreate Post /api/storages/export/redis Create export storage
StorageRedisApi ApiStoragesExportRedisDelete Delete /api/storages/export/redis/{id} Delete export storage
StorageRedisApi ApiStoragesExportRedisList Get /api/storages/export/redis Get all export storage
StorageRedisApi ApiStoragesExportRedisPartialUpdate Patch /api/storages/export/redis/{id} Update export storage
StorageRedisApi ApiStoragesExportRedisRead Get /api/storages/export/redis/{id} Get export storage
StorageRedisApi ApiStoragesExportRedisSyncCreate Post /api/storages/export/redis/{id}/sync Sync export storage
StorageRedisApi ApiStoragesExportRedisValidateCreate Post /api/storages/export/redis/validate Validate export storage
StorageRedisApi ApiStoragesRedisCreate Post /api/storages/redis/ Create import storage
StorageRedisApi ApiStoragesRedisDelete Delete /api/storages/redis/{id} Delete import storage
StorageRedisApi ApiStoragesRedisList Get /api/storages/redis/ Get all import storage
StorageRedisApi ApiStoragesRedisPartialUpdate Patch /api/storages/redis/{id} Update import storage
StorageRedisApi ApiStoragesRedisRead Get /api/storages/redis/{id} Get import storage
StorageRedisApi ApiStoragesRedisSyncCreate Post /api/storages/redis/{id}/sync Sync import storage
StorageRedisApi ApiStoragesRedisValidateCreate Post /api/storages/redis/validate Validate import storage
StorageS3Api ApiStoragesExportS3Create Post /api/storages/export/s3 Create export storage
StorageS3Api ApiStoragesExportS3Delete Delete /api/storages/export/s3/{id} Delete export storage
StorageS3Api ApiStoragesExportS3List Get /api/storages/export/s3 Get all export storage
StorageS3Api ApiStoragesExportS3PartialUpdate Patch /api/storages/export/s3/{id} Update export storage
StorageS3Api ApiStoragesExportS3Read Get /api/storages/export/s3/{id} Get export storage
StorageS3Api ApiStoragesExportS3SyncCreate Post /api/storages/export/s3/{id}/sync Sync export storage
StorageS3Api ApiStoragesExportS3ValidateCreate Post /api/storages/export/s3/validate Validate export storage
StorageS3Api ApiStoragesS3Create Post /api/storages/s3/ Create new storage
StorageS3Api ApiStoragesS3Delete Delete /api/storages/s3/{id} Delete import storage
StorageS3Api ApiStoragesS3List Get /api/storages/s3/ Get import storage
StorageS3Api ApiStoragesS3PartialUpdate Patch /api/storages/s3/{id} Update import storage
StorageS3Api ApiStoragesS3Read Get /api/storages/s3/{id} Get import storage
StorageS3Api ApiStoragesS3SyncCreate Post /api/storages/s3/{id}/sync Sync import storage
StorageS3Api ApiStoragesS3ValidateCreate Post /api/storages/s3/validate Validate import storage
TasksApi ApiTasksCreate Post /api/tasks/ Create task
TasksApi ApiTasksDelete Delete /api/tasks/{id}/ Delete task
TasksApi ApiTasksList Get /api/tasks/ Get tasks list
TasksApi ApiTasksPartialUpdate Patch /api/tasks/{id}/ Update task
TasksApi ApiTasksRead Get /api/tasks/{id}/ Get task
UsersApi ApiCurrentUserResetTokenCreate Post /api/current-user/reset-token/ Reset user token
UsersApi ApiCurrentUserTokenList Get /api/current-user/token Get user token
UsersApi ApiCurrentUserWhoamiRead Get /api/current-user/whoami Retrieve my user
UsersApi ApiUsersCreate Post /api/users/ Create new user
UsersApi ApiUsersDelete Delete /api/users/{id}/ Delete user
UsersApi ApiUsersList Get /api/users/ List users
UsersApi ApiUsersPartialUpdate Patch /api/users/{id}/ Update user details
UsersApi ApiUsersRead Get /api/users/{id}/ Get user info
WebhooksApi ApiWebhooksCreate Post /api/webhooks/ Create a webhook
WebhooksApi ApiWebhooksDelete Delete /api/webhooks/{id}/ Delete webhook info
WebhooksApi ApiWebhooksInfoList Get /api/webhooks/info/ Get all webhook actions
WebhooksApi ApiWebhooksList Get /api/webhooks/ List all webhooks
WebhooksApi ApiWebhooksPartialUpdate Patch /api/webhooks/{id}/ Update webhook info
WebhooksApi ApiWebhooksRead Get /api/webhooks/{id}/ Get webhook info
WebhooksApi ApiWebhooksUpdate Put /api/webhooks/{id}/ Save webhook info

Documentation For Models

Documentation For Authorization

Token

  • Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	AnnotationsApi *AnnotationsApiService

	DataManagerApi *DataManagerApiService

	ExportApi *ExportApiService

	ImportApi *ImportApiService

	InvitesApi *InvitesApiService

	LabelsApi *LabelsApiService

	MachineLearningApi *MachineLearningApiService

	OrganizationsApi *OrganizationsApiService

	PredictionsApi *PredictionsApiService

	ProjectsApi *ProjectsApiService

	StorageApi *StorageApiService

	StorageAzureApi *StorageAzureApiService

	StorageGCSApi *StorageGCSApiService

	StorageLocalApi *StorageLocalApiService

	StorageRedisApi *StorageRedisApiService

	StorageS3Api *StorageS3ApiService

	TasksApi *TasksApiService

	UsersApi *UsersApiService

	WebhooksApi *WebhooksApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Label Studio API API vv1.11.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type Annotation 

type Annotation struct {
	Id int32 `json:"id,omitempty"`
	// Username string
	CreatedUsername string `json:"created_username,omitempty"`
	// Time delta from creation time
	CreatedAgo  string `json:"created_ago,omitempty"`
	CompletedBy int32  `json:"completed_by,omitempty"`
	UniqueId    string `json:"unique_id,omitempty"`
	// The main value of annotator work - labeling result in JSON format
	Result interface{} `json:"result,omitempty"`
	// User skipped the task
	WasCancelled bool `json:"was_cancelled,omitempty"`
	// This annotation is a Ground Truth (ground_truth)
	GroundTruth bool `json:"ground_truth,omitempty"`
	// Creation time
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Last updated time
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// Draft creation time
	DraftCreatedAt time.Time `json:"draft_created_at,omitempty"`
	// How much time it took to annotate the task
	LeadTime float32 `json:"lead_time,omitempty"`
	// Original annotation ID that was at the import step or NULL if this annotation wasn't imported
	ImportId int32 `json:"import_id,omitempty"`
	// Action which was performed in the last annotation history item
	LastAction string `json:"last_action,omitempty"`
	// Corresponding task for this annotation
	Task int32 `json:"task,omitempty"`
	// Project ID for this annotation
	Project int32 `json:"project,omitempty"`
	// Last user who updated this annotation
	UpdatedBy int32 `json:"updated_by,omitempty"`
	// Points to the prediction from which this annotation was created
	ParentPrediction int32 `json:"parent_prediction,omitempty"`
	// Points to the parent annotation from which this annotation was created
	ParentAnnotation int32 `json:"parent_annotation,omitempty"`
	// User who created the last annotation history item
	LastCreatedBy int32 `json:"last_created_by,omitempty"`
}

type AnnotationFilterOptions 

type AnnotationFilterOptions struct {
	// Include not skipped and not ground truth annotations
	Usual bool `json:"usual,omitempty"`
	// Include ground truth annotations
	GroundTruth bool `json:"ground_truth,omitempty"`
	// Include skipped annotations
	Skipped bool `json:"skipped,omitempty"`
}

type AnnotationsApiService 

type AnnotationsApiService service

func (*AnnotationsApiService) ApiAnnotationsDelete 

func (a *AnnotationsApiService) ApiAnnotationsDelete(ctx context.Context, id int32) (*http.Response, error)

AnnotationsApiService Delete annotation Delete an annotation. This action can't be undone!

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this annotation.

func (*AnnotationsApiService) ApiAnnotationsPartialUpdate 

func (a *AnnotationsApiService) ApiAnnotationsPartialUpdate(ctx context.Context, id int32, data Annotation) (Annotation, *http.Response, error)

AnnotationsApiService Update annotation Update existing attributes on an annotation.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this annotation.
  • @param data

@return Annotation

func (*AnnotationsApiService) ApiAnnotationsRead 

func (a *AnnotationsApiService) ApiAnnotationsRead(ctx context.Context, id int32) (Annotation, *http.Response, error)

AnnotationsApiService Get annotation by its ID Retrieve a specific annotation for a task using the annotation result ID.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this annotation.

@return Annotation

func (*AnnotationsApiService) ApiTasksAnnotationsCreate 

func (a *AnnotationsApiService) ApiTasksAnnotationsCreate(ctx context.Context, data Annotation, id int32) (Annotation, *http.Response, error)

AnnotationsApiService Create annotation 

Add annotations to a task like an annotator does. The content of the result field depends on your  labeling configuration. For example, send the following data as part of your POST  request to send an empty annotation with the ID of the user who completed the task:  ```json { \"result\": {}, \"was_cancelled\": true, \"ground_truth\": true, \"lead_time\": 0, \"task\": 0 \"completed_by\": 123 }  ```
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param data
* @param id Task ID

@return Annotation

func (*AnnotationsApiService) ApiTasksAnnotationsList 

func (a *AnnotationsApiService) ApiTasksAnnotationsList(ctx context.Context, id int32) ([]Annotation, *http.Response, error)

AnnotationsApiService Get all task annotations List all annotations for a task.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id Task ID

@return []Annotation

type AzureBlobExportStorage 

type AzureBlobExportStorage struct {
	Id             int32  `json:"id,omitempty"`
	Type_          string `json:"type,omitempty"`
	Synchronizable bool   `json:"synchronizable,omitempty"`
	// Azure blob container
	Container string `json:"container,omitempty"`
	// Azure blob prefix name
	Prefix string `json:"prefix,omitempty"`
	// Cloud storage regex for filtering objects
	RegexFilter string `json:"regex_filter,omitempty"`
	// Interpret objects as BLOBs and generate URLs
	UseBlobUrls bool `json:"use_blob_urls,omitempty"`
	// Azure Blob account name
	AccountName string `json:"account_name,omitempty"`
	// Azure Blob account key
	AccountKey string `json:"account_key,omitempty"`
	// Last sync finished time
	LastSync time.Time `json:"last_sync,omitempty"`
	// Count of tasks synced last time
	LastSyncCount int32 `json:"last_sync_count,omitempty"`
	// Last sync job ID
	LastSyncJob string `json:"last_sync_job,omitempty"`
	Status      string `json:"status,omitempty"`
	// Traceback report for the last failed sync
	Traceback string `json:"traceback,omitempty"`
	// Meta and debug information about storage processes
	Meta interface{} `json:"meta,omitempty"`
	// Cloud storage title
	Title string `json:"title,omitempty"`
	// Cloud storage description
	Description string `json:"description,omitempty"`
	// Creation time
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Deletion from storage enabled
	CanDeleteObjects bool `json:"can_delete_objects,omitempty"`
	// A unique integer value identifying this project.
	Project int32 `json:"project"`
}

type AzureBlobImportStorage 

type AzureBlobImportStorage struct {
	Id             int32  `json:"id,omitempty"`
	Type_          string `json:"type,omitempty"`
	Synchronizable bool   `json:"synchronizable,omitempty"`
	Presign        bool   `json:"presign,omitempty"`
	// Azure blob container
	Container string `json:"container,omitempty"`
	// Azure blob prefix name
	Prefix string `json:"prefix,omitempty"`
	// Cloud storage regex for filtering objects
	RegexFilter string `json:"regex_filter,omitempty"`
	// Interpret objects as BLOBs and generate URLs
	UseBlobUrls bool `json:"use_blob_urls,omitempty"`
	// Azure Blob account name
	AccountName string `json:"account_name,omitempty"`
	// Azure Blob account key
	AccountKey string `json:"account_key,omitempty"`
	// Last sync finished time
	LastSync time.Time `json:"last_sync,omitempty"`
	// Count of tasks synced last time
	LastSyncCount int32 `json:"last_sync_count,omitempty"`
	// Last sync job ID
	LastSyncJob string `json:"last_sync_job,omitempty"`
	Status      string `json:"status,omitempty"`
	// Traceback report for the last failed sync
	Traceback string `json:"traceback,omitempty"`
	// Meta and debug information about storage processes
	Meta interface{} `json:"meta,omitempty"`
	// Cloud storage title
	Title string `json:"title,omitempty"`
	// Cloud storage description
	Description string `json:"description,omitempty"`
	// Creation time
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Presigned URLs TTL (in minutes)
	PresignTtl int32 `json:"presign_ttl,omitempty"`
	// A unique integer value identifying this project.
	Project int32 `json:"project"`
}

type BaseTask 

type BaseTask struct {
	Id int32 `json:"id,omitempty"`
	// User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI.
	Data interface{} `json:"data"`
	// Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps.
	Meta interface{} `json:"meta,omitempty"`
	// Time a task was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Last time a task was updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project
	IsLabeled bool `json:"is_labeled,omitempty"`
	// Number of distinct annotators that processed the current task
	Overlap int32 `json:"overlap,omitempty"`
	// Internal task ID in the project, starts with 1
	InnerId int32 `json:"inner_id,omitempty"`
	// Number of total annotations for the current task except cancelled annotations
	TotalAnnotations int32 `json:"total_annotations,omitempty"`
	// Number of total cancelled annotations for the current task
	CancelledAnnotations int32 `json:"cancelled_annotations,omitempty"`
	// Number of total predictions for the current task
	TotalPredictions int32 `json:"total_predictions,omitempty"`
	// Number of comments in the task including all annotations
	CommentCount int32 `json:"comment_count,omitempty"`
	// Number of unresolved comments in the task including all annotations
	UnresolvedCommentCount int32 `json:"unresolved_comment_count,omitempty"`
	// When the last comment was updated
	LastCommentUpdatedAt time.Time `json:"last_comment_updated_at,omitempty"`
	// Project ID for this task
	Project int32 `json:"project,omitempty"`
	// Last annotator or reviewer who updated this task
	UpdatedBy int32 `json:"updated_by,omitempty"`
	// Uploaded file used as data source for this task
	FileUpload int32 `json:"file_upload,omitempty"`
	// Users who wrote comments
	CommentAuthors []int32 `json:"comment_authors,omitempty"`
}

type BaseUser 

type BaseUser struct {
	Id                 int32     `json:"id,omitempty"`
	FirstName          string    `json:"first_name,omitempty"`
	LastName           string    `json:"last_name,omitempty"`
	Username           string    `json:"username"`
	Email              string    `json:"email,omitempty"`
	LastActivity       time.Time `json:"last_activity,omitempty"`
	Avatar             string    `json:"avatar,omitempty"`
	Initials           string    `json:"initials,omitempty"`
	Phone              string    `json:"phone,omitempty"`
	ActiveOrganization int32     `json:"active_organization,omitempty"`
	// Allow sending newsletters to user
	AllowNewsletters bool `json:"allow_newsletters,omitempty"`
}

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type ConvertedFormat 

type ConvertedFormat struct {
	Id         int32  `json:"id,omitempty"`
	Status     string `json:"status,omitempty"`
	ExportType string `json:"export_type"`
	// Traceback report in case of errors
	Traceback string `json:"traceback,omitempty"`
}

type Data 

type Data struct {
	// Project ID
	Project int32 `json:"project,omitempty"`
	// ML backend URL
	Url string `json:"url,omitempty"`
}

type Data1 

type Data1 struct {
	// Whether to include ground truth annotations in training
	UseGroundTruth bool `json:"use_ground_truth,omitempty"`
}

type DataManagerApiApiDmViewsListOpts 

type DataManagerApiApiDmViewsListOpts struct {
	Project optional.Int32
}

type DataManagerApiService 

type DataManagerApiService service

func (*DataManagerApiService) ApiDmActionsCreate 

func (a *DataManagerApiService) ApiDmActionsCreate(ctx context.Context) (*http.Response, error)

DataManagerApiService Post actions Perform an action with the selected items from a specific view.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*DataManagerApiService) ApiDmActionsList 

func (a *DataManagerApiService) ApiDmActionsList(ctx context.Context) (*http.Response, error)

DataManagerApiService Get actions Retrieve all the registered actions with descriptions that data manager can use.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*DataManagerApiService) ApiDmColumnsList 

func (a *DataManagerApiService) ApiDmColumnsList(ctx context.Context) (*http.Response, error)

DataManagerApiService Get data manager columns Retrieve the data manager columns available for the tasks in a specific project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*DataManagerApiService) ApiDmProjectList 

func (a *DataManagerApiService) ApiDmProjectList(ctx context.Context) (*http.Response, error)

DataManagerApiService Get project state Retrieve the project state for the data manager.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*DataManagerApiService) ApiDmViewsCreate 

func (a *DataManagerApiService) ApiDmViewsCreate(ctx context.Context, data View) (View, *http.Response, error)

DataManagerApiService Create view Create a view for a specific project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return View

func (*DataManagerApiService) ApiDmViewsDelete 

func (a *DataManagerApiService) ApiDmViewsDelete(ctx context.Context, id string) (*http.Response, error)

DataManagerApiService Delete view Delete a specific view by ID.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id View ID

func (*DataManagerApiService) ApiDmViewsList 

func (a *DataManagerApiService) ApiDmViewsList(ctx context.Context, localVarOptionals *DataManagerApiApiDmViewsListOpts) ([]View, *http.Response, error)

func (*DataManagerApiService) ApiDmViewsPartialUpdate 

func (a *DataManagerApiService) ApiDmViewsPartialUpdate(ctx context.Context, data View, id string) (View, *http.Response, error)

DataManagerApiService Update view Update view data with additional filters and other information for a specific project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data
  • @param id View ID

@return View

func (*DataManagerApiService) ApiDmViewsRead 

func (a *DataManagerApiService) ApiDmViewsRead(ctx context.Context, id string) (View, *http.Response, error)

DataManagerApiService Get view details Get the details about a specific view in the data manager

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id View ID

@return View

func (*DataManagerApiService) ApiDmViewsReset 

func (a *DataManagerApiService) ApiDmViewsReset(ctx context.Context, data ViewReset) (*http.Response, error)

DataManagerApiService Reset project views Reset all views for a specific project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

func (*DataManagerApiService) ApiDmViewsUpdate 

func (a *DataManagerApiService) ApiDmViewsUpdate(ctx context.Context, data View, id string) (View, *http.Response, error)

DataManagerApiService Put view Overwrite view data with updated filters and other information for a specific project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data
  • @param id View ID

@return View

type DataManagerTaskSerializer 

type DataManagerTaskSerializer struct {
	Id                       int32        `json:"id,omitempty"`
	Predictions              string       `json:"predictions,omitempty"`
	Annotations              []Annotation `json:"annotations,omitempty"`
	Drafts                   string       `json:"drafts,omitempty"`
	Annotators               string       `json:"annotators,omitempty"`
	InnerId                  int32        `json:"inner_id,omitempty"`
	CancelledAnnotations     int32        `json:"cancelled_annotations,omitempty"`
	TotalAnnotations         int32        `json:"total_annotations,omitempty"`
	TotalPredictions         int32        `json:"total_predictions,omitempty"`
	CompletedAt              time.Time    `json:"completed_at,omitempty"`
	AnnotationsResults       string       `json:"annotations_results,omitempty"`
	PredictionsResults       string       `json:"predictions_results,omitempty"`
	PredictionsScore         float32      `json:"predictions_score,omitempty"`
	FileUpload               string       `json:"file_upload,omitempty"`
	StorageFilename          string       `json:"storage_filename,omitempty"`
	AnnotationsIds           string       `json:"annotations_ids,omitempty"`
	PredictionsModelVersions string       `json:"predictions_model_versions,omitempty"`
	AvgLeadTime              float32      `json:"avg_lead_time,omitempty"`
	DraftExists              bool         `json:"draft_exists,omitempty"`
	UpdatedBy                string       `json:"updated_by,omitempty"`
	// User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI.
	Data interface{} `json:"data"`
	// Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps.
	Meta interface{} `json:"meta,omitempty"`
	// Time a task was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Last time a task was updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project
	IsLabeled bool `json:"is_labeled,omitempty"`
	// Number of distinct annotators that processed the current task
	Overlap int32 `json:"overlap,omitempty"`
	// Number of comments in the task including all annotations
	CommentCount int32 `json:"comment_count,omitempty"`
	// Number of unresolved comments in the task including all annotations
	UnresolvedCommentCount int32 `json:"unresolved_comment_count,omitempty"`
	// When the last comment was updated
	LastCommentUpdatedAt time.Time `json:"last_comment_updated_at,omitempty"`
	// Project ID for this task
	Project int32 `json:"project,omitempty"`
	// Users who wrote comments
	CommentAuthors []int32 `json:"comment_authors,omitempty"`
}

type Export 

type Export struct {
	Title     string      `json:"title,omitempty"`
	Id        int32       `json:"id,omitempty"`
	CreatedBy *UserSimple `json:"created_by,omitempty"`
	// Creation time
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Complete or fail time
	FinishedAt       time.Time         `json:"finished_at,omitempty"`
	Status           string            `json:"status,omitempty"`
	Md5              string            `json:"md5,omitempty"`
	Counters         interface{}       `json:"counters,omitempty"`
	ConvertedFormats []ConvertedFormat `json:"converted_formats,omitempty"`
}

type ExportApiApiProjectsExportReadOpts 

type ExportApiApiProjectsExportReadOpts struct {
	ExportType        optional.String
	DownloadAllTasks  optional.String
	DownloadResources optional.Bool
	Ids               optional.Interface
}

type ExportApiApiProjectsExportsDownloadReadOpts 

type ExportApiApiProjectsExportsDownloadReadOpts struct {
	ExportType optional.String
}

type ExportApiService 

type ExportApiService service

func (*ExportApiService) ApiProjectsExportFormatsRead 

func (a *ExportApiService) ApiProjectsExportFormatsRead(ctx context.Context, id int32) ([]string, *http.Response, error)

ExportApiService Get export formats Retrieve the available export formats for the current project by ID.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this project.

@return []string

func (*ExportApiService) ApiProjectsExportRead 

func (a *ExportApiService) ApiProjectsExportRead(ctx context.Context, id int32, localVarOptionals *ExportApiApiProjectsExportReadOpts) (*os.File, *http.Response, error)

func (*ExportApiService) ApiProjectsExportsConvertCreate 

func (a *ExportApiService) ApiProjectsExportsConvertCreate(ctx context.Context, data ExportConvert, id int32, exportPk string) (ExportConvert, *http.Response, error)

ExportApiService Export conversion 

Convert export snapshot to selected format
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param data
* @param id A unique integer value identifying this project.
* @param exportPk Primary key identifying the export file.

@return ExportConvert

func (*ExportApiService) ApiProjectsExportsCreate 

func (a *ExportApiService) ApiProjectsExportsCreate(ctx context.Context, data ExportCreate, id int32) (ExportCreate, *http.Response, error)

ExportApiService Create new export snapshot 

Create a new export request to start a background task and generate an export file for a specific project by ID.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param data
* @param id A unique integer value identifying this project.

@return ExportCreate

func (*ExportApiService) ApiProjectsExportsDelete 

func (a *ExportApiService) ApiProjectsExportsDelete(ctx context.Context, id int32, exportPk string) (*http.Response, error)

ExportApiService Delete export snapshot 

Delete an export file by specified export ID.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param id A unique integer value identifying this project.
* @param exportPk Primary key identifying the export file.

func (*ExportApiService) ApiProjectsExportsDownloadRead 

func (a *ExportApiService) ApiProjectsExportsDownloadRead(ctx context.Context, id int32, exportPk string, localVarOptionals *ExportApiApiProjectsExportsDownloadReadOpts) (*http.Response, error)

func (*ExportApiService) ApiProjectsExportsList 

func (a *ExportApiService) ApiProjectsExportsList(ctx context.Context, id int32) ([]Export, *http.Response, error)

ExportApiService List all export snapshots 

Returns a list of exported files for a specific project by ID.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param id A unique integer value identifying this project.

@return []Export

func (*ExportApiService) ApiProjectsExportsRead 

func (a *ExportApiService) ApiProjectsExportsRead(ctx context.Context, id int32, exportPk string) (Export, *http.Response, error)

ExportApiService Get export snapshot by ID 

Retrieve information about an export file by export ID for a specific project.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param id A unique integer value identifying this project.
* @param exportPk Primary key identifying the export file.

@return Export

type ExportConvert 

type ExportConvert struct {
	// Export file format.
	ExportType string `json:"export_type"`
}

type ExportCreate 

type ExportCreate struct {
	Title     string      `json:"title,omitempty"`
	Id        int32       `json:"id,omitempty"`
	CreatedBy *UserSimple `json:"created_by,omitempty"`
	// Creation time
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Complete or fail time
	FinishedAt              time.Time                `json:"finished_at,omitempty"`
	Status                  string                   `json:"status,omitempty"`
	Md5                     string                   `json:"md5,omitempty"`
	Counters                interface{}              `json:"counters,omitempty"`
	ConvertedFormats        []ConvertedFormat        `json:"converted_formats,omitempty"`
	TaskFilterOptions       *TaskFilterOptions       `json:"task_filter_options,omitempty"`
	AnnotationFilterOptions *AnnotationFilterOptions `json:"annotation_filter_options,omitempty"`
	SerializationOptions    *SerializationOptions    `json:"serialization_options,omitempty"`
}

type FileUpload 

type FileUpload struct {
	Id   int32  `json:"id,omitempty"`
	File string `json:"file,omitempty"`
}

type Filter 

type Filter struct {
	Id int32 `json:"id,omitempty"`
	// To keep filter order
	Index int32 `json:"index,omitempty"`
	// Field name
	Column string `json:"column"`
	// Field type
	Type_ string `json:"type"`
	// Filter operator
	Operator string `json:"operator"`
	// Filter value
	Value interface{} `json:"value,omitempty"`
}

type FilterGroup 

type FilterGroup struct {
	Id      int32    `json:"id,omitempty"`
	Filters []Filter `json:"filters"`
	// Type of conjunction
	Conjunction string `json:"conjunction"`
}

type GcsExportStorage 

type GcsExportStorage struct {
	Id             int32  `json:"id,omitempty"`
	Type_          string `json:"type,omitempty"`
	Synchronizable bool   `json:"synchronizable,omitempty"`
	// GCS bucket name
	Bucket string `json:"bucket,omitempty"`
	// GCS bucket prefix
	Prefix string `json:"prefix,omitempty"`
	// Cloud storage regex for filtering objects
	RegexFilter string `json:"regex_filter,omitempty"`
	// Interpret objects as BLOBs and generate URLs
	UseBlobUrls bool `json:"use_blob_urls,omitempty"`
	// The content of GOOGLE_APPLICATION_CREDENTIALS json file
	GoogleApplicationCredentials string `json:"google_application_credentials,omitempty"`
	// Google project ID
	GoogleProjectId string `json:"google_project_id,omitempty"`
	// Last sync finished time
	LastSync time.Time `json:"last_sync,omitempty"`
	// Count of tasks synced last time
	LastSyncCount int32 `json:"last_sync_count,omitempty"`
	// Last sync job ID
	LastSyncJob string `json:"last_sync_job,omitempty"`
	Status      string `json:"status,omitempty"`
	// Traceback report for the last failed sync
	Traceback string `json:"traceback,omitempty"`
	// Meta and debug information about storage processes
	Meta interface{} `json:"meta,omitempty"`
	// Cloud storage title
	Title string `json:"title,omitempty"`
	// Cloud storage description
	Description string `json:"description,omitempty"`
	// Creation time
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Deletion from storage enabled
	CanDeleteObjects bool `json:"can_delete_objects,omitempty"`
	// A unique integer value identifying this project.
	Project int32 `json:"project"`
}

type GcsImportStorage 

type GcsImportStorage struct {
	Id             int32  `json:"id,omitempty"`
	Type_          string `json:"type,omitempty"`
	Synchronizable bool   `json:"synchronizable,omitempty"`
	Presign        bool   `json:"presign,omitempty"`
	// GCS bucket name
	Bucket string `json:"bucket,omitempty"`
	// GCS bucket prefix
	Prefix string `json:"prefix,omitempty"`
	// Cloud storage regex for filtering objects
	RegexFilter string `json:"regex_filter,omitempty"`
	// Interpret objects as BLOBs and generate URLs
	UseBlobUrls bool `json:"use_blob_urls,omitempty"`
	// The content of GOOGLE_APPLICATION_CREDENTIALS json file
	GoogleApplicationCredentials string `json:"google_application_credentials,omitempty"`
	// Google project ID
	GoogleProjectId string `json:"google_project_id,omitempty"`
	// Last sync finished time
	LastSync time.Time `json:"last_sync,omitempty"`
	// Count of tasks synced last time
	LastSyncCount int32 `json:"last_sync_count,omitempty"`
	// Last sync job ID
	LastSyncJob string `json:"last_sync_job,omitempty"`
	Status      string `json:"status,omitempty"`
	// Traceback report for the last failed sync
	Traceback string `json:"traceback,omitempty"`
	// Meta and debug information about storage processes
	Meta interface{} `json:"meta,omitempty"`
	// Cloud storage title
	Title string `json:"title,omitempty"`
	// Cloud storage description
	Description string `json:"description,omitempty"`
	// Creation time
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Presigned URLs TTL (in minutes)
	PresignTtl int32 `json:"presign_ttl,omitempty"`
	// A unique integer value identifying this project.
	Project int32 `json:"project"`
}

type GenericSwaggerError 

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type ImportApi 

type ImportApi struct {
	Id          int32        `json:"id,omitempty"`
	Annotations []Annotation `json:"annotations,omitempty"`
	Predictions []Prediction `json:"predictions,omitempty"`
	// User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI.
	Data interface{} `json:"data"`
	// Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps.
	Meta interface{} `json:"meta,omitempty"`
	// Time a task was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Last time a task was updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// Number of distinct annotators that processed the current task
	Overlap int32 `json:"overlap,omitempty"`
	// Internal task ID in the project, starts with 1
	InnerId int32 `json:"inner_id,omitempty"`
	// Number of total annotations for the current task except cancelled annotations
	TotalAnnotations int32 `json:"total_annotations,omitempty"`
	// Number of total cancelled annotations for the current task
	CancelledAnnotations int32 `json:"cancelled_annotations,omitempty"`
	// Number of total predictions for the current task
	TotalPredictions int32 `json:"total_predictions,omitempty"`
	// Number of comments in the task including all annotations
	CommentCount int32 `json:"comment_count,omitempty"`
	// Number of unresolved comments in the task including all annotations
	UnresolvedCommentCount int32 `json:"unresolved_comment_count,omitempty"`
	// When the last comment was updated
	LastCommentUpdatedAt time.Time `json:"last_comment_updated_at,omitempty"`
	// Last annotator or reviewer who updated this task
	UpdatedBy int32 `json:"updated_by,omitempty"`
	// Uploaded file used as data source for this task
	FileUpload int32 `json:"file_upload,omitempty"`
	// Users who wrote comments
	CommentAuthors []int32 `json:"comment_authors,omitempty"`
}

type ImportApiApiProjectsFileUploadsListOpts 

type ImportApiApiProjectsFileUploadsListOpts struct {
	All optional.Bool
	Ids optional.Interface
}

type ImportApiService 

type ImportApiService service

func (*ImportApiService) ApiImportFileUploadDelete 

func (a *ImportApiService) ApiImportFileUploadDelete(ctx context.Context, id int32) (*http.Response, error)

ImportApiService Delete file upload Delete a specific uploaded file.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this file upload.

func (*ImportApiService) ApiImportFileUploadPartialUpdate 

func (a *ImportApiService) ApiImportFileUploadPartialUpdate(ctx context.Context, id int32, data FileUpload) (FileUpload, *http.Response, error)

ImportApiService Update file upload Update a specific uploaded file.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this file upload.
  • @param data

@return FileUpload

func (*ImportApiService) ApiImportFileUploadRead 

func (a *ImportApiService) ApiImportFileUploadRead(ctx context.Context, id int32) (FileUpload, *http.Response, error)

ImportApiService Get file upload Retrieve details about a specific uploaded file.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this file upload.

@return FileUpload

func (*ImportApiService) ApiProjectsFileUploadsDelete 

func (a *ImportApiService) ApiProjectsFileUploadsDelete(ctx context.Context, id int32) (*http.Response, error)

ImportApiService Delete files 

Delete uploaded files for a specific project.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param id A unique integer value identifying this file upload.

func (*ImportApiService) ApiProjectsFileUploadsList 

func (a *ImportApiService) ApiProjectsFileUploadsList(ctx context.Context, id int32, localVarOptionals *ImportApiApiProjectsFileUploadsListOpts) ([]FileUpload, *http.Response, error)

func (*ImportApiService) ApiProjectsImportCreate 

func (a *ImportApiService) ApiProjectsImportCreate(ctx context.Context, data ImportApi, id int32) (TaskCreationResponse, *http.Response, error)

ImportApiService Import tasks 

Import data as labeling tasks in bulk using this API endpoint. You can use this API endpoint to import multiple tasks. One POST request is limited at 250K tasks and 200 MB.  **Note:** Imported data is verified against a project *label_config* and must include all variables that were used in the *label_config*. For example, if the label configuration has a *$text* variable, then each item in a data object must include a \"text\" field. <br>  ## POST requests <hr style=\"opacity:0.3\">  There are three possible ways to import tasks with this endpoint:  ### 1\\. **POST with data** Send JSON tasks as POST data. Only JSON is supported for POSTing files directly. Update this example to specify your authorization token and Label Studio instance host, then run the following from the command line.  ```bash curl -H 'Content-Type: application/json' -H 'Authorization: Token abc123' \\ -X POST 'https://localhost:8080/api/projects/1/import' --data '[{\"text\": \"Some text 1\"}, {\"text\": \"Some text 2\"}]' ```  ### 2\\. **POST with files** Send tasks as files. You can attach multiple files with different names.  - **JSON**: text files in JavaScript object notation format - **CSV**: text files with tables in Comma Separated Values format - **TSV**: text files with tables in Tab Separated Value format - **TXT**: simple text files are similar to CSV with one column and no header, supported for projects with one source only  Update this example to specify your authorization token, Label Studio instance host, and file name and path, then run the following from the command line:  ```bash curl -H 'Authorization: Token abc123' \\ -X POST 'https://localhost:8080/api/projects/1/import' -F ‘file=@path/to/my_file.csv’ ```  ### 3\\. **POST with URL** You can also provide a URL to a file with labeling tasks. Supported file formats are the same as in option 2.  ```bash curl -H 'Content-Type: application/json' -H 'Authorization: Token abc123' \\ -X POST 'https://localhost:8080/api/projects/1/import' \\ --data '[{\"url\": \"http://example.com/test1.csv\"}, {\"url\": \"http://example.com/test2.csv\"}]' ```  <br>
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param data
* @param id A unique integer value identifying this project.

@return TaskCreationResponse

type InlineResponse200 

type InlineResponse200 struct {
	Count    int32       `json:"count"`
	Next     string      `json:"next,omitempty"`
	Previous string      `json:"previous,omitempty"`
	Results  []LabelLink `json:"results"`
}

type InlineResponse2001 

type InlineResponse2001 struct {
	Count    int32   `json:"count"`
	Next     string  `json:"next,omitempty"`
	Previous string  `json:"previous,omitempty"`
	Results  []Label `json:"results"`
}

type InlineResponse2002 

type InlineResponse2002 struct {
	Count    int32                    `json:"count"`
	Next     string                   `json:"next,omitempty"`
	Previous string                   `json:"previous,omitempty"`
	Results  []OrganizationMemberUser `json:"results"`
}

type InlineResponse2003 

type InlineResponse2003 struct {
	Count    int32     `json:"count"`
	Next     string    `json:"next,omitempty"`
	Previous string    `json:"previous,omitempty"`
	Results  []Project `json:"results"`
}

type InlineResponse201 

type InlineResponse201 struct {
	// Token
	Token string `json:"token,omitempty"`
}

User token

type InvitesApiService 

type InvitesApiService service

func (*InvitesApiService) ApiInviteRead 

func (a *InvitesApiService) ApiInviteRead(ctx context.Context) (OrganizationInvite, *http.Response, error)

InvitesApiService Get organization invite link Get a link to use to invite a new member to an organization in Label Studio Enterprise.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return OrganizationInvite

func (*InvitesApiService) ApiInviteResetTokenCreate 

func (a *InvitesApiService) ApiInviteResetTokenCreate(ctx context.Context) (OrganizationInvite, *http.Response, error)

InvitesApiService Reset organization token Reset the token used in the invitation link to invite someone to an organization.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return OrganizationInvite

type Label 

type Label struct {
	Id    int32   `json:"id,omitempty"`
	Links []int32 `json:"links,omitempty"`
	// Time of label creation
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Time of label modification
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// Label value
	Value interface{} `json:"value"`
	// Label title
	Title string `json:"title"`
	// Label description
	Description string `json:"description,omitempty"`
	// Status of label
	Approved bool `json:"approved,omitempty"`
	// User who made this label
	CreatedBy int32 `json:"created_by"`
	// User who approved this label
	ApprovedBy   int32   `json:"approved_by,omitempty"`
	Organization int32   `json:"organization"`
	Projects     []int32 `json:"projects,omitempty"`
}

type LabelCreate 

type LabelCreate struct {
	Id           int32  `json:"id,omitempty"`
	CreatedBy    int32  `json:"created_by,omitempty"`
	Organization int32  `json:"organization,omitempty"`
	Project      int32  `json:"project"`
	FromName     string `json:"from_name"`
	// Time of label creation
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Time of label modification
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// Label value
	Value interface{} `json:"value"`
	// Label title
	Title string `json:"title"`
	// Label description
	Description string `json:"description,omitempty"`
	// Status of label
	Approved bool `json:"approved,omitempty"`
	// User who approved this label
	ApprovedBy int32   `json:"approved_by,omitempty"`
	Projects   []int32 `json:"projects,omitempty"`
}
type LabelLink struct {
	Id               int32 `json:"id,omitempty"`
	AnnotationsCount int32 `json:"annotations_count,omitempty"`
	// Tag name
	FromName string `json:"from_name"`
	Project  int32  `json:"project"`
	Label    int32  `json:"label"`
}

type LabelsApiApiLabelLinksListOpts 

type LabelsApiApiLabelLinksListOpts struct {
	Page optional.Int32
}

type LabelsApiApiLabelsListOpts 

type LabelsApiApiLabelsListOpts struct {
	Page optional.Int32
}

type LabelsApiService 

type LabelsApiService service

func (*LabelsApiService) ApiLabelLinksCreate 

func (a *LabelsApiService) ApiLabelLinksCreate(ctx context.Context, data LabelLink) (LabelLink, *http.Response, error)

LabelsApiService Create label links Create label links to link new custom labels to your project labeling configuration.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return LabelLink

func (*LabelsApiService) ApiLabelLinksDelete 

func (a *LabelsApiService) ApiLabelLinksDelete(ctx context.Context, id string) (*http.Response, error)

LabelsApiService Remove label link 

Remove a label link that links custom labels to your project labeling configuration. If you remove a label link, the label stops being available for the project it was linked to. You can add a new label link at any time.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param id

func (a *LabelsApiService) ApiLabelLinksList(ctx context.Context, localVarOptionals *LabelsApiApiLabelLinksListOpts) (InlineResponse200, *http.Response, error)

func (*LabelsApiService) ApiLabelLinksPartialUpdate 

func (a *LabelsApiService) ApiLabelLinksPartialUpdate(ctx context.Context, id string, data LabelLink) (LabelLink, *http.Response, error)

LabelsApiService Update label link 

Update a label link that links custom labels to a project labeling configuration, for example if the fromName,   toName, or name parameters for a tag in the labeling configuration change.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param id
* @param data

@return LabelLink

func (*LabelsApiService) ApiLabelLinksRead 

func (a *LabelsApiService) ApiLabelLinksRead(ctx context.Context, id string) (LabelLink, *http.Response, error)

LabelsApiService Get label link Get label links for a specific project configuration.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return LabelLink

func (*LabelsApiService) ApiLabelsBulkCreate 

func (a *LabelsApiService) ApiLabelsBulkCreate(ctx context.Context) (*http.Response, error)

LabelsApiService Bulk update labels 

If you want to update the labels in saved annotations, use this endpoint.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*LabelsApiService) ApiLabelsCreate 

func (a *LabelsApiService) ApiLabelsCreate(ctx context.Context, data []LabelCreate) ([]LabelCreate, *http.Response, error)

LabelsApiService Create labels Add labels to your project without updating the labeling configuration.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return []LabelCreate

func (*LabelsApiService) ApiLabelsDelete 

func (a *LabelsApiService) ApiLabelsDelete(ctx context.Context, id string) (*http.Response, error)

LabelsApiService Remove labels Remove labels from your project without updating the labeling configuration.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

func (*LabelsApiService) ApiLabelsList 

func (a *LabelsApiService) ApiLabelsList(ctx context.Context, localVarOptionals *LabelsApiApiLabelsListOpts) (InlineResponse2001, *http.Response, error)

func (*LabelsApiService) ApiLabelsPartialUpdate 

func (a *LabelsApiService) ApiLabelsPartialUpdate(ctx context.Context, id string, data Label) (Label, *http.Response, error)

LabelsApiService Update labels Update labels used for your project without updating the labeling configuration.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param data

@return Label

func (*LabelsApiService) ApiLabelsRead 

func (a *LabelsApiService) ApiLabelsRead(ctx context.Context, id string) (Label, *http.Response, error)

LabelsApiService Get label 

Retrieve a specific custom label used for your project by its ID.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param id

@return Label

type LocalFilesExportStorage 

type LocalFilesExportStorage struct {
	Id             int32  `json:"id,omitempty"`
	Type_          string `json:"type,omitempty"`
	Synchronizable bool   `json:"synchronizable,omitempty"`
	// Local path
	Path string `json:"path,omitempty"`
	// Regex for filtering objects
	RegexFilter string `json:"regex_filter,omitempty"`
	// Interpret objects as BLOBs and generate URLs
	UseBlobUrls bool `json:"use_blob_urls,omitempty"`
	// Last sync finished time
	LastSync time.Time `json:"last_sync,omitempty"`
	// Count of tasks synced last time
	LastSyncCount int32 `json:"last_sync_count,omitempty"`
	// Last sync job ID
	LastSyncJob string `json:"last_sync_job,omitempty"`
	Status      string `json:"status,omitempty"`
	// Traceback report for the last failed sync
	Traceback string `json:"traceback,omitempty"`
	// Meta and debug information about storage processes
	Meta interface{} `json:"meta,omitempty"`
	// Cloud storage title
	Title string `json:"title,omitempty"`
	// Cloud storage description
	Description string `json:"description,omitempty"`
	// Creation time
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Deletion from storage enabled
	CanDeleteObjects bool `json:"can_delete_objects,omitempty"`
	// A unique integer value identifying this project.
	Project int32 `json:"project"`
}

type LocalFilesImportStorage 

type LocalFilesImportStorage struct {
	Id             int32  `json:"id,omitempty"`
	Type_          string `json:"type,omitempty"`
	Synchronizable bool   `json:"synchronizable,omitempty"`
	// Local path
	Path string `json:"path,omitempty"`
	// Regex for filtering objects
	RegexFilter string `json:"regex_filter,omitempty"`
	// Interpret objects as BLOBs and generate URLs
	UseBlobUrls bool `json:"use_blob_urls,omitempty"`
	// Last sync finished time
	LastSync time.Time `json:"last_sync,omitempty"`
	// Count of tasks synced last time
	LastSyncCount int32 `json:"last_sync_count,omitempty"`
	// Last sync job ID
	LastSyncJob string `json:"last_sync_job,omitempty"`
	Status      string `json:"status,omitempty"`
	// Traceback report for the last failed sync
	Traceback string `json:"traceback,omitempty"`
	// Meta and debug information about storage processes
	Meta interface{} `json:"meta,omitempty"`
	// Cloud storage title
	Title string `json:"title,omitempty"`
	// Cloud storage description
	Description string `json:"description,omitempty"`
	// Creation time
	CreatedAt time.Time `json:"created_at,omitempty"`
	// A unique integer value identifying this project.
	Project int32 `json:"project"`
}

type MachineLearningApiApiMlListOpts 

type MachineLearningApiApiMlListOpts struct {
	Project optional.Int32
}

type MachineLearningApiService 

type MachineLearningApiService service

func (*MachineLearningApiService) ApiMlCreate 

func (a *MachineLearningApiService) ApiMlCreate(ctx context.Context, data Data) (Data, *http.Response, error)

MachineLearningApiService Add ML Backend 

Add an ML backend to a project using the Label Studio UI or by sending a POST request using the following cURL  command: ```bash curl -X POST -H 'Content-type: application/json' https://localhost:8080/api/ml -H 'Authorization: Token abc123'\\ --data '{\"url\": \"http://localhost:9090\", \"project\": {project_id}}'
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param data

@return Data

func (*MachineLearningApiService) ApiMlDelete 

func (a *MachineLearningApiService) ApiMlDelete(ctx context.Context, id int32) (*http.Response, error)

MachineLearningApiService Remove ML Backend 

Remove an existing ML backend connection by ID. For example, use the following cURL command: ```bash curl -X DELETE https://localhost:8080/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param id A unique integer value identifying this ml backend.

func (*MachineLearningApiService) ApiMlInteractiveAnnotatingCreate 

func (a *MachineLearningApiService) ApiMlInteractiveAnnotatingCreate(ctx context.Context, data MlInteractiveAnnotatingRequest, id int32) (*http.Response, error)

MachineLearningApiService Request Interactive Annotation 

Send a request to the machine learning backend set up to be used for interactive preannotations to retrieve a predicted region based on annotator input.  See [set up machine learning](https://labelstud.io/guide/ml.html#Get-interactive-preannotations) for more.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param data
* @param id A unique integer value identifying this ML backend.

func (*MachineLearningApiService) ApiMlList 

func (a *MachineLearningApiService) ApiMlList(ctx context.Context, localVarOptionals *MachineLearningApiApiMlListOpts) ([]MlBackend, *http.Response, error)

func (*MachineLearningApiService) ApiMlPartialUpdate 

func (a *MachineLearningApiService) ApiMlPartialUpdate(ctx context.Context, id int32, data MlBackend) (MlBackend, *http.Response, error)

MachineLearningApiService Update ML Backend 

Update ML backend parameters using the Label Studio UI or by sending a PATCH request using the following cURL command: ```bash curl -X PATCH -H 'Content-type: application/json' https://localhost:8080/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'\\ --data '{\"url\": \"http://localhost:9091\"}'
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param id A unique integer value identifying this ml backend.
* @param data

@return MlBackend

func (*MachineLearningApiService) ApiMlRead 

func (a *MachineLearningApiService) ApiMlRead(ctx context.Context, id int32) (MlBackend, *http.Response, error)

MachineLearningApiService Get ML Backend 

Get details about a specific ML backend connection by ID. For example, make a GET request using the following cURL command: ```bash curl https://localhost:8080/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param id A unique integer value identifying this ml backend.

@return MlBackend

func (*MachineLearningApiService) ApiMlTrainCreate 

func (a *MachineLearningApiService) ApiMlTrainCreate(ctx context.Context, data Data1, id int32) (*http.Response, error)

MachineLearningApiService Train 

After you add an ML backend, call this API with the ML backend ID to start training with  already-labeled tasks.   Get the ML backend ID by [listing the ML backends for a project](https://labelstud.io/api/#operation/api_ml_list).
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param data
* @param id A unique integer value identifying this ML backend.

func (*MachineLearningApiService) ApiMlVersionsRead 

func (a *MachineLearningApiService) ApiMlVersionsRead(ctx context.Context, id string) (*http.Response, error)

MachineLearningApiService Get model versions Get available versions of the model.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

type MlBackend 

type MlBackend struct {
	Id    int32  `json:"id,omitempty"`
	State string `json:"state,omitempty"`
	// Used to interactively annotate tasks. If true, model returns one list with results
	IsInteractive bool `json:"is_interactive,omitempty"`
	// URL for the machine learning model server
	Url string `json:"url"`
	// Error message in error state
	ErrorMessage string `json:"error_message,omitempty"`
	// Name of the machine learning backend
	Title string `json:"title,omitempty"`
	// Description for the machine learning backend
	Description string `json:"description,omitempty"`
	// Current model version associated with this machine learning backend
	ModelVersion string `json:"model_version,omitempty"`
	// Response model timeout
	Timeout   float32   `json:"timeout,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// If false, model version is set by the user, if true - getting latest version from backend.
	AutoUpdate bool  `json:"auto_update,omitempty"`
	Project    int32 `json:"project"`
}

type MlInteractiveAnnotatingRequest 

type MlInteractiveAnnotatingRequest struct {
	// ID of task to annotate
	Task int32 `json:"task"`
	// Context for ML model
	Context interface{} `json:"context,omitempty"`
}

type Organization 

type Organization struct {
	Id          int32     `json:"id,omitempty"`
	Title       string    `json:"title"`
	Token       string    `json:"token,omitempty"`
	CreatedAt   time.Time `json:"created_at,omitempty"`
	UpdatedAt   time.Time `json:"updated_at,omitempty"`
	ContactInfo string    `json:"contact_info,omitempty"`
	CreatedBy   int32     `json:"created_by,omitempty"`
	Users       []int32   `json:"users,omitempty"`
}

type OrganizationId 

type OrganizationId struct {
	Id          int32  `json:"id,omitempty"`
	Title       string `json:"title"`
	ContactInfo string `json:"contact_info,omitempty"`
}

type OrganizationInvite 

type OrganizationInvite struct {
	Token     string `json:"token,omitempty"`
	InviteUrl string `json:"invite_url,omitempty"`
}

type OrganizationMemberUser 

type OrganizationMemberUser struct {
	Id int32 `json:"id,omitempty"`
	// Organization ID
	Organization int32                       `json:"organization"`
	User         *UserSerializerWithProjects `json:"user"`
}

type OrganizationsApiApiOrganizationsMembershipsListOpts 

type OrganizationsApiApiOrganizationsMembershipsListOpts struct {
	Page     optional.Int32
	PageSize optional.Int32
}

type OrganizationsApiService 

type OrganizationsApiService service

func (*OrganizationsApiService) ApiOrganizationsList 

func (a *OrganizationsApiService) ApiOrganizationsList(ctx context.Context) ([]OrganizationId, *http.Response, error)

OrganizationsApiService List your organizations 

Return a list of the organizations you've created or that you have access to.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []OrganizationId

func (*OrganizationsApiService) ApiOrganizationsMembershipsDelete 

func (a *OrganizationsApiService) ApiOrganizationsMembershipsDelete(ctx context.Context, id string, pk int32, userPk int32) (*http.Response, error)

OrganizationsApiService Soft delete an organization member Soft delete a member from the organization.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param pk A unique integer value identifying this organization.
  • @param userPk A unique integer value identifying the user to be deleted from the organization.

func (*OrganizationsApiService) ApiOrganizationsMembershipsList 

func (a *OrganizationsApiService) ApiOrganizationsMembershipsList(ctx context.Context, id int32, localVarOptionals *OrganizationsApiApiOrganizationsMembershipsListOpts) (InlineResponse2002, *http.Response, error)

func (*OrganizationsApiService) ApiOrganizationsPartialUpdate 

func (a *OrganizationsApiService) ApiOrganizationsPartialUpdate(ctx context.Context, id int32, data Organization) (Organization, *http.Response, error)

OrganizationsApiService Update organization settings Update the settings for a specific organization by ID.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this organization.
  • @param data

@return Organization

func (*OrganizationsApiService) ApiOrganizationsRead 

func (a *OrganizationsApiService) ApiOrganizationsRead(ctx context.Context, id int32) (Organization, *http.Response, error)

OrganizationsApiService Get organization settings Retrieve the settings for a specific organization by ID.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this organization.

@return Organization

type Prediction 

type Prediction struct {
	Id           int32  `json:"id,omitempty"`
	ModelVersion string `json:"model_version,omitempty"`
	// Delta time from creation time
	CreatedAgo string `json:"created_ago,omitempty"`
	// Prediction result
	Result interface{} `json:"result,omitempty"`
	// Prediction score
	Score float32 `json:"score,omitempty"`
	// Cluster for the current prediction
	Cluster int32 `json:"cluster,omitempty"`
	// Array of task IDs of the closest neighbors
	Neighbors interface{} `json:"neighbors,omitempty"`
	// Related task mislabeling score
	Mislabeling float32   `json:"mislabeling,omitempty"`
	CreatedAt   time.Time `json:"created_at,omitempty"`
	UpdatedAt   time.Time `json:"updated_at,omitempty"`
	Task        int32     `json:"task"`
	Project     int32     `json:"project,omitempty"`
}

type PredictionsApiService 

type PredictionsApiService service

func (*PredictionsApiService) ApiPredictionsCreate 

func (a *PredictionsApiService) ApiPredictionsCreate(ctx context.Context, data Prediction) (Prediction, *http.Response, error)

PredictionsApiService Create prediction Create a prediction for a specific task.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return Prediction

func (*PredictionsApiService) ApiPredictionsDelete 

func (a *PredictionsApiService) ApiPredictionsDelete(ctx context.Context, id int32) (*http.Response, error)

PredictionsApiService Delete prediction Delete a prediction by prediction ID.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id Prediction ID

func (*PredictionsApiService) ApiPredictionsList 

func (a *PredictionsApiService) ApiPredictionsList(ctx context.Context) ([]Prediction, *http.Response, error)

PredictionsApiService List predictions List all predictions and their IDs.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Prediction

func (*PredictionsApiService) ApiPredictionsPartialUpdate 

func (a *PredictionsApiService) ApiPredictionsPartialUpdate(ctx context.Context, data Prediction, id int32) (Prediction, *http.Response, error)

PredictionsApiService Update prediction Update prediction data by prediction ID.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data
  • @param id Prediction ID

@return Prediction

func (*PredictionsApiService) ApiPredictionsRead 

func (a *PredictionsApiService) ApiPredictionsRead(ctx context.Context, id int32) (Prediction, *http.Response, error)

PredictionsApiService Get prediction details Get details about a specific prediction by its ID.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id Prediction ID

@return Prediction

func (*PredictionsApiService) ApiPredictionsUpdate 

func (a *PredictionsApiService) ApiPredictionsUpdate(ctx context.Context, data Prediction, id int32) (Prediction, *http.Response, error)

PredictionsApiService Put prediction Overwrite prediction data by prediction ID.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data
  • @param id Prediction ID

@return Prediction

type Project 

type Project struct {
	Id int32 `json:"id,omitempty"`
	// Project name. Must be between 3 and 50 characters long.
	Title string `json:"title,omitempty"`
	// Project description
	Description string `json:"description,omitempty"`
	// Label config in XML format. See more about it in documentation
	LabelConfig string `json:"label_config,omitempty"`
	// Labeling instructions in HTML format
	ExpertInstruction string `json:"expert_instruction,omitempty"`
	// Show instructions to the annotator before they start
	ShowInstruction bool `json:"show_instruction,omitempty"`
	// Show a skip button in interface and allow annotators to skip the task
	ShowSkipButton bool `json:"show_skip_button,omitempty"`
	// Allow annotators to submit empty annotations
	EnableEmptyAnnotation bool `json:"enable_empty_annotation,omitempty"`
	// Show annotation history to annotator
	ShowAnnotationHistory bool   `json:"show_annotation_history,omitempty"`
	Organization          int32  `json:"organization,omitempty"`
	Color                 string `json:"color,omitempty"`
	// Maximum number of annotations for one task. If the number of annotations per task is equal or greater to this value, the task is completed (is_labeled=True)
	MaximumAnnotations int32 `json:"maximum_annotations,omitempty"`
	// Whether or not the project is published to annotators
	IsPublished bool `json:"is_published,omitempty"`
	// Machine learning model version
	ModelVersion string `json:"model_version,omitempty"`
	// Whether or not the project is in the middle of being created
	IsDraft   bool        `json:"is_draft,omitempty"`
	CreatedBy *UserSimple `json:"created_by,omitempty"`
	CreatedAt time.Time   `json:"created_at,omitempty"`
	// Minimum number of completed tasks after which model training is started
	MinAnnotationsToStartTraining int32 `json:"min_annotations_to_start_training,omitempty"`
	// Start model training after any annotations are submitted or updated
	StartTrainingOnAnnotationUpdate bool `json:"start_training_on_annotation_update,omitempty"`
	// If set, the annotator can view model predictions
	ShowCollabPredictions bool `json:"show_collab_predictions,omitempty"`
	// Tasks with annotations count
	NumTasksWithAnnotations int32 `json:"num_tasks_with_annotations,omitempty"`
	// Total task number in project
	TaskNumber int32 `json:"task_number,omitempty"`
	// Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number
	UsefulAnnotationNumber int32 `json:"useful_annotation_number,omitempty"`
	// Honeypot annotation number in project
	GroundTruthNumber int32 `json:"ground_truth_number,omitempty"`
	// Skipped by collaborators annotation number in project
	SkippedAnnotationsNumber int32 `json:"skipped_annotations_number,omitempty"`
	// Total annotations number in project including skipped_annotations_number and ground_truth_number.
	TotalAnnotationsNumber int32 `json:"total_annotations_number,omitempty"`
	// Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.
	TotalPredictionsNumber  int32  `json:"total_predictions_number,omitempty"`
	Sampling                string `json:"sampling,omitempty"`
	ShowGroundTruthFirst    bool   `json:"show_ground_truth_first,omitempty"`
	ShowOverlapFirst        bool   `json:"show_overlap_first,omitempty"`
	OverlapCohortPercentage int32  `json:"overlap_cohort_percentage,omitempty"`
	// Task data credentials: login
	TaskDataLogin string `json:"task_data_login,omitempty"`
	// Task data credentials: password
	TaskDataPassword string `json:"task_data_password,omitempty"`
	// Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}
	ControlWeights interface{} `json:"control_weights,omitempty"`
	// JSON-formatted labeling configuration
	ParsedLabelConfig interface{} `json:"parsed_label_config,omitempty"`
	// Retrieve and display predictions when loading a task
	EvaluatePredictionsAutomatically bool `json:"evaluate_predictions_automatically,omitempty"`
	// Flag to detect is project ready for labeling
	ConfigHasControlTags interface{} `json:"config_has_control_tags,omitempty"`
	SkipQueue            string      `json:"skip_queue,omitempty"`
	// Reveal pre-annotations interactively
	RevealPreannotationsInteractively bool `json:"reveal_preannotations_interactively,omitempty"`
	// Pinned date and time
	PinnedAt time.Time `json:"pinned_at,omitempty"`
	// Finished tasks
	FinishedTaskNumber int32 `json:"finished_task_number,omitempty"`
	QueueTotal         int32 `json:"queue_total,omitempty"`
	QueueDone          int32 `json:"queue_done,omitempty"`
}

type ProjectImport 

type ProjectImport struct {
	Id                     int32       `json:"id,omitempty"`
	PreannotatedFromFields interface{} `json:"preannotated_from_fields,omitempty"`
	CommitToProject        bool        `json:"commit_to_project,omitempty"`
	ReturnTaskIds          bool        `json:"return_task_ids,omitempty"`
	Status                 string      `json:"status,omitempty"`
	Url                    string      `json:"url,omitempty"`
	Traceback              string      `json:"traceback,omitempty"`
	Error_                 string      `json:"error,omitempty"`
	// Creation time
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Updated time
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// Complete or fail time
	FinishedAt       time.Time   `json:"finished_at,omitempty"`
	TaskCount        int32       `json:"task_count,omitempty"`
	AnnotationCount  int32       `json:"annotation_count,omitempty"`
	PredictionCount  int32       `json:"prediction_count,omitempty"`
	Duration         int32       `json:"duration,omitempty"`
	FileUploadIds    interface{} `json:"file_upload_ids,omitempty"`
	CouldBeTasksList bool        `json:"could_be_tasks_list,omitempty"`
	FoundFormats     interface{} `json:"found_formats,omitempty"`
	DataColumns      interface{} `json:"data_columns,omitempty"`
	Tasks            interface{} `json:"tasks,omitempty"`
	TaskIds          interface{} `json:"task_ids,omitempty"`
	Project          int32       `json:"project,omitempty"`
}

type ProjectLabelConfig 

type ProjectLabelConfig struct {
	// Label config in XML format. See more about it in documentation
	LabelConfig string `json:"label_config"`
}

type ProjectReimport 

type ProjectReimport struct {
	Id               int32       `json:"id,omitempty"`
	Status           string      `json:"status,omitempty"`
	Error_           string      `json:"error,omitempty"`
	TaskCount        int32       `json:"task_count,omitempty"`
	AnnotationCount  int32       `json:"annotation_count,omitempty"`
	PredictionCount  int32       `json:"prediction_count,omitempty"`
	Duration         int32       `json:"duration,omitempty"`
	FileUploadIds    interface{} `json:"file_upload_ids,omitempty"`
	FilesAsTasksList bool        `json:"files_as_tasks_list,omitempty"`
	FoundFormats     interface{} `json:"found_formats,omitempty"`
	DataColumns      interface{} `json:"data_columns,omitempty"`
	Traceback        string      `json:"traceback,omitempty"`
	Project          int32       `json:"project,omitempty"`
}

type ProjectsApiApiProjectsListOpts 

type ProjectsApiApiProjectsListOpts struct {
	Ordering optional.String
	Ids      optional.String
	Title    optional.String
	Page     optional.Int32
	PageSize optional.Int32
}

type ProjectsApiApiProjectsTasksListOpts 

type ProjectsApiApiProjectsTasksListOpts struct {
	Page     optional.Int32
	PageSize optional.Int32
}

type ProjectsApiService 

type ProjectsApiService service

func (*ProjectsApiService) ApiProjectsCreate 

func (a *ProjectsApiService) ApiProjectsCreate(ctx context.Context, data Project) (Project, *http.Response, error)

ProjectsApiService Create new project 

Create a project and set up the labeling interface in Label Studio using the API.  ```bash curl -H Content-Type:application/json -H 'Authorization: Token abc123' -X POST 'https://localhost:8080/api/projects'     --data '{\"label_config\": \"<View>[...]</View>\"}' ```
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param data

@return Project

func (*ProjectsApiService) ApiProjectsDelete 

func (a *ProjectsApiService) ApiProjectsDelete(ctx context.Context, id int32) (*http.Response, error)

ProjectsApiService Delete project Delete a project by specified project ID.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this project.

func (*ProjectsApiService) ApiProjectsImportsRead 

func (a *ProjectsApiService) ApiProjectsImportsRead(ctx context.Context, importPk string, id int32) (ProjectImport, *http.Response, error)

ProjectsApiService Get project import info Return data related to async project import operation

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param importPk
  • @param id A unique integer value identifying this project import.

@return ProjectImport

func (*ProjectsApiService) ApiProjectsList 

func (a *ProjectsApiService) ApiProjectsList(ctx context.Context, localVarOptionals *ProjectsApiApiProjectsListOpts) (InlineResponse2003, *http.Response, error)

func (*ProjectsApiService) ApiProjectsPartialUpdate 

func (a *ProjectsApiService) ApiProjectsPartialUpdate(ctx context.Context, id int32, data Project) (Project, *http.Response, error)

ProjectsApiService Update project Update the project settings for a specific project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this project.
  • @param data

@return Project

func (*ProjectsApiService) ApiProjectsRead 

func (a *ProjectsApiService) ApiProjectsRead(ctx context.Context, id int32) (Project, *http.Response, error)

ProjectsApiService Get project by ID Retrieve information about a project by project ID.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this project.

@return Project

func (*ProjectsApiService) ApiProjectsReimportsRead 

func (a *ProjectsApiService) ApiProjectsReimportsRead(ctx context.Context, reimportPk string, id int32) (ProjectReimport, *http.Response, error)

ProjectsApiService Get project reimport info Return data related to async project reimport operation

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reimportPk
  • @param id A unique integer value identifying this project reimport.

@return ProjectReimport

func (*ProjectsApiService) ApiProjectsTasksDelete 

func (a *ProjectsApiService) ApiProjectsTasksDelete(ctx context.Context, id int32) (*http.Response, error)

ProjectsApiService Delete all tasks Delete all tasks from a specific project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this project.

func (*ProjectsApiService) ApiProjectsTasksList 

func (a *ProjectsApiService) ApiProjectsTasksList(ctx context.Context, id int32, localVarOptionals *ProjectsApiApiProjectsTasksListOpts) (*http.Response, error)

func (*ProjectsApiService) ApiProjectsValidateCreate 

func (a *ProjectsApiService) ApiProjectsValidateCreate(ctx context.Context, data ProjectLabelConfig) (*http.Response, error)

ProjectsApiService Validate label config Validate an arbitrary labeling configuration.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

func (*ProjectsApiService) ApiProjectsValidateCreate_1 

func (a *ProjectsApiService) ApiProjectsValidateCreate_1(ctx context.Context, data ProjectLabelConfig, id int32) (ProjectLabelConfig, *http.Response, error)

ProjectsApiService Validate project label config 

Determine whether the label configuration for a specific project is valid.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param data
* @param id A unique integer value identifying this project.

@return ProjectLabelConfig

type RedisExportStorage 

type RedisExportStorage struct {
	Id             int32  `json:"id,omitempty"`
	Type_          string `json:"type,omitempty"`
	Synchronizable bool   `json:"synchronizable,omitempty"`
	// Storage prefix (optional)
	Path string `json:"path,omitempty"`
	// Server Host IP (optional)
	Host string `json:"host,omitempty"`
	// Server Port (optional)
	Port string `json:"port,omitempty"`
	// Server Password (optional)
	Password string `json:"password,omitempty"`
	// Cloud storage regex for filtering objects
	RegexFilter string `json:"regex_filter,omitempty"`
	// Interpret objects as BLOBs and generate URLs
	UseBlobUrls bool `json:"use_blob_urls,omitempty"`
	// Last sync finished time
	LastSync time.Time `json:"last_sync,omitempty"`
	// Count of tasks synced last time
	LastSyncCount int32 `json:"last_sync_count,omitempty"`
	// Last sync job ID
	LastSyncJob string `json:"last_sync_job,omitempty"`
	Status      string `json:"status,omitempty"`
	// Traceback report for the last failed sync
	Traceback string `json:"traceback,omitempty"`
	// Meta and debug information about storage processes
	Meta interface{} `json:"meta,omitempty"`
	// Cloud storage title
	Title string `json:"title,omitempty"`
	// Cloud storage description
	Description string `json:"description,omitempty"`
	// Creation time
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Deletion from storage enabled
	CanDeleteObjects bool `json:"can_delete_objects,omitempty"`
	// Server Database
	Db int32 `json:"db,omitempty"`
	// A unique integer value identifying this project.
	Project int32 `json:"project"`
}

type RedisImportStorage 

type RedisImportStorage struct {
	Id             int32  `json:"id,omitempty"`
	Type_          string `json:"type,omitempty"`
	Synchronizable bool   `json:"synchronizable,omitempty"`
	// Storage prefix (optional)
	Path string `json:"path,omitempty"`
	// Server Host IP (optional)
	Host string `json:"host,omitempty"`
	// Server Port (optional)
	Port string `json:"port,omitempty"`
	// Server Password (optional)
	Password string `json:"password,omitempty"`
	// Cloud storage regex for filtering objects
	RegexFilter string `json:"regex_filter,omitempty"`
	// Interpret objects as BLOBs and generate URLs
	UseBlobUrls bool `json:"use_blob_urls,omitempty"`
	// Last sync finished time
	LastSync time.Time `json:"last_sync,omitempty"`
	// Count of tasks synced last time
	LastSyncCount int32 `json:"last_sync_count,omitempty"`
	// Last sync job ID
	LastSyncJob string `json:"last_sync_job,omitempty"`
	Status      string `json:"status,omitempty"`
	// Traceback report for the last failed sync
	Traceback string `json:"traceback,omitempty"`
	// Meta and debug information about storage processes
	Meta interface{} `json:"meta,omitempty"`
	// Cloud storage title
	Title string `json:"title,omitempty"`
	// Cloud storage description
	Description string `json:"description,omitempty"`
	// Creation time
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Server Database
	Db int32 `json:"db,omitempty"`
	// A unique integer value identifying this project.
	Project int32 `json:"project"`
}

type S3ExportStorage 

type S3ExportStorage struct {
	Id             int32  `json:"id,omitempty"`
	Type_          string `json:"type,omitempty"`
	Synchronizable bool   `json:"synchronizable,omitempty"`
	// Last sync finished time
	LastSync time.Time `json:"last_sync,omitempty"`
	// Count of tasks synced last time
	LastSyncCount int32 `json:"last_sync_count,omitempty"`
	// Last sync job ID
	LastSyncJob string `json:"last_sync_job,omitempty"`
	Status      string `json:"status,omitempty"`
	// Traceback report for the last failed sync
	Traceback string `json:"traceback,omitempty"`
	// Meta and debug information about storage processes
	Meta interface{} `json:"meta,omitempty"`
	// Cloud storage title
	Title string `json:"title,omitempty"`
	// Cloud storage description
	Description string `json:"description,omitempty"`
	// Creation time
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Deletion from storage enabled
	CanDeleteObjects bool `json:"can_delete_objects,omitempty"`
	// S3 bucket name
	Bucket string `json:"bucket,omitempty"`
	// S3 bucket prefix
	Prefix string `json:"prefix,omitempty"`
	// Cloud storage regex for filtering objects
	RegexFilter string `json:"regex_filter,omitempty"`
	// Interpret objects as BLOBs and generate URLs
	UseBlobUrls bool `json:"use_blob_urls,omitempty"`
	// AWS_ACCESS_KEY_ID
	AwsAccessKeyId string `json:"aws_access_key_id,omitempty"`
	// AWS_SECRET_ACCESS_KEY
	AwsSecretAccessKey string `json:"aws_secret_access_key,omitempty"`
	// AWS_SESSION_TOKEN
	AwsSessionToken string `json:"aws_session_token,omitempty"`
	// AWS SSE KMS Key ID
	AwsSseKmsKeyId string `json:"aws_sse_kms_key_id,omitempty"`
	// AWS Region
	RegionName string `json:"region_name,omitempty"`
	// S3 Endpoint
	S3Endpoint string `json:"s3_endpoint,omitempty"`
	// A unique integer value identifying this project.
	Project int32 `json:"project"`
}

type S3ImportStorage 

type S3ImportStorage struct {
	Id             int32  `json:"id,omitempty"`
	Type_          string `json:"type,omitempty"`
	Synchronizable bool   `json:"synchronizable,omitempty"`
	Presign        bool   `json:"presign,omitempty"`
	// Last sync finished time
	LastSync time.Time `json:"last_sync,omitempty"`
	// Count of tasks synced last time
	LastSyncCount int32 `json:"last_sync_count,omitempty"`
	// Last sync job ID
	LastSyncJob string `json:"last_sync_job,omitempty"`
	Status      string `json:"status,omitempty"`
	// Traceback report for the last failed sync
	Traceback string `json:"traceback,omitempty"`
	// Meta and debug information about storage processes
	Meta interface{} `json:"meta,omitempty"`
	// Cloud storage title
	Title string `json:"title,omitempty"`
	// Cloud storage description
	Description string `json:"description,omitempty"`
	// Creation time
	CreatedAt time.Time `json:"created_at,omitempty"`
	// S3 bucket name
	Bucket string `json:"bucket,omitempty"`
	// S3 bucket prefix
	Prefix string `json:"prefix,omitempty"`
	// Cloud storage regex for filtering objects
	RegexFilter string `json:"regex_filter,omitempty"`
	// Interpret objects as BLOBs and generate URLs
	UseBlobUrls bool `json:"use_blob_urls,omitempty"`
	// AWS_ACCESS_KEY_ID
	AwsAccessKeyId string `json:"aws_access_key_id,omitempty"`
	// AWS_SECRET_ACCESS_KEY
	AwsSecretAccessKey string `json:"aws_secret_access_key,omitempty"`
	// AWS_SESSION_TOKEN
	AwsSessionToken string `json:"aws_session_token,omitempty"`
	// AWS SSE KMS Key ID
	AwsSseKmsKeyId string `json:"aws_sse_kms_key_id,omitempty"`
	// AWS Region
	RegionName string `json:"region_name,omitempty"`
	// S3 Endpoint
	S3Endpoint string `json:"s3_endpoint,omitempty"`
	// Presigned URLs TTL (in minutes)
	PresignTtl int32 `json:"presign_ttl,omitempty"`
	// Perform recursive scan over the bucket content
	RecursiveScan bool `json:"recursive_scan,omitempty"`
	// A unique integer value identifying this project.
	Project int32 `json:"project"`
}

type SerializationOption 

type SerializationOption struct {
	// Include a full json body or IDs only
	OnlyId bool `json:"only_id,omitempty"`
}

JSON dict with parameters

type SerializationOptions 

type SerializationOptions struct {
	Drafts                 *SerializationOption `json:"drafts,omitempty"`
	Predictions            *SerializationOption `json:"predictions,omitempty"`
	AnnotationsCompletedBy *SerializationOption `json:"annotations__completed_by,omitempty"`
	// Interpolate video key frames
	InterpolateKeyFrames bool `json:"interpolate_key_frames,omitempty"`
}

type StorageApiService 

type StorageApiService service

func (*StorageApiService) ApiStoragesExportList 

func (a *StorageApiService) ApiStoragesExportList(ctx context.Context, project int32) (*http.Response, error)

StorageApiService List all export storages from the project Retrieve a list of the export storages of all types with their IDs.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param project A unique integer value identifying your project.

func (*StorageApiService) ApiStoragesExportTypesList 

func (a *StorageApiService) ApiStoragesExportTypesList(ctx context.Context) (*http.Response, error)

StorageApiService List all export storages types Retrieve a list of the export storages types.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*StorageApiService) ApiStoragesList 

func (a *StorageApiService) ApiStoragesList(ctx context.Context, project int32) (*http.Response, error)

StorageApiService List all import storages from the project Retrieve a list of the import storages of all types with their IDs.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param project A unique integer value identifying your project.

func (*StorageApiService) ApiStoragesTypesList 

func (a *StorageApiService) ApiStoragesTypesList(ctx context.Context) (*http.Response, error)

StorageApiService List all import storages types Retrieve a list of the import storages types.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

type StorageAzureApiApiStoragesAzureListOpts 

type StorageAzureApiApiStoragesAzureListOpts struct {
	Project optional.Int32
}

type StorageAzureApiApiStoragesExportAzureListOpts 

type StorageAzureApiApiStoragesExportAzureListOpts struct {
	Project optional.Int32
}

type StorageAzureApiService 

type StorageAzureApiService service

func (*StorageAzureApiService) ApiStoragesAzureCreate 

func (a *StorageAzureApiService) ApiStoragesAzureCreate(ctx context.Context, data AzureBlobImportStorage) (AzureBlobImportStorage, *http.Response, error)

StorageAzureApiService Create new storage Get new Azure import storage

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return AzureBlobImportStorage

func (*StorageAzureApiService) ApiStoragesAzureDelete 

func (a *StorageAzureApiService) ApiStoragesAzureDelete(ctx context.Context, id int32) (*http.Response, error)

StorageAzureApiService Delete import storage Delete a specific Azure import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this azure blob import storage.

func (*StorageAzureApiService) ApiStoragesAzureList 

func (a *StorageAzureApiService) ApiStoragesAzureList(ctx context.Context, localVarOptionals *StorageAzureApiApiStoragesAzureListOpts) ([]AzureBlobImportStorage, *http.Response, error)

func (*StorageAzureApiService) ApiStoragesAzurePartialUpdate 

func (a *StorageAzureApiService) ApiStoragesAzurePartialUpdate(ctx context.Context, id int32, data AzureBlobImportStorage) (AzureBlobImportStorage, *http.Response, error)

StorageAzureApiService Update import storage Update a specific Azure import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this azure blob import storage.
  • @param data

@return AzureBlobImportStorage

func (*StorageAzureApiService) ApiStoragesAzureRead 

func (a *StorageAzureApiService) ApiStoragesAzureRead(ctx context.Context, id int32) (AzureBlobImportStorage, *http.Response, error)

StorageAzureApiService Get import storage Get a specific Azure import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this azure blob import storage.

@return AzureBlobImportStorage

func (*StorageAzureApiService) ApiStoragesAzureSyncCreate 

func (a *StorageAzureApiService) ApiStoragesAzureSyncCreate(ctx context.Context, id string, data AzureBlobImportStorage) (AzureBlobImportStorage, *http.Response, error)

StorageAzureApiService Sync import storage Sync tasks from an Azure import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param data

@return AzureBlobImportStorage

func (*StorageAzureApiService) ApiStoragesAzureValidateCreate 

func (a *StorageAzureApiService) ApiStoragesAzureValidateCreate(ctx context.Context, data AzureBlobImportStorage) (AzureBlobImportStorage, *http.Response, error)

StorageAzureApiService Validate import storage Validate a specific Azure import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return AzureBlobImportStorage

func (*StorageAzureApiService) ApiStoragesExportAzureCreate 

func (a *StorageAzureApiService) ApiStoragesExportAzureCreate(ctx context.Context, data AzureBlobExportStorage) (AzureBlobExportStorage, *http.Response, error)

StorageAzureApiService Create export storage Create a new Azure export storage connection to store annotations.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return AzureBlobExportStorage

func (*StorageAzureApiService) ApiStoragesExportAzureDelete 

func (a *StorageAzureApiService) ApiStoragesExportAzureDelete(ctx context.Context, id int32) (*http.Response, error)

StorageAzureApiService Delete export storage Delete a specific Azure export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this azure blob export storage.

func (*StorageAzureApiService) ApiStoragesExportAzureList 

func (a *StorageAzureApiService) ApiStoragesExportAzureList(ctx context.Context, localVarOptionals *StorageAzureApiApiStoragesExportAzureListOpts) ([]AzureBlobExportStorage, *http.Response, error)

func (*StorageAzureApiService) ApiStoragesExportAzurePartialUpdate 

func (a *StorageAzureApiService) ApiStoragesExportAzurePartialUpdate(ctx context.Context, id int32, data AzureBlobExportStorage) (AzureBlobExportStorage, *http.Response, error)

StorageAzureApiService Update export storage Update a specific Azure export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this azure blob export storage.
  • @param data

@return AzureBlobExportStorage

func (*StorageAzureApiService) ApiStoragesExportAzureRead 

func (a *StorageAzureApiService) ApiStoragesExportAzureRead(ctx context.Context, id int32) (AzureBlobExportStorage, *http.Response, error)

StorageAzureApiService Get export storage Get a specific Azure export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this azure blob export storage.

@return AzureBlobExportStorage

func (*StorageAzureApiService) ApiStoragesExportAzureSyncCreate 

func (a *StorageAzureApiService) ApiStoragesExportAzureSyncCreate(ctx context.Context, id string, data AzureBlobExportStorage) (AzureBlobExportStorage, *http.Response, error)

StorageAzureApiService Sync export storage Sync tasks from an Azure export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param data

@return AzureBlobExportStorage

func (*StorageAzureApiService) ApiStoragesExportAzureValidateCreate 

func (a *StorageAzureApiService) ApiStoragesExportAzureValidateCreate(ctx context.Context, data AzureBlobExportStorage) (AzureBlobExportStorage, *http.Response, error)

StorageAzureApiService Validate export storage Validate a specific Azure export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return AzureBlobExportStorage

type StorageGCSApiApiStoragesExportGcsListOpts 

type StorageGCSApiApiStoragesExportGcsListOpts struct {
	Project optional.Int32
}

type StorageGCSApiApiStoragesGcsListOpts 

type StorageGCSApiApiStoragesGcsListOpts struct {
	Project optional.Int32
}

type StorageGCSApiService 

type StorageGCSApiService service

func (*StorageGCSApiService) ApiStoragesExportGcsCreate 

func (a *StorageGCSApiService) ApiStoragesExportGcsCreate(ctx context.Context, data GcsExportStorage) (GcsExportStorage, *http.Response, error)

StorageGCSApiService Create export storage Create a new GCS export storage connection to store annotations.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return GcsExportStorage

func (*StorageGCSApiService) ApiStoragesExportGcsDelete 

func (a *StorageGCSApiService) ApiStoragesExportGcsDelete(ctx context.Context, id int32) (*http.Response, error)

StorageGCSApiService Delete export storage Delete a specific GCS export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this gcs export storage.

func (*StorageGCSApiService) ApiStoragesExportGcsList 

func (a *StorageGCSApiService) ApiStoragesExportGcsList(ctx context.Context, localVarOptionals *StorageGCSApiApiStoragesExportGcsListOpts) ([]GcsExportStorage, *http.Response, error)

func (*StorageGCSApiService) ApiStoragesExportGcsPartialUpdate 

func (a *StorageGCSApiService) ApiStoragesExportGcsPartialUpdate(ctx context.Context, id int32, data GcsExportStorage) (GcsExportStorage, *http.Response, error)

StorageGCSApiService Update export storage Update a specific GCS export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this gcs export storage.
  • @param data

@return GcsExportStorage

func (*StorageGCSApiService) ApiStoragesExportGcsRead 

func (a *StorageGCSApiService) ApiStoragesExportGcsRead(ctx context.Context, id int32) (GcsExportStorage, *http.Response, error)

StorageGCSApiService Get export storage Get a specific GCS export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this gcs export storage.

@return GcsExportStorage

func (*StorageGCSApiService) ApiStoragesExportGcsSyncCreate 

func (a *StorageGCSApiService) ApiStoragesExportGcsSyncCreate(ctx context.Context, id string, data GcsExportStorage) (GcsExportStorage, *http.Response, error)

StorageGCSApiService Sync export storage Sync tasks from an GCS export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param data

@return GcsExportStorage

func (*StorageGCSApiService) ApiStoragesExportGcsValidateCreate 

func (a *StorageGCSApiService) ApiStoragesExportGcsValidateCreate(ctx context.Context, data GcsExportStorage) (GcsExportStorage, *http.Response, error)

StorageGCSApiService Validate export storage Validate a specific GCS export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return GcsExportStorage

func (*StorageGCSApiService) ApiStoragesGcsCreate 

func (a *StorageGCSApiService) ApiStoragesGcsCreate(ctx context.Context, data GcsImportStorage) (GcsImportStorage, *http.Response, error)

StorageGCSApiService Create import storage Create a new GCS import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return GcsImportStorage

func (*StorageGCSApiService) ApiStoragesGcsDelete 

func (a *StorageGCSApiService) ApiStoragesGcsDelete(ctx context.Context, id int32) (*http.Response, error)

StorageGCSApiService Delete import storage Delete a specific GCS import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this gcs import storage.

func (*StorageGCSApiService) ApiStoragesGcsList 

func (a *StorageGCSApiService) ApiStoragesGcsList(ctx context.Context, localVarOptionals *StorageGCSApiApiStoragesGcsListOpts) ([]GcsImportStorage, *http.Response, error)

func (*StorageGCSApiService) ApiStoragesGcsPartialUpdate 

func (a *StorageGCSApiService) ApiStoragesGcsPartialUpdate(ctx context.Context, id int32, data GcsImportStorage) (GcsImportStorage, *http.Response, error)

StorageGCSApiService Update import storage Update a specific GCS import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this gcs import storage.
  • @param data

@return GcsImportStorage

func (*StorageGCSApiService) ApiStoragesGcsRead 

func (a *StorageGCSApiService) ApiStoragesGcsRead(ctx context.Context, id int32) (GcsImportStorage, *http.Response, error)

StorageGCSApiService Get import storage Get a specific GCS import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this gcs import storage.

@return GcsImportStorage

func (*StorageGCSApiService) ApiStoragesGcsSyncCreate 

func (a *StorageGCSApiService) ApiStoragesGcsSyncCreate(ctx context.Context, id string, data GcsImportStorage) (GcsImportStorage, *http.Response, error)

StorageGCSApiService Sync import storage Sync tasks from an GCS import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param data

@return GcsImportStorage

func (*StorageGCSApiService) ApiStoragesGcsValidateCreate 

func (a *StorageGCSApiService) ApiStoragesGcsValidateCreate(ctx context.Context, data GcsImportStorage) (GcsImportStorage, *http.Response, error)

StorageGCSApiService Validate import storage Validate a specific GCS import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return GcsImportStorage

type StorageLocalApiApiStoragesExportLocalfilesListOpts 

type StorageLocalApiApiStoragesExportLocalfilesListOpts struct {
	Project optional.Int32
}

type StorageLocalApiApiStoragesLocalfilesListOpts 

type StorageLocalApiApiStoragesLocalfilesListOpts struct {
	Project optional.Int32
}

type StorageLocalApiService 

type StorageLocalApiService service

func (*StorageLocalApiService) ApiStoragesExportLocalfilesCreate 

func (a *StorageLocalApiService) ApiStoragesExportLocalfilesCreate(ctx context.Context, data LocalFilesExportStorage) (LocalFilesExportStorage, *http.Response, error)

StorageLocalApiService Create export storage Create a new local file export storage connection to store annotations.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return LocalFilesExportStorage

func (*StorageLocalApiService) ApiStoragesExportLocalfilesDelete 

func (a *StorageLocalApiService) ApiStoragesExportLocalfilesDelete(ctx context.Context, id int32) (*http.Response, error)

StorageLocalApiService Delete export storage Delete a specific local file export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this local files export storage.

func (*StorageLocalApiService) ApiStoragesExportLocalfilesList 

func (a *StorageLocalApiService) ApiStoragesExportLocalfilesList(ctx context.Context, localVarOptionals *StorageLocalApiApiStoragesExportLocalfilesListOpts) ([]LocalFilesExportStorage, *http.Response, error)

func (*StorageLocalApiService) ApiStoragesExportLocalfilesPartialUpdate 

func (a *StorageLocalApiService) ApiStoragesExportLocalfilesPartialUpdate(ctx context.Context, id int32, data LocalFilesExportStorage) (LocalFilesExportStorage, *http.Response, error)

StorageLocalApiService Update export storage Update a specific local file export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this local files export storage.
  • @param data

@return LocalFilesExportStorage

func (*StorageLocalApiService) ApiStoragesExportLocalfilesRead 

func (a *StorageLocalApiService) ApiStoragesExportLocalfilesRead(ctx context.Context, id int32) (LocalFilesExportStorage, *http.Response, error)

StorageLocalApiService Get export storage Get a specific local file export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this local files export storage.

@return LocalFilesExportStorage

func (*StorageLocalApiService) ApiStoragesExportLocalfilesSyncCreate 

func (a *StorageLocalApiService) ApiStoragesExportLocalfilesSyncCreate(ctx context.Context, id string, data LocalFilesExportStorage) (LocalFilesExportStorage, *http.Response, error)

StorageLocalApiService Sync export storage Sync tasks from a local file export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param data

@return LocalFilesExportStorage

func (*StorageLocalApiService) ApiStoragesExportLocalfilesValidateCreate 

func (a *StorageLocalApiService) ApiStoragesExportLocalfilesValidateCreate(ctx context.Context, data LocalFilesExportStorage) (LocalFilesExportStorage, *http.Response, error)

StorageLocalApiService Validate export storage Validate a specific local file export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return LocalFilesExportStorage

func (*StorageLocalApiService) ApiStoragesLocalfilesCreate 

func (a *StorageLocalApiService) ApiStoragesLocalfilesCreate(ctx context.Context, data LocalFilesImportStorage) (LocalFilesImportStorage, *http.Response, error)

StorageLocalApiService Create import storage Create a new local file import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return LocalFilesImportStorage

func (*StorageLocalApiService) ApiStoragesLocalfilesDelete 

func (a *StorageLocalApiService) ApiStoragesLocalfilesDelete(ctx context.Context, id int32) (*http.Response, error)

StorageLocalApiService Delete import storage Delete a specific local import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this local files import storage.

func (*StorageLocalApiService) ApiStoragesLocalfilesList 

func (a *StorageLocalApiService) ApiStoragesLocalfilesList(ctx context.Context, localVarOptionals *StorageLocalApiApiStoragesLocalfilesListOpts) ([]LocalFilesImportStorage, *http.Response, error)

func (*StorageLocalApiService) ApiStoragesLocalfilesPartialUpdate 

func (a *StorageLocalApiService) ApiStoragesLocalfilesPartialUpdate(ctx context.Context, id int32, data LocalFilesImportStorage) (LocalFilesImportStorage, *http.Response, error)

StorageLocalApiService Update import storage Update a specific local file import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this local files import storage.
  • @param data

@return LocalFilesImportStorage

func (*StorageLocalApiService) ApiStoragesLocalfilesRead 

func (a *StorageLocalApiService) ApiStoragesLocalfilesRead(ctx context.Context, id int32) (LocalFilesImportStorage, *http.Response, error)

StorageLocalApiService Get import storage Get a specific local file import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this local files import storage.

@return LocalFilesImportStorage

func (*StorageLocalApiService) ApiStoragesLocalfilesSyncCreate 

func (a *StorageLocalApiService) ApiStoragesLocalfilesSyncCreate(ctx context.Context, id string, data LocalFilesImportStorage) (LocalFilesImportStorage, *http.Response, error)

StorageLocalApiService Sync import storage Sync tasks from a local file import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param data

@return LocalFilesImportStorage

func (*StorageLocalApiService) ApiStoragesLocalfilesValidateCreate 

func (a *StorageLocalApiService) ApiStoragesLocalfilesValidateCreate(ctx context.Context, data LocalFilesImportStorage) (LocalFilesImportStorage, *http.Response, error)

StorageLocalApiService Validate import storage Validate a specific local file import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return LocalFilesImportStorage

type StorageRedisApiApiStoragesExportRedisListOpts 

type StorageRedisApiApiStoragesExportRedisListOpts struct {
	Project optional.Int32
}

type StorageRedisApiApiStoragesRedisListOpts 

type StorageRedisApiApiStoragesRedisListOpts struct {
	Project optional.Int32
}

type StorageRedisApiService 

type StorageRedisApiService service

func (*StorageRedisApiService) ApiStoragesExportRedisCreate 

func (a *StorageRedisApiService) ApiStoragesExportRedisCreate(ctx context.Context, data RedisExportStorage) (RedisExportStorage, *http.Response, error)

StorageRedisApiService Create export storage Create a new Redis export storage connection to store annotations.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return RedisExportStorage

func (*StorageRedisApiService) ApiStoragesExportRedisDelete 

func (a *StorageRedisApiService) ApiStoragesExportRedisDelete(ctx context.Context, id int32) (*http.Response, error)

StorageRedisApiService Delete export storage Delete a specific Redis export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this redis export storage.

func (*StorageRedisApiService) ApiStoragesExportRedisList 

func (a *StorageRedisApiService) ApiStoragesExportRedisList(ctx context.Context, localVarOptionals *StorageRedisApiApiStoragesExportRedisListOpts) ([]RedisExportStorage, *http.Response, error)

func (*StorageRedisApiService) ApiStoragesExportRedisPartialUpdate 

func (a *StorageRedisApiService) ApiStoragesExportRedisPartialUpdate(ctx context.Context, id int32, data RedisExportStorage) (RedisExportStorage, *http.Response, error)

StorageRedisApiService Update export storage Update a specific Redis export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this redis export storage.
  • @param data

@return RedisExportStorage

func (*StorageRedisApiService) ApiStoragesExportRedisRead 

func (a *StorageRedisApiService) ApiStoragesExportRedisRead(ctx context.Context, id int32) (RedisExportStorage, *http.Response, error)

StorageRedisApiService Get export storage Get a specific Redis export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this redis export storage.

@return RedisExportStorage

func (*StorageRedisApiService) ApiStoragesExportRedisSyncCreate 

func (a *StorageRedisApiService) ApiStoragesExportRedisSyncCreate(ctx context.Context, id string, data RedisExportStorage) (RedisExportStorage, *http.Response, error)

StorageRedisApiService Sync export storage Sync tasks from a specific Redis export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param data

@return RedisExportStorage

func (*StorageRedisApiService) ApiStoragesExportRedisValidateCreate 

func (a *StorageRedisApiService) ApiStoragesExportRedisValidateCreate(ctx context.Context, data RedisExportStorage) (RedisExportStorage, *http.Response, error)

StorageRedisApiService Validate export storage Validate a specific Redis export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return RedisExportStorage

func (*StorageRedisApiService) ApiStoragesRedisCreate 

func (a *StorageRedisApiService) ApiStoragesRedisCreate(ctx context.Context, data RedisImportStorage) (RedisImportStorage, *http.Response, error)

StorageRedisApiService Create import storage Create a new Redis import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return RedisImportStorage

func (*StorageRedisApiService) ApiStoragesRedisDelete 

func (a *StorageRedisApiService) ApiStoragesRedisDelete(ctx context.Context, id int32) (*http.Response, error)

StorageRedisApiService Delete import storage Delete a specific Redis import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this redis import storage.

func (*StorageRedisApiService) ApiStoragesRedisList 

func (a *StorageRedisApiService) ApiStoragesRedisList(ctx context.Context, localVarOptionals *StorageRedisApiApiStoragesRedisListOpts) ([]RedisImportStorage, *http.Response, error)

func (*StorageRedisApiService) ApiStoragesRedisPartialUpdate 

func (a *StorageRedisApiService) ApiStoragesRedisPartialUpdate(ctx context.Context, id int32, data RedisImportStorage) (RedisImportStorage, *http.Response, error)

StorageRedisApiService Update import storage Update a specific Redis import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this redis import storage.
  • @param data

@return RedisImportStorage

func (*StorageRedisApiService) ApiStoragesRedisRead 

func (a *StorageRedisApiService) ApiStoragesRedisRead(ctx context.Context, id int32) (RedisImportStorage, *http.Response, error)

StorageRedisApiService Get import storage Get a specific Redis import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this redis import storage.

@return RedisImportStorage

func (*StorageRedisApiService) ApiStoragesRedisSyncCreate 

func (a *StorageRedisApiService) ApiStoragesRedisSyncCreate(ctx context.Context, id string, data RedisImportStorage) (RedisImportStorage, *http.Response, error)

StorageRedisApiService Sync import storage Sync tasks from a specific Redis import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param data

@return RedisImportStorage

func (*StorageRedisApiService) ApiStoragesRedisValidateCreate 

func (a *StorageRedisApiService) ApiStoragesRedisValidateCreate(ctx context.Context, data RedisImportStorage) (RedisImportStorage, *http.Response, error)

StorageRedisApiService Validate import storage Validate a specific Redis import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return RedisImportStorage

type StorageS3ApiApiStoragesExportS3ListOpts 

type StorageS3ApiApiStoragesExportS3ListOpts struct {
	Project optional.Int32
}

type StorageS3ApiApiStoragesS3ListOpts 

type StorageS3ApiApiStoragesS3ListOpts struct {
	Project optional.Int32
}

type StorageS3ApiService 

type StorageS3ApiService service

func (*StorageS3ApiService) ApiStoragesExportS3Create 

func (a *StorageS3ApiService) ApiStoragesExportS3Create(ctx context.Context, data S3ExportStorage) (S3ExportStorage, *http.Response, error)

StorageS3ApiService Create export storage Create a new S3 export storage connection to store annotations.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return S3ExportStorage

func (*StorageS3ApiService) ApiStoragesExportS3Delete 

func (a *StorageS3ApiService) ApiStoragesExportS3Delete(ctx context.Context, id int32) (*http.Response, error)

StorageS3ApiService Delete export storage Delete a specific S3 export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this s3 export storage.

func (*StorageS3ApiService) ApiStoragesExportS3List 

func (a *StorageS3ApiService) ApiStoragesExportS3List(ctx context.Context, localVarOptionals *StorageS3ApiApiStoragesExportS3ListOpts) ([]S3ExportStorage, *http.Response, error)

func (*StorageS3ApiService) ApiStoragesExportS3PartialUpdate 

func (a *StorageS3ApiService) ApiStoragesExportS3PartialUpdate(ctx context.Context, id int32, data S3ExportStorage) (S3ExportStorage, *http.Response, error)

StorageS3ApiService Update export storage Update a specific S3 export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this s3 export storage.
  • @param data

@return S3ExportStorage

func (*StorageS3ApiService) ApiStoragesExportS3Read 

func (a *StorageS3ApiService) ApiStoragesExportS3Read(ctx context.Context, id int32) (S3ExportStorage, *http.Response, error)

StorageS3ApiService Get export storage Get a specific S3 export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this s3 export storage.

@return S3ExportStorage

func (*StorageS3ApiService) ApiStoragesExportS3SyncCreate 

func (a *StorageS3ApiService) ApiStoragesExportS3SyncCreate(ctx context.Context, id string, data S3ExportStorage) (S3ExportStorage, *http.Response, error)

StorageS3ApiService Sync export storage Sync tasks from an S3 export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param data

@return S3ExportStorage

func (*StorageS3ApiService) ApiStoragesExportS3ValidateCreate 

func (a *StorageS3ApiService) ApiStoragesExportS3ValidateCreate(ctx context.Context, data S3ExportStorage) (S3ExportStorage, *http.Response, error)

StorageS3ApiService Validate export storage Validate a specific S3 export storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return S3ExportStorage

func (*StorageS3ApiService) ApiStoragesS3Create 

func (a *StorageS3ApiService) ApiStoragesS3Create(ctx context.Context, data S3ImportStorage) (S3ImportStorage, *http.Response, error)

StorageS3ApiService Create new storage Get new S3 import storage

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return S3ImportStorage

func (*StorageS3ApiService) ApiStoragesS3Delete 

func (a *StorageS3ApiService) ApiStoragesS3Delete(ctx context.Context, id int32) (*http.Response, error)

StorageS3ApiService Delete import storage Delete a specific S3 import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this s3 import storage.

func (*StorageS3ApiService) ApiStoragesS3List 

func (a *StorageS3ApiService) ApiStoragesS3List(ctx context.Context, localVarOptionals *StorageS3ApiApiStoragesS3ListOpts) ([]S3ImportStorage, *http.Response, error)

func (*StorageS3ApiService) ApiStoragesS3PartialUpdate 

func (a *StorageS3ApiService) ApiStoragesS3PartialUpdate(ctx context.Context, id int32, data S3ImportStorage) (S3ImportStorage, *http.Response, error)

StorageS3ApiService Update import storage Update a specific S3 import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this s3 import storage.
  • @param data

@return S3ImportStorage

func (*StorageS3ApiService) ApiStoragesS3Read 

func (a *StorageS3ApiService) ApiStoragesS3Read(ctx context.Context, id int32) (S3ImportStorage, *http.Response, error)

StorageS3ApiService Get import storage Get a specific S3 import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this s3 import storage.

@return S3ImportStorage

func (*StorageS3ApiService) ApiStoragesS3SyncCreate 

func (a *StorageS3ApiService) ApiStoragesS3SyncCreate(ctx context.Context, id string, data S3ImportStorage) (S3ImportStorage, *http.Response, error)

StorageS3ApiService Sync import storage Sync tasks from an S3 import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param data

@return S3ImportStorage

func (*StorageS3ApiService) ApiStoragesS3ValidateCreate 

func (a *StorageS3ApiService) ApiStoragesS3ValidateCreate(ctx context.Context, data S3ImportStorage) (S3ImportStorage, *http.Response, error)

StorageS3ApiService Validate import storage Validate a specific S3 import storage connection.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return S3ImportStorage

type TaskCreationResponse 

type TaskCreationResponse struct {
	// Number of tasks added
	TaskCount int32 `json:"task_count,omitempty"`
	// Number of annotations added
	AnnotationCount int32 `json:"annotation_count,omitempty"`
	// Number of predictions added
	PredictionsCount int32 `json:"predictions_count,omitempty"`
	// Time in seconds to create
	Duration float32 `json:"duration,omitempty"`
	// Database IDs of uploaded files
	FileUploadIds []int32 `json:"file_upload_ids,omitempty"`
	// Whether uploaded files can contain lists of tasks, like CSV/TSV files
	CouldBeTasksList bool `json:"could_be_tasks_list,omitempty"`
	// The list of found file formats
	FoundFormats []string `json:"found_formats,omitempty"`
	// The list of found data columns
	DataColumns []string `json:"data_columns,omitempty"`
}

Task creation response

type TaskFilterOptions 

type TaskFilterOptions struct {
	// Apply filters from the view ID (a tab from the Data Manager)
	View int32 `json:"view,omitempty"`
	// `only` - include all tasks with skipped annotations<br>`exclude` - exclude all tasks with skipped annotations
	Skipped string `json:"skipped,omitempty"`
	// `only` - include all finished tasks (is_labeled = true)<br>`exclude` - exclude all finished tasks
	Finished string `json:"finished,omitempty"`
	// `only` - include all tasks with at least one not skipped annotation<br>`exclude` - exclude all tasks with at least one not skipped annotation
	Annotated           string `json:"annotated,omitempty"`
	OnlyWithAnnotations bool   `json:"only_with_annotations,omitempty"`
}

type TaskSimple 

type TaskSimple struct {
	Id int32 `json:"id,omitempty"`
	// User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI.
	Data interface{} `json:"data"`
	// Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps.
	Meta interface{} `json:"meta,omitempty"`
	// Time a task was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Last time a task was updated
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project
	IsLabeled bool `json:"is_labeled,omitempty"`
	// Number of distinct annotators that processed the current task
	Overlap int32 `json:"overlap,omitempty"`
	// Internal task ID in the project, starts with 1
	InnerId int32 `json:"inner_id,omitempty"`
	// Number of total annotations for the current task except cancelled annotations
	TotalAnnotations int32 `json:"total_annotations,omitempty"`
	// Number of total cancelled annotations for the current task
	CancelledAnnotations int32 `json:"cancelled_annotations,omitempty"`
	// Number of total predictions for the current task
	TotalPredictions int32 `json:"total_predictions,omitempty"`
	// Number of comments in the task including all annotations
	CommentCount int32 `json:"comment_count,omitempty"`
	// Number of unresolved comments in the task including all annotations
	UnresolvedCommentCount int32 `json:"unresolved_comment_count,omitempty"`
	// When the last comment was updated
	LastCommentUpdatedAt time.Time `json:"last_comment_updated_at,omitempty"`
	// Project ID for this task
	Project int32 `json:"project,omitempty"`
	// Last annotator or reviewer who updated this task
	UpdatedBy int32 `json:"updated_by,omitempty"`
	// Uploaded file used as data source for this task
	FileUpload int32 `json:"file_upload,omitempty"`
	// Users who wrote comments
	CommentAuthors []int32      `json:"comment_authors,omitempty"`
	Annotations    []Annotation `json:"annotations,omitempty"`
	Predictions    []Prediction `json:"predictions,omitempty"`
}

type TasksApiApiTasksListOpts 

type TasksApiApiTasksListOpts struct {
	View       optional.Int32
	Project    optional.Int32
	ResolveUri optional.Bool
}

type TasksApiService 

type TasksApiService service

func (*TasksApiService) ApiTasksCreate 

func (a *TasksApiService) ApiTasksCreate(ctx context.Context, data BaseTask) (BaseTask, *http.Response, error)

TasksApiService Create task Create a new labeling task in Label Studio.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return BaseTask

func (*TasksApiService) ApiTasksDelete 

func (a *TasksApiService) ApiTasksDelete(ctx context.Context, id string) (*http.Response, error)

TasksApiService Delete task Delete a task in Label Studio. This action cannot be undone!

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id Task ID

func (*TasksApiService) ApiTasksList 

func (a *TasksApiService) ApiTasksList(ctx context.Context, localVarOptionals *TasksApiApiTasksListOpts) ([]BaseTask, *http.Response, error)

func (*TasksApiService) ApiTasksPartialUpdate 

func (a *TasksApiService) ApiTasksPartialUpdate(ctx context.Context, data TaskSimple, id string) (TaskSimple, *http.Response, error)

TasksApiService Update task Update the attributes of an existing labeling task.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data
  • @param id Task ID

@return TaskSimple

func (*TasksApiService) ApiTasksRead 

func (a *TasksApiService) ApiTasksRead(ctx context.Context, id string) (DataManagerTaskSerializer, *http.Response, error)

TasksApiService Get task 

Get task data, metadata, annotations and other attributes for a specific labeling task by task ID.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param id Task ID

@return DataManagerTaskSerializer

type UserSerializerWithProjects 

type UserSerializerWithProjects struct {
	Id                 int32     `json:"id,omitempty"`
	FirstName          string    `json:"first_name,omitempty"`
	LastName           string    `json:"last_name,omitempty"`
	Username           string    `json:"username"`
	Email              string    `json:"email,omitempty"`
	LastActivity       time.Time `json:"last_activity,omitempty"`
	Avatar             string    `json:"avatar,omitempty"`
	Initials           string    `json:"initials,omitempty"`
	Phone              string    `json:"phone,omitempty"`
	ActiveOrganization int32     `json:"active_organization,omitempty"`
	// Allow sending newsletters to user
	AllowNewsletters      bool   `json:"allow_newsletters,omitempty"`
	CreatedProjects       string `json:"created_projects,omitempty"`
	ContributedToProjects string `json:"contributed_to_projects,omitempty"`
}

type UserSimple 

type UserSimple struct {
	Id        int32  `json:"id,omitempty"`
	FirstName string `json:"first_name,omitempty"`
	LastName  string `json:"last_name,omitempty"`
	Email     string `json:"email,omitempty"`
	Avatar    string `json:"avatar,omitempty"`
}

Project owner

type UsersApiService 

type UsersApiService service

func (*UsersApiService) ApiCurrentUserResetTokenCreate 

func (a *UsersApiService) ApiCurrentUserResetTokenCreate(ctx context.Context) (InlineResponse201, *http.Response, error)

UsersApiService Reset user token Reset the user token for the current user.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InlineResponse201

func (*UsersApiService) ApiCurrentUserTokenList 

func (a *UsersApiService) ApiCurrentUserTokenList(ctx context.Context) (*http.Response, error)

UsersApiService Get user token Get a user token to authenticate to the API as the current user.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*UsersApiService) ApiCurrentUserWhoamiRead 

func (a *UsersApiService) ApiCurrentUserWhoamiRead(ctx context.Context) (BaseUser, *http.Response, error)

UsersApiService Retrieve my user Retrieve details of the account that you are using to access the API.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return BaseUser

func (*UsersApiService) ApiUsersCreate 

func (a *UsersApiService) ApiUsersCreate(ctx context.Context, data BaseUser) (BaseUser, *http.Response, error)

UsersApiService Create new user Create a user in Label Studio.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return BaseUser

func (*UsersApiService) ApiUsersDelete 

func (a *UsersApiService) ApiUsersDelete(ctx context.Context, id int32) (*http.Response, error)

UsersApiService Delete user Delete a specific Label Studio user.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id User ID

func (*UsersApiService) ApiUsersList 

func (a *UsersApiService) ApiUsersList(ctx context.Context) ([]BaseUser, *http.Response, error)

UsersApiService List users List the users that exist on the Label Studio server.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []BaseUser

func (*UsersApiService) ApiUsersPartialUpdate 

func (a *UsersApiService) ApiUsersPartialUpdate(ctx context.Context, data BaseUser, id int32) (BaseUser, *http.Response, error)

UsersApiService Update user details 

Update details for a specific user, such as their name or contact information, in Label Studio.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param data
* @param id User ID

@return BaseUser

func (*UsersApiService) ApiUsersRead 

func (a *UsersApiService) ApiUsersRead(ctx context.Context, id int32) (BaseUser, *http.Response, error)

UsersApiService Get user info Get info about a specific Label Studio user, based on the user ID.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id User ID

@return BaseUser

type View 

type View struct {
	Id          int32        `json:"id,omitempty"`
	FilterGroup *FilterGroup `json:"filter_group,omitempty"`
	// Custom view data
	Data interface{} `json:"data,omitempty"`
	// Ordering parameters
	Ordering interface{} `json:"ordering,omitempty"`
	// Selected items
	SelectedItems interface{} `json:"selected_items,omitempty"`
	// User who made this view
	User int32 `json:"user,omitempty"`
	// Project ID
	Project int32 `json:"project"`
}

type ViewReset 

type ViewReset struct {
	Project int32 `json:"project"`
}

type Webhook 

type Webhook struct {
	Id           int32 `json:"id,omitempty"`
	Organization int32 `json:"organization,omitempty"`
	Project      int32 `json:"project,omitempty"`
	// URL of webhook
	Url string `json:"url"`
	// If value is False send only action
	SendPayload bool `json:"send_payload,omitempty"`
	// If value is False - used only for actions from WebhookAction
	SendForAllActions bool `json:"send_for_all_actions,omitempty"`
	// Key Value Json of headers
	Headers interface{} `json:"headers,omitempty"`
	// If value is False the webhook is disabled
	IsActive bool     `json:"is_active,omitempty"`
	Actions  []string `json:"actions,omitempty"`
	// Creation time
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Last update time
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type WebhookSerializerForUpdate 

type WebhookSerializerForUpdate struct {
	Id           int32 `json:"id,omitempty"`
	Organization int32 `json:"organization,omitempty"`
	Project      int32 `json:"project,omitempty"`
	// URL of webhook
	Url string `json:"url"`
	// If value is False send only action
	SendPayload bool `json:"send_payload,omitempty"`
	// If value is False - used only for actions from WebhookAction
	SendForAllActions bool `json:"send_for_all_actions,omitempty"`
	// Key Value Json of headers
	Headers interface{} `json:"headers,omitempty"`
	// If value is False the webhook is disabled
	IsActive bool     `json:"is_active,omitempty"`
	Actions  []string `json:"actions,omitempty"`
	// Creation time
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Last update time
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type WebhooksApiApiWebhooksInfoListOpts 

type WebhooksApiApiWebhooksInfoListOpts struct {
	OrganizationOnly optional.Bool
}

type WebhooksApiApiWebhooksListOpts 

type WebhooksApiApiWebhooksListOpts struct {
	Project optional.String
}

type WebhooksApiApiWebhooksPartialUpdateOpts 

type WebhooksApiApiWebhooksPartialUpdateOpts struct {
	SendPayload       optional.Bool
	SendForAllActions optional.Bool
	Headers           optional.String
	IsActive          optional.Bool
	Actions           optional.Interface
}

type WebhooksApiApiWebhooksUpdateOpts 

type WebhooksApiApiWebhooksUpdateOpts struct {
	SendPayload       optional.Bool
	SendForAllActions optional.Bool
	Headers           optional.String
	IsActive          optional.Bool
	Actions           optional.Interface
}

type WebhooksApiService 

type WebhooksApiService service

func (*WebhooksApiService) ApiWebhooksCreate 

func (a *WebhooksApiService) ApiWebhooksCreate(ctx context.Context, data Webhook) (Webhook, *http.Response, error)

WebhooksApiService Create a webhook Create a webhook for your organization.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param data

@return Webhook

func (*WebhooksApiService) ApiWebhooksDelete 

func (a *WebhooksApiService) ApiWebhooksDelete(ctx context.Context, id int32) (*http.Response, error)

WebhooksApiService Delete webhook info

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this webhook.

func (*WebhooksApiService) ApiWebhooksInfoList 

func (a *WebhooksApiService) ApiWebhooksInfoList(ctx context.Context, localVarOptionals *WebhooksApiApiWebhooksInfoListOpts) (*http.Response, error)

func (*WebhooksApiService) ApiWebhooksList 

func (a *WebhooksApiService) ApiWebhooksList(ctx context.Context, localVarOptionals *WebhooksApiApiWebhooksListOpts) ([]Webhook, *http.Response, error)

func (*WebhooksApiService) ApiWebhooksPartialUpdate 

func (a *WebhooksApiService) ApiWebhooksPartialUpdate(ctx context.Context, id int32, data WebhookSerializerForUpdate, url string, localVarOptionals *WebhooksApiApiWebhooksPartialUpdateOpts) (WebhookSerializerForUpdate, *http.Response, error)

func (*WebhooksApiService) ApiWebhooksRead 

func (a *WebhooksApiService) ApiWebhooksRead(ctx context.Context, id int32) (Webhook, *http.Response, error)

WebhooksApiService Get webhook info

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A unique integer value identifying this webhook.

@return Webhook

func (*WebhooksApiService) ApiWebhooksUpdate 

func (a *WebhooksApiService) ApiWebhooksUpdate(ctx context.Context, id int32, data WebhookSerializerForUpdate, url string, localVarOptionals *WebhooksApiApiWebhooksUpdateOpts) (WebhookSerializerForUpdate, *http.Response, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.