Aracılığıyla paylaş


Conversational Analysis Authoring - Get Supported Prebuilt Entities

Oluşturulan varlıkları oluştururken kullanılabilecek desteklenen önceden oluşturulmuş varlıkları Listeler.

GET {Endpoint}/language/authoring/analyze-conversations/projects/global/prebuilt-entities?api-version=2023-04-01
GET {Endpoint}/language/authoring/analyze-conversations/projects/global/prebuilt-entities?language={language}&multilingual={multilingual}&top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-01

URI Parametreleri

Name İçinde Gerekli Tür Description
Endpoint
path True

string

Desteklenen Bilişsel Hizmetler uç noktası (ör. https://.api.cognitiveservices.azure.com).

api-version
query True

string

İstemci API sürümü.

language
query

string

Için desteklenen önceden oluşturulmuş varlıkları almak için dil. Çok dilli yanlışsa gereklidir. Bu, bir dilin BCP-47 gösterimidir. Örneğin, İngilizce için "en", İngilizce (Birleşik Krallık) için "en-gb", İspanyolca için "es" vb. kullanın.

maxpagesize
query

integer

int32

Tek bir yanıta eklenecek kaynak sayısı üst sınırı.

multilingual
query

string

Çok dilli veya tek dilli projeler için önceden oluşturulmuş destek varlıklarının alınıp alınmayacağı. True ise, dil parametresi yoksayılır.

skip
query

integer

int32

Döndürülecek ilk kaynağın koleksiyonuna uzaklık.

top
query

integer

int32

Koleksiyondan döndürülecek en fazla kaynak sayısı.

Yanıtlar

Name Tür Description
200 OK

ConversationalAnalysisAuthoringPrebuiltEntities

Önceden oluşturulmuş desteklenen varlıkların listesi.

Other Status Codes

ErrorResponse

Hata yanıtı.

Güvenlik

AADToken

Bunlar Azure Active Directory OAuth2 Akışlarıdır. Azure rol tabanlı erişim denetimiyle eşleştirildiğinde, Azure Haritalar REST API'lerine erişimi denetlemek için kullanılabilir. Azure rol tabanlı erişim denetimleri, bir veya daha fazla Azure Haritalar kaynak hesabına veya alt kaynağa erişim tanımlamak için kullanılır. Tüm kullanıcılara, gruplara veya hizmet sorumlularına yerleşik bir rol veya Azure Haritalar REST API'leri için bir veya daha fazla izinden oluşan özel bir rol aracılığıyla erişim verilebilir.

Senaryoları uygulamak için kimlik doğrulama kavramlarını görüntülemenizi öneririz. Özetle, bu güvenlik tanımı belirli API'ler ve kapsamlar üzerinde erişim denetimi yapabilen nesneler aracılığıyla uygulamaları modellemek için bir çözüm sağlar.

Notlar

  • Bu güvenlik tanımı, uygulamanın erişim istediği Azure Haritalar kaynağı belirtmek için üst bilgi kullanımını x-ms-client-idgerektirir. Bu, Haritalar yönetim API'sinden alınabilir.

Authorization URL, Azure genel bulut örneğine özgüdür. Bağımsız bulutların benzersiz Yetkilendirme URL'leri ve Azure Active Directory yapılandırmaları vardır. * Azure rol tabanlı erişim denetimi azure yönetim düzleminden Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla yapılandırılır. * Azure Haritalar Web SDK'sının kullanımı, bir uygulamanın birden çok kullanım örneği için yapılandırma tabanlı kurulumuna olanak tanır.

  • Şu anda Azure Active Directory v1.0 veya v2.0 , İş, Okul ve Konuklar'ı destekler ancak Kişisel hesapları desteklemez.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name Description
https://cognitiveservices.azure.com/.default https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Dil hizmeti kaynağı için abonelik anahtarı.

Tür: apiKey
İçinde: header

Örnekler

Successful Get Supported Prebuilt Entities

Örnek isteği

GET {Endpoint}/language/authoring/analyze-conversations/projects/global/prebuilt-entities?language=en&api-version=2023-04-01

Örnek yanıt

{
  "value": [
    {
      "category": "Person.Name",
      "description": "Name of an individual",
      "examples": "john, Sam, Lisa"
    },
    {
      "category": "General.Event",
      "description": "Important events",
      "examples": "World War two, Covid 19"
    },
    {
      "category": "General.Organization",
      "description": "Companies and corporations",
      "examples": "Microsoft, Amazon"
    },
    {
      "category": "Choice.Boolean",
      "description": "boolean choice",
      "examples": "yes, no, agreed"
    },
    {
      "category": "Quantity.Age",
      "description": "Age of a person or thing",
      "examples": "10-month-old, 19 years old, 58 year-old"
    },
    {
      "category": "Quantity.NumberRange",
      "description": "a numeric interval",
      "examples": "between 25 and 35, 25-35"
    },
    {
      "category": "Quantity.Number",
      "description": "A cardinal number in numeric or text form",
      "examples": "ten, forty two, 3.141, 10K"
    },
    {
      "category": "Quantity.Percentage",
      "description": "A percentage, using the symbol % or the word \"percent\"",
      "examples": "10%, 5.6 percent"
    },
    {
      "category": "Quantity.Ordinal",
      "description": "An ordinal number in numeric or text form",
      "examples": "first, second, tenth, 1st, 2nd, 10th"
    },
    {
      "category": "Quantity.Dimension",
      "description": "Spacial dimensions, including length, distance, area, and volume",
      "examples": "2 miles, 650 square kilometres, 9,350 feet"
    },
    {
      "category": "Quantity.Temperature",
      "description": "A temperature in celsius or fahrenheit",
      "examples": "32F, 34 degrees celsius, 2 deg C"
    },
    {
      "category": "Quantity.Currency",
      "description": "Monetary amounts, including currency",
      "examples": "1000.00 US dollars, £20.00, $ 67.5 B"
    },
    {
      "category": "DateTime",
      "description": "exact date values",
      "examples": "May 11th"
    },
    {
      "category": "Email",
      "description": "Email addresses",
      "examples": "user@example.net, user_name@example.com, user.Name12@example.net"
    },
    {
      "category": "Phone Number",
      "description": "US phone numbers",
      "examples": "123-456-7890, +1 123 456 789, (123)456-789"
    },
    {
      "category": "URL",
      "description": "Websites URLs and links",
      "examples": "www.example.com, http://example.net?name=my_name&age=10"
    }
  ],
  "nextLink": null
}

Tanımlar

Name Description
ConversationalAnalysisAuthoringPrebuiltEntities

Alınan desteklenen önceden oluşturulmuş varlıkların listesini temsil eder.

ConversationalAnalysisAuthoringPrebuiltEntity

Desteklenen bir önceden oluşturulmuş varlığı temsil eder.

Error

Hata nesnesi.

ErrorCode

İnsan tarafından okunabilir hata kodu.

ErrorResponse

Hata yanıtı.

InnerErrorCode

İnsan tarafından okunabilir hata kodu.

InnerErrorModel

Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

ConversationalAnalysisAuthoringPrebuiltEntities

Alınan desteklenen önceden oluşturulmuş varlıkların listesini temsil eder.

Name Tür Description
nextLink

string

Sonraki sayfa bağlantısı.

value

ConversationalAnalysisAuthoringPrebuiltEntity[]

Desteklenen önceden oluşturulmuş varlıklar.

ConversationalAnalysisAuthoringPrebuiltEntity

Desteklenen bir önceden oluşturulmuş varlığı temsil eder.

Name Tür Description
category

string

Önceden oluşturulmuş varlık kategorisi.

description

string

Açıklama.

examples

string

Varlık için İngilizce örnekler.

Error

Hata nesnesi.

Name Tür Description
code

ErrorCode

Sunucu tanımlı hata kodları kümesinden biri.

details

Error[]

Bu bildirilen hataya yol açan belirli hatalarla ilgili ayrıntılar dizisi.

innererror

InnerErrorModel

Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.

message

string

Hatanın insan tarafından okunabilen bir gösterimi.

target

string

Hatanın hedefi.

ErrorCode

İnsan tarafından okunabilir hata kodu.

Name Tür Description
AzureCognitiveSearchIndexLimitReached

string

AzureCognitiveSearchIndexNotFound

string

AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

Conflict

string

Forbidden

string

InternalServerError

string

InvalidArgument

string

InvalidRequest

string

NotFound

string

OperationNotFound

string

ProjectNotFound

string

QuotaExceeded

string

ServiceUnavailable

string

Timeout

string

TooManyRequests

string

Unauthorized

string

Warning

string

ErrorResponse

Hata yanıtı.

Name Tür Description
error

Error

Hata nesnesi.

InnerErrorCode

İnsan tarafından okunabilir hata kodu.

Name Tür Description
AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

EmptyRequest

string

ExtractionFailure

string

InvalidCountryHint

string

InvalidDocument

string

InvalidDocumentBatch

string

InvalidParameterValue

string

InvalidRequest

string

InvalidRequestBodyFormat

string

KnowledgeBaseNotFound

string

MissingInputDocuments

string

ModelVersionIncorrect

string

UnsupportedLanguageCode

string

InnerErrorModel

Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Tür Description
code

InnerErrorCode

Sunucu tanımlı hata kodları kümesinden biri.

details

object

Hata ayrıntıları.

innererror

InnerErrorModel

Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.

message

string

Hata iletisi.

target

string

Hata hedefi.