Time Series Instances - Suggest

서비스:

Time Series Insights

API 버전:

2020-07-31

나중에 검색 인스턴스에서 사용할 시계열 instance 특성을 기반으로 키워드를 제안합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
environmentFqdn	path	True	string	환경별 FQDN(예: 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com). 환경 가져오기 API, Azure Portal 또는 Azure Resource Manager 응답에서 이 도메인 이름을 가져올 수 있습니다.
api-version	query	True	string	클라이언트 요청과 함께 사용할 API의 버전입니다. 현재 지원되는 버전은 "2020-07-31"입니다.

요청 헤더

Name	필수	형식	Description
x-ms-client-request-id		string	선택적 클라이언트 요청 ID입니다. 서비스는 이 값을 기록합니다. 서비스가 서비스 간에 작업을 추적할 수 있도록 허용하고 고객이 특정 요청과 관련하여 지원에 문의할 수 있도록 허용합니다.
x-ms-client-session-id		string	선택적 클라이언트 세션 ID입니다. 서비스는 이 값을 기록합니다. 서비스에서 서비스 전반의 관련 작업 그룹을 추적할 수 있도록 허용하고 고객이 특정 요청 그룹에 대한 지원에 문의할 수 있도록 합니다.

요청 본문

Name	필수	형식	Description
searchString	True	string	제안 사항이 필요한 검색 문자열입니다. 빈 은 허용되지만 null은 허용되지 않습니다.
take		integer	결과에 예상되는 최대 제안 수입니다. 설정되지 않은 경우 기본값은 10입니다.

응답

Name	형식	Description
200 OK	InstancesSuggestResponse	작업이 성공했습니다. 헤더 x-ms-request-id: string
Other Status Codes	TsiError	예기치 않은 오류입니다. 헤더 x-ms-request-id: string

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

InstancesSuggest

샘플 요청

HTTP

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

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

샘플 응답

상태 코드:

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"
    }
  ]
}

정의

Name	Description
InstancesSearchStringSuggestion	시계열 인스턴스에 대한 추가 검색에 사용할 제안된 검색 문자열입니다.
InstancesSuggestRequest	접두사 텍스트를 기반으로 시계열 인스턴스 검색에 대한 검색 문자열 제안을 가져오기 위해 요청합니다.
InstancesSuggestResponse	시계열 인스턴스 검색에 대한 제안 가져오기에 대한 응답입니다.
TsiError	API 오류에 대한 정보입니다.
TsiErrorBody	오류 코드 및 메시지가 있는 특정 API 오류입니다.
TsiErrorDetails	추가 오류 정보입니다.

InstancesSearchStringSuggestion

시계열 인스턴스에 대한 추가 검색에 사용할 제안된 검색 문자열입니다.

Name	형식	Description
highlightedSearchString	string	사용자에게 표시할 추천 검색 문자열이 강조 표시되었습니다. 검색 문자열과 일치하는 텍스트 부분에 삽입 및 태그를 강조 표시합니다. 강조 표시된 검색 문자열을 사용하여 추가 검색 호출을 수행하지 마세요.
searchString	string	제안된 검색 문자열입니다. 시계열 인스턴스에 대한 추가 검색에 사용할 수 있습니다.

InstancesSuggestRequest

접두사 텍스트를 기반으로 시계열 인스턴스 검색에 대한 검색 문자열 제안을 가져오기 위해 요청합니다.

Name	형식	Description
searchString	string	제안 사항이 필요한 검색 문자열입니다. 빈 은 허용되지만 null은 허용되지 않습니다.
take	integer	결과에 예상되는 최대 제안 수입니다. 설정되지 않은 경우 기본값은 10입니다.

InstancesSuggestResponse

시계열 인스턴스 검색에 대한 제안 가져오기에 대한 응답입니다.

Name	형식	Description
suggestions	InstancesSearchStringSuggestion[]	시계열 모델을 검색하기 위한 instance 제안 목록입니다.

TsiError

API 오류에 대한 정보입니다.

Name	형식	Description
error	TsiErrorBody	오류 코드 및 메시지가 있는 특정 API 오류입니다.

TsiErrorBody

오류 코드 및 메시지가 있는 특정 API 오류입니다.

Name	형식	Description
code	string	서비스별 오류 코드를 정의하는 언어 독립적이며 사람이 읽을 수 있는 문자열입니다. 이 코드는 응답에 지정된 HTTP 오류 코드에 대한 보다 구체적인 표시기 역할을 합니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다.
details	TsiErrorDetails[]	추가 오류 정보를 포함합니다. null일 수 있습니다.
innerError	TsiErrorBody	원인을 좁히는 보다 구체적인 오류를 포함합니다. null일 수 있습니다.
message	string	사람이 읽을 수 있는 언어 독립적 오류 표현입니다. 개발자를 돕기 위한 것이며 최종 사용자에게 노출하기에 적합하지 않습니다.
target	string	특정 오류의 대상입니다(예: 오류에 있는 속성의 이름). null일 수 있습니다.

TsiErrorDetails

추가 오류 정보입니다.

Name	형식	Description
code	string	서비스별 오류 코드를 정의하는 언어 독립적이며 사람이 읽을 수 있는 문자열입니다. 이 코드는 응답에 지정된 HTTP 오류 코드에 대한 보다 구체적인 표시기 역할을 합니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다.
message	string	사람이 읽을 수 있는 언어 독립적 오류 표현입니다. 개발자를 돕기 위한 것이며 최종 사용자에게 노출하기에 적합하지 않습니다.