Get Embeddings - Get Embeddings

Layanan:: AI Foundry

Versi API:: 2024-05-01-preview

Mengembalikan vektor penyematan untuk perintah teks tertentu. Metode ini melakukan panggilan REST API ke rute /embeddings pada titik akhir yang diberikan.

POST https://{resource}.services.ai.azure.com/models/embeddings?api-version=2024-05-01-preview

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resource	path	True	string	Nama sumber daya Azure AI Services, misalnya 'my-resource'
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
extra-parameters		ExtraParameters	Mengontrol apa yang terjadi jika parameter tambahan, yang tidak ditentukan oleh REST API, diteruskan dalam payload permintaan JSON. Ini mengatur header permintaan HTTP `extra-parameters`.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
input	True	string[]	Masukkan teks untuk disematkan, dikodekan sebagai string atau array token. Untuk menyematkan beberapa input dalam satu permintaan, berikan array string atau array array token.
dimensions		integer (int32)	Fakultatif. Jumlah dimensi yang harus dimiliki penyematan output yang dihasilkan. Meneruskan null menyebabkan model menggunakan nilai defaultnya. Mengembalikan kesalahan 422 jika model tidak mendukung nilai atau parameter.
encoding_format		EmbeddingEncodingFormat	Fakultatif. Format yang diinginkan untuk penyematan yang dikembalikan.
input_type		EmbeddingInputType	Fakultatif. Jenis input. Mengembalikan kesalahan 422 jika model tidak mendukung nilai atau parameter.
model		string	ID model AI tertentu untuk digunakan, jika lebih dari satu model tersedia di titik akhir.

Respons

Nama	Jenis	Deskripsi
200 OK	EmbeddingsResult	Permintaan telah berhasil.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Respons kesalahan tak terduga. Header x-ms-error-code: string

Nama

Jenis

Deskripsi

200 OK

EmbeddingsResult

Permintaan telah berhasil.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Respons kesalahan tak terduga.

Header

x-ms-error-code: string

Keamanan

api-key

Jenis: apiKey
Dalam: header

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Cakupan

Nama	Deskripsi
https://cognitiveservices.azure.com/.default

Contoh

maximum set embeddings

minimum set embeddings

maximum set embeddings

Permintaan sampel

HTTP

POST https://{resource}.services.ai.azure.com/models/embeddings?api-version=2024-05-01-preview


{
  "input": [
    "This is a very good text"
  ],
  "dimensions": 1024,
  "encoding_format": "float",
  "input_type": "text",
  "model": "my-model-name"
}

Respon sampel

Kode status:: 200

{
  "id": "cknxthfa",
  "data": [
    {
      "index": 0,
      "object": "embedding",
      "embedding": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ],
  "object": "list",
  "model": "my-model-name",
  "usage": {
    "prompt_tokens": 15,
    "total_tokens": 15
  }
}

minimum set embeddings

Permintaan sampel

HTTP

POST https://{resource}.services.ai.azure.com/models/embeddings?api-version=2024-05-01-preview

{
  "input": [
    "This is a very good text"
  ]
}

Respon sampel

Kode status:: 200

{
  "id": "cknxthfa",
  "data": [
    {
      "index": 0,
      "object": "embedding",
      "embedding": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ],
  "object": "list",
  "model": "my-model-name",
  "usage": {
    "prompt_tokens": 15,
    "total_tokens": 15
  }
}

Definisi

Nama	Deskripsi
Azure.Core.Foundations.Error	Objek kesalahan.
Azure.Core.Foundations.ErrorResponse	Respons yang berisi detail kesalahan.
Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai pedoman Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.
EmbeddingEncodingFormat	Menentukan jenis penyematan yang akan dihasilkan. Jenis penyematan terkompresi seperti `uint8`, `int8`, `ubinary` dan `binary`, dapat mengurangi biaya penyimpanan tanpa mengorbankan integritas data. Mengembalikan kesalahan 422 jika model tidak mendukung nilai atau parameter. Baca dokumentasi model untuk mengetahui nilai yang didukung oleh model Anda.
EmbeddingInputType	Mewakili jenis input yang digunakan untuk menyematkan pencarian.
EmbeddingItem	Representasi perbandingan keterkaitan penyematan tunggal.
EmbeddingsOptions	Informasi konfigurasi untuk permintaan penyematan.
EmbeddingsResult	Representasi data respons dari permintaan penyematan. Penyematan mengukur keterkaitan string teks dan umumnya digunakan untuk pencarian, pengklusteran, rekomendasi, dan skenario serupa lainnya.
EmbeddingsUsage	Pengukuran jumlah token yang digunakan dalam permintaan dan respons ini.
ExtraParameters	Mengontrol apa yang terjadi jika parameter tambahan, yang tidak ditentukan oleh REST API, diteruskan dalam payload permintaan JSON.

Azure.Core.Foundations.Error

Objek

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	Azure.Core.Foundations.Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

Azure.Core.Foundations.ErrorResponse

Objek

Respons yang berisi detail kesalahan.

Nama	Jenis	Deskripsi
error	Azure.Core.Foundations.Error	Objek kesalahan.

Azure.Core.Foundations.InnerError

Objek

Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai pedoman Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
innererror	Azure.Core.Foundations.InnerError	Kesalahan dalam.

EmbeddingEncodingFormat

Enumeration

Menentukan jenis penyematan yang akan dihasilkan. Jenis penyematan terkompresi seperti uint8, int8, ubinary dan binary, dapat mengurangi biaya penyimpanan tanpa mengorbankan integritas data. Mengembalikan kesalahan 422 jika model tidak mendukung nilai atau parameter. Baca dokumentasi model untuk mengetahui nilai yang didukung oleh model Anda.

Nilai	Deskripsi
base64	Dapatkan kembali representasi biner dari penyematan yang dikodekan sebagai string Base64. Pustaka OpenAI Python mengambil penyematan dari API sebagai data biner yang dikodekan, daripada menggunakan representasi desimal perantara seperti yang biasanya dilakukan.
binary	Mendapatkan kembali penyematan biner yang ditandatangani
float	Dapatkan kembali penyematan presisi penuh
int8	Dapatkan kembali penyematan int8 yang ditandatangani
ubinary	Mendapatkan kembali penyematan biner yang tidak ditandatangani
uint8	Dapatkan kembali penyematan int8 yang tidak ditandatangani

EmbeddingInputType

Enumeration

Mewakili jenis input yang digunakan untuk menyematkan pencarian.

Nilai	Deskripsi
text	Menunjukkan input adalah input teks umum.
query	Menunjukkan input mewakili kueri pencarian untuk menemukan dokumen yang paling relevan di database vektor Anda.
document	Menunjukkan input mewakili dokumen yang disimpan dalam database vektor.

EmbeddingItem

Objek

Representasi perbandingan keterkaitan penyematan tunggal.

Nama	Jenis	Deskripsi
embedding	number[] (float)	Daftar nilai penyematan untuk perintah input. Ini mewakili pengukuran keterkaitan berbasis vektor dari input yang disediakan. Atau string yang dikodekan base64 dari vektor penyematan.
index	integer (int32)	Indeks perintah yang sesuai dengan EmbeddingItem.
object	enum: embedding	Tipe objek dari item penyematan ini. Akan selalu `embedding`.

EmbeddingsOptions

Objek

Informasi konfigurasi untuk permintaan penyematan.

Nama	Jenis	Deskripsi
dimensions	integer (int32)	Fakultatif. Jumlah dimensi yang harus dimiliki penyematan output yang dihasilkan. Meneruskan null menyebabkan model menggunakan nilai defaultnya. Mengembalikan kesalahan 422 jika model tidak mendukung nilai atau parameter.
encoding_format	EmbeddingEncodingFormat	Fakultatif. Format yang diinginkan untuk penyematan yang dikembalikan.
input	string[]	Masukkan teks untuk disematkan, dikodekan sebagai string atau array token. Untuk menyematkan beberapa input dalam satu permintaan, berikan array string atau array array token.
input_type	EmbeddingInputType	Fakultatif. Jenis input. Mengembalikan kesalahan 422 jika model tidak mendukung nilai atau parameter.
model	string	ID model AI tertentu untuk digunakan, jika lebih dari satu model tersedia di titik akhir.

EmbeddingsResult

Objek

Representasi data respons dari permintaan penyematan. Penyematan mengukur keterkaitan string teks dan umumnya digunakan untuk pencarian, pengklusteran, rekomendasi, dan skenario serupa lainnya.

Nama	Jenis	Deskripsi
data	EmbeddingItem[]	Menyematkan nilai untuk perintah yang dikirimkan dalam permintaan.
id	string	Pengidentifikasi unik untuk hasil penyematan.
model	string	ID model yang digunakan untuk menghasilkan hasil ini.
object	enum: list	Jenis objek hasil penyematan. Akan selalu `list`.
usage	EmbeddingsUsage	Jumlah penggunaan untuk input token menggunakan API penyematan.

EmbeddingsUsage

Objek

Pengukuran jumlah token yang digunakan dalam permintaan dan respons ini.

Nama	Jenis	Deskripsi
prompt_tokens	integer (int32)	Jumlah token dalam permintaan.
total_tokens	integer (int32)	Jumlah total token yang ditransaksikan dalam permintaan/respons ini. Harus sama dengan jumlah token dalam permintaan.

ExtraParameters

Enumeration

Mengontrol apa yang terjadi jika parameter tambahan, yang tidak ditentukan oleh REST API, diteruskan dalam payload permintaan JSON.

Nilai	Deskripsi
error	Layanan akan melakukan kesalahan jika mendeteksi parameter tambahan dalam payload permintaan. Ini adalah default layanan.
drop	Layanan akan mengabaikan (menghilangkan) parameter tambahan dalam payload permintaan. Ini hanya akan meneruskan parameter yang diketahui ke model AI back-end.
pass-through	Layanan ini akan meneruskan parameter tambahan ke model AI back-end.

Bagikan melalui

Get Embeddings - Get Embeddings

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Keamanan

api-key

OAuth2Auth

Cakupan

Contoh

maximum set embeddings

Permintaan sampel

Respon sampel

minimum set embeddings

Permintaan sampel

Respon sampel

Definisi

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

EmbeddingEncodingFormat

EmbeddingInputType

EmbeddingItem

EmbeddingsOptions

EmbeddingsResult

EmbeddingsUsage

ExtraParameters