AI 자산 API
AI 자산 API는 시스템, 데이터 세트, 프롬프트 및 모델과 같은 여러 유형의 AI 자산을 검색, 업데이트 및 생성할 수 있는 엔드포인트를 제공합니다.
AI 자산 API - GET /sn_ent/asset/ai_dataset/{sys_id}
지정된 AI 데이터 세트 자산의 데이터를 조회합니다.
URL 형식
버전이 지정된 URL: /api/sn_ent/{api_version}/asset/ai_dataset/{sys_id}
기본 URL: /api/sn_ent/asset/ai_dataset/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | AI 데이터 세트 자산 [alm_ai_dataset_digital_asset] 테이블에 있는 자산의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| 안 함 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 sys_id로 자산을 가져오지 못했습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수
| 이름 | 설명 |
|---|---|
| 결과 | 새로 생성된 AI 데이터 세트 자산의 상세 정보입니다. 데이터 유형: 객체 |
| result.acceptable_usage | AI 데이터 세트 자산 기록에 허용되는 사용량입니다. 허용되는 사용은 일반적으로 교육 또는 평가 목적으로 데이터 세트 또는 모델을 사용할 수 있는 방법을 나타냅니다. 데이터 유형: 객체 |
| result.acceptable_usage.레이블 | 허용되는 사용 값의 레이블을 표시합니다. 데이터 유형: 문자열 |
| result.acceptable_usage.값 | 허용되는 사용의 숫자 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| result.base_datasets | 지정된 데이터 세트를 빌드하는 데 필요한 기본 데이터 세트의 쉼표로 구분된 목록입니다. AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset] 테이블에 있는 기본 데이터 세트의 이름 또는 sys_id 허용합니다. 데이터 유형: 배열 |
| 결과.생성됨 | AI 데이터 세트 자산 기록이 생성된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| result.data_type | AI 데이터 세트 자산 기록에 있는 데이터의 유형입니다. 데이터 유형: 객체 |
| result.data_type.레이블 | 데이터 유형 값의 표시 레이블입니다. 데이터 유형: 문자열 |
| result.data_type.값 | 데이터 세트 자산의 데이터 유형 값입니다. 데이터 유형: 문자열 |
| result.dataset_card | 데이터 세트 카드입니다. dataset_card는 AI 데이터 세트의 내용, 구조 및 컨텍스트를 설명하는 메타데이터 문서입니다. 적절한 이해와 사용을 보장하기 위해 데이터 소스, 기능, 사용 목적, 알려진 제한 사항 등의 상세 정보를 제공합니다. 데이터 유형: 문자열 |
| 결과.설명 | 연결된 AI 데이터 세트 제품 모델 기록에 대한 설명입니다. 테이블: AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 데이터 유형: 문자열 |
| result.display_name | AI 데이터 세트 자산 기록의 표시 이름입니다. 테이블: AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset] 데이터 유형: 문자열 |
| result.documentation | 연결된 AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 테이블 기록에 대한 설명서입니다. 데이터 유형: 문자열 |
| result.managed_by | AI 데이터 세트 자산 기록을 관리하는 사용자에 대한 세부 정보입니다. 데이터 유형: 객체 |
| result.managed_by.name | AI 데이터 세트 자산 기록을 관리하는 사용자의 이름입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.managed_by.sys_id | AI 데이터 세트 자산 기록을 관리하는 사용자의 Sys_id입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.name | 연결된 AI 데이터 세트 제품 모델 기록의 이름입니다. 테이블: AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 데이터 유형: 문자열 |
| 결과.제공자 | 연결된 AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 테이블 기록의 제공자입니다. 데이터 유형: 객체 |
| result.provider.name | 제공자의 이름입니다. 데이터 유형: 문자열 |
| result.provider.sys_id | 연결된 AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 테이블 기록에 있는 제공자의 Sys_id입니다. 데이터 유형: 문자열 |
| 결과.소스 | AI 데이터 세트 자산의 소스에 대한 상세 정보입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 비어 있음 또는 null |
| 결과.상태 | AI 데이터 세트 자산 기록의 상태입니다. 가능한 값:
데이터 유형: 문자열 |
| result.sys_id | AI 데이터 세트 자산 기록의 Sys_id입니다. 테이블: AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset] 데이터 유형: 문자열 |
| 결과.업데이트됨 | AI 데이터 세트 자산 기록이 마지막으로 업데이트된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| result.version | 연결된 AI 데이터 세트 제품 모델 기록의 버전 번호입니다. 예를 들어 V2입니다.데이터 유형: 문자열 |
cURL 요청
다음 예제.
curl "https://instance.servicenow.com/api/sn_ent/asset/ai_dataset/ cc419cb2331e92101c9aca989d5c7b4c" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
출력:
{
"result": {
"sys_id": "9d60fb5f40d21210f877b00c113d1fea",
"display_name": "ServiceNow Closed Incidents v1",
"name": "Closed Incidents",
"description": "Incidents with resolution",
"documentation": "Sample Documentation",
"source": "incident table on servicenow instance",
"dataset_card": "Sample Dataset Card",
"state": "Development",
"version": "v1",
"data_type": {
"value": "2",
"label": "Image"
},
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"managed_by": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter"
},
"acceptable_usage": {
"value": "1",
"label": "Training"
},
"base_datasets": [],
"created": "2024-12-11 08:50:40",
"updated": "2024-12-11 08:50:40"
}
}
AI 자산 API - GET /sn_ent/asset/ai_model/{sys_id}
지정된 AI 모델 자산의 데이터를 검색합니다.
URL 형식
버전이 지정된 URL: /api/sn_ent/{api_version}/asset/ai_model/{sys_id}
기본 URL: /api/sn_ent/asset/ai_model/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | AI 모델 자산 [alm_ai_model_digital_asset] 테이블에 있는 자산의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| 안 함 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 sys_id로 자산을 가져오지 못했습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수
| 결과 | 모델 자산 레코드의 상세 정보입니다. 데이터 유형: 객체 |
| result.base_model | 이 모델 버전이 파생된 AI 모델입니다. 주: 조직 내에서 개발된 모델에만 적용할 수 있습니다. 데이터 유형: 객체 기본값: |
| result.base_model.name | 이 AI 모델을 모델링할 AI 모델 자산의 이름입니다. 데이터 유형: 문자열 |
| result.base_model.sys_id | 이 AI 모델을 모델링할 AI 모델 자산의 Sys_id입니다. 데이터 유형: 문자열 |
| result.context_window | 모델이 처리할 수 있는 입력 시퀀스의 크기(즉, 토큰 수)입니다. 데이터 유형: 숫자로 표시된 문자열 |
| 결과.생성됨 | AI 데이터 세트 자산 기록이 생성된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| result.deployment_guideline | 조직 내에서 개발 및 배포된 모델에 적용할 수 있는 지침입니다. 데이터 유형: 문자열 |
| 결과.설명 | AI 모델 제품 모델에 부여한 설명입니다. 테이블에서 업데이트됨: AI 모델 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 문자열 |
| result.result.display_name | 자산 기록의 표시 이름입니다. 데이터 유형: 문자열 |
| result.documentation | AI 프롬프트 제품 모델 기록의 문서화입니다. 테이블: AI 프롬프트 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 문자열 |
| result.evaluation_datasets | 모델을 평가하는 데 사용되는 AI 데이터 세트 디지털 자산의 AI 데이터 세트 sys_ids 또는 표시 이름의 쉼표로 구분된 목록입니다. 주로 조직 내에서 개발된 모델에 적용할 수 있습니다. 테이블: AI 데이터 세트 디지털 자산 [alm_ai_dataset_digital_asset] 데이터 유형: 배열 |
| result.evaluation_metrics_report | 평가 결과에 대한 참조입니다. 가능한 값:
데이터 유형: 문자열 |
| result.managed_by | AI 모델 자산 기록을 관리하는 사용자에 대한 세부 정보입니다. 데이터 유형: 객체 |
| result.managed_by.name | AI 데이터 세트 자산 기록을 관리하는 사용자의 이름입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.managed_by.sys_id | AI 데이터 세트 자산 기록을 관리하는 사용자의 Sys_id입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.model_size_in_mb | 모델의 크기(MB)입니다. 조직 내에서 개발 및 배포된 모델에 주로 적용할 수 있습니다. 데이터 유형: 숫자 |
| result.name | 필수 AI 모델 제품 모델의 이름입니다. 테이블에서 업데이트됨: AI 모델 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 문자열 |
| 결과.제공자 | 연결된 AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 테이블 기록의 제공자입니다. 데이터 유형: 객체 |
| result.provider.sys_id | 연결된 AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 테이블 기록에 있는 제공자의 Sys_id입니다. 데이터 유형: 문자열 |
| result.provider.name | 제공자의 이름입니다. 데이터 유형: 문자열 |
| result.required_infrastructure | 모델 배포를 위한 인프라 요구 사항에 대한 설명서입니다. 예를 들어 인프라 스택 및 처리 요구 사항에 대한 세부 정보입니다. 주로 조직 내에 배포된 모델에 적용할 수 있습니다. 데이터 유형: 문자열 |
| 결과.소스 | 모델의 소스에 대한 상세 정보입니다. 가능한 값:
데이터 유형: 문자열 |
| 결과.상태 | AI 모델 자산에 적용할 상태입니다. 가능한 값:
데이터 유형: 문자열 |
| result.supported_languages | AI 모델에서 지원하는 언어입니다. 데이터 유형: 배열 |
| result.supported_languages.name | 언어 기록의 이름입니다. 예: "프랑스어", "영어".테이블: 언어 [sys_language] 데이터 유형: 문자열 |
| result.supported_languages.sys_id | 언어 기록의 Sys_id입니다. 테이블: 언어 [sys_language] 데이터 유형: 문자열 |
| result.sys_id | AI 모델 자산 기록의 Sys_id입니다. 테이블: AI 모델 자산 [alm_ai_model_digital_asset] 데이터 유형: 문자열 |
| result.version | AI 모델 제품 모델의 버전입니다. 예를 들어 V2입니다.데이터 유형: 문자열 |
cURL 요청
다음 예제.
curl "https://instance.servicenow.com/api/sn_ent/asset/ai_model/cc419cb2331e92101c9aca989d5c7b4c" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
출력:
{
"result": {
"sys_id": "a438d170ff96da10c1fbffffffffffd5",
"display_name": "ServiceNow Now LLM V6",
"name": "Now LLM",
"description": "enables text-to-text like question answering and summarization",
"version": "V6",
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"documentation": "Now LLM V5 Documentation",
"parameters_info": "7B",
"supported_languages": [
{
"sys_id": "914493a30f320010e96b0e4fef767e90",
"name": "English"
}
],
"model_size_in_mb": "87",
"deployment_guideline": "Deployed on ServiceNow infrastructure",
"source": null,
"training_procedure": "2",
"context_window": "8000",
"state": "Deployed",
"required_infrastructure": "undefined",
"base_model": {
"sys_id": null,
"name": ""
},
"evaluation_datasets": [
{
"sys_id": "45cb45baff06d610c1fbffffffffffa9",
"name": "ServiceNow Open Incidents"
}
],
"training_datasets": [
{
"sys_id": "45cb45baff06d610c1fbffffffffffa9",
"name": "ServiceNow Open Incidents"
}
],
"evaluation_metrics_report": "Testing results: See files attached to this record",
"managed_by": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter"
},
"created": "2024-12-03 16:50:53",
"updated": "2024-12-03 16:50:53"
}
}
AI 자산 API - GET /sn_ent/asset/ai_prompt/{sys_id}
지정된 AI 프롬프트 자산의 데이터를 조회합니다.
URL 형식
버전이 지정된 URL: /api/sn_ent/{api_version}/asset/ai_prompt/{sys_id}
기본 URL: /api/sn_ent/asset/ai_prompt/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | AI 프롬프트 자산 [alm_ai_prompt_digital_asset] 테이블에 있는 자산의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| 안 함 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 sys_id로 자산을 가져오지 못했습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수
| 이름 | 설명 |
|---|---|
| 결과 | AI 프롬프트 자산에 대한 상세 정보입니다. |
| result.ai_model | AI 프롬프트 자산 기록의 AI 모델입니다. 데이터 유형: 객체 |
| result.ai_model.name | AI 모델의 이름입니다. 데이터 유형: 문자열 |
| result.ai_model.sys_id | AI 프롬프트 제품 모델 기록의 Sys_id입니다. 테이블: AI 프롬프트 제품 모델 [alm_ai_model_digital_asset] 데이터 유형: 문자열 |
| 결과.생성됨 | AI 프롬프트 자산 기록이 생성된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| 결과.설명 | AI 프롬프트 제품 모델 기록에 대한 설명입니다. 테이블: AI 프롬프트 제품 모델 [cmdb_ai_prompt_product_model] 데이터 유형: 문자열 |
| result.display_name | 연결된 AI 프롬프트 자산 기록의 표시 이름입니다. 테이블: AI 프롬프트 자산 [alm_ai_prompt_digital_asset] 데이터 유형: 문자열 |
| result.documentation | AI 프롬프트 제품 모델 기록에 대한 설명서입니다. 테이블: AI 프롬프트 제품 모델 [cmdb_ai_prompt_product_model] 데이터 유형: 문자열 |
| result.managed_by | AI 프롬프트 자산 기록을 관리하는 사용자입니다. 데이터 유형: 객체 |
| result.managed_by.name | 자산 레코드를 관리하는 사용자의 이름입니다. 데이터 유형: 문자열 |
| result.managed_by.sys_id | 자산 레코드의 관리자 사용자에 해당하는 사용자 레코드의 Sys_id입니다. 테이블: 사용자[sys_user], AI 프롬프트 자산[alm_ai_model_digital_asset] 데이터 유형: 문자열 |
| result.name | 연결된 AI 프롬프트 제품 모델의 이름입니다. 테이블: AI 프롬프트 제품 모델 [cmdb_ai_prompt_product_model] 데이터 유형: 문자열 |
| result.prompt_info | AI 프롬프트 자산 기록의 프롬프트 정보입니다. 테이블: AI 프롬프트 자산 [alm_ai_prompt_digital_asset] 데이터 유형: 문자열 |
| 결과.제공자 | AI 프롬프트 제품 모델 기록의 제공자입니다.데이터 유형: 객체 |
| result.provider.name | 연결된 AI 프롬프트 제품 모델 기록의 이름입니다. 데이터 유형: 문자열 |
| result.provider.sys_id | 연결된 AI 프롬프트 제품 모델 기록의 제공자에 해당하는 회사 [core_company] 테이블 기록의 Sys_id입니다. 테이블: 회사 [core_company], AI 프롬프트 제품 모델 [cmdb_ai_prompt_product_model] 데이터 유형: 문자열 |
| 결과.상태 | AI 프롬프트 자산 기록의 상태입니다. 가능한 값:
데이터 유형: 문자열 |
| result.sys_id | AI 프롬프트 자산 기록의 Sys_id입니다. 테이블: AI 프롬프트 자산 [alm_ai_prompt_digital_asset] 데이터 유형: 문자열 |
| 결과.업데이트됨 | AI 프롬프트 자산 기록이 마지막으로 업데이트된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| result.version | 연결된 AI 프롬프트 제품 모델 기록의 버전입니다. 예를 들어 V2입니다.데이터 유형: 문자열 |
cURL 요청
다음 예시는 특정 ID를 사용하여 AI 프롬프트 자산 모델에 대한 정보를 검색하는 방법을 보여줍니다.
curl "https://instance.servicenow.com/api/sn_ent/asset/ai_prompt/cc419cb2331e92101c9aca989d5c7b4c" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
응답 본문은 검색된 특정 프롬프트 자산 모델에 대한 상세 정보를 반환합니다.
{
"result": {
"sys_id": "cc419cb2331e92101c9aca989d5c7b4c",
"display_name": "ServiceNow ServiceNow Incident Summarization Prompt 4 V8",
"name": "ServiceNow Incident Summarization Prompt 4",
"description": "Prompt for Incident Summarization",
"version": "V8",
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"documentation": "Documentation",
"state": "Development",
"ai_model": {
"sys_id": "a57d0be6eb1e5210aa82fab8bad0cd18",
"name": "mistral-large"
},
"prompt_info": "Provide incident summary using short_decription, state, worknotes",
"managed_by": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter"
},
"created": "2024-12-09 03:18:46",
"updated": "2024-12-09 04:26:08"
}
}
AI 자산 API - GET /sn_ent/asset/ai_system/{sys_id}
지정된 AI 시스템 자산의 데이터를 조회합니다.
URL 형식
버전이 지정된 URL: /api/sn_ent/{api_version}/asset/ai_system/{sys_id}
기본 URL: /api/sn_ent/asset/ai_system/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | AI 시스템 디지털 자산[alm_ai_system_digital_asset] 테이블에 있는 자산의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| 안 함 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 sys_id로 자산을 가져오지 못했습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수
| 이름 | 설명 |
|---|---|
| 결과 | 검색된 AI 시스템 자산에 대한 상세 정보입니다. |
| result.ai_models | AI 시스템 디지털 자산[alm_ai_system_digital_asset] 테이블 기록의 AI 모델 목록입니다. 데이터 유형: 배열 |
| result.ai_models.name | AI 시스템 디지털 자산 기록의 이름입니다. 테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 문자열 |
| result.ai_models.sys_id | AI 시스템 디지털 자산 기록의 Sys_id입니다. 테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 문자열 |
| result.ai_prompts | AI 시스템 자산 기록의 AI 프롬프트 목록입니다. 데이터 유형: 배열 |
| result.ai_prompts.name | AI 프롬프트의 이름입니다. 데이터 유형: 문자열 |
| result.ai_prompts.sys_id | AI 프롬프트 디지털 자산 기록의 Sys_id입니다. 테이블: AI 프롬프트 디지털 자산 [alm_ai_prompt_digital_asset] 데이터 유형: 문자열 |
| 결과.생성됨 | AI 시스템 자산이 생성된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| 결과.설명 | 연결된 AI 시스템 제품 모델 기록에 대한 설명입니다. 테이블: AI 시스템 제품 모델 [cmdb_ai_system_product_model] 데이터 유형: 문자열 |
| result.display_name | AI 시스템 자산 기록의 표시 이름입니다. 테이블: AI 시스템 자산[cmdb_ai_ system_asset_model] 데이터 유형: 문자열 |
| result.documentation | AI 시스템 제품 시스템 기록에 대한 설명서입니다. 테이블: AI 시스템 제품 시스템 [cmdb_ai_system_product_system] 데이터 유형: 문자열 |
| result.evaluation_datasets | AI 시스템 디지털 자산 기록에서 모델을 평가하는 데 사용되는 AI 데이터 세트 목록입니다. 주로 조직 내에서 개발된 모델에 적용할 수 있습니다. 테이블: AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset], AI 시스템 자산[alm_ai_system_digital_asset] 데이터 유형: 배열 기본값: 빈 문자열 |
| result.evaluation_datasets.name | AI 데이터 세트 디지털 자산의 이름입니다. 데이터 유형: 문자열 |
| result.evaluation_datasets.sys_id | AI 데이터 세트 디지털 자산 기록의 Sys_id입니다. 테이블: AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset] 데이터 유형: 문자열 |
| result.evaluation_metrics_report | AI 시스템 자산 기록의 평가 결과입니다. 가능한 값:
데이터 유형: 문자열 |
| result.managed_by | AI 시스템 자산 기록을 관리하는 사용자에 대한 세부 정보입니다. 데이터 유형: 객체 |
| result.managed_by.name | AI 시스템 자산 기록을 관리하는 사용자의 Sys_id입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.managed_by.sys_id | AI 시스템 자산 기록을 관리하는 사용자의 이름입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.name | 연결된 AI 시스템 제품 모델 기록의 이름입니다. 테이블: AI 시스템 제품 모델 [cmdb_ai_system_product_model] 데이터 유형: 문자열 |
| 결과.제공자 | 연결된 AI 시스템 제품 모델 기록의 제공자 필드 값입니다. 테이블: AI 시스템 제품 모델[cmdb_ai_ system_product_model] 데이터 유형: 객체 |
| result.provider.name | 연결된 AI 시스템 제품 모델 기록의 제공자 이름입니다. 테이블: AI 시스템 제품 모델[cmdb_ai_ system_product_model] 데이터 유형: 문자열 |
| result.provider.sys_id | 연결된 AI 시스템 제품 모델 기록에 있는 제공자의 Sys_id입니다. 테이블: AI 시스템 제품 모델[cmdb_ai_ system_product_model] 데이터 유형: 문자열 |
| 결과.상태 | AI 시스템 자산 기록의 상태입니다. 가능한 값:
테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 문자열 |
| result.sys_id | AI 시스템 자산 기록의 Sys_id입니다. 테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 문자열 |
| 결과.업데이트됨 | AI 시스템 자산이 마지막으로 업데이트된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| result.version | 연결된 AI 시스템 제품 모델 기록의 버전 번호입니다. 예를 들어 V2입니다.데이터 유형: 문자열 |
cURL 요청
다음 예시는 주어진 ID로 AI 시스템 모델 에셋을 검색하는 방법을 보여줍니다.
curl "https://instance.servicenow.com/api/sn_ent/asset/ai_system/3b140397435a9210a63d00002fb8f2d7" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
응답 본문은 지정된 AI 시스템 모델 자산에 대한 상세 정보를 반환합니다.
{
"result": {
"sys_id": "3b140397435a9210a63d00002fb8f2d7",
"display_name": "ServiceNow Incident Summarization V2",
"name": "Incident Summarization",
"description": "Incident Summarization Skill",
"version": "V2",
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"documentation": "Sample Documentation",
"state": "Deployed",
"ai_models": [{
"sys_id": "9tgdc7e6eb1e5210aa82fab8bad0cda2",
"name": "llm_generic_small"
},
{
"sys_id": "7efdc7e6eb1e5210aa82fab8bad0cda2",
"name": "mixtral-instruct"
}],
"ai_prompts": [{
"sys_id": "7d7dc7e6eb1e5210aa82fab8bad0cda2",
"name": "LLM Prompt"
}],
"evaluation_datasets": [{
"sys_id": "9d7dc7e6eb1e5210aa82fab8bad0cda2",
"name": "Base dataset"
}],
"evaluation_metrics_report": "Sample Report",
"managed_by": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter"
},
"created": "2024-12-11 18:23:09",
"updated": "2024-12-11 18:23:09"
}
}
AI 자산 API - POST /sn_ent/asset/ai_dataset
요청 본문에 입력한 세부 정보에 따라 AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset] 및 AI 데이터 세트 제품 모델[cmdb_ai_dataset_product_model]에 새 AI 데이터 세트 자산 항목을 생성합니다.
URL 형식
버전이 지정된 URL: /api/sn_ent/{api_version}/asset/ai_dataset
기본 URL: /api/sn_ent/asset/ai_dataset
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| {객체} |
|
| {객체} |
|
| {object}.acceptable_usage | 일반적으로 교육 또는 평가 목적으로 데이터 세트 또는 모델을 사용할 수 있는 방법을 결정합니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| {object}.base_datasets | 이 데이터 세트를 빌드하는 데 필요한 기본 데이터 세트의 쉼표로 구분된 목록입니다. AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset] 테이블에 있는 데이터 세트의 이름 또는 sys_ids 허용합니다. 데이터 유형: 배열 |
| {object}.data_type | 데이터 세트에 있는 데이터의 유형입니다. 예를 들어 텍스트, 비디오, 이미지 또는 1,2입니다.데이터 유형: 문자열 |
| {object}.dataset_card | 데이터 세트 카드입니다. dataset_card는 AI 데이터 세트의 내용, 구조 및 컨텍스트를 설명하는 메타데이터 문서입니다. 적절한 이해와 사용을 보장하기 위해 데이터 소스, 기능, 사용 목적, 알려진 제한 사항 등의 상세 정보를 제공합니다. 데이터 유형: 문자열 |
| {object}.description | AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 테이블의 연결된 기록에 대한 설명입니다. 데이터 유형: 문자열 |
| {object}.documentation | AI 데이터 세트 제품 모델에 대한 설명서입니다. 데이터 유형: 문자열 |
| {object}.managed_by | 기존 사용자 [sys_user] 테이블 기록의 관리자 필드 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| {object}.name | 필수 AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 테이블에 있는 연결된 기록의 이름입니다. 데이터 유형: 문자열 |
| {object}.provider | 필수 회사 [core_company] 테이블에 있는 기존 기록의 제공자 필드 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| {object}.source | 데이터 세트의 소스에 대한 상세 정보입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 비어 있음 또는 null |
| {object}.state | AI 데이터 세트 자산의 상태입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| {object}.version | 연결된 AI 데이터 세트 제품 모델 기록의 버전 번호입니다. 예를 들어 V2입니다.데이터 유형: 문자열 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 결과 | 새로 생성된 AI 데이터 세트 자산의 상세 정보입니다. 데이터 유형: 객체 |
| result.acceptable_usage | AI 데이터 세트 자산 기록에 허용되는 사용량입니다. 허용되는 사용은 일반적으로 교육 또는 평가 목적으로 데이터 세트 또는 모델을 사용할 수 있는 방법을 나타냅니다. 데이터 유형: 객체 |
| result.acceptable_usage.레이블 | 허용되는 사용 값의 레이블을 표시합니다. 데이터 유형: 문자열 |
| result.acceptable_usage.값 | 허용되는 사용의 숫자 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| result.base_datasets | 지정된 데이터 세트를 빌드하는 데 필요한 기본 데이터 세트의 쉼표로 구분된 목록입니다. AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset] 테이블에 있는 기본 데이터 세트의 이름 또는 sys_id 허용합니다. 데이터 유형: 배열 |
| 결과.생성됨 | AI 데이터 세트 자산 기록이 생성된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| result.data_type | AI 데이터 세트 자산 기록에 있는 데이터의 유형입니다. 데이터 유형: 객체 |
| result.data_type.레이블 | 데이터 유형 값의 표시 레이블입니다. 데이터 유형: 문자열 |
| result.data_type.값 | 데이터 세트 자산의 데이터 유형 값입니다. 데이터 유형: 문자열 |
| result.dataset_card | 데이터 세트 카드입니다. dataset_card는 AI 데이터 세트의 내용, 구조 및 컨텍스트를 설명하는 메타데이터 문서입니다. 적절한 이해와 사용을 보장하기 위해 데이터 소스, 기능, 사용 목적, 알려진 제한 사항 등의 상세 정보를 제공합니다. 데이터 유형: 문자열 |
| 결과.설명 | 연결된 AI 데이터 세트 제품 모델 기록에 대한 설명입니다. 테이블: AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 데이터 유형: 문자열 |
| result.display_name | AI 데이터 세트 자산 기록의 표시 이름입니다. 테이블: AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset] 데이터 유형: 문자열 |
| result.documentation | 연결된 AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 테이블 기록에 대한 설명서입니다. 데이터 유형: 문자열 |
| result.managed_by | AI 데이터 세트 자산 기록을 관리하는 사용자에 대한 세부 정보입니다. 데이터 유형: 객체 |
| result.managed_by.name | AI 데이터 세트 자산 기록을 관리하는 사용자의 이름입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.managed_by.sys_id | AI 데이터 세트 자산 기록을 관리하는 사용자의 Sys_id입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.name | 연결된 AI 데이터 세트 제품 모델 기록의 이름입니다. 테이블: AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 데이터 유형: 문자열 |
| 결과.제공자 | 연결된 AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 테이블 기록의 제공자입니다. 데이터 유형: 객체 |
| result.provider.sys_id | 연결된 AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 테이블 기록에 있는 제공자의 Sys_id입니다. 데이터 유형: 문자열 |
| result.provider.name | 제공자의 이름입니다. 데이터 유형: 문자열 |
| 결과.소스 | AI 데이터 세트 자산의 소스에 대한 상세 정보입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 비어 있음 또는 null |
| 결과.상태 | AI 데이터 세트 자산 기록의 상태입니다. 가능한 값:
데이터 유형: 문자열 |
| result.sys_id | AI 데이터 세트 자산 기록의 Sys_id입니다. 테이블: AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset] 데이터 유형: 문자열 |
| 결과.업데이트됨 | AI 데이터 세트 자산 기록이 마지막으로 업데이트된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| result.version | 연결된 AI 데이터 세트 제품 모델 기록의 버전 번호입니다. 예를 들어 V2입니다.데이터 유형: 문자열 |
| 결과.경고 | 데이터 세트를 생성할 때 존재하는 경고 메시지의 쉼표로 구분된 목록입니다. 이러한 경고는 선택적 매개 변수의 sys_id 잘못된 경우와 같은 유효성 검사일 수 있습니다. 데이터 유형: 배열 |
cURL 요청
다음 예는 새 AI 데이터 세트 자산 레코드를 만드는 방법을 보여줍니다.
curl -X POST 'https://instance.servicenow.com/api/sn_ent/asset/ai_dataset' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d ' {
"name": "Dataset One",
"description": "Description for dataset ",
"provider": "servicenow",
"version": "V1",
"state": 31,
“source”: “Source of dataset”
"documentation": "document",
“dataset_card”: “Dataset Card”,
“base_datasets”: [ “Dataset Two”, “Dataset Three”],
“data_type”: “1,2”,
“acceptable_usage”: “1,2”,
"managed_by": "abel.tuter"
}'
응답 본문. 새로 만든 데이터 세트 자산 기록의 결과입니다.
{
"result": {
"asset": {
"sys_id": "da8393eb40d25210f877b00c113d1fc1",
"display_name": "ServiceNow Closed Incidents",
"name": "Closed Incidents",
"description": "Incidents with resolution",
"documentation": "Sample Documentation",
"source": "incident table on servicenow instance",
"dataset_card": "Dataset Card",
"state": "Deployed",
"version": null,
"data_type": {
"value": "1",
"label": "Text"
},
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"managed_by": {
"sys_id": "undefined",
"name": ""
},
"acceptable_usage": {
"value": "1",
"label": "Training"
},
"base_datasets": [],
"created": "2024-12-12 01:23:03",
"updated": "2024-12-12 01:23:03"
},
"warnings": []
}
}
AI 자산 API - POST /sn_ent/asset/ai_prompt
요청 본문에 입력한 상세 정보에 따라 AI 프롬프트 디지털 자산[alm_ai_prompt_digital_asset] 및 AI 프롬프트 제품 모델[cmdb_ai_promt_product_model] 테이블에 새 AI 프롬프트 자산 항목을 생성합니다.
URL 형식
버전이 지정된 URL: /api/sn_ent/{api_version}/asset/ai_prompt
기본 URL: /api/sn_ent/asset/ai_prompt
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| 객체 | 필수 업데이트할 AI 프롬프트 자산의 컨텐츠입니다. 데이터 유형: 객체 |
| ai_model | AI 모델 디지털 자산[alm_ai_model_digital_asset] 테이블에 있는 기존 기록의 AI 모델 필드 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 빈 문자열 |
| 설명 | AI 프롬프트 제품 모델에 제공하는 설명입니다. 테이블: AI 프롬프트 제품 모델 [cmdb_ai_prompt_product_model] 데이터 유형: 문자열 기본값: 빈 문자열 |
| 문서 | AI 프롬프트 제품 모델에 대한 설명서입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| managed_by | 사용자 [sys_user] 테이블에 있는 기존 기록의 관리자 필드 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 빈 문자열 |
| 이름 | 필수 AI 프롬프트 제품 모델 [cmdb_ai_prompt_product_model] 테이블에 있는 연결된 기록의 이름입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| prompt_info | AI 프롬프트 자산에 대한 프롬프트 정보입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 제공자 | 필수 회사 [core_company] 테이블에 있는 기존 기록의 제공자 필드 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 상태 | AI 모델 자산에 적용할 상태입니다. 예: 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 버전 | AI 프롬프트 제품 모델을 할당할 버전 번호입니다. 예를 들어 V2입니다.데이터 유형: 문자열 기본값: 빈 문자열 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 결과 | 새 AI 자산 프롬프트의 결과입니다. 데이터 유형: 객체 |
| 결과.자산 | 새로 생성된 항목에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.asset.ai_model | AI 시스템 자산 [cmdb_ai_ system_asset_model] 테이블 기록의 AI 모델 목록입니다. 데이터 유형: 배열 |
| result.asset.ai_models.name | AI 시스템 디지털 자산 [alm_ai_system_digital_asset] 테이블 기록의 이름입니다. 데이터 유형: 문자열 |
| result.asset.ai_models.sys_id | AI 시스템 디지털 자산[alm_ai_system_digital_asset] 테이블 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.asset.ai_prompts | AI 시스템 자산 기록의 AI 프롬프트 목록입니다. 테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 배열 |
| result.asset.ai_prompts.name | AI 프롬프트의 이름입니다. 데이터 유형: 문자열 |
| result.asset.ai_prompts.sys_id | AI 시스템 디지털 자산[alm_ai_system_digital_asset] 테이블 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| 결과.자산.생성됨 | AI 모델 자산이 생성된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| 결과.자산.설명 | 연결된 AI 시스템 제품 모델 기록에 대한 설명입니다. 테이블: AI 시스템 제품 모델 [cmdb_ai_system_product_model] 데이터 유형: 문자열 |
| result.asset.display_name | AI 시스템 자산 기록의 표시 이름입니다. 테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 문자열 |
| 결과.자산.설명서 | 연결된 AI 시스템 제품 모델 [cmdb_ai_ system_product_model] 테이블 기록에 대한 설명서입니다. 데이터 유형: 문자열 |
| result.asset.evaluation_datasets | AI 시스템 자산 모델을 평가하는 데 사용되는 AI 데이터 세트의 sys_ids 또는 표시 이름 목록입니다. 주로 조직 내에서 개발된 모델에 적용할 수 있습니다. 테이블: AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset], AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 배열 |
| result.asset.evaluation_datasets.name | AI 데이터 세트 디지털 자산의 이름입니다. 데이터 유형: 문자열 |
| result.asset.evaluation_datasets.sys_id | AI 시스템 디지털 자산 기록의 Sys_id입니다. 테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 문자열 |
| result.asset.evaluation_metrics_report | AI 시스템 자산의 평가 결과입니다. 가능한 값:
데이터 유형: 문자열 |
| result.asset.managed_by | 자산을 관리하는 사용자에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.asset.managed_by.name | AI 모델 자산 기록을 관리하는 사용자의 이름입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.asset.managed_by.sys_id | AI 모델 자산 기록을 관리하는 사용자의 Sys_id입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.asset.name | 연결된 AI 시스템 제품 모델 기록의 이름입니다. 테이블: AI 시스템 제품 모델 [cmdb_ai_system_product_model] 데이터 유형: 문자열 |
| 결과.자산.제공자 | 연결된 AI 시스템 제품 모델 [cmdb_ai_ system_product_model] 테이블 기록의 제공자 필드 값입니다. 데이터 유형: 객체 |
| result.asset.provider.name | 연결된 AI 시스템 제품 모델 [cmdb_ai_ system_product_model] 테이블 기록의 제공자 이름입니다. 데이터 유형: 문자열 |
| result.asset.provider.sys_id | 연결된 AI 시스템 제품 모델 [cmdb_ai_ system_product_model] 테이블 기록에 있는 제공자의 Sys_id입니다. 데이터 유형: 문자열 |
| 결과.자산.상태 | AI 모델 자산의 상태입니다. 가능한 값:
데이터 유형: 문자열 |
| result.asset.sys_id | AI 시스템 자산 기록의 Sys_id입니다. 테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 문자열 |
| 결과.자산.업데이트됨 | AI 모델 자산이 마지막으로 업데이트된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| 결과.경고 | 쉼표로 구분된 경고 메시지 목록입니다. 이러한 경고는 선택적 매개 변수의 sys_id 잘못된 경우와 같은 유효성 검사일 수 있습니다. 데이터 유형: 배열 |
cURL 요청
다음 예제에서는 POST 메서드를 사용하여 요청 본문에 제공된 세부 정보에 따라 새 AI 프롬프트를 만드는 방법을 보여줍니다.
curl -X POST 'https://instance.servicenow.com/api/sn_ent/asset/ai_prompt' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d '{
"name": "Incident Summarization prompt1",
"description": "Prompt for Incident Summarization",
"provider": "servicenow",
"version": "V1",
"state": 31,
"documentation": "Document",
"ai_model": "mixtral-instruct",
"prompt_info": "Provide incident summary using short_decription, state, worknotes",
"managed_by": "abel.tuter"
}'
응답 본문.
{
"result": {
"asset": {
"sys_id": "9833721b331e92101c9aca989d5c7bf0",
"display_name": "ServiceNow Incident Summarization prompt1 V1",
"name": "Incident Summarization prompt1",
"description": "Prompt for Incident Summarization",
"version": "V1",
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"documentation": "Document",
"state": "Deployed",
"ai_model": {
"sys_id": "9d7dc7e6eb1e5210aa82fab8bad0cda2",
"name": "mixtral-instruct"
},
"prompt_info": "Provide incident summary using short_decription, state, worknotes",
"managed_by": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter"
},
"created": "2024-12-11 04:23:17",
"updated": "2024-12-11 04:23:17"
},
"warnings": []
}
}
AI 자산 API - POST /sn_ent/asset/ai_model
요청 본문에 입력한 세부 정보에 따라 AI 모델 디지털 자산[alm_ai_model_digital_asset] 및 AI 모델 제품 모델[cmdb_ai_model_product_model] 테이블에 새 AI 모델 자산 항목을 생성합니다.
URL 형식
버전이 지정된 URL: /api/sn_ent/{api_version}/asset/ai_model
기본 URL: /api/sn_ent/asset/ai_model
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| {객체} | 필수 새 자산 모델 기록에 적용할 상세 정보입니다. 데이터 유형: 객체 |
| {object}.base_model | 이 모델 버전이 파생된 AI 모델입니다. 주: 조직 내에서 개발된 모델에만 적용할 수 있습니다. 데이터 유형: 객체 |
| {object}.base_model.name | 이 AI 모델을 모델링할 AI 모델 자산의 이름입니다. 데이터 유형: 문자열 |
| {object}.base_model.sys_id | 이 AI 모델을 모델링할 AI 모델 자산의 Sys_id입니다. 테이블: AI 모델 디지털 자산 [alm_ai_dataset_digital_asset] 데이터 유형: 문자열 기본값: 빈 문자열 |
| {object}.context_window | 모델이 처리할 수 있는 입력 시퀀스의 크기(즉, 토큰 수)입니다. 데이터 유형: 정수 기본값: 빈 값 |
| {object}.deployment_guideline | 조직 내에서 개발 및 배포된 모델에 적용할 수 있는 지침입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| {object}.description | AI 모델 제품 모델에 부여한 설명입니다. 업데이트된 테이블: AI 모델 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 문자열 기본값: 빈 문자열 |
| {object}.documentation | AI 모델 제품 모델에 대한 문서입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| {object}.evaluation_datasets | 모델을 평가하는 데 사용되는 AI 데이터 세트의 AI 데이터 세트 또는 표시 이름의 쉼표로 구분된 sys_ids목록입니다. 주로 조직 내에서 개발된 모델에 적용할 수 있습니다. 테이블: AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset], AI 모델 자산[alm_ai_model_digital_asset] 데이터 유형: 배열 유효한 값은 다음과 같습니다.
기본값: 빈 문자열 |
| {object}.evaluation_metrics_report | AI 모델 디지털 자산 기록의 텍스트 필드 내에 있는 평가 결과에 대한 참조입니다. 예:테이블: AI 모델 디지털 자산[alm_ai_model_digital_asset] 데이터 유형: 문자열 기본값: 빈 문자열 |
| {object}.managed_by | 사용자 [sys_user] 테이블에 있는 기존 기록의 "관리자" 필드 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 빈 문자열 |
| {object}.model_size_in_mb | 모델의 크기(MB)입니다. 조직 내에서 개발 및 배포된 모델에 주로 적용할 수 있습니다. 데이터 유형: 숫자 기본값: null 또는 비어 있음 |
| {object}.model_weights_info | 추가 모델 정보입니다(사용 가능한 경우). 주로 조직 내에서 개발된 모델에 적용할 수 있습니다. 데이터 유형: 문자열 기본값: null 또는 비어 있음 |
| {object}.name | 필수 AI 모델 제품 모델의 이름입니다. 테이블: AI 모델 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 문자열 기본값: null 또는 비어 있음 |
| {object}.parameters_info | 모델에 대해 제공된 매개변수 수입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| {object}.provider | 필수 회사 [core_company] 테이블에 있는 기존 기록의 "제공자" 필드 값입니다. 이 제공자를 새 AI 모델에 할당합니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 빈 문자열 |
| {object}.required_infrastructure | 모델 배포를 위한 인프라 요구 사항에 대한 설명서입니다. 예를 들어 인프라 스택 및 처리 요구 사항에 대한 세부 정보입니다. 주로 조직 내에 배포된 모델에 적용할 수 있습니다. 데이터 유형: 문자열 기본값: 비어 있음 또는 null |
| {object}.source | 모델을 만든 사람 또는 항목의 소스에 대한 상세 정보입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 비어 있음 또는 null |
| {object}.state | AI 모델 자산에 적용할 상태입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| {object}.supported_languages | AI 모델에서 지원하는 쉼표로 구분된 언어 목록입니다. 데이터 유형: 배열 유효한 값은 다음과 같습니다.
기본값: 빈 문자열 |
| {object}.training_datasets | AI 모델을 교육하는 데 사용되는 데이터 세트입니다. AI 데이터 세트 자산 [alm_ai_dataset_digital_asset] 테이블의 쉼표로 구분된 sys_ids 또는 표시 이름 목록입니다. 주로 조직 내에서 개발된 모델에 적용할 수 있습니다. 데이터 유형: 배열 기본값: 빈 문자열 |
| {object}.training_procedure | AI 모델에 적용할 교육 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 숫자로 표시된 문자열(예: 기본값: 1: 의사 결정 트리 |
| {object}.version | AI 모델 제품 모델의 버전입니다. 예를 들어 V2입니다.데이터 유형: 문자열 기본값: 빈 문자열 |
응답 본문 매개변수(JSON 또는 XML)
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 201 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 결과 | AI 모델 자산 생성 결과입니다. 데이터 유형: 객체 |
| 결과.자산 | 생성된 AI 모델 자산에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.asset.base_model | 이 버전이 파생된 AI 모델 자산에 대한 정보입니다. 데이터 유형: 객체 |
| result.asset.base_model.name | AI 모델 자산의 표시 이름입니다. 테이블: AI 모델 디지털 자산 [alm_ai_model_digital_asset] 데이터 유형: 문자열 |
| result.asset.base_model.sys_id | AI 모델 자산의 Sys_id입니다. 테이블: AI 모델 디지털 자산 [alm_ai_model_digital_asset] 데이터 유형: 문자열 |
| result.asset.context_window | 모델이 처리할 수 있는 입력 시퀀스의 크기입니다. 즉, 토큰의 수입니다. 데이터 유형: 숫자로 표시된 문자열입니다. 예: |
| 결과.자산.생성됨 | AI 모델 자산이 생성된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| result.asset.deployment_guideline | 조직 내에서 개발 및 배포된 모델에 적용할 수 있는 지침입니다. 데이터 유형: 문자열 |
| 결과.자산.설명 | 연결된 AI 모델 제품 모델 기록에 대한 설명입니다. 테이블: AI 모델 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 문자열 |
| result.asset.display_name | AI 모델 자산 기록의 표시 이름입니다. 테이블: AI 모델 디지털 자산 [alm_ai_model_digital_asset](display_name 필드) 데이터 유형: 문자열 |
| 결과.자산.설명서 | 연결된 AI 모델 제품 모델 기록의 문서입니다. 테이블: AI 모델 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 문자열 |
| result.asset.evaluation_datasets | 모델을 평가하는 데 사용되는 AI 모델 디지털 자산의 AI 데이터 세트의 쉼표로 구분된 sys_ids 또는 표시 이름 목록입니다. 주로 조직 내에서 개발된 모델에 적용할 수 있습니다. 테이블: AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset], AI 모델 디지털 자산[alm_ai_model_digital_asset] 데이터 유형: 배열 |
| result.evaluation_datasets.name | AI 데이터 세트 디지털 자산의 이름입니다. 데이터 유형: 문자열 |
| result.evaluation_datasets.sys_id | AI 모델 디지털 자산 기록의 Sys_id입니다. 테이블: AI 모델 디지털 자산 [alm_ai_model_digital_asset] 데이터 유형: 문자열 |
| result.asset.evaluation_metrics_report | 평가 결과에 대한 참조입니다. 가능한 값:
데이터 유형: 문자열 |
| result.asset.managed_by | AI 모델 자산 기록을 관리하는 사용자입니다. 데이터 유형: 객체 |
| result.asset.managed_by.name | AI 모델 자산 기록을 관리하는 사용자의 이름입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.asset.managed_by.sys_id | AI 모델 자산 기록을 관리하는 사용자의 Sys_id입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.asset.model_size_in_mb | 모델의 크기(MB)입니다. 일반적으로 조직 내에서 개발 및 배포된 모델에 적용할 수 있습니다. 데이터 유형: 숫자 |
| result.asset.name | 연결된 AI 모델 제품 모델 기록의 이름입니다. 테이블: AI 모델 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 문자열 |
| 결과.자산.제공자 | 연결된 AI 모델 제품 모델 기록의 제공자입니다. 테이블: AI 모델 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 객체 |
| result.asset.provider.name | 제공자의 이름입니다. 데이터 유형: 문자열 |
| result.asset.provider.sys_id | 연결된 AI 모델 제품 모델 기록의 제공자에 해당하는 회사 [core_company] 테이블의 기록 Sys_id입니다. 테이블: AI 모델 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 문자열 |
| 결과.자산.소스 | 자산의 소스에 대한 상세 정보입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 결과.자산.상태 | AI 모델 자산 기록의 상태입니다. 가능한 값:
데이터 유형: 문자열 |
| result.asset.supported_languages.name | 지원되는 언어의 이름입니다. 테이블: 언어 [sys_language] 데이터 유형: 문자열 |
| result.asset.supported_languages.sys_id | 지원되는 언어의 Sys_id입니다. 테이블: 언어 [sys_language] 데이터 유형: 문자열 |
| result.asset.sys_id | AI 모델 자산 기록의 Sys_id 테이블: AI 모델 디지털 자산 [alm_ai_model_digital_asset] 데이터 유형: 문자열 |
| result.asset.training_datasets | 모델 학습에 사용되는 1+ 관련 데이터 세트에 대한 참조입니다. 데이터 유형: 배열 |
| result.asset.training_procedure | 모델에 적용된 AI 교육의 유형입니다. 가능한 값:
데이터 유형: 문자열 |
| 결과.자산.업데이트됨 | AI 모델 자산이 마지막으로 업데이트된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| 결과.자산.버전 | 연결된 AI 모델 제품 모델 기록의 버전입니다. 테이블: AI 모델 제품 모델[cmdb_ai_model_product_model 테이블] 데이터 유형: 문자열 |
| result.required_infrastructure | 모델 배포를 위한 인프라 요구 사항에 대한 설명서입니다. 예를 들어 인프라 스택 및 처리 요구 사항에 대한 세부 정보입니다. 데이터 유형: 문자열 |
| result.asset.parameters_info | 학습 프로세스 중에 학습하는 교육 데이터의 속성입니다. 예: 7B 또는 30B.데이터 유형: 문자열 |
| result.asset.supported_languages | AI 모델 자산에서 지원하는 언어에 대한 상세 정보입니다. 테이블: 언어 [sys_language] 데이터 유형: 객체 |
| 결과.경고 | 쉼표로 구분된 경고 메시지 목록입니다. 이러한 경고는 유효성 검사일 수 있습니다(예: 선택적 매개변수의 sysId가 잘못된 경우). 데이터 유형: 배열 |
cURL 요청
다음 예에서는 요청 본문에 제공된 세부 정보에 따라 AI 모델 자산을 생성합니다.
curl -X POST 'https://instance.servicenow.com/api/sn_ent/asset/ai_prompt' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d ' {
"name": "Now LLM",
"description": "enables text-to-text like question answering and summarization",
"provider": "servicenow",
"documentation": "Now LLM V5 Documentation",
"version": "V8",
"parameters_info": "7B",
"supported_languages": [
"English",
"French"
],
"model_size_in_mb": "87",
"deployment_guideline": "Deployed on ServiceNow infrastructure",
"source": "https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1",
"training_procedure": "2",
"context_window": "8000",
"state": "31",
"base_model": "Servicenow Now LLM V6",
"model_weights_info": "refer to weights and biases project",
"required_infrastructre": "GPUs needed: 1, GPU Type: A100",
"training_datasets": [
"Servicenow Open Incidents"
],
"evaluation_datasets": [
"Servicenow Open Incidents"
],
"evaluation_metrics_report": "Testing results: See files attached to this record",
"managed_by": "abel.tuter"
}'
{
"result": {
"asset": {
"sys_id": "a438d170ff96da10c1fbffffffffffd5",
"display_name": "ServiceNow Now LLM V6",
"name": "Now LLM",
"description": "enables text-to-text like question answering and summarization",
"version": "V8",
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"documentation": "Now LLM V5 Documentation",
"parameters_info": "7B",
"supported_languages": [
{
"sys_id": "914493a30f320010e96b0e4fef767e90",
"name": "English"
}
],
"model_size_in_mb": "87",
"deployment_guideline": "Deployed on ServiceNow infrastructure",
"source": "https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1",
"training_procedure": "2",
"context_window": "8000",
"state": "Deployed",
"required_infrastructure": "Servicenow Instance",
"base_model": {
"sys_id": "a438d170ff96da10c1fbffffffffffd5",
"name": "ServiceNow Now LLM V8"
},
"evaluation_datasets": [
{
"sys_id": "45cb45baff06d610c1fbffffffffffa9",
"name": "ServiceNow Open Incidents"
}
],
"training_datasets": [
{
"sys_id": "45cb45baff06d610c1fbffffffffffa9",
"name": "ServiceNow Open Incidents"
}
],
"evaluation_metrics_report": "Testing results: See files attached to this record",
"managed_by": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter"
},
"created": "2024-12-03 16:50:53",
"updated": "2024-12-12 15:56:28"
},
"warnings": [
"Reference record 'French' not found for supported_languages in table sys_language"
]
}
}AI 자산 API - POST /sn_ent/asset/ai_system
요청 본문에 입력한 세부 정보에 따라 AI 시스템 디지털 자산[alm_ai_system_digital_asset] 및 AI 시스템 제품 모델[cmdb_ai_system_product_model] 테이블에 새 AI 시스템 자산 항목을 생성합니다.
URL 형식
버전이 지정된 URL: /api/sn_ent/{api_version}/asset/ai_system
기본 URL: /api/sn_ent/asset/ai_system
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| 객체 | 필수 AI 시스템에서 업데이트할 상세 정보입니다. 데이터 유형: 객체 |
| object.name | 필수 AI 시스템 제품 모델의 이름입니다. 데이터 유형: 문자열 |
| object.description | AI 시스템 제품 모델에 대한 설명입니다. 데이터 유형: 문자열 |
| 객체.공급자 | 필수 기존 회사 [core_company] 테이블 기록의 제공자 필드 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| Object.State | AI 시스템 자산에 적용할 상태입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 빈 문자열 |
| object.version | AI 시스템 제품 모델의 버전입니다. 예를 들어 V2입니다.데이터 유형: 문자열 기본값: 빈 문자열 |
| object.documentation | AI 시스템 자산에 대한 문서입니다. 데이터 유형: 문자열 기본값: |
| object.ai_models | 쉼표로 구분된 문자열 목록입니다. 여기서 각 문자열은 기존 AI 모델 디지털 자산 기록의 AI 모델 필드 값을 나타냅니다. 테이블: AI 모델 디지털 자산 [alm_ai_model_digital_asset] 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 빈 문자열 |
| object.evaluation_datasets | AI 시스템 자산 기록을 평가하는 데 사용되는 AI 데이터 세트의 쉼표로 구분된 목록입니다. 주로 조직 내에서 개발된 모델에 적용할 수 있습니다. 테이블: AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset], AI 시스템 자산[AI 시스템 디지털 자산 alm_ai_system_digital_asset] 데이터 유형: 배열 유효한 값은 다음과 같습니다.
기본값: 빈 문자열 |
| object.evaluation_metrics_report | AI 시스템 자산 기록의 텍스트 필드 내에 있는 평가 결과에 대한 참조입니다. 예:테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 문자열 기본값: 빈 문자열 |
| object.managed_by | 기존 사용자[sys_user] 테이블 기록의 "관리자" 필드 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 빈 문자열 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 결과 | 새 AI 시스템 자산의 결과입니다. 데이터 유형: 객체 |
| 결과.자산 | 새로 생성된 항목에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.asset.ai_models | AI 시스템 디지털 자산 [alm_ai_system_digital_asset] 기록의 AI 모델 목록입니다. 데이터 유형: 배열 |
| result.asset.ai_models.name | AI 시스템 디지털 자산 [alm_ai_system_digital_asset] 테이블 기록의 이름입니다. 데이터 유형: 문자열 |
| result.asset.ai_models.sys_id | AI 시스템 디지털 자산[alm_ai_system_digital_asset] 테이블 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.asset.ai_prompts | AI 시스템 디지털 자산 [alm_ai_system_digital_asset] 기록의 AI 프롬프트 목록입니다. 데이터 유형: 배열 |
| result.asset.ai_prompts.name | AI 프롬프트의 이름입니다. 데이터 유형: 문자열 |
| result.asset.ai_prompts.sys_id | AI 시스템 디지털 자산[alm_ai_system_digital_asset] 테이블 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| 결과.자산.생성됨 | AI 모델 자산이 생성된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| 결과.자산.설명 | 연결된 AI 시스템 제품 모델 기록에 대한 설명입니다. 테이블: AI 시스템 제품 모델 [cmdb_ai_system_product_model] 데이터 유형: 문자열 |
| result.asset.display_name | AI 시스템 자산 기록의 표시 이름입니다. 테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 문자열 |
| 결과.자산.설명서 | 연결된 AI 시스템 제품 모델 [cmdb_ai_ system_product_model] 테이블 기록에 대한 설명서입니다. 데이터 유형: 문자열 |
| result.asset.evaluation_datasets | AI 시스템 자산 기록을 평가하는 데 사용되는 AI 데이터 세트 목록입니다. 주로 조직 내에서 개발된 모델에 적용할 수 있습니다. 테이블: AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset], AI 시스템 자산[alm_ai_system_digital_asset] 데이터 유형: 배열 |
| result.asset.evaluation_datasets.name | AI 데이터 세트 디지털 자산의 이름입니다. 데이터 유형: 문자열 |
| result.asset.evaluation_datasets.sys_id | AI 데이터 세트 디지털 자산 [alm_ai_dataset_digital_asset] 테이블 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.asset.evaluation_metrics_report | AI 시스템 자산의 평가 결과입니다. 가능한 값:
데이터 유형: 문자열 |
| result.asset.managed_by | 모델을 평가하는 데 사용되는 AI 시스템 자산의 AI 데이터 세트 sys_ids 또는 표시 이름의 쉼표로 구분된 목록입니다. 주로 조직 내에서 개발된 모델에 적용할 수 있습니다. 테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 객체 |
| result.asset.managed_by.name | AI 모델 자산 기록을 관리하는 사용자의 Sys_id입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.asset.managed_by.sys_id | AI 모델 자산 기록을 관리하는 사용자의 이름입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.asset.name | 연결된 AI 시스템 제품 모델 기록의 이름입니다. 테이블: AI 시스템 제품 모델 [cmdb_ai_system_product_model] 데이터 유형: 문자열 |
| 결과.자산.제공자 | 연결된 AI 시스템 제품 모델 [cmdb_ai_ system_product_model] 테이블 기록의 제공자 필드 값입니다. 데이터 유형: 객체 |
| result.asset.provider.name | 연결된 AI 시스템 제품 모델 [cmdb_ai_ system_product_model] 테이블 기록의 제공자 이름입니다. 데이터 유형: 문자열 |
| result.asset.provider.sys_id | 연결된 AI 시스템 제품 모델 [cmdb_ai_ system_product_model] 테이블 기록에 있는 제공자의 Sys_id입니다. 데이터 유형: 문자열 |
| 결과.자산.상태 | AI 모델 자산의 상태입니다. 가능한 값:
데이터 유형: 문자열 |
| result.asset.sys_id | AI 시스템 자산 기록의 Sys_id입니다. 테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 문자열 |
| 결과.자산.업데이트됨 | AI 모델 자산이 마지막으로 업데이트된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| 결과.자산.버전 | 연결된 AI 시스템 제품 모델 기록의 버전 번호입니다. 예를 들어 V2입니다.데이터 유형: 문자열 |
| 결과.자산.경고 | 쉼표로 구분된 경고 메시지 목록입니다. 이러한 경고는 선택적 매개 변수의 sys_id 잘못된 경우와 같은 유효성 검사일 수 있습니다. 데이터 유형: 배열 |
cURL 요청
다음 예에서는 요청 본문에 포함된 세부 정보를 사용하여 AI 시스템 디지털 자산 및 AI 시스템 제품 모델 테이블에 새 항목을 삽입합니다.
curl -X POST 'https://instance.servicenow.com/api/sn_ent/asset/ai_prompt' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d '{
"name": "Incident Summarization",
"description": "Incident Summarization Skill",
"provider": "servicenow",
"documentation": "Sample Documentation",
"version": "V2",
"state": 31,
"ai_models": [
"llm_generic_small",
"mixtral-instruct"
],
"ai_prompts": [
"LLM Prompt"
],
"evaluation_datasets": [
"Base dataset"
],
"evaluation_metrics_report": "Sample Report",
"managed_by": "abel.tuter"
}'
응답 본문.
{
"result": {
"asset": {
"sys_id": "3b140397435a9210a63d00002fb8f2d7",
"display_name": "ServiceNow Incident Summarization V2",
"name": "Incident Summarization",
"description": "Incident Summarization Skill",
"version": "V2",
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"documentation": "Sample Documentation",
"state": "Deployed",
"ai_models": [{
"sys_id": "9tgdc7e6eb1e5210aa82fab8bad0cda2",
"name": "llm_generic_small"
},
{
"sys_id": "7efdc7e6eb1e5210aa82fab8bad0cda2",
"name": "mixtral-instruct"
}],
"ai_prompts": [{
"sys_id": "7d7dc7e6eb1e5210aa82fab8bad0cda2",
"name": "LLM Prompt"
}],
"evaluation_datasets": [{
"sys_id": "9d7dc7e6eb1e5210aa82fab8bad0cda2",
"name": "Base dataset"
}],
"evaluation_metrics_report": "Sample Report",
"managed_by": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter"
},
"created": "2024-12-11 18:23:09",
"updated": "2024-12-11 18:23:09"
},
"warnings": []
}
}
AI 자산 API - PUT /sn_ent/asset/ai_dataset/{sys_id}
요청 본문에 입력한 정보에 따라 특정 AI 데이터 세트 자산 기록의 데이터를 업데이트합니다.
이 AI 자산 API - GET /sn_ent/asset/ai_dataset/{sys_id} 메서드를 사용하여 지정된 ID로 기존 AI 데이터 세트 기록을 검색합니다. 그런 다음 이 PUT 메서드를 사용하여 동일한 ID 정보를 사용하여 데이터 세트의 값을 업데이트할 수 있습니다.
URL 형식
버전이 지정된 URL: /api/sn_ent/{api_version}/asset/ai_dataset/{sys_id}
기본 URL: /api/sn_ent/asset/ai_dataset/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | AI 데이터 세트 자산 [alm_ai_dataset_digital_asset] 테이블에 있는 자산의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| {객체} |
|
| {object}.acceptable_usage | 일반적으로 교육 또는 평가 목적으로 데이터 세트 또는 모델을 사용할 수 있는 방법을 결정합니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| {object}.base_datasets | 이 데이터 세트를 빌드하는 데 필요한 기본 데이터 세트의 쉼표로 구분된 목록입니다. AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset] 테이블에 있는 데이터 세트의 이름 또는 sys_ids 허용합니다. 데이터 유형: 배열 |
| {object}.data_type | 데이터 세트에 있는 데이터의 유형입니다. 예를 들어 텍스트, 비디오, 이미지 또는 1,2입니다.데이터 유형: 문자열 |
| {object}.dataset_card | 데이터 세트 카드입니다. dataset_card는 AI 데이터 세트의 내용, 구조 및 컨텍스트를 설명하는 메타데이터 문서입니다. 적절한 이해와 사용을 보장하기 위해 데이터 소스, 기능, 사용 목적, 알려진 제한 사항 등의 상세 정보를 제공합니다. 데이터 유형: 문자열 |
| {object}.description | AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 테이블의 연결된 기록에 대한 설명입니다. 데이터 유형: 문자열 |
| {object}.documentation | AI 데이터 세트 제품 모델에 대한 설명서입니다. 데이터 유형: 문자열 |
| {object}.managed_by | 기존 사용자 [sys_user] 테이블 기록의 관리자 필드 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| {object}.name | 필수 AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 테이블에 있는 연결된 기록의 이름입니다. 데이터 유형: 문자열 |
| {object}.provider | 필수 회사 [core_company] 테이블에 있는 기존 기록의 제공자 필드 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| {object}.source | 데이터 세트의 소스에 대한 상세 정보입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 비어 있음 또는 null |
| {object}.state | AI 데이터 세트 자산의 상태입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| {object}.version | 연결된 AI 데이터 세트 제품 모델 기록의 버전 번호입니다. 예를 들어 V2입니다.데이터 유형: 문자열 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 결과 | 새로 생성된 AI 데이터 세트 자산의 상세 정보입니다. 데이터 유형: 객체 |
| result.acceptable_usage | AI 데이터 세트 자산 기록에 허용되는 사용량입니다. 허용되는 사용은 일반적으로 교육 또는 평가 목적으로 데이터 세트 또는 모델을 사용할 수 있는 방법을 나타냅니다. 데이터 유형: 객체 |
| result.acceptable_usage.레이블 | 허용되는 사용 값의 레이블을 표시합니다. 데이터 유형: 문자열 |
| result.acceptable_usage.값 | 허용되는 사용의 숫자 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| result.base_datasets | 지정된 데이터 세트를 빌드하는 데 필요한 기본 데이터 세트의 쉼표로 구분된 목록입니다. AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset] 테이블에 있는 기본 데이터 세트의 이름 또는 sys_id 허용합니다. 데이터 유형: 배열 |
| 결과.생성됨 | AI 데이터 세트 자산 기록이 생성된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| result.data_type | AI 데이터 세트 자산 기록에 있는 데이터의 유형입니다. 데이터 유형: 객체 |
| result.data_type.레이블 | 데이터 유형 값의 표시 레이블입니다. 데이터 유형: 문자열 |
| result.data_type.값 | 데이터 세트 자산의 데이터 유형 값입니다. 데이터 유형: 문자열 |
| result.dataset_card | 데이터 세트 카드입니다. dataset_card는 AI 데이터 세트의 내용, 구조 및 컨텍스트를 설명하는 메타데이터 문서입니다. 적절한 이해와 사용을 보장하기 위해 데이터 소스, 기능, 사용 목적, 알려진 제한 사항 등의 상세 정보를 제공합니다. 데이터 유형: 문자열 |
| 결과.설명 | 연결된 AI 데이터 세트 제품 모델 기록에 대한 설명입니다. 테이블: AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 데이터 유형: 문자열 |
| result.display_name | AI 데이터 세트 자산 기록의 표시 이름입니다. 테이블: AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset] 데이터 유형: 문자열 |
| result.documentation | 연결된 AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 테이블 기록에 대한 설명서입니다. 데이터 유형: 문자열 |
| result.managed_by | AI 데이터 세트 자산 기록을 관리하는 사용자에 대한 세부 정보입니다. 데이터 유형: 객체 |
| result.managed_by.name | AI 데이터 세트 자산 기록을 관리하는 사용자의 이름입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.managed_by.sys_id | AI 데이터 세트 자산 기록을 관리하는 사용자의 Sys_id입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.name | 연결된 AI 데이터 세트 제품 모델 기록의 이름입니다. 테이블: AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 데이터 유형: 문자열 |
| 결과.제공자 | 연결된 AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 테이블 기록의 제공자입니다. 데이터 유형: 객체 |
| result.provider.name | 제공자의 이름입니다. 데이터 유형: 문자열 |
| result.provider.sys_id | 연결된 AI 데이터 세트 제품 모델 [cmdb_ai_dataset_product_model] 테이블 기록에 있는 제공자의 Sys_id입니다. 데이터 유형: 문자열 |
| 결과.소스 | AI 데이터 세트 자산의 소스에 대한 상세 정보입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 비어 있음 또는 null |
| 결과.상태 | AI 데이터 세트 자산 기록의 상태입니다. 가능한 값:
데이터 유형: 문자열 |
| result.sys_id | AI 데이터 세트 자산 기록의 Sys_id입니다. 테이블: AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset] 데이터 유형: 문자열 |
| 결과.업데이트됨 | AI 데이터 세트 자산 기록이 마지막으로 업데이트된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| result.version | 연결된 AI 데이터 세트 제품 모델 기록의 버전 번호입니다. 예를 들어 V2입니다.데이터 유형: 문자열 |
| 결과.경고 | 데이터 세트를 생성할 때 존재하는 경고 메시지의 쉼표로 구분된 목록입니다. 이러한 경고는 선택적 매개 변수의 sys_id 잘못된 경우와 같은 유효성 검사일 수 있습니다. 데이터 유형: 배열 |
cURL 요청
다음 예제에서는 지정된 ID를 사용하여 AI 데이터 세트 기록의 세부 정보를 업데이트하는 방법을 보여줍니다. 요청 본문에는 업데이트할 매개변수 값이 포함되어 있습니다.
curl -X PUT 'https://instance.servicenow.com/api/sn_ent/asset/ai_dataset/9833721b331e92101c9aca989d5c7bf0' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d '{
"name": "Dataset One",
"description": "Description for dataset ",
"provider": "servicenow",
"version": "V1",
"state": 31,
“source”: “Source of dataset”
"documentation": "document",
“dataset_card”: “Dataset Card”,
“base_datasets”: [ “Dataset Two”, “Dataset Three”],
“data_type”: “1,2”,
“acceptable_usage”: “1,2”,
"managed_by": "abel.tuter"
}'
응답 본문.
{
"result": {
"asset": {
"sys_id": "da8393eb40d25210f877b00c113d1fc1",
"display_name": "ServiceNow Closed Incidents",
"name": "Closed Incidents",
"description": "Incidents with resolution",
"documentation": "Sample Documentation",
"source": "incident table on servicenow instance",
"dataset_card": "Dataset Card",
"state": "Deployed",
"version": null,
"data_type": {
"value": "1",
"label": "Text"
},
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"managed_by": {
"sys_id": "undefined",
"name": ""
},
"acceptable_usage": {
"value": "1",
"label": "Training"
},
"base_datasets": [],
"created": "2024-12-12 01:23:03",
"updated": "2024-12-12 01:23:03"
},
"warnings": []
}
}
AI 자산 API - PUT /sn_ent/asset/ai_prompt/{sys_id}
요청 본문에 입력한 정보에 따라 특정 AI 프롬프트 자산 기록의 데이터를 업데이트합니다.
URL 형식
버전이 지정된 URL: /api/sn_ent/{api_version}/asset/ai_prompt/{sys_id}
기본 URL: /api/sn_ent/asset/ai_prompt/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | AI 프롬프트 자산 [alm_ai_prompt_digital_asset] 테이블에 있는 자산의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| 객체 | 필수 업데이트할 AI 프롬프트 자산의 컨텐츠입니다. 데이터 유형: 객체 |
| ai_model | AI 모델 디지털 자산[alm_ai_model_digital_asset] 테이블에 있는 기존 기록의 AI 모델 필드 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 빈 문자열 |
| 설명 | AI 프롬프트 제품 모델에 제공하는 설명입니다. 테이블: AI 프롬프트 제품 모델 [cmdb_ai_prompt_product_model] 데이터 유형: 문자열 기본값: 빈 문자열 |
| 문서 | AI 프롬프트 제품 모델에 대한 설명서입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| managed_by | 사용자 [sys_user] 테이블에 있는 기존 기록의 관리자 필드 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 빈 문자열 |
| 이름 | 필수 AI 프롬프트 제품 모델 [cmdb_ai_prompt_product_model] 테이블에 있는 연결된 기록의 이름입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| prompt_info | AI 프롬프트 자산에 대한 프롬프트 정보입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 제공자 | 필수 회사 [core_company] 테이블에 있는 기존 기록의 제공자 필드 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 상태 | AI 모델 자산에 적용할 상태입니다. 예: 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 버전 | AI 프롬프트 제품 모델을 할당할 버전 번호입니다. 예를 들어 V2입니다.데이터 유형: 문자열 기본값: 빈 문자열 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 sys_id로 자산을 가져오지 못했습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수
| 이름 | 설명 |
|---|---|
| 결과 |
|
| 결과.자산 | 새로 생성된 항목에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.asset.ai_model | AI 시스템 자산 [cmdb_ai_ system_asset_model] 테이블 기록의 AI 모델 목록입니다. 데이터 유형: 배열 |
| result.asset.ai_models.name | AI 시스템 디지털 자산 [alm_ai_system_digital_asset] 테이블 기록의 이름입니다. 데이터 유형: 문자열 |
| result.asset.ai_models.sys_id | AI 시스템 디지털 자산[alm_ai_system_digital_asset] 테이블 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| 결과.자산.생성됨 | AI 모델 자산이 생성된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| 결과.자산.설명 | 연결된 AI 시스템 제품 모델 기록에 대한 설명입니다. 테이블: AI 시스템 제품 모델 [cmdb_ai_system_product_model] 데이터 유형: 문자열 |
| result.asset.display_name | AI 시스템 자산 기록의 표시 이름입니다. 테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 문자열 |
| 결과.자산.설명서 | 연결된 AI 시스템 제품 모델 [cmdb_ai_ system_product_model] 테이블 기록에 대한 설명서입니다. 데이터 유형: 문자열 |
| result.asset.managed_by | 자산을 관리하는 사용자에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.asset.managed_by.name | AI 모델 자산 기록을 관리하는 사용자의 이름입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.asset.managed_by.sys_id | AI 모델 자산 기록을 관리하는 사용자의 Sys_id입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.asset.name | 연결된 AI 시스템 제품 모델 기록의 이름입니다. 테이블: AI 시스템 제품 모델 [cmdb_ai_system_product_model] 데이터 유형: 문자열 |
| result.asset.prompt_info | AI 프롬프트 자산 기록의 프롬프트 정보입니다. 데이터 유형: 문자열 |
| 결과.자산.제공자 | 연결된 AI 시스템 제품 모델 [cmdb_ai_ system_product_model] 테이블 기록의 제공자 필드 값입니다. 데이터 유형: 객체 |
| result.asset.provider.name | 연결된 AI 시스템 제품 모델 [cmdb_ai_ system_product_model] 테이블 기록의 제공자 이름입니다. 데이터 유형: 문자열 |
| result.asset.provider.sys_id | 연결된 AI 시스템 제품 모델 [cmdb_ai_ system_product_model] 테이블 기록에 있는 제공자의 Sys_id입니다. 데이터 유형: 문자열 |
| 결과.자산.상태 | AI 모델 자산의 상태입니다. 가능한 값:
데이터 유형: 문자열 |
| result.asset.sys_id | AI 시스템 자산 기록의 Sys_id입니다. 테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 문자열 |
| 결과.자산.업데이트됨 | AI 모델 자산이 마지막으로 업데이트된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| 결과.자산.버전 | 연결된 AI 시스템 제품 모델 기록의 버전 번호입니다. 예를 들어 V2입니다.데이터 유형: 문자열 |
| 결과.경고 | 쉼표로 구분된 경고 메시지 목록입니다. 이러한 경고는 선택적 매개 변수의 sys_id 잘못된 경우와 같은 유효성 검사일 수 있습니다. 데이터 유형: 배열 |
cURL 요청
다음 예에서는 요청 본문에 제공된 매개변수 값에 따라 지정된 sys_id 사용하여 AI 프롬프트 자산의 데이터를 업데이트합니다.
curl -X PUT 'https://instance.servicenow.com/api/sn_ent/asset/ai_prompt/9833721b331e92101c9aca989d5c7bf0' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d '{
"name": "Incident Summarization prompt1",
"description": "Prompt for Incident Summarization",
"provider": "servicenow",
"version": "V1",
"state": 31,
"documentation": "Docuuu",
"ai_model": "mixtral-instruct",
"prompt_info": "Provide incident summary using short_decription, state, worknotes",
"managed_by": "abel.tuter"
}'
응답 본문:
{
"result": {
"asset": {
"sys_id": "9833721b331e92101c9aca989d5c7bf0",
"display_name": "ServiceNow Incident Summarization prompt1 V1",
"name": "Incident Summarization prompt1",
"description": "Prompt for Incident Summarization",
"version": "V1",
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"documentation": "Docuuu",
"state": "Deployed",
"ai_model": {
"sys_id": "9d7dc7e6eb1e5210aa82fab8bad0cda2",
"name": "mixtral-instruct"
},
"prompt_info": "Provide incident summary using short_decription, state, worknotes",
"managed_by": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter"
},
"created": "2024-12-11 04:23:17",
"updated": "2024-12-11 04:23:17"
},
"warnings": []
}
}
AI 자산 API - PUT /sn_ent/asset/ai_system/{sys_id}
요청 본문에 입력한 정보에 따라 특정 AI 시스템 기록의 데이터를 업데이트합니다.
URL 형식
버전이 지정된 URL: /api/sn_ent/{api_version}/asset/ai_system/{sys_id}
기본 URL: /api/sn_ent/asset/ai_system/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | AI 시스템 디지털 자산[alm_ai_system_digital_asset] 테이블에 있는 자산의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| 객체 | 필수 AI 시스템에서 업데이트할 상세 정보입니다. 데이터 유형: 객체 |
| object.name | 필수 AI 시스템 제품 모델의 이름입니다. 데이터 유형: 문자열 |
| object.description | AI 시스템 제품 모델에 대한 설명입니다. 데이터 유형: 문자열 |
| 객체.공급자 | 필수 기존 회사 [core_company] 테이블 기록의 제공자 필드 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| Object.State | AI 시스템 자산에 적용할 상태입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 빈 문자열 |
| object.version | AI 시스템 제품 모델의 버전입니다. 예를 들어 V2입니다.데이터 유형: 문자열 기본값: 빈 문자열 |
| object.documentation | AI 시스템 자산에 대한 문서입니다. 데이터 유형: 문자열 기본값: |
| object.ai_models | 쉼표로 구분된 문자열 목록입니다. 여기서 각 문자열은 기존 AI 모델 디지털 자산 기록의 AI 모델 필드 값을 나타냅니다. 테이블: AI 모델 디지털 자산 [alm_ai_model_digital_asset] 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 빈 문자열 |
| object.evaluation_datasets | AI 시스템 자산 기록을 평가하는 데 사용되는 AI 데이터 세트의 쉼표로 구분된 목록입니다. 주로 조직 내에서 개발된 모델에 적용할 수 있습니다. 테이블: AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset], AI 시스템 자산[AI 시스템 디지털 자산 alm_ai_system_digital_asset] 데이터 유형: 배열 유효한 값은 다음과 같습니다.
기본값: 빈 문자열 |
| object.evaluation_metrics_report | AI 시스템 자산 기록의 텍스트 필드 내에 있는 평가 결과에 대한 참조입니다. 예:테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 문자열 기본값: 빈 문자열 |
| object.managed_by | 기존 사용자[sys_user] 테이블 기록의 "관리자" 필드 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 빈 문자열 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 404 | 찾을 수 없습니다. 지정된 sys_id로 자산을 가져오지 못했습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 결과 | 업데이트된 AI 시스템 자산의 결과입니다. 데이터 유형: 객체 |
| 결과.자산 | 새로 생성된 자산에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.ai_models | AI 시스템 디지털 자산[alm_ai_system_digital_asset] 테이블 기록의 AI 모델 목록입니다. 데이터 유형: 배열 |
| result.ai_models.name | AI 시스템 디지털 자산 기록의 이름입니다. 테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 문자열 |
| result.ai_models.sys_id | AI 시스템 디지털 자산 기록의 Sys_id입니다. 테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 문자열 |
| result.ai_prompts | AI 시스템 자산 기록의 AI 프롬프트 목록입니다. 데이터 유형: 배열 |
| result.ai_prompts.name | AI 프롬프트의 이름입니다. 데이터 유형: 문자열 |
| result.ai_prompts.sys_id | AI 프롬프트 디지털 자산 기록의 Sys_id입니다. 테이블: AI 프롬프트 디지털 자산 [alm_ai_prompt_digital_asset] 데이터 유형: 문자열 |
| 결과.자산.생성됨 | AI 모델 자산이 생성된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| 결과.자산.설명 | 연결된 AI 시스템 제품 모델 기록에 대한 설명입니다. 테이블: AI 시스템 제품 모델 [cmdb_ai_system_product_model] 데이터 유형: 문자열 |
| result.asset.display_name | AI 시스템 자산 기록의 표시 이름입니다. 테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 문자열 |
| 결과.자산.설명서 | 연결된 AI 시스템 제품 모델 [cmdb_ai_ system_product_model] 테이블 기록에 대한 설명서입니다. 데이터 유형: 문자열 |
| result.asset.evaluation_datasets | AI 시스템 자산 기록을 평가하는 데 사용되는 AI 데이터 세트 목록입니다. 주로 조직 내에서 개발된 모델에 적용할 수 있습니다. 테이블: AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset], AI 시스템 자산[alm_ai_system_digital_asset] 데이터 유형: 배열 |
| result.asset.evaluation_datasets.name | AI 데이터 세트 디지털 자산의 이름입니다. 데이터 유형: 문자열 |
| result.asset.evaluation_datasets.sys_id | AI 데이터 세트 디지털 자산 [alm_ai_dataset_digital_asset] 테이블 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.asset.evaluation_metrics_report | AI 시스템 자산의 평가 결과입니다. 가능한 값:
데이터 유형: 문자열 |
| result.asset.managed_by | 모델을 평가하는 데 사용되는 AI 시스템 자산의 AI 데이터 세트 sys_ids 또는 표시 이름의 쉼표로 구분된 목록입니다. 주로 조직 내에서 개발된 모델에 적용할 수 있습니다. 테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 객체 |
| result.asset.managed_by.name | AI 모델 자산 기록을 관리하는 사용자의 Sys_id입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.asset.managed_by.sys_id | AI 모델 자산 기록을 관리하는 사용자의 이름입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.asset.name | 연결된 AI 시스템 제품 모델 기록의 이름입니다. 테이블: AI 시스템 제품 모델 [cmdb_ai_system_product_model] 데이터 유형: 문자열 |
| 결과.자산.제공자 | 연결된 AI 시스템 제품 모델 [cmdb_ai_ system_product_model] 테이블 기록의 제공자 필드 값입니다. 데이터 유형: 객체 |
| result.asset.provider.name | 연결된 AI 시스템 제품 모델 [cmdb_ai_ system_product_model] 테이블 기록의 제공자 이름입니다. 데이터 유형: 문자열 |
| result.asset.provider.sys_id | 연결된 AI 시스템 제품 모델 [cmdb_ai_ system_product_model] 테이블 기록에 있는 제공자의 Sys_id입니다. 데이터 유형: 문자열 |
| 결과.자산.상태 | AI 모델 자산의 상태입니다. 가능한 값:
데이터 유형: 문자열 |
| result.asset.sys_id | AI 시스템 자산 기록의 Sys_id입니다. 테이블: AI 시스템 디지털 자산[alm_ai_system_digital_asset] 데이터 유형: 문자열 |
| 결과.자산.업데이트됨 | AI 모델 자산이 마지막으로 업데이트된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| 결과.자산.버전 | 연결된 AI 시스템 제품 모델 기록의 버전 번호입니다. 예를 들어 V2입니다.데이터 유형: 문자열 |
| 결과.자산.경고 | 쉼표로 구분된 경고 메시지 목록입니다. 이러한 경고는 선택적 매개 변수의 sys_id 잘못된 경우와 같은 유효성 검사일 수 있습니다. 데이터 유형: 배열 |
cURL 요청
다음 예제에서는 요청 본문에서 업데이트할 세부 정보로 AI 시스템을 업데이트합니다.
curl -X PUT 'https://instance.servicenow.com/api/sn_ent/asset/ai_prompt/3b140397435a9210a63d00002fb8f2d7' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d '{
"name": "Incident Summarization",
"description": "Skill to summarize incident",
"provider": "servicenow",
"documentation": "Sample Documentation",
"version": "V3",
"state": 31,
"ai_models": [
"llm_generic_small"
],
"ai_prompts": [
"LLM Prompt"
],
"evaluation_datasets": [
"Base dataset"
],
"evaluation_metrics_report": "Sample Report",
"managed_by": "abel.tutor"
}'
응답 본문은 지정된 AI 시스템 sys_id에 적용된 업데이트의 결과를 보여줍니다.
{
"result": {
"asset": {
"sys_id": "3b140397435a9210a63d00002fb8f2d7",
"display_name": "ServiceNow Incident Summarization V2",
"name": "Incident Summarization",
"description": "Skill to summarize incident",
"version": "V3",
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"documentation": "Sample Documentation",
"state": "Deployed",
"ai_models": [{
"sys_id": "9tgdc7e6eb1e5210aa82fab8bad0cda2",
"name": "llm_generic_small"
}],
"ai_prompts": [{
"sys_id": "7d7dc7e6eb1e5210aa82fab8bad0cda2",
"name": "LLM Prompt"
}],
"evaluation_datasets": [{
"sys_id": "9d7dc7e6eb1e5210aa82fab8bad0cda2",
"name": "Base dataset"
}],
"evaluation_metrics_report": "Sample Report",
"managed_by": {
"sys_id": "a8f98bb0eb32010045e1a5115206fe3a",
"name": "Abraham Lincoln"
},
"created": "2024-12-11 19:07:13",
"updated": "2024-12-11 19:07:42"
},
"warnings": []
}
}
AI 자산 API - PUT /sn_ent/asset/ai_model/{sys_id}
요청 본문에 입력한 정보에 따라 특정 AI 모델 자산 기록의 데이터를 업데이트합니다.
URL 형식
버전이 지정된 URL: /api/sn_ent/{api_version}/asset/ai_model/{sys_id}
기본 URL: /api/sn_ent/asset/ai_model/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | AI 프롬프트 자산 [alm_ai_prompt_digital_asset] 테이블에 있는 자산의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| 객체 | 필수 지정된 AI 모델에서 업데이트할 상세 정보입니다. 데이터 유형: 객체 |
| base_model | 이 모델 버전이 파생된 AI 모델입니다. 주: 조직 내에서 개발된 모델에만 적용할 수 있습니다. 데이터 유형: 객체 기본값: 빈 객체 |
| base_model.name | 이 AI 모델을 모델링할 AI 모델 자산의 이름입니다. 데이터 유형: 문자열 |
| base_model.sys_id | 이 AI 모델을 모델링할 AI 모델 자산의 Sys_id입니다. 테이블: AI 모델 디지털 자산 alm_ai_model_digital_asset 데이터 유형: 문자열 |
| context_window | 모델이 처리할 수 있는 입력 시퀀스의 크기(즉, 토큰 수)입니다. 데이터 유형: 정수 기본값: 0 |
| deployment_guideline | 조직 내에서 개발 및 배포된 모델에 적용할 수 있는 지침입니다. 데이터 유형: 문자열 기본값: 비어 있음 |
| 설명 | AI 모델 제품 모델에 부여한 설명입니다. 테이블에서 업데이트됨: AI 모델 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 문자열 기본값: 비어 있음 |
| 문서 | AI 프롬프트 제품 모델 기록의 문서화입니다. 테이블: AI 프롬프트 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 문자열 기본값: 비어 있음 |
| evaluation_datasets | 모델을 평가하는 데 사용되는 AI 프롬프트 디지털 자산의 AI 데이터 세트의 쉼표로 구분된 sys_ids 또는 표시 이름 목록입니다. 주로 조직 내에서 개발된 모델에 적용할 수 있습니다. 테이블: AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset], AI 프롬프트 디지털 자산[alm_ai_prompt_digital_asset] 데이터 유형: 배열 유효한 값은 다음과 같습니다.
기본값: 빈 문자열 |
| evaluation_metrics_report | AI 데이터 세트 자산 기록의 텍스트 필드 내에 있는 평가 결과에 대한 참조입니다. 예:테이블: AI 데이터 세트 자산 [alm_ai_dataset_digital_asset] 데이터 유형: 문자열 기본값: 빈 문자열 |
| managed_by | 사용자 [sys_user] 테이블에 있는 기존 기록의 "관리자" 필드 값입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 비어 있음 |
| model_size_in_mb | 모델의 크기(MB)입니다. 조직 내에서 개발 및 배포된 모델에 주로 적용할 수 있습니다. 데이터 유형: 숫자 기본값: 비어 있음 |
| model_weights_info | 추가 모델 정보입니다(사용 가능한 경우). 주로 조직 내에서 개발된 모델에 적용할 수 있습니다. 데이터 유형: 문자열 기본값: 비어 있음 |
| 이름 | 필수 AI 모델 제품 모델의 이름입니다. 테이블에서 업데이트됨: AI 모델 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 문자열 |
| parameters_info | 모델에 제공할 매개변수의 수입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 제공자 | 필수 기존 회사 [core_company] 테이블 기록의 "공급자" 필드 값입니다. 이 제공자를 새 AI 모델에 할당합니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| required_infrastructure | 모델 배포를 위한 인프라 요구 사항에 대한 설명서입니다. 예를 들어 인프라 스택 및 처리 요구 사항에 대한 세부 정보입니다. 주로 조직 내에 배포된 모델에 적용할 수 있습니다. 데이터 유형: 문자열 기본값: 비어 있음 |
| 소스 | 모델을 만든 사람 또는 항목의 소스에 대한 상세 정보입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: 비어 있음 또는 null |
| 상태 | AI 모델 자산에 적용할 상태입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| supported_languages | AI 모델에서 지원하는 쉼표로 구분된 언어 목록입니다. 데이터 유형: 배열 유효한 값은 다음과 같습니다.
기본값: 빈 문자열 |
| training_datasets | 모델 학습에 사용되는 1+ 관련 데이터 세트에 대한 참조입니다. AI 데이터 세트 자산 [alm_ai_dataset_digital_asset] 테이블의 쉼표로 구분된 sys_ids 또는 표시 이름 목록입니다. 주로 조직 내에서 개발된 모델에 적용할 수 있습니다. 데이터 유형: 배열 기본값: 빈 문자열 |
| training_procedure | AI 모델에 적용할 교육 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 숫자로 표시된 문자열(예: 기본값: 1: 의사 결정 트리 |
| 버전 | AI 모델 제품 모델의 버전입니다. 예를 들어 V2입니다.데이터 유형: 문자열 기본값: 비어 있음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 결과 | AI 모델 자산 생성 결과입니다. 데이터 유형: 객체 |
| 결과.자산 | 생성된 AI 모델 자산에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.asset.base_model | 이 버전이 파생된 AI 모델 자산에 대한 정보입니다. 데이터 유형: 객체 |
| result.asset.base_model.name | AI 모델 자산의 표시 이름입니다. 테이블: AI 모델 디지털 자산 [alm_ai_model_digital_asset] 데이터 유형: 문자열 |
| result.asset.base_model.sys_id | AI 모델 자산의 Sys_id입니다. 테이블: AI 모델 디지털 자산 [alm_ai_model_digital_asset] 데이터 유형: 문자열 |
| result.asset.context_window | 모델이 처리할 수 있는 입력 시퀀스의 크기입니다. 즉, 토큰의 수입니다. 데이터 유형: 숫자로 표시된 문자열입니다. 예: |
| 결과.자산.생성됨 | AI 모델 자산이 생성된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| result.asset.deployment_guideline | 조직 내에서 개발 및 배포된 모델에 적용할 수 있는 지침입니다. 데이터 유형: 문자열 |
| 결과.자산.설명 | 연결된 AI 모델 제품 모델 기록에 대한 설명입니다. 테이블: AI 모델 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 문자열 |
| result.asset.display_name | AI 모델 자산 기록의 표시 이름입니다. 테이블: AI 모델 디지털 자산 [alm_ai_model_digital_asset](display_name 필드) 데이터 유형: 문자열 |
| 결과.자산.설명서 | 연결된 AI 모델 제품 모델 기록의 문서입니다. 테이블: AI 모델 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 문자열 |
| result.asset.evaluation_datasets | 모델을 평가하는 데 사용되는 AI 모델 디지털 자산의 AI 데이터 세트의 쉼표로 구분된 sys_ids 또는 표시 이름 목록입니다. 주로 조직 내에서 개발된 모델에 적용할 수 있습니다. 테이블: AI 데이터 세트 디지털 자산[alm_ai_dataset_digital_asset], AI 모델 디지털 자산[alm_ai_model_digital_asset] 데이터 유형: 배열 |
| result.evaluation_datasets.name | AI 데이터 세트 디지털 자산의 이름입니다. 데이터 유형: 문자열 |
| result.evaluation_datasets.sys_id | AI 모델 디지털 자산 기록의 Sys_id입니다. 테이블: AI 모델 디지털 자산 [alm_ai_model_digital_asset] 데이터 유형: 문자열 |
| result.asset.evaluation_metrics_report | 평가 결과에 대한 참조입니다. 가능한 값:
데이터 유형: 문자열 |
| result.asset.managed_by | AI 모델 자산 기록을 관리하는 사용자입니다. 데이터 유형: 객체 |
| result.asset.managed_by.name | AI 모델 자산 기록을 관리하는 사용자의 이름입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.asset.managed_by.sys_id | AI 모델 자산 기록을 관리하는 사용자의 Sys_id입니다. 테이블: 사용자 [user] 데이터 유형: 문자열 |
| result.asset.model_size_in_mb | 모델의 크기(MB)입니다. 일반적으로 조직 내에서 개발 및 배포된 모델에 적용할 수 있습니다. 데이터 유형: 숫자 |
| result.asset.name | 연결된 AI 모델 제품 모델 기록의 이름입니다. 테이블: AI 모델 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 문자열 |
| 결과.자산.제공자 | 연결된 AI 모델 제품 모델 기록의 제공자입니다. 테이블: AI 모델 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 객체 |
| result.asset.provider.name | 제공자의 이름입니다. 데이터 유형: 문자열 |
| result.asset.provider.sys_id | 연결된 AI 모델 제품 모델 기록의 제공자에 해당하는 회사 [core_company] 테이블의 기록 Sys_id입니다. 테이블: AI 모델 제품 모델 [cmdb_ai_model_product_model] 데이터 유형: 문자열 |
| 결과.자산.소스 | 자산의 소스에 대한 상세 정보입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 결과.자산.상태 | AI 모델 자산 기록의 상태입니다. 가능한 값:
데이터 유형: 문자열 |
| result.asset.supported_languages.name | 지원되는 언어의 이름입니다. 테이블: 언어 [sys_language] 데이터 유형: 문자열 |
| result.asset.supported_languages.sys_id | 지원되는 언어의 Sys_id입니다. 테이블: 언어 [sys_language] 데이터 유형: 문자열 |
| result.asset.sys_id | AI 모델 자산 기록의 Sys_id 테이블: AI 모델 디지털 자산 [alm_ai_model_digital_asset] 데이터 유형: 문자열 |
| result.asset.training_datasets | 모델 학습에 사용되는 1+ 관련 데이터 세트에 대한 참조입니다. 데이터 유형: 배열 |
| result.asset.training_procedure | 모델에 적용된 AI 교육의 유형입니다. 가능한 값:
데이터 유형: 문자열 |
| 결과.자산.업데이트됨 | AI 모델 자산이 마지막으로 업데이트된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열 |
| 결과.자산.버전 | 연결된 AI 모델 제품 모델 기록의 버전입니다. 테이블: AI 모델 제품 모델[cmdb_ai_model_product_model 테이블] 데이터 유형: 문자열 |
| result.required_infrastructure | 모델 배포를 위한 인프라 요구 사항에 대한 설명서입니다. 예를 들어 인프라 스택 및 처리 요구 사항에 대한 세부 정보입니다. 데이터 유형: 문자열 |
| result.asset.parameters_info | 학습 프로세스 중에 학습하는 교육 데이터의 속성입니다. 예: 7B 또는 30B.데이터 유형: 문자열 |
| result.asset.supported_languages | AI 모델 자산에서 지원하는 언어에 대한 상세 정보입니다. 테이블: 언어 [sys_language] 데이터 유형: 객체 |
| 결과.경고 | 쉼표로 구분된 경고 메시지 목록입니다. 이러한 경고는 유효성 검사일 수 있습니다(예: 선택적 매개변수의 sysId가 잘못된 경우). 데이터 유형: 배열 |
cURL 요청
다음 예제에서는 PUT 메서드를 사용하여 지정된 AI 자산 모델을 업데이트하는 방법을 보여줍니다.
curl -X PUT 'https://instance.servicenow.com/api/sn_ent/asset/ai_model/9833721b331e92101c9aca989d5c7bf0' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d '{
"name": "Now LLM",
"description": "enables text-to-text like question answering and summarization",
"provider": "servicenow",
"documentation": "Now LLM V5 Documentation",
"version": "V8",
"parameters_info": "7B",
"supported_languages": [
"English",
"French"
],
"model_size_in_mb": "87",
"deployment_guideline": "Deployed on ServiceNow infrastructure",
"source": "huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1",
"training_procedure": "2",
"context_window": "8000",
"state": "31",
"base_model": "Servicenow Now LLM V6",
"model_weights_info": "refer to weights and biases project",
"required_infrastructre": "GPUs needed: 1, GPU Type: A100",
"training_datasets": [
"Servicenow Open Incidents"
],
"evaluation_datasets": [
"Servicenow Open Incidents"
],
"evaluation_metrics_report": "Testing results: See files attached to this record",
"managed_by": "abel.tuter"
}'
응답 본문.
{
"result": {
"asset": {
"sys_id": "a438d170ff96da10c1fbffffffffffd5",
"display_name": "ServiceNow Now LLM V6",
"name": "Now LLM",
"description": "enables text-to-text like question answering and summarization",
"version": "V8",
"provider": {
"sys_id": "93d4ecfac0a8000b6294d71b733977fb",
"name": "ServiceNow"
},
"documentation": "Now LLM V5 Documentation",
"parameters_info": "7B",
"supported_languages": [
{
"sys_id": "914493a30f320010e96b0e4fef767e90",
"name": "English"
}
],
"model_size_in_mb": "87",
"deployment_guideline": "Deployed on ServiceNow infrastructure",
"source": "https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1",
"training_procedure": "2",
"context_window": "8000",
"state": "Deployed",
"required_infrastructure": "undefined",
"base_model": {
"sys_id": "a438d170ff96da10c1fbffffffffffd5",
"name": "ServiceNow Now LLM V8"
},
"evaluation_datasets": [
{
"sys_id": "45cb45baff06d610c1fbffffffffffa9",
"name": "ServiceNow Open Incidents"
}
],
"training_datasets": [
{
"sys_id": "45cb45baff06d610c1fbffffffffffa9",
"name": "ServiceNow Open Incidents"
}
],
"evaluation_metrics_report": "Testing results: See files attached to this record",
"managed_by": {
"sys_id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter"
},
"created": "2024-12-03 16:50:53",
"updated": "2024-12-12 15:56:28"
},
"warnings": [
"Reference record 'French' not found for supported_languages in table sys_language"
]
}
}