Translator 3.0: Ordlisteexempel

Artikel
09/01/2024

Innehåller exempel som visar hur termer i ordlistan används i kontexten. Den här åtgärden används tillsammans med ordlistesökning.

Begärans-URL

Skicka en POST-begäran till:

https://api.cognitive.microsofttranslator.com/dictionary/examples?api-version=3.0

Se Stöd för virtuellt nätverk för Translator-tjänsten valt nätverk och privat slutpunktskonfiguration och support.

Parametrar för begäran

Begärandeparametrar som skickas på frågesträngen är:

Frågeparameter	beskrivning
api-version	Obligatorisk parameter. Version av API:et som begärs av klienten. Värdet måste vara `3.0`.
from	Obligatorisk parameter. Anger språket för indatatexten. Källspråket måste vara ett av de språk som stöds i omfånget`dictionary`.
to	Obligatorisk parameter. Anger språket för utdatatexten. Målspråket måste vara ett av de språk som stöds i omfånget`dictionary`.

Bland begäranderubrikerna finns:

Sidhuvuden	beskrivning
Autentiseringshuvuden	Obligatoriskt begärandehuvud. Se Tillgängliga autentiseringsalternativ>för autentisering.
Innehållstyp	Obligatoriskt begärandehuvud. Anger nyttolastens innehållstyp. Möjliga värden är: `application/json`.
Innehållslängd	Valfritt. Längden på begärandetexten.
X-ClientTraceId	Valfritt. Ett klientgenererat GUID för att unikt identifiera begäran. Du kan utelämna den här rubriken om du inkluderar spårnings-ID:t i frågesträngen med hjälp av en frågeparameter med namnet `ClientTraceId`.

Begärandetext

Brödtexten i begäran är en JSON-matris. Varje matriselement är ett JSON-objekt med följande egenskaper:

Text: En sträng som anger termen som ska slås upp. Den här egenskapen ska vara värdet för ett normalizedText fält från back-translations av en tidigare ordlistesökningsbegäran . Det kan också vara värdet för fältet normalizedSource .
Translation: En sträng som anger den översatta text som tidigare returnerats av uppslagsåtgärden Ordlista. Den här egenskapen ska vara värdet från fältet normalizedTarget i listan över ordlistesökningssvaret.translations Tjänsten returnerar exempel för det specifika ordparet source-target.

Ett exempel är:

[
    {"Text":"fly", "Translation":"volar"}
]

Följande begränsningar gäller:

Matrisen kan ha högst 10 element.
Textvärdet för ett matriselement får inte överstiga 100 tecken, inklusive blanksteg.

Själva svaret

Ett lyckat svar är en JSON-matris med ett resultat för varje sträng i indatamatrisen. Ett resultatobjekt innehåller följande egenskaper:

normalizedSource: En sträng som ger den normaliserade formen av källtermen. I allmänhet bör den här egenskapen vara identisk med värdet Text för fältet i matchande listindex i brödtexten i begäran.
normalizedTarget: En sträng som ger den normaliserade formen av måltermen. I allmänhet bör den här egenskapen vara identisk med värdet Translation för fältet i matchande listindex i brödtexten i begäran.
examples: En lista med exempel för paret (källtermen, måltermen). Varje element i listan är ett objekt med följande egenskaper:
sourcePrefix: Strängen som ska sammanfogas före värdet sourceTerm för för att bilda ett fullständigt exempel. Lägg inte till ett blankstegstecken eftersom det redan finns där när det ska vara det. Det här värdet kan vara en tom sträng.
sourceTerm: En sträng som är lika med den faktiska termen som har letats upp. Strängen läggs till med sourcePrefix och sourceSuffix för att bilda det fullständiga exemplet. Dess värde är avgränsat så att det kan markeras i ett användargränssnitt, till exempel genom att fetstila det.
- sourceSuffix: Strängen som ska sammanfogas efter värdet sourceTerm för för att bilda ett fullständigt exempel. Lägg inte till ett blankstegstecken eftersom det redan finns där när det ska vara det. Det här värdet kan vara en tom sträng.
- targetPrefix: En sträng som liknar sourcePrefix men för målet.
- targetTerm: En sträng som liknar sourceTerm men för målet.
- targetSuffix: En sträng som liknar sourceSuffix men för målet.
  
  Kommentar
  
  Om det inte finns några exempel i ordlistan är svaret 200 (OK) men listan examples är en tom lista.

Exempel

Det här exemplet visar hur du söker efter exempel för paret som består av den engelska termen fly och dess spanska översättning volar.

curl -X POST "https://api.cognitive.microsofttranslator.com/dictionary/examples?api-version=3.0&from=en&to=es" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d "[{'Text':'fly', 'Translation':'volar'}]"

Svarstexten (förkortad för tydlighetens skull) är:

[
    {
        "normalizedSource":"fly",
        "normalizedTarget":"volar",
        "examples":[
            {
                "sourcePrefix":"They need machines to ",
                "sourceTerm":"fly",
                "sourceSuffix":".",
                "targetPrefix":"Necesitan máquinas para ",
                "targetTerm":"volar",
                "targetSuffix":"."
            },
            {
                "sourcePrefix":"That should really ",
                "sourceTerm":"fly",
                "sourceSuffix":".",
                "targetPrefix":"Eso realmente debe ",
                "targetTerm":"volar",
                "targetSuffix":"."
            },
            //
            // ...list abbreviated for documentation clarity
            //
        ]
    }
]

Dela via