Prediction - Get Version Prediction

Služba:

Azure AI Services

Verze rozhraní API:

3.0

Získá předpovědi pro verzi aplikace.

POST {Endpoint}/luis/prediction/v3.0/apps/{appId}/versions/{versionId}/predict

S volitelnými parametry:

POST {Endpoint}/luis/prediction/v3.0/apps/{appId}/versions/{versionId}/predict?verbose={verbose}&show-all-intents={show-all-intents}&log={log}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
appId	path	True	string (uuid)	ID aplikace.
Endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus.api.cognitive.microsoft.com).
versionId	path	True	string	ID verze aplikace.
log	query		boolean	Určuje, jestli se má dotaz koncového bodu protokolovat, nebo ne.
show-all-intents	query		boolean	Určuje, jestli se mají vrátit všechny záměry v odpovědi, nebo jenom nejvyšší záměr.
verbose	query		boolean	Určuje, jestli se mají získat další metadata pro predikce entit, nebo ne.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Text požadavku

Name	Vyžadováno	Typ	Description
query	True	string	Dotaz, který se má předpovědět.
dynamicLists		DynamicList[]	Dynamicky vytvořené entity seznamu pro tento požadavek.
externalEntities		ExternalEntity[]	Externě předpovězené entity pro tento požadavek.
options		PredictionRequestOptions	Vlastní možnosti definované pro tento požadavek

Odpovědi

Name	Typ	Description
200 OK	PredictionResponse	Predikce zadaného dotazu
Other Status Codes	Error	Neočekávaná chyba

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

Příklady

Successful Get Version Predictions From Endpoint Via Post request

Ukázkový požadavek

HTTP

POST {Endpoint}/luis/prediction/v3.0/apps/{Application Id}/versions/{Version Id}/predict


{
  "query": "forward to frank 30 dollars through HSBC",
  "options": {
    "datetimeReference": "2015-02-13T13:15:00.000Z"
  },
  "externalEntities": [
    {
      "entityName": "Bank",
      "startIndex": 36,
      "entityLength": 4,
      "resolution": {
        "text": "International Bank"
      }
    }
  ],
  "dynamicLists": [
    {
      "listEntityName": "Employees",
      "requestLists": [
        {
          "name": "Management",
          "canonicalForm": "Frank",
          "synonyms": []
        }
      ]
    }
  ]
}

Ukázková odpověď

Stavový kód:

200

{
  "query": "forward to frank 30 dollars through HSBC",
  "prediction": {
    "topIntent": "give",
    "intents": {
      "give": {
        "score": 0.943442
      }
    },
    "entities": {
      "Employees": [
        [
          "frank"
        ]
      ],
      "number": [
        30
      ],
      "money": [
        {
          "units": "Dollar",
          "value": 30
        }
      ],
      "Bank": [
        {
          "text": "International Bank"
        }
      ]
    },
    "sentiment": {
      "label": "positive",
      "score": 0.9163064
    }
  }
}

Definice

Name	Description
DynamicList	Definuje rozšíření pro entitu seznamu.
Error	Představuje chybu, ke které došlo.
ErrorBody	Představuje definici chyby, ke které došlo.
ExternalEntity	Definuje entitu predikovanou uživatelem, která rozšiřuje již existující entitu.
Intent	Představuje predikci záměru.
Prediction	Představuje predikci dotazu.
PredictionRequest	Představuje parametry prediktivního požadavku.
PredictionRequestOptions	Vlastní možnosti pro požadavek předpovědi.
PredictionResponse	Představuje predikční odpověď.
RequestList	Definuje dílčí seznam, který se má připojit k existující entitě seznamu.
Sentiment	Výsledek analýzy mínění.

DynamicList

Objekt

Definuje rozšíření pro entitu seznamu.

Name	Typ	Description
listEntityName	string	Název entity seznamu, která se má rozšířit.
requestLists	RequestList[]	Seznamy, které se mají připojit k entitě rozšířeného seznamu.

Error

Objekt

Představuje chybu, ke které došlo.

Name	Typ	Description
error	ErrorBody	Představuje definici chyby, ke které došlo.

ErrorBody

Objekt

Představuje definici chyby, ke které došlo.

Name	Typ	Description
code	string	Kód chyby.
message	string	Chybová zpráva.

ExternalEntity

Objekt

Definuje entitu predikovanou uživatelem, která rozšiřuje již existující entitu.

Name	Typ	Description
entityLength	integer (int32)	Délka predikované entity.
entityName	string	Název entity, která se má rozšířit.
resolution		Uživatel zadal vlastní rozlišení, které se má vrátit jako predikce entity.
score	number (float)	Uživatel zadal skóre, které se má vrátit jako skóre předpovědi entity.
startIndex	integer (int32)	Počáteční znak index predikované entity.

Intent

Objekt

Představuje predikci záměru.

Name	Typ	Description
childApp	Prediction	Predikce odesílané aplikace
score	number (float)	Skóre aktivovaného záměru.

Prediction

Objekt

Představuje predikci dotazu.

Name	Typ	Description
alteredQuery	string	Dotaz po kontrole pravopisu. Nastaveno pouze v případě, že byla povolena kontrola pravopisu a byla nalezena chyba pravopisu.
entities		Slovník představující entity, které se aktivovaly.
intents	<string,  Intent>	Slovník představující záměry, které se aktivovaly.
sentiment	Sentiment	Výsledek analýzy mínění.
topIntent	string	Název záměru s nejvyšším skóre.

PredictionRequest

Objekt

Představuje parametry prediktivního požadavku.

Name	Typ	Description
dynamicLists	DynamicList[]	Dynamicky vytvořené entity seznamu pro tento požadavek.
externalEntities	ExternalEntity[]	Externě předpovězené entity pro tento požadavek.
options	PredictionRequestOptions	Vlastní možnosti definované pro tento požadavek
query	string	Dotaz, který se má předpovědět.

PredictionRequestOptions

Objekt

Vlastní možnosti pro požadavek předpovědi.

Name	Typ	Description
datetimeReference	string (date-time)	Referenční hodnota DateTime použitá k predikci entit data a času.
preferExternalEntities	boolean	Zda se má rozlišení externích entit přepsat predikce, pokud dojde k překrytí.

PredictionResponse

Objekt

Představuje predikční odpověď.

Name	Typ	Description
prediction	Prediction	Predikce požadovaného dotazu.
query	string	Dotaz použitý v predikci.

RequestList

Objekt

Definuje dílčí seznam, který se má připojit k existující entitě seznamu.

Name	Typ	Description
canonicalForm	string	Kanonický formulář dílčího seznamu.
name	string	Název dílčího seznamu.
synonyms	string[]	Synonyma kanonické formy.

Sentiment

Objekt

Výsledek analýzy mínění.

Name	Typ	Description
label	string	Popisek výsledku analýzy mínění.
score	number (float)	Skóre mínění dotazu.