Tartalomkészítési API
Az egyéni kérdésre válaszoló Authoring API-val automatizálhatóak a gyakori feladatok, például új kérdésekre adott válaszpárok hozzáadása, valamint projektek létrehozása, közzététele és karbantartása.
Feljegyzés
A szerzői funkciók a REST API-n és a Szerzői SDK-n (előzetes verzió) keresztül érhetők el. Ez a cikk példákat tartalmaz a REST API cURL-vel való használatára. Az összes elérhető paraméter és funkció teljes dokumentációját a REST API referenciatartalma tartalmazza.
Előfeltételek
- A cURL aktuális verziója. Ebben a cikkben számos parancssori kapcsolót használunk, amelyeket a cURL dokumentációjában jegyezünk fel.
- A cikkben szereplő parancsokat Bash-rendszerhéjban való végrehajtásra tervezték. Ezek a parancsok nem mindig működnek a Windows parancssorában vagy a PowerShellben módosítás nélkül. Ha nincs helyileg telepítve Bash-rendszerhéj, használhatja az Azure Cloud Shell bash-környezetét.
Projekt létrehozása
Projekt programozott létrehozása:
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Azt is megteheti, hogy a Language Studio>kérdésében megtalálja az értéket, amely>a Project>Get előrejelzési URL-címének üzembe helyezésére válaszol. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha az előző példa a végpont volt az alábbi kódmintában, akkor csak a régióspecifikus részét kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Azt is megteheti, hogy a Language Studio>kérdésében megtalálja az értéket, amely>a Project>Get előrejelzési URL-címének üzembe helyezésére válaszol. A kulcsérték a mintakérés része. |
NEW-PROJECT-NAME |
Az új egyéni kérdés megválaszolási projekt neve. |
További értékeket is beállíthat, például a projekt nyelvét, az alapértelmezett választ, ha nem található olyan válasz, amely megfelel vagy meghaladja a megbízhatósági küszöbértéket, és hogy ez a nyelvi erőforrás több nyelvet is támogat-e.
Példa lekérdezés
curl -X PATCH -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{
"description": "proj1 is a test project.",
"language": "en",
"settings": {
"defaultAnswer": "No good match found for your question in the project."
},
"multilingualResource": true
}
}' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{NEW-PROJECT-NAME}?api-version=2021-10-01'
Példaválasz
{
"200": {
"headers": {},
"body": {
"projectName": "proj1",
"description": "proj1 is a test project.",
"language": "en",
"settings": {
"defaultAnswer": "No good match found for your question in the project."
},
"multilingualResource": true,
"createdDateTime": "2021-05-01T15:13:22Z",
"lastModifiedDateTime": "2021-05-01T15:13:22Z",
"lastDeployedDateTime": "2021-05-01T15:13:22Z"
}
}
}
Projekt törlése
Projekt programozott törlése:
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha az előző példa a végpont volt az alábbi kódmintában, akkor csak a régióspecifikus részét kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
A törölni kívánt projekt neve. |
Példa lekérdezés
curl -X DELETE -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}?api-version=2021-10-01'
Egy projekt törlésére irányuló sikeres hívás egy fejléc visszaadását Operation-Location eredményezi, amely a projekt törlése feladat állapotának ellenőrzésére használható. A legtöbb példánkban nem kellett megnézni a válaszfejléceket, ezért nem jelenítettük meg őket. A válaszfejlécek lekéréséhez a curl parancsot használjuk -i. A végpontcím előtti paraméter nélkül a parancsra adott válasz üresen jelenik meg, mintha nem lenne válasz.
Példaválasz
HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deletion-jobs/{JOB-ID-GUID}
x-envoy-upstream-service-time: 324
apim-request-id:
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Tue, 23 Nov 2021 20:56:18 GMT
Ha a projekt már törölve lett, vagy nem található, a következő üzenet érkezik:
{
"error": {
"code": "ProjectNotFound",
"message": "The specified project was not found.",
"details": [
{
"code": "ProjectNotFound",
"message": "{GUID}"
}
]
}
}
Projekttörlés állapotának lekérése
A törlési projektkérelem állapotának ellenőrzése:
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Azt is megteheti, hogy a Language Studio>kérdésében megtalálja az értéket, amely>a Project>Get előrejelzési URL-címének üzembe helyezésére válaszol. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
Annak a projektnek a neve, amelynél ellenőrizni szeretné az üzembe helyezés állapotát. |
JOB-ID |
Amikor programozott módon töröl egy projektet, JOB-ID a rendszer a törlési operation-location kérelem válaszfejlécének részeként jön létre. A JOB-ID guid a végén a operation-location. Például: operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deletion-jobs/{THIS GUID IS YOUR JOB ID} |
Példa lekérdezés
curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/deletion-jobs/{JOB-ID}?api-version=2021-10-01'
Példaválasz
{
"createdDateTime": "2021-11-23T20:56:18+00:00",
"expirationDateTime": "2021-11-24T02:56:18+00:00",
"jobId": "GUID",
"lastUpdatedDateTime": "2021-11-23T20:56:18+00:00",
"status": "succeeded"
}
Projektbeállítások lekérése
Egy adott projekt adatainak lekéréséhez frissítse az alábbi lekérdezés alábbi értékeit:
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
Annak a projektnek a neve, amelyről adatokat szeretne lekérni. |
Példa lekérdezés
curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}?api-version=2021-10-01'
Példaválasz
{
"200": {
"headers": {},
"body": {
"projectName": "proj1",
"description": "proj1 is a test project.",
"language": "en",
"settings": {
"defaultAnswer": "No good match found for your question in the project."
},
"createdDateTime": "2021-05-01T15:13:22Z",
"lastModifiedDateTime": "2021-05-01T15:13:22Z",
"lastDeployedDateTime": "2021-05-01T15:13:22Z"
}
}
}
Kérdésre adott válaszpárok lekérése
Ha egy adott projekt kérdés-válaszpárjait és kapcsolódó információit szeretné lekérni, frissítse az alábbi lekérdezés alábbi értékeit:
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
Annak a projektnek a neve, amelyhez le szeretné kérni az összes kérdésre adott válaszpárt. |
Példa lekérdezés
curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/qnas?api-version=2021-10-01'
Példaválasz
{
"200": {
"headers": {},
"body": {
"value": [
{
"id": 1,
"answer": "ans1",
"source": "source1",
"questions": [
"question 1.1",
"question 1.2"
],
"metadata": {
"k1": "v1",
"k2": "v2"
},
"dialog": {
"isContextOnly": false,
"prompts": [
{
"displayOrder": 1,
"qnaId": 11,
"displayText": "prompt 1.1"
},
{
"displayOrder": 2,
"qnaId": 21,
"displayText": "prompt 1.2"
}
]
},
"lastUpdatedDateTime": "2021-05-01T17:21:14Z"
},
{
"id": 2,
"answer": "ans2",
"source": "source2",
"questions": [
"question 2.1",
"question 2.2"
],
"lastUpdatedDateTime": "2021-05-01T17:21:14Z"
}
]
}
}
}
Források lekérése
Egy adott projekt forrásainak és kapcsolódó információinak lekéréséhez frissítse az alábbi lekérdezés alábbi értékeit:
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
Annak a projektnek a neve, amelyhez le szeretné kérni az összes forrásinformációt. |
Példa lekérdezés
curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT_NAME}/sources?api-version=2021-10-01'
Példaválasz
{
"200": {
"headers": {},
"body": {
"value": [
{
"displayName": "source1",
"sourceUri": "https://learn.microsoft.com/azure/ai-services/qnamaker/overview/overview",
"sourceKind": "url",
"lastUpdatedDateTime": "2021-05-01T15:13:22Z"
},
{
"displayName": "source2",
"sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf",
"sourceKind": "file",
"contentStructureKind": "unstructured",
"lastUpdatedDateTime": "2021-05-01T15:13:22Z"
}
]
}
}
}
Szinonimák lekérése
Egy adott projekt szinonimáinak és kapcsolódó adatainak lekéréséhez frissítse az alábbi lekérdezés alábbi értékeit:
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
Annak a projektnek a neve, amelyről szinonimaadatokat szeretne lekérni. |
Példa lekérdezés
curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/synonyms?api-version=2021-10-01'
Példaválasz
{
"200": {
"headers": {},
"body": {
"value": [
{
"alterations": [
"qnamaker",
"qna maker"
]
},
{
"alterations": [
"botframework",
"bot framework"
]
}
]
}
}
}
Projekt üzembe helyezése
Ha éles környezetben szeretne üzembe helyezni egy projektet, frissítse az alábbi lekérdezés alábbi értékeit:
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
Az éles környezetben üzembe helyezni kívánt projekt neve. |
Példa lekérdezés
curl -X PUT -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/deployments/production?api-version=2021-10-01'
Egy projekt üzembe helyezésére irányuló sikeres hívás egy fejléc visszaadását Operation-Location eredményezi, amely az üzembe helyezési feladat állapotának ellenőrzésére használható. A legtöbb példánkban nem kellett megnézni a válaszfejléceket, ezért nem jelenítettük meg őket. A válaszfejlécek lekéréséhez a curl parancsot használjuk -i. A végpontcím előtti paraméter nélkül a parancsra adott válasz üresen jelenik meg, mintha nem lenne válasz.
Példaválasz
0HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deployments/production/jobs/{JOB-ID-GUID}
x-envoy-upstream-service-time: 31
apim-request-id:
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Tue, 23 Nov 2021 20:35:00 GMT
Projekt üzembe helyezési állapotának lekérése
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
Annak a projektnek a neve, amelynél ellenőrizni szeretné az üzembe helyezés állapotát. |
JOB-ID |
Amikor programozott módon telepít egy projektet, JOB-ID a rendszer a központi telepítési kérelem válaszfejlécének operation-location részeként jön létre. A JOB-ID guid a végén a operation-location. Például: operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deployments/production/jobs/{THIS GUID IS YOUR JOB ID} |
Példa lekérdezés
curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/deployments/production/jobs/{JOB-ID}?api-version=2021-10-01'
Példaválasz
{
"200": {
"headers": {},
"body": {
"errors": [],
"createdDateTime": "2021-05-01T17:21:14Z",
"expirationDateTime": "2021-05-01T17:21:14Z",
"jobId": "{JOB-ID-GUID}",
"lastUpdatedDateTime": "2021-05-01T17:21:14Z",
"status": "succeeded"
}
}
}
Projekt metaadatainak és eszközeinek exportálása
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
Az exportálni kívánt projekt neve. |
Példa lekérdezés
curl -X POST -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{exportAssetTypes": ["qnas","synonyms"]}' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/:export?api-version=2021-10-01&format=tsv'
Példaválasz
HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/Sample-project/export/jobs/{JOB-ID_GUID}
x-envoy-upstream-service-time: 214
apim-request-id:
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Tue, 23 Nov 2021 21:24:03 GMT
Exportálás állapotának ellenőrzése
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
Annak a projektnek a neve, amelynél ellenőrizni szeretné az exportálási állapotot. |
JOB-ID |
Amikor programozott módon exportál egy projektet, JOB-ID a rendszer a operation-location válaszfejléc részeként jön létre az exportálási kérelemhez. A JOB-ID guid a végén a operation-location. Például: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/export/jobs/{THIS GUID IS YOUR JOB ID} |
Példa lekérdezés
curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID}?api-version=2021-10-01'
Példaválasz
{
"createdDateTime": "2021-11-23T21:24:03+00:00",
"expirationDateTime": "2021-11-24T03:24:03+00:00",
"jobId": "JOB-ID-GUID",
"lastUpdatedDateTime": "2021-11-23T21:24:08+00:00",
"status": "succeeded",
"resultUrl": "https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result"
}
Ha közvetlenül próbál hozzáférni a resultUrl fájlhoz, 404-et kap. Hozzá kell fűznie ?api-version=2021-10-01 az elérési utat ahhoz, hogy hitelesített kéréssel elérhetővé tegye: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01
Projekt importálása
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
Annak a projektnek a neve, amely az importálás célhelye szeretne lenni. |
FILE-URI-PATH |
Amikor programozott módon exportál egy projektet, majd ellenőrzi, hogy az exportálás resultUrl a válasz részeként létrejön-e. Például: "resultUrl": "https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result" a resultUrl használatával forrásfájlként hozzáfűzött API-verzióval importálhat egy projektet a következőből: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01. |
Példa lekérdezés
curl -X POST -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{
"fileUri": "FILE-URI-PATH"
}' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/:import?api-version=2021-10-01&format=tsv'
Egy projekt importálásának sikeres hívása egy fejléc visszaadását Operation-Location eredményezi, amely az importálási feladat állapotának ellenőrzésére használható. Számos példánkban nem kellett áttekintenünk a válaszfejléceket, ezért nem jelenítettük meg őket. A válaszfejlécek lekéréséhez a curl parancsot használjuk -i. A végpontcím előtti további paraméter nélkül a parancsra adott válasz üresen jelenik meg, mintha nem lenne válasz.
Példaválasz
HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/import/jobs/{JOB-ID-GUID}
x-envoy-upstream-service-time: 417
apim-request-id:
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 00:35:11 GMT
Importálási állapot ellenőrzése
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
Annak a projektnek a neve, amely az importálás célhelye szeretne lenni. |
JOB-ID |
Amikor programozott módon importál egy projektet, JOB-ID a rendszer a válaszfejléc részeként operation-location jön létre az exportálási kérelemhez. A JOB-ID GUID a végén operation-location. Például: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/import/jobs/{THIS GUID IS YOUR JOB ID} |
Példa lekérdezés
curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME/import/jobs/{JOB-ID-GUID}?api-version=2021-10-01'
Példa lekérdezési válaszra
{
"errors": [],
"createdDateTime": "2021-05-01T17:21:14Z",
"expirationDateTime": "2021-05-01T17:21:14Z",
"jobId": "JOB-ID-GUID",
"lastUpdatedDateTime": "2021-05-01T17:21:14Z",
"status": "succeeded"
}
Üzemelő példányok listázása
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
Annak a projektnek a neve, amelyhez üzembe helyezési listát szeretne létrehozni. |
Példa lekérdezés
curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/deployments?api-version=2021-10-01'
Példaválasz
[
{
"deploymentName": "production",
"lastDeployedDateTime": "2021-10-26T15:12:02Z"
}
]
Projektek listázása
Kérje le az összes kérdésre válaszoló olyan projektek listáját, amelyekhez a fiókja rendelkezik hozzáféréssel.
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
Példa lekérdezés
curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects?api-version=2021-10-01'
Példaválasz
{
"value": [
{
"projectName": "Sample-project",
"description": "My first question answering project",
"language": "en",
"multilingualResource": false,
"createdDateTime": "2021-10-07T04:51:15Z",
"lastModifiedDateTime": "2021-10-27T00:42:01Z",
"lastDeployedDateTime": "2021-11-24T01:34:18Z",
"settings": {
"defaultAnswer": "No good match found in KB"
}
}
]
}
Források frissítése
Ebben a példában egy új forrást adunk hozzá egy meglévő projekthez. Ezzel a paranccsal lecserélheti és törölheti a meglévő forrásokat attól függően, hogy milyen műveleteket ad át a lekérdezés törzsének részeként.
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
Annak a projektnek a neve, amelyben frissíteni szeretné a forrásokat. |
METHOD |
JAVÍTÁS |
Példa lekérdezés
curl -X PATCH -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '[
{
"op": "add",
"value": {
"displayName": "source5",
"sourceKind": "url",
"sourceUri": "https://download.microsoft.com/download/7/B/1/7B10C82E-F520-4080-8516-5CF0D803EEE0/surface-book-user-guide-EN.pdf",
"sourceContentStructureKind": "semistructured"
}
}
]' -i '{LanguageServiceName}.cognitiveservices.azure.com//language/query-knowledgebases/projects/{projectName}/sources?api-version=2021-10-01'
A forrásfrissítés sikeres hívása Operation-Location egy fejléc visszaadását eredményezi, amely az importálási feladat állapotának ellenőrzésére használható. Számos példánkban nem kellett áttekintenünk a válaszfejléceket, ezért nem mindig jelenítettük meg őket. A válaszfejlécek lekéréséhez a curl parancsot használjuk -i. A végpontcím előtti paraméter nélkül a parancsra adott válasz üresen jelenik meg, mintha nem lenne válasz.
Példaválasz
HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/Sample-project/sources/jobs/{JOB_ID_GUID}
x-envoy-upstream-service-time: 412
apim-request-id: dda23d2b-f110-4645-8bce-1a6f8d504b33
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 02:47:53 GMT
Frissítés forrásának állapotának lekérése
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Azt is megteheti, hogy a Language Studio>kérdésében megtalálja az értéket, amely>a Project>Get előrejelzési URL-címének üzembe helyezésére válaszol. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
Annak a projektnek a neve, amely az importálás célhelye szeretne lenni. |
JOB-ID |
Amikor programozott módon frissít egy forrást, JOB-ID a rendszer a válaszfejléc részeként operation-location generálja a forráskérelem frissítését. A JOB-ID GUID a végén operation-location. Például: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/sources/jobs/{THIS GUID IS YOUR JOB ID} |
Példa lekérdezés
curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/sources/jobs/{JOB-ID}?api-version=2021-10-01'
Példaválasz
{
"createdDateTime": "2021-11-24T02:47:53+00:00",
"expirationDateTime": "2021-11-24T08:47:53+00:00",
"jobId": "{JOB-ID-GUID}",
"lastUpdatedDateTime": "2021-11-24T02:47:56+00:00",
"status": "succeeded",
"resultUrl": "/knowledgebases/Sample-project"
}
Kérdés- és válaszpárok frissítése
Ebben a példában egy kérdésre adott válaszpárt adunk hozzá egy meglévő forráshoz. A lekérdezéssel meglévő kérdés-válaszpárokat is módosíthatja vagy törölheti attól függően, hogy milyen műveletet ad át a lekérdezés törzsében. Ha nem rendelkezik elnevezett forrással source5, ez a példa lekérdezés sikertelen lesz. A lekérdezés törzsében található forrásértéket a célprojekthez tartozó forráshoz igazíthatja.
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
Annak a projektnek a neve, amely az importálás célhelye szeretne lenni. |
curl -X PATCH -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '[
{
"op": "add",
"value":{
"id": 1,
"answer": "The latest question answering docs are on https://learn.microsoft.com",
"source": "source5",
"questions": [
"Where do I find docs for question answering?"
],
"metadata": {},
"dialog": {
"isContextOnly": false,
"prompts": []
}
}
}
]' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/qnas?api-version=2021-10-01'
A kérdés-válaszpár frissítésére irányuló sikeres hívás egy fejléc visszaadását eredményezi Operation-Location , amely a frissítési feladat állapotának ellenőrzésére használható. Számos példánkban nem kellett áttekintenünk a válaszfejléceket, ezért nem mindig jelenítettük meg őket. A válaszfejlécek lekéréséhez a curl parancsot használjuk -i. A végpontcím előtti paraméter nélkül a parancsra adott válasz üresen jelenik meg, mintha nem lenne válasz.
Példaválasz
HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/Sample-project/qnas/jobs/{JOB-ID-GUID}
x-envoy-upstream-service-time: 507
apim-request-id:
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 03:16:01 GMT
Frissítési kérdés válaszpárok állapotának lekérése
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
Annak a projektnek a neve, amely a kérdésre adott válaszpárok frissítésének célhelye szeretne lenni. |
JOB-ID |
Amikor programozott módon frissít egy kérdés-válaszpárt, JOB-ID a rendszer a operation-location válaszfejléc részeként jön létre a frissítési kérelemhez. A JOB-ID GUID a végén operation-location. Például: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/qnas/jobs/{THIS GUID IS YOUR JOB ID} |
Példa lekérdezés
curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/qnas/jobs/{JOB-ID}?api-version=2021-10-01'
Példaválasz
"createdDateTime": "2021-11-24T03:16:01+00:00",
"expirationDateTime": "2021-11-24T09:16:01+00:00",
"jobId": "{JOB-ID-GUID}",
"lastUpdatedDateTime": "2021-11-24T03:16:06+00:00",
"status": "succeeded",
"resultUrl": "/knowledgebases/Sample-project"
Szinonimák frissítése
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
A szinonimákat hozzáadni kívánt projekt neve. |
Példa lekérdezés
curl -X PUT -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{
"value": [
{
"alterations": [
"qnamaker",
"qna maker"
]
},
{
"alterations": [
"botframework",
"bot framework"
]
}
]
}' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/synonyms?api-version=2021-10-01'
Példaválasz
0HTTP/2 200
content-length: 17
content-type: application/json; charset=utf-8
x-envoy-upstream-service-time: 39
apim-request-id: 5deb2692-dac8-43a8-82fe-36476e407ef6
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 03:59:09 GMT
{
"value": []
}
Aktív tanulási visszajelzés frissítése
| Változó neve | Érték |
|---|---|
ENDPOINT |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. Példavégpont: https://southcentralus.api.cognitive.microsoft.com/. Ha ez az ön végpontja az alábbi kódmintában, akkor csak a régióspecifikus részt kell hozzáadnia southcentral , mivel a végpont útvonalának többi része már jelen van. |
API-KEY |
Ez az érték a Kulcsok és végpont szakaszban található meg, amikor megvizsgálja az erőforrást az Azure Portalon. Használhatja az 1. vagy a 2. kulcsot is. Ha mindig két érvényes billentyűvel rendelkezik, akkor a kulcsok biztonságos forgása nulla állásidővel biztosítható. Másik lehetőségként megtalálhatja az értéket a Language Studio>kérdésében, amely megválaszolja>a Project>Get előrejelzési URL-címének üzembe helyezését. A kulcsérték a mintakérés része. |
PROJECT-NAME |
Annak a projektnek a neve, amely az aktív tanulási visszajelzési frissítések célhelye szeretne lenni. |
Példa lekérdezés
curl -X POST -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{
records": [
{
"userId": "user1",
"userQuestion": "hi",
"qnaId": 1
},
{
"userId": "user1",
"userQuestion": "hello",
"qnaId": 2
}
]
}' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/feedback?api-version=2021-10-01'
Példaválasz
HTTP/2 204
x-envoy-upstream-service-time: 37
apim-request-id: 92225e03-e83f-4c7f-b35a-223b1b0f29dd
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 04:02:56 GMT