Time Series Instances - Suggest

Service:

Time Series Insights

API Version:

2020-07-31

Daha sonra Arama Örneklerinde kullanılacak zaman serisi örneği özniteliklerini temel alan anahtar sözcükler önerir.

POST https://{environmentFqdn}/timeseries/instances/suggest?api-version=2020-07-31

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
environmentFqdn	path	True	string	Ortam başına FQDN, örneğin 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Bu etki alanı adını Ortamları Al API'sinin, Azure portal veya Azure Resource Manager yanıtından alabilirsiniz.
api-version	query	True	string	İstemci isteğiyle kullanılacak API'nin sürümü. Şu anda desteklenen sürüm :"2020-07-31".

İstek Başlığı

Name	Gerekli	Tür	Description
x-ms-client-request-id		string	İsteğe bağlı istemci istek kimliği. Hizmet bu değeri kaydeder. Hizmetin hizmetler arasında işlemi izlemesine ve müşterinin belirli bir istekle ilgili desteğe başvurmasına olanak tanır.
x-ms-client-session-id		string	İsteğe bağlı istemci oturum kimliği. Hizmet bu değeri kaydeder. Hizmetin hizmetler arasında bir grup ilgili işlemi izlemesine ve müşterinin belirli bir istek grubuyla ilgili desteğe başvurmasına olanak tanır.

İstek Gövdesi

Name	Gerekli	Tür	Description
searchString	True	string	Önerilerin gerekli olduğu arama dizesi. Boş değere izin verilir, ancak null kullanılamaz.
take		integer	Sonuçta beklenen en fazla öneri sayısı. Ayarlanmadığında varsayılan olarak 10'a ayarlanır.

Yanıtlar

Name	Tür	Description
200 OK	InstancesSuggestResponse	Başarılı bir işlem. Headers x-ms-request-id: string
Other Status Codes	TsiError	Beklenmeyen hata. Headers x-ms-request-id: string

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

InstancesSuggest

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/suggest?api-version=2020-07-31

{
  "searchString": "flo",
  "take": 3
}

Sample Response

Status code:

200

{
  "suggestions": [
    {
      "searchString": "floor 100",
      "highlightedSearchString": "<hit>flo</hit>or 100"
    },
    {
      "searchString": "sensor on floor 0",
      "highlightedSearchString": "sensor on <hit>flo</hit>or 0"
    },
    {
      "searchString": "sensor on floor 1",
      "highlightedSearchString": "sensor on <hit>flo</hit>or 1"
    }
  ]
}

Tanımlar

Name	Description
InstancesSearchStringSuggestion	Zaman serisi örnekleri için daha fazla arama yapmak için kullanılacak önerilen arama dizesi.
InstancesSuggestRequest	Ön ek metnine göre zaman serisi örnekleri araması için arama dizesi önerileri alma isteği.
InstancesSuggestResponse	Zaman serisi örnekleri için arama önerileri alma yanıtı.
TsiError	API hatası hakkında bilgi.
TsiErrorBody	Hata kodu ve ileti içeren belirli bir API hatası.
TsiErrorDetails	Ek hata bilgileri.

InstancesSearchStringSuggestion

Zaman serisi örnekleri için daha fazla arama yapmak için kullanılacak önerilen arama dizesi.

Name	Tür	Description
highlightedSearchString	string	Kullanıcıya görüntülenmesi önerilen arama dizesi vurgulandı. Metnin arama dizesiyle eşleşen bölümlerine eklenenleri ve etiketleri vurgulama. Başka arama aramaları yapmak için vurgulanan arama dizesini kullanmayın.
searchString	string	Önerilen arama dizesi. Zaman serisi örnekleri için daha fazla arama için kullanılabilir.

InstancesSuggestRequest

Ön ek metnine göre zaman serisi örnekleri araması için arama dizesi önerileri alma isteği.

Name	Tür	Description
searchString	string	Önerilerin gerekli olduğu arama dizesi. Boş değere izin verilir, ancak null kullanılamaz.
take	integer	Sonuçta beklenen en fazla öneri sayısı. Ayarlanmadığında varsayılan olarak 10'a ayarlanır.

InstancesSuggestResponse

Zaman serisi örnekleri için arama önerileri alma yanıtı.

Name	Tür	Description
suggestions	InstancesSearchStringSuggestion[]	Zaman serisi modellerini aramak için örnek önerilerinin listesi.

TsiError

API hatası hakkında bilgi.

Name	Tür	Description
error	TsiErrorBody	Hata kodu ve ileti içeren belirli bir API hatası.

TsiErrorBody

Hata kodu ve ileti içeren belirli bir API hatası.

Name	Tür	Description
code	string	Hizmete özgü bir hata kodunu tanımlayan dilden bağımsız, insan tarafından okunabilir dize. Bu kod, yanıtta belirtilen HTTP hata kodu için daha belirgin bir gösterge görevi görür. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
details	TsiErrorDetails[]	Ek hata bilgileri içerir. Null olabilir.
innerError	TsiErrorBody	Nedeni daraltan daha belirgin bir hata içerir. Null olabilir.
message	string	Hatanın insan tarafından okunabilir, dilden bağımsız gösterimi. Geliştiricilere yardımcı olmak için tasarlanmıştır ve son kullanıcıların etkilenmesi için uygun değildir.
target	string	Belirli bir hatanın hedefi (örneğin, hatadaki özelliğin adı). Null olabilir.

TsiErrorDetails

Ek hata bilgileri.

Name	Tür	Description
code	string	Hizmete özgü bir hata kodunu tanımlayan dilden bağımsız, insan tarafından okunabilir dize. Bu kod, yanıtta belirtilen HTTP hata kodu için daha belirgin bir gösterge görevi görür. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
message	string	Hatanın insan tarafından okunabilir, dilden bağımsız gösterimi. Geliştiricilere yardımcı olmak için tasarlanmıştır ve son kullanıcıların etkilenmesi için uygun değildir.