예측 인텔리전스 API

Yokohama API 참조

Release

yokohama

ft:locale

ko-KR

ft:publication_title

Yokohama API 참조

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

예측 인텔리전스 API

릴리스 버전: Yokohama

업데이트 날짜 2025년 01월 30일

읽기8분

예측 인텔리전스 API는 하나 이상의 입력 필드와 학습된 솔루션을 기반으로 필드 값을 예측하는 엔드포인트를 제공합니다.

(com.glide.platform_ml) 플러그인이 활성화된 경우에만 이 API를 예측 인텔리전스 사용할 수 있습니다.

예측 인텔리전스 - GET /agent_intelligence/solution/{solution_name}/prediction

특정 솔루션을 사용하여 출력 필드 값을 예측합니다.

URL 형식

기본 URL: /api/now/agent_intelligence/solution/{solution_name}/prediction

지원되는 요청 매개변수

표 1. 경로 매개변수
이름	설명
solution_name	예측에 사용할 솔루션의 이름입니다. 예를 들어 `ml_incident_categorization`. 데이터 유형: 문자열

표 2. 쿼리 매개변수
이름	설명
솔루션 정의 입력 필드 키-값 쌍	솔루션 입력 필드의 이름-값 쌍입니다. 예를 들어 이름: `short_description` 및 값: `VPN에 연결할 수 없음을` 입력합니다. 데이터 유형: 문자열

표 3. 요청 본문 매개변수(XML 또는 JSON)
이름	설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 4. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 5. 응답 헤더
헤더	설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 6. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
401	승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)


요소	설명
입력	호출에 대한 입력값으로 지정된 이름-값 쌍입니다. 데이터 유형: 객체
출력	지정된 솔루션을 기반으로 예측된 결과 값입니다. 데이터 유형: 객체 `"output": { "confidence": Number", "outcome": "String", "threshold": Number" }`
output.confidence	예측의 예상 정확도를 백분율로 나타낸 것입니다. 예: 53.84615375762915 데이터 유형: 숫자
output.outcome	예측 출력 필드 값입니다. 예를 들어 인시던트 분류 솔루션은 문의와 같은 인시던트 범주를 반환합니다. 데이터 유형: 문자열
output.threshold	예측과 연결된 구성된 임계치의 값입니다. 데이터 유형: 숫자

샘플 cURL 요청

curl "https://instance.service-now.com/api/now/predictive_intelligence/solution/ml_incident_categorization/prediction?short_description=unable%20to%20connect%20to%20VPN" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "input": {
      "short_description": "unable to connect to VPN",
      "api": "api"
    },
    "output": {
      "outcome": "inquiry",
      "confidence": 53.84615375762915,
      "threshold": 5
    }
  }
}

예측 인텔리전스 - GET /agent_intelligence/solution/prediction

여러 솔루션에 대한 예측을 반환합니다.

주:

결과 개체는 솔루션 이름별로 그룹화되고 result.<solutionname>.<sys_id>.[ 형식으로 sys_id됩니다. { <result1> },{ <result2>}]입니다.

커스터마이제이션 정보는 MLSolutionFactory 스크립트 가능한 객체를 참조하세요.

URL 형식

버전이 지정된 URL: /now/{api_version}/agent_intelligence/solution/prediction

기본 URL: /now/agent_intelligence/solution/prediction

주:

사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 7. 경로 매개변수
이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 `v1` 또는 `v2`입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열

표 8. 쿼리 매개변수
매개변수	설명
input_filter	필수 매개변수 사용되는 경우 input_table 이 매개변수를 매개변수와 함께 input_maps 사용하지 마십시오. 예측을 실행할 기록을 선택하려면 필터링합니다. 예: `sys_id 0ef47232db801300864adfea5e961912` 데이터 유형: 문자열
input_maps	매개변수를 사용하지 input_table 않는 한 필수입니다. 입력 이름-값 쌍의 배열입니다. 예: `[{"short_description":"my email is not working"}, {"short_description":"need help with password"}]` 데이터 유형: 객체 배열
input_table	매개변수를 사용하지 input_maps 않는 한 필수입니다. 예측을 실행할 테이블 이름입니다. 예: `incident` 데이터 유형: 문자열
옵션	선택적 인수가 있는 JSON 객체입니다. 예: `{"top_n" : 5, "apply_threshold":false}` 유효한 옵션: top_n: 숫자. 제공된 경우 지정된 예측 수까지 상위 결과를 반환합니다. apply_threshold: 부울. 솔루션의 임계값을 확인하고 결과 집합에 적용합니다. 임계치 값은 유사성에 대한 솔루션 임계치 또는 분류에 대한 클래스 수준 임계치입니다. 기본값은 true입니다. custom_results_filter: 문자열. 유사성 솔루션만 해당됩니다. 인코딩된 쿼리를 사용하여 결과가 반환되는 허용되는 집합을 지정합니다. 데이터 유형: 객체
solution_names	필수 예측을 실행할 솔루션 이름의 목록이며 콤마로 구분됩니다. 예: `ml_incident_categorization,ml_incident_assignment` 데이터 유형: 문자열

표 9. 요청 본문 매개변수(XML 또는 JSON)
이름	설명
안 함

머리글

표 10. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 11. 응답 헤더
헤더	설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 12. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
401	승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)


요소	설명
신뢰도	예측과 연결된 신뢰도의 값입니다. 예를 들어 53.84입니다. 데이터 유형: 숫자
상세한결과	유사성 솔루션만 해당됩니다. 일치하는 텍스트 인덱스에 대한 세부 정보를 포함하는 JSON 키-값 쌍입니다. 데이터 유형: 문자열
예측된 SysId	예측 값의 sys_id입니다. 결과는 정보가 예측되는 모든 테이블에서 나올 수 있습니다. 데이터 유형: 문자열
예측값	예측 결과를 나타내는 값입니다. 데이터 유형: 문자열
임계치	예측과 연결된 구성된 임계치의 값입니다. 데이터 유형: 숫자

샘플 cURL 요청

curl "http://instance.servicenow.com/api/now/agent_intelligence/solution/prediction?input_table=incident&input_filter=sys_id%3D0ef47232db801300864adfea5e961912&solution_names=ml_incident_categorization%2Cml_incident_assignment&options=%7B%22top_n%22%20%3A%202%2C%20%22apply_threshold%22%3Afalse%7D" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "ml_incident_categorization": {
      "0ef47232db801300864adfea5e961912": [
        {
          "confidence": 29.12211732875455,
          "threshold": 15,
          "predictedValue": "Email",
          "predictedSysId": ""
        },
        {
          "confidence": 19.08583525847071,
          "threshold": 14,
          "predictedValue": "Platform Performance",
          "predictedSysId": ""
        }
      ]
    },
    "ml_incident_assignment": {
      "0ef47232db801300864adfea5e961912": [
        {
          "confidence": 5.782322543467415,
          "threshold": 5,
          "predictedValue": "IT Finance CAB",
          "predictedSysId": "5f63e48fc0a8010e00eeaad81cd4dd37"
        },
        {
          "confidence": 5.303589009246953,
          "threshold": -1,
          "predictedValue": "NY DB",
          "predictedSysId": "5f74727dc0a8010e01efe33a251993f9"
        }
      ]
    }
  }
}