Analisis Teks (Azure Cognitive Search REST API)

Analyze API menunjukkan bagaimana penganalisis memecah teks menjadi token. Ini ditujukan untuk pengujian interaktif sehingga Anda dapat melihat bagaimana penganalisis tertentu akan membuat token input string.

POST https://[service name].search.windows.net/indexes/[index name]/analyze?api-version=[api-version]
    Content-Type: application/json
    api-key: [admin key]

Untuk menentukan penganalisis yang digunakan selama pengindeksan dan eksekusi kueri, atur properti penganalisis pada bidang string dalam indeks.

Parameter URI

Parameter Deskripsi
nama layanan Wajib diisi. Atur ini ke nama unik yang ditentukan pengguna dari layanan pencarian Anda.
nama indeks Wajib diisi. URI permintaan menentukan nama indeks yang berisi bidang yang ingin Anda analisis.
versi-api Wajib diisi. Versi stabil saat ini adalah api-version=2020-06-30. Lihat Versi API untuk versi lainnya.

Judul Permintaan

Tabel berikut ini menjelaskan header permintaan yang diperlukan dan opsional.

Bidang Deskripsi
Jenis-Konten Wajib diisi. Atur titik akhir ini ke application/json
api-key Wajib diisi. api-key digunakan untuk mengautentikasi permintaan ke layanan Pencarian Anda. Ini adalah nilai string, unik untuk layanan Anda. Permintaan penganalisis harus menyertakan header yang api-key diatur ke kunci admin Anda (dibandingkan dengan kunci kueri). Anda dapat menemukan kunci API di dasbor layanan pencarian di portal Azure.

Isi Permintaan

{
  "text": "Text to analyze",
  "analyzer": "analyzer_name"
}

atau

{
  "text": "Text to analyze",
  "tokenizer": "tokenizer_name",
  "tokenFilters": (optional) [ "token_filter_name" ],
  "charFilters": (optional) [ "char_filter_name" ]
}

analyzer_name, tokenizer_name, token_filter_name dan char_filter_name harus berupa nama yang valid dari penganalisis yang telah ditentukan atau kustom, tokenizer, filter token, dan filter karakter untuk indeks. Untuk mempelajari selengkapnya tentang proses analisis leksikal, lihat Analisis di Azure Cognitive Search.

Respons

Kode Status: 200 OK dikembalikan untuk respons yang berhasil.

Isi respons dalam format berikut:

    {
      "tokens": [
        {
          "token": string (token),
          "startOffset": number (index of the first character of the token),
          "endOffset": number (index of the last character of the token),
          "position": number (position of the token in the input text)
        },
        ...
      ]
    }

Contoh

Isi permintaan menyertakan string dan penganalisis yang ingin Anda gunakan.

     {
       "text": "The quick brown fox",
       "analyzer": "standard"
     }

Respons menunjukkan token yang dipancarkan oleh penganalisis untuk string yang Anda berikan.

{
    "tokens": [
        {
            "token": "the",
            "startOffset": 0,
            "endOffset": 3,
            "position": 0
        },
        {
            "token": "quick",
            "startOffset": 4,
            "endOffset": 9,
            "position": 1
        },
        {
            "token": "brown",
            "startOffset": 10,
            "endOffset": 15,
            "position": 2
        },
        {
            "token": "fox",
            "startOffset": 16,
            "endOffset": 19,
            "position": 3
        }
    ]
}

Lihat juga