Datasets - Create

Usługa:

Azure AI Services

Wersja interfejsu API:

2023-04-01-preview

Zarejestruj nowy zestaw danych.

Zwrócone kody stanu:

• 201: Operacja została ukończona pomyślnie.
• 400: Żądanie zostało źle sformułowane.
• 409: Zestaw danych o określonej nazwie już istnieje.

PUT /datasets/{name}?api-version=2023-04-01-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
name	path	True	string	Nazwa, która może służyć do unikatowego identyfikowania zestawu danych po jego zarejestrowaniu. Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
api-version	query	True	string	Żądana wersja interfejsu API.

Treść żądania

Media Types: "application/json-patch+json"

Nazwa	Typ	Opis
annotationFileUris	string[]	Lista bezwzględnych identyfikatorów URI do plików adnotacji, z których każda musi być przechowywana jako obiekt blob w kontenerze obiektów blob usługi Azure Storage. Każdy plik musi być zgodny z formatem COCO dla określonej adnotacjiKind, a każda ścieżka obrazu jest bezwzględnym identyfikatorem URI obiektu blob w kontenerze obiektów blob. Zasób przetwarzania obrazów musi mieć uprawnienia do odczytywania plików adnotacji i wszystkich przywołynych plików obrazów. Można to zrobić, włączając tożsamości zarządzane przez system dla zasobu przetwarzania obrazów, a następnie przypisując tożsamość do roli, która ma uprawnienia do odczytu z kontenera obiektów blob zawierających adnotację i pliki obrazów.
annotationKind	AnnotationKind	Rodzaj adnotacji zawartych w plikach adnotacji. Na przykład "ImageClassification" w celu określenia, że plik adnotacji zawiera etykiety obiektów do trenowania lub testowania modelu klasyfikacji obrazów wieloklasowych.
authentication	StorageAuthenticationSettingsApiModel	Opisuje ustawienia uwierzytelniania magazynu.
createdDateTime	string	Tylko do odczytu. Data i godzina pierwszego zarejestrowania zestawu danych w formacie UTC.
customProperties	object	Słownik dowolnych par klucz-wartość do użycia przez aplikację. Dozwolone są maksymalnie 10 par klucz-wartość.
eTag	string	Tylko do odczytu. Najnowszy element ETag dla zestawu danych. Może być używany z nagłówkiem "If-Match" podczas aktualizowania lub usuwania zestawu danych.
name	string	Tylko do odczytu. Nazwa używana do unikatowego identyfikowania zestawu danych.
updatedDateTime	string	Tylko do odczytu. Data i godzina ostatniej aktualizacji zestawu danych w formacie UTC.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	Dataset	Utworzone
Other Status Codes	ErrorResponse	Błąd Nagłówki x-ms-error-code: string

Przykłady

RegisterDataset_ImageClassification

Przykładowe żądanie

HTTP

PUT /datasets/my_dataset_name?api-version=2023-04-01-preview

{
  "annotationKind": "imageClassification",
  "annotationFileUris": [
    "https://example.com/dataset.json"
  ]
}

Przykładowa odpowiedź

Kod stanu:

201

{
  "annotationKind": "imageClassification",
  "annotationFileUris": [
    "https://example.com/dataset.json"
  ],
  "name": "my_dataset_name",
  "createdDateTime": "2023-01-13T20:46:20.189Z",
  "updatedDateTime": "2023-01-13T20:46:20.189Z",
  "eTag": "kzktjgnqkjagdlkualdzikaseg"
}

Definicje

Nazwa	Opis
AnnotationKind	Rodzaj adnotacji zawartych w plikach adnotacji. Na przykład "ImageClassification" w celu określenia, że plik adnotacji zawiera etykiety obiektów do trenowania lub testowania modelu klasyfikacji obrazów wieloklasowych.
Dataset	Opisuje zestaw danych, który reprezentuje zestaw obrazów i adnotacji, które mogą być używane do trenowania lub testowania modelu.
ErrorResponse	Odpowiedź zwrócona po wystąpieniu błędu.
ErrorResponseDetails	Informacje o błędzie.
ErrorResponseInnerError	Szczegółowy błąd.
StorageAuthenticationKind	Rodzaj uwierzytelniania magazynu.
StorageAuthenticationSettingsApiModel	Opisuje ustawienia uwierzytelniania magazynu.

AnnotationKind

Rodzaj adnotacji zawartych w plikach adnotacji. Na przykład "ImageClassification" w celu określenia, że plik adnotacji zawiera etykiety obiektów do trenowania lub testowania modelu klasyfikacji obrazów wieloklasowych.

Nazwa	Typ	Opis
imageClassification	string
imageObjectDetection	string

Dataset

Opisuje zestaw danych, który reprezentuje zestaw obrazów i adnotacji, które mogą być używane do trenowania lub testowania modelu.

Nazwa	Typ	Opis
annotationFileUris	string[]	Lista bezwzględnych identyfikatorów URI do plików adnotacji, z których każda musi być przechowywana jako obiekt blob w kontenerze obiektów blob usługi Azure Storage. Każdy plik musi być zgodny z formatem COCO dla określonej adnotacjiKind, a każda ścieżka obrazu jest bezwzględnym identyfikatorem URI obiektu blob w kontenerze obiektów blob. Zasób przetwarzania obrazów musi mieć uprawnienia do odczytywania plików adnotacji i wszystkich przywołynych plików obrazów. Można to zrobić, włączając tożsamości zarządzane przez system dla zasobu przetwarzania obrazów, a następnie przypisując tożsamość do roli, która ma uprawnienia do odczytu z kontenera obiektów blob zawierających adnotację i pliki obrazów.
annotationKind	AnnotationKind	Rodzaj adnotacji zawartych w plikach adnotacji. Na przykład "ImageClassification" w celu określenia, że plik adnotacji zawiera etykiety obiektów do trenowania lub testowania modelu klasyfikacji obrazów wieloklasowych.
authentication	StorageAuthenticationSettingsApiModel	Opisuje ustawienia uwierzytelniania magazynu.
createdDateTime	string	Tylko do odczytu. Data i godzina pierwszego zarejestrowania zestawu danych w formacie UTC.
customProperties	object	Słownik dowolnych par klucz-wartość do użycia przez aplikację. Dozwolone są maksymalnie 10 par klucz-wartość.
eTag	string	Tylko do odczytu. Najnowszy element ETag dla zestawu danych. Może być używany z nagłówkiem "If-Match" podczas aktualizowania lub usuwania zestawu danych.
name	string	Tylko do odczytu. Nazwa używana do unikatowego identyfikowania zestawu danych.
updatedDateTime	string	Tylko do odczytu. Data i godzina ostatniej aktualizacji zestawu danych w formacie UTC.

ErrorResponse

Odpowiedź zwrócona po wystąpieniu błędu.

Nazwa	Typ	Opis
error	ErrorResponseDetails	Informacje o błędzie.

ErrorResponseDetails

Informacje o błędzie.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	ErrorResponseDetails[]	Lista szczegółowych błędów.
innererror	ErrorResponseInnerError	Szczegółowy błąd.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponseInnerError

Szczegółowy błąd.

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	ErrorResponseInnerError	Szczegółowy błąd.
message	string	Komunikat o błędzie.

StorageAuthenticationKind

Rodzaj uwierzytelniania magazynu.

Nazwa	Typ	Opis
managedIdentity	string
none	string
sas	string

StorageAuthenticationSettingsApiModel

Opisuje ustawienia uwierzytelniania magazynu.

Nazwa	Typ	Opis
kind	StorageAuthenticationKind	Rodzaj uwierzytelniania magazynu.
sasToken	string	Opcjonalny. Token sygnatury dostępu współdzielonego do uzyskiwania dostępu do kontenera. Potrzebne tylko wtedy, gdy kind = Sas.