Evaluations - Update

Uppdateringar de föränderliga detaljerna i utvärderingen som identifieras med dess ID.

PATCH {endpoint}/speechtotext/v3.2-preview.2/evaluations/{id}

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
path True

string

Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus.api.cognitive.microsoft.com).

id
path True

string

uuid

Identifieraren för utvärderingen.

Begärandetext

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

Name Typ Description
customProperties

object

De anpassade egenskaperna för den här entiteten. Den maximala tillåtna nyckellängden är 64 tecken, den maximala tillåtna värdelängden är 256 tecken och antalet tillåtna poster är 10.

description

string

Beskrivningen av objektet.

displayName

string

Namnet på objektet.

project

EntityReference

EntityReference

Svar

Name Typ Description
200 OK

Evaluation

OK

Headers

Retry-After: integer

Other Status Codes

Error

Ett fel inträffade.

Säkerhet

Ocp-Apim-Subscription-Key

Ange din cognitive services-kontonyckel här.

Type: apiKey
In: header

Authorization

Ange en åtkomsttoken från den JWT som returneras av STS i den här regionen. Se till att lägga till hanteringsomfånget i token genom att lägga till följande frågesträng i STS-URL:en: ?scope=speechservicesmanagement

Type: apiKey
In: header

Exempel

Update a evaluation

Sample Request

PATCH {endpoint}/speechtotext/v3.2-preview.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6

{
  "displayName": "Updated evaluation",
  "description": "Updated evaluation description"
}

Sample Response

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6",
  "model1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "model2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "dataset": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
  },
  "transcription2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
  },
  "transcription1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
  },
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/evaluations/00000000-0000-0000-0000-000000000000/files"
  },
  "properties": {
    "wordErrorRate2": 0.065,
    "wordErrorRate1": 0.065,
    "sentenceErrorRate2": 0.375,
    "sentenceCount2": 8,
    "wordCount2": 46,
    "correctWordCount2": 43,
    "wordSubstitutionCount2": 3,
    "wordDeletionCount2": 0,
    "wordInsertionCount2": 0,
    "sentenceErrorRate1": 0.375,
    "sentenceCount1": 8,
    "wordCount1": 46,
    "correctWordCount1": 43,
    "wordSubstitutionCount1": 3,
    "wordDeletionCount1": 0,
    "wordInsertionCount1": 0,
    "tokenErrorRate2": 0.125,
    "tokenErrorRate1": 0.125,
    "tokenCount2": 48,
    "correctTokenCount2": 42,
    "tokenSubstitutionCount2": 6,
    "tokenDeletionCount2": 0,
    "tokenInsertionCount2": 0,
    "tokenCount1": 48,
    "correctTokenCount1": 42,
    "tokenSubstitutionCount1": 6,
    "tokenDeletionCount1": 0,
    "tokenInsertionCount1": 0
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Evalution of one model against another model"
}

Definitioner

Name Description
DetailedErrorCode

DetailedErrorCode

EntityError

EntityError

EntityReference

EntityReference

Error

Fel

ErrorCode

Felkod

Evaluation

Utvärdering

EvaluationLinks

EvaluationLinks

EvaluationProperties

EvaluationProperties

EvaluationUpdate

EvaluationUpdate

InnerError

InnerError

Status

Status

DetailedErrorCode

DetailedErrorCode

Name Typ Description
DataImportFailed

string

Dataimporten misslyckades.

DeleteNotAllowed

string

Ta bort tillåts inte.

DeployNotAllowed

string

Distribution tillåts inte.

DeployingFailedModel

string

Det gick inte att distribuera modellen.

EmptyRequest

string

Tom begäran.

EndpointCannotBeDefault

string

Slutpunkten kan inte vara standard.

EndpointNotUpdatable

string

Slutpunkten kan inte uppdateras.

EndpointWithoutLogging

string

Slutpunkt utan loggning.

ExceededNumberOfRecordingsUris

string

Överskred antalet inspelningar.

FailedDataset

string

Datauppsättningen misslyckades.

Forbidden

string

Förbjudet.

InUseViolation

string

Vid användningsöverträdelse.

InaccessibleCustomerStorage

string

Otillgänglig kundlagring.

InvalidAdaptationMapping

string

Ogiltig anpassningsmappning.

InvalidBaseModel

string

Ogiltig basmodell.

InvalidCallbackUri

string

Ogiltig återanrops-URI.

InvalidCollection

string

Ogiltig samling.

InvalidDataset

string

Ogiltig datauppsättning.

InvalidDocument

string

Ogiltigt dokument.

InvalidDocumentBatch

string

Ogiltig dokumentbatch.

InvalidLocale

string

Ogiltigt språk.

InvalidLogDate

string

Ogiltigt loggdatum.

InvalidLogEndTime

string

Ogiltig sluttid för logg.

InvalidLogId

string

Ogiltigt logg-ID.

InvalidLogStartTime

string

Ogiltig starttid för logg.

InvalidModel

string

Ogiltig modell.

InvalidModelUri

string

Ogiltig modell-URI.

InvalidParameter

string

Ogiltig parameter.

InvalidParameterValue

string

Ogiltigt parametervärde.

InvalidPayload

string

Ogiltig nyttolast.

InvalidPermissions

string

Ogiltiga behörigheter.

InvalidPrerequisite

string

Ogiltigt krav.

InvalidProductId

string

Ogiltigt produkt-ID.

InvalidProject

string

Ogiltigt projekt.

InvalidProjectKind

string

Ogiltig projekttyp.

InvalidRecordingsUri

string

Ogiltig inspelnings-URI.

InvalidRequestBodyFormat

string

Ogiltigt format för begärandetext.

InvalidSasValidityDuration

string

Ogiltig varaktighet för SAS-giltighet.

InvalidSkipTokenForLogs

string

Ogiltig hopptoken för loggar.

InvalidSourceAzureResourceId

string

Ogiltigt käll-resurs-ID för Azure.

InvalidSubscription

string

Ogiltig prenumeration.

InvalidTest

string

Ogiltigt test.

InvalidTimeToLive

string

Ogiltigt time to live.

InvalidTopForLogs

string

Ogiltig topp för loggar.

InvalidTranscription

string

Ogiltig transkription.

InvalidWebHookEventKind

string

Ogiltig webhookhändelsetyp.

MissingInputRecords

string

Indataposter saknas.

ModelCopyOperationExists

string

Modellkopieringsåtgärden finns.

ModelDeploymentNotCompleteState

string

Modelldistributionen är inte fullständigt.

ModelDeprecated

string

Modellen är inaktuell.

ModelExists

string

Modellen finns.

ModelMismatch

string

Modellmatchningsfel.

ModelNotDeployable

string

Modellen kan inte distribueras.

ModelVersionIncorrect

string

Felaktig modellversion.

NoUtf8WithBom

string

Ingen utf8 med bom.

OnlyOneOfUrlsOrContainerOrDataset

string

Endast en av URL:erna, containern eller datauppsättningen.

ProjectGenderMismatch

string

Projektets könsmatchningsfel.

QuotaViolation

string

Kvotöverträdelse.

SingleDefaultEndpoint

string

Enskild standardslutpunkt.

SkuLimitsExist

string

Det finns SKU-gränser.

SubscriptionNotFound

string

Det går inte att hitta prenumerationen.

UnexpectedError

string

Oväntat fel.

UnsupportedClassBasedAdaptation

string

Klassbaserad anpassning stöds inte.

UnsupportedDelta

string

Delta stöds inte.

UnsupportedDynamicConfiguration

string

Dynamisk konfiguration som inte stöds.

UnsupportedFilter

string

Filter som inte stöds.

UnsupportedLanguageCode

string

Språkkod som inte stöds.

UnsupportedOrderBy

string

Beställningen stöds inte av.

UnsupportedPagination

string

Sidnumrering stöds inte.

UnsupportedTimeRange

string

Tidsintervallet stöds inte.

EntityError

EntityError

Name Typ Description
code

string

Koden för det här felet.

message

string

Meddelandet för det här felet.

EntityReference

EntityReference

Name Typ Description
self

string

Platsen för den refererade entiteten.

Error

Fel

Name Typ Description
code

ErrorCode

Felkod
Felkoder på hög nivå.

details

Error[]

Ytterligare stödjande information om fel- och/eller förväntade principer.

innerError

InnerError

InnerError
Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper mål, information (nyckelvärdepar), inre fel (detta kan kapslas).

message

string

Felmeddelande på hög nivå.

target

string

Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt.

ErrorCode

Felkod

Name Typ Description
Conflict

string

Representerar konfliktfelkoden.

Forbidden

string

Representerar den otillåtna felkoden.

InternalCommunicationFailed

string

Det gick inte att representera felkoden för intern kommunikation.

InternalServerError

string

Representerar felkoden för den interna servern.

InvalidArgument

string

Representerar den ogiltiga argumentfelkoden.

InvalidRequest

string

Representerar felkoden för ogiltig begäran.

NotAllowed

string

Representerar den felkod som inte tillåts.

NotFound

string

Representerar felkoden som inte hittades.

PipelineError

string

Representerar felkoden för pipelinefel.

ServiceUnavailable

string

Representerar felkoden för tjänsten som inte är tillgänglig.

TooManyRequests

string

Representerar felkoden för många begäranden.

Unauthorized

string

Representerar den otillåtna felkoden.

UnprocessableEntity

string

Representerar felkoden för entiteten som inte kan bearbetas.

UnsupportedMediaType

string

Representerar felkoden för medietypen som inte stöds.

Evaluation

Utvärdering

Name Typ Description
createdDateTime

string

Tidsstämpeln när objektet skapades. Tidsstämpeln är kodad som ISO 8601 datum- och tidsformat ("ÅÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

customProperties

object

De anpassade egenskaperna för den här entiteten. Den maximala tillåtna nyckellängden är 64 tecken, den maximala tillåtna värdelängden är 256 tecken och antalet tillåtna poster är 10.

dataset

EntityReference

EntityReference

description

string

Beskrivningen av objektet.

displayName

string

Visningsnamnet för objektet.

lastActionDateTime

string

Tidsstämpeln när den aktuella statusen angavs. Tidsstämpeln är kodad som ISO 8601 datum- och tidsformat ("ÅÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

links

EvaluationLinks

EvaluationLinks

locale

string

Nationella inställningar för inneslutna data.

model1

EntityReference

EntityReference

model2

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

EvaluationProperties

EvaluationProperties

self

string

Platsen för den här entiteten.

status

Status

Status
Beskriva api:ets aktuella tillstånd

transcription1

EntityReference

EntityReference

transcription2

EntityReference

EntityReference

EvaluationLinks

Name Typ Description
files

string

Platsen för att hämta alla filer i den här entiteten. Mer information finns i åtgärden "Evaluations_ListFiles".

EvaluationProperties

EvaluationProperties

Name Typ Description
correctTokenCount1

integer

Antalet token som identifieras korrekt av model1.

correctTokenCount2

integer

Antalet token som identifieras korrekt av model2.

correctWordCount1

integer

Antalet korrekt identifierade ord efter model1.

correctWordCount2

integer

Antalet korrekt identifierade ord enligt model2.

email

string

E-postadressen som e-postaviseringar ska skickas till om åtgärden slutförs. Värdet tas bort när e-postmeddelandet har skickats.

error

EntityError

EntityError

sentenceCount1

integer

Antalet bearbetade meningar efter model1.

sentenceCount2

integer

Antalet bearbetade meningar efter model2.

sentenceErrorRate1

number

Igenkänningsfrekvensen för meningsfel med model1.

sentenceErrorRate2

number

Igenkänningsfrekvensen för meningsfel med model2.

tokenCount1

integer

Antalet bearbetade token per model1.

tokenCount2

integer

Antalet bearbetade token per model2.

tokenDeletionCount1

integer

Antalet identifierade token efter model1, som är borttagningar.

tokenDeletionCount2

integer

Antalet identifierade token efter model2, som är borttagningar.

tokenErrorRate1

number

Tokenfelfrekvensen för igenkänning med model1.

tokenErrorRate2

number

Tokenfelfrekvensen för igenkänning med model2.

tokenInsertionCount1

integer

Antalet identifierade token efter model1, som är infogningar.

tokenInsertionCount2

integer

Antalet identifierade token efter model2, som är infogningar.

tokenSubstitutionCount1

integer

Antalet identifierade token efter model1, som är ersättningar.

tokenSubstitutionCount2

integer

Antalet identifierade token efter model2, som är ersättningar.

wordCount1

integer

Antalet bearbetade ord efter model1.

wordCount2

integer

Antalet bearbetade ord efter model2.

wordDeletionCount1

integer

Antalet identifierade ord efter model1, som är borttagningar.

wordDeletionCount2

integer

Antalet identifierade ord efter model2, som är borttagningar.

wordErrorRate1

number

Ordet felfrekvens för igenkänning med model1.

wordErrorRate2

number

Ordet felfrekvens för igenkänning med model2.

wordInsertionCount1

integer

Antalet identifierade ord efter model1, som är infogningar.

wordInsertionCount2

integer

Antalet identifierade ord enligt model2, som är infogningar.

wordSubstitutionCount1

integer

Antalet identifierade ord efter model1, som är ersättningar.

wordSubstitutionCount2

integer

Antalet identifierade ord efter model2, som är ersättningar.

EvaluationUpdate

EvaluationUpdate

Name Typ Description
customProperties

object

De anpassade egenskaperna för den här entiteten. Den maximala tillåtna nyckellängden är 64 tecken, den maximala tillåtna värdelängden är 256 tecken och antalet tillåtna poster är 10.

description

string

Beskrivningen av objektet.

displayName

string

Namnet på objektet.

project

EntityReference

EntityReference

InnerError

InnerError

Name Typ Description
code

DetailedErrorCode

DetailedErrorCode
Detaljerad felkodsuppräkning.

details

object

Ytterligare stödjande information om fel- och/eller förväntade principer.

innerError

InnerError

InnerError
Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller de obligatoriska egenskaperna ErrorCode, message och optional properties target, details(key value pair), inner error(this can be nested).

message

string

Felmeddelande på hög nivå.

target

string

Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt.

Status

Status

Name Typ Description
Failed

string

Den långvariga åtgärden misslyckades.

NotStarted

string

Den långvariga åtgärden har ännu inte startats.

Running

string

Den tidskrävande åtgärden bearbetas för närvarande.

Succeeded

string

Den långvariga åtgärden har slutförts.