Roboflow 사용자 지정 메타데이터

Roboflow Model Monitoring 대시보드에 사용자 지정 메타데이터를 추가합니다.

Roboflow Model Monitoring 대시보드에서 예측 결과의 inference ID를 추출하고 이름-값 쌍을 추가하여 필터링, 분석, 그리고 모니터링 워크플로, 프로덕션 분석, 모델 성능 추적을 위한 추론 데이터의 정리 및 구성을 가능하게 하는 사용자 지정 메타데이터 필드를 연결합니다.

이 블록의 작동 방식

이 블록은 Roboflow Model Monitoring에 저장된 추론 결과에 사용자 지정 메타데이터를 추가하여, 필터링과 분석을 위해 예측에 문맥 정보를 첨부할 수 있게 해줍니다. 이 블록은:

1. 모델 예측 및 메타데이터 설정을 받습니다:

   • 지원되는 모든 모델 유형(객체 탐지, 인스턴스 분할, 키포인트 탐지 또는 분류)의 예측을 받습니다

   • 첨부할 사용자 지정 메타데이터의 필드 이름과 필드 값을 받습니다

   • 실행 모드를 위한 fire_and_forget 플래그를 स्वीकार합니다

2. Roboflow API 키를 검증합니다:

   • 유효한 Roboflow API 키가 있는지 확인합니다(API 접근에 필요함)

   • API 키가 없으면 가져오는 방법에 대한 안내와 함께 오류를 발생시킵니다

3. 예측에서 inference ID를 추출합니다:

   • supervision Detections 객체의 경우: 데이터 딕셔너리에서 inference ID를 추출합니다

   • 분류 예측의 경우: prediction 딕셔너리에서 inference ID를 추출합니다

   • 메타데이터를 첨부해야 하는 모든 고유한 inference ID를 수집합니다

   • inference ID를 찾지 못한 경우를 처리합니다(오류 메시지를 반환함)

4. 워크스페이스 정보를 가져옵니다:

   • 제공된 API 키를 사용하여 Roboflow API에서 워크스페이스 ID를 가져옵니다

   • 워크스페이스 조회를 위한 반복 API 호출을 방지하기 위해 캐싱(15분 만료)을 사용합니다

   • API 키의 MD5 해시를 캐시 키로 사용하여 워크스페이스 이름을 캐시합니다

5. API를 통해 사용자 지정 메타데이터를 추가합니다:

   • Roboflow API를 호출하여 각 inference ID에 사용자 지정 메타데이터 필드를 연결합니다

   • 필드 이름과 필드 값을 추론 결과와 연결합니다

   • 메타데이터는 필터링과 분석을 위해 Model Monitoring 대시보드에서 사용할 수 있게 됩니다

6. 동기 또는 비동기 방식으로 실행됩니다:

   • 비동기 모드(fire_and_forget=True): 작업을 백그라운드 스레드 풀 또는 FastAPI 백그라운드 작업에 제출하여, API 호출이 완료될 때까지 기다리지 않고 워크플로를 계속 진행할 수 있게 합니다

   • 동기 모드(fire_and_forget=False): API 호출이 완료될 때까지 기다린 뒤 즉시 상태를 반환합니다. 디버깅 및 오류 처리에 유용합니다

7. 상태 정보를 반환합니다:

   • 성공(False) 또는 실패(True)를 나타내는 error_status를 출력합니다

   • 업로드 상태 또는 오류 세부 정보를 담은 message를 출력합니다

   • 메타데이터가 성공적으로 연결되었는지에 대한 피드백을 제공합니다

이 블록은 추론 결과에 사용자 지정 메타데이터를 연결할 수 있게 해주어, Model Monitoring 대시보드에서 예측을 더 쉽게 필터링하고 분석할 수 있게 합니다. 예를 들어 위치 레이블, 품질 점수, 처리 플래그 또는 추론 데이터를 정리하고 분석하는 데 도움이 되는 기타 문맥 정보를 첨부할 수 있습니다.

일반적인 사용 사례

• 위치 기반 필터링: 지리적 분석과 필터링을 위해 추론에 위치 메타데이터를 첨부합니다(예: "toronto", "warehouse_a", "production_line_1" 같은 위치 레이블로 추론을 태깅). 이를 통해 위치 기반 모니터링 워크플로를 사용할 수 있습니다

• 품질 관리 태깅: 품질 추적을 위해 추론에 품질 또는 검증 메타데이터를 첨부합니다(예: 추론에 "pass", "fail", "requires_review", "approved"로 태깅). 이를 통해 품질 관리 워크플로를 사용할 수 있습니다

• 문맥 주석: 더 나은 정리와 분석을 위해 추론에 문맥 정보를 추가합니다(예: 카메라 ID, 시간대, 배치 번호, 작업자 ID, 환경 조건으로 태깅). 이를 통해 문맥 분석 워크플로를 사용할 수 있습니다

• 분류 향상: 모델 예측을 넘어 추론 결과에 사용자 지정 레이블 또는 카테고리를 첨부합니다(예: 비즈니스 로직 결과, 워크플로 결정, 사용자 피드백, 수동 수정으로 태깅). 이를 통해 향상된 분류 워크플로를 사용할 수 있습니다

• 프로덕션 분석: 운영 문맥을 나타내는 메타데이터를 첨부하여 프로덕션 지표를 추적합니다(예: 교대 정보, 생산 배치, 장비 상태, 성능 지표로 태깅). 이를 통해 프로덕션 분석 워크플로를 사용할 수 있습니다

• 필터링 및 세분화: 데이터 세그먼트를 나타내는 메타데이터를 첨부하여 Model Monitoring 대시보드에서 고급 필터링을 가능하게 합니다(예: 고객 세그먼트, 제품 카테고리, 사용 사례 유형, 배포 환경으로 태깅). 이를 통해 세분화 워크플로를 사용할 수 있습니다

다른 블록과 연결하기

이 블록은 예측을 받아 상태 정보를 출력합니다:

• 모델 블록 뒤에 (Object Detection Model, Instance Segmentation Model, Classification Model, Keypoint Detection Model) 메타데이터를 추론 결과에 첨부합니다(예: 탐지 결과에 위치 태그 추가, 분류 결과에 품질 레이블 첨부, 키포인트 탐지 결과에 문맥 태깅). 이를 통해 모델-메타데이터 워크플로를 사용할 수 있습니다

• 필터링 또는 분석 블록 이후 (DetectionsFilter, ContinueIf, OverlapFilter) 필터링되거나 분석된 결과에 메타데이터를 태깅합니다(예: 필터링된 탐지 결과에 필터 기준 태깅, 분석 결과를 메타데이터로 첨부, 처리된 결과를 워크플로 상태로 레이블링). 이를 통해 분석-메타데이터 워크플로를 사용할 수 있습니다

• 조건부 실행 블록 뒤에 (ContinueIf, Expression) 워크플로 결정에 따라 메타데이터를 첨부합니다(예: 결정 결과로 태깅, 조건 분기 레이블 첨부, 조건에 따라 결과 표시). 이를 통해 조건-메타데이터 워크플로를 사용할 수 있습니다

• 다른 sink 블록과 병렬로 메타데이터 태깅을 다른 데이터 저장 작업과 결합합니다(예: 데이터셋 업로드 중 태깅, 로깅 중 메타데이터 첨부, 웹훅 알림과 결합). 이를 통해 병렬 sink 워크플로를 사용할 수 있습니다

• 시각화 블록 전후에 시각화 작업 전후에 메타데이터가 첨부되도록 보장합니다(예: 시각화 결과에 문맥 태깅, 시각화된 결과에 메타데이터 첨부). 이를 통해 메타데이터가 포함된 시각화 워크플로를 사용할 수 있습니다

• 워크플로 끝점에서 워크플로가 완료되기 전에 모든 추론 결과에 메타데이터가 태깅되도록 보장합니다(예: 최종 메타데이터 첨부, 포괄적인 결과 태깅, 완전한 메타데이터 적용). 이를 통해 엔드투엔드 메타데이터 워크플로를 사용할 수 있습니다

요구 사항

이 블록은 환경 또는 워크플로 설정에 구성된 유효한 Roboflow API 키가 필요합니다. API 키는 Roboflow API로 인증하고 Model Monitoring 기능에 접근하는 데 필요합니다. API 키를 가져오는 방법은 https://docs.roboflow.com/reference/authentication/authentication/find-your-roboflow-api-key 를 참조하세요. 이 블록은 inference ID를 포함한 예측이 필요합니다(예측은 inference ID를 포함하는 모델에 의해 생성되어야 함). 지원되는 예측 유형: 객체 탐지, 인스턴스 분할, 키포인트 탐지, 분류. 이 블록은 API 호출을 최적화하기 위해 워크스페이스 캐싱(15분 만료)을 사용합니다. Roboflow의 Model Monitoring에 대한 자세한 내용은 https://docs.roboflow.com/deployment/monitoring-and-analytics/model-monitoring 를 참조하세요.

유형 식별자

step에서 다음 식별자를 사용하세요 "type" 필드: roboflow_core/roboflow_custom_metadata@v1 를 워크플로에 단계로 추가합니다.

속성

이름	유형	설명	참조
name	str	이 단계에 고유 식별자를 입력하세요..	❌
field_name	str	Roboflow Model Monitoring에 생성할 사용자 지정 메타데이터 필드의 이름입니다. 이는 Model Monitoring 대시보드에서 필터링과 분석에 사용할 수 있는 필드 이름이 됩니다. 필드 이름은 설명적이어야 하며 첨부되는 메타데이터의 유형을 나타내야 합니다(예: 'location', 'quality', 'camera_id', 'batch_number'). 필드 이름은 메타데이터 값을 정리하고 분류하는 데 사용됩니다..	❌
field_value	str	사용자 지정 메타데이터 필드에 할당할 값입니다. 이는 추론 결과에 실제로 첨부될 데이터이며 Model Monitoring 대시보드에서 필터링과 분석에 사용할 수 있습니다. 문자열 리터럴이거나 워크플로 출력을 참조하는 선택자일 수 있습니다. 일반적인 값: 위치 식별자(예: 'toronto', 'warehouse_a'), 품질 레이블(예: 'pass', 'fail', 'review'), 식별자(예: 카메라 ID, 배치 번호), 또는 사용 사례와 관련된 기타 문맥 정보..	✅
fire_and_forget	bool	실행 모드 플래그입니다. True(기본값)인 경우 블록은 백그라운드에서 비동기적으로 실행되어 API 호출이 완료될 때까지 기다리지 않고 워크플로가 계속 처리될 수 있습니다. 이는 더 빠른 워크플로 실행을 제공하지만 오류가 즉시 표시되지는 않습니다. False인 경우 블록은 동기적으로 실행되어 API 호출이 완료될 때까지 기다린 뒤 즉시 상태와 오류 정보를 반환합니다. 디버깅 및 오류 처리에는 False를, 성능이 우선인 프로덕션 워크플로에는 True를 사용하세요..	✅

해당 참조 열은 워크플로 런타임에서 사용할 수 있는 동적 값으로 속성을 매개변수화할 수 있음을 나타냅니다. 자세한 내용은 워크플로 런타임. 자세한 내용은 바인딩 를 참조하세요.

런타임 호환성

requires_internet - 에어갭 / 오프라인 배포: 이 블록은 완전 오프라인 / 에어갭 환경에서 접근할 수 없는 서비스에 의존합니다.

입력 및 출력 바인딩

사용 가능한 연결은 바인딩 종류에 따라 달라집니다. 어떤 바인딩 종류가 있는지 확인하세요 Roboflow 사용자 지정 메타데이터 버전 v1 가 있습니다.

입력 및 출력 바인딩

• 입력

  • predictions (Union[classification_prediction, instance_segmentation_prediction, keypoint_detection_prediction, object_detection_prediction]): 사용자 지정 메타데이터를 첨부할 모델 예측(객체 탐지, 인스턴스 분할, 키포인트 탐지 또는 분류)입니다. 예측에는 Roboflow Model Monitoring에서 메타데이터를 특정 추론 결과와 연결하는 데 사용되는 inference ID가 포함되어 있어야 합니다. inference ID는 supervision Detections 객체 또는 분류 예측 딕셔너리에서 자동으로 추출됩니다. 메타데이터는 예측에서 찾은 모든 inference ID에 첨부됩니다..

  • field_value (문자열): 사용자 지정 메타데이터 필드에 할당할 값입니다. 이는 추론 결과에 실제로 첨부될 데이터이며 Model Monitoring 대시보드에서 필터링과 분석에 사용할 수 있습니다. 문자열 리터럴이거나 워크플로 출력을 참조하는 선택자일 수 있습니다. 일반적인 값: 위치 식별자(예: 'toronto', 'warehouse_a'), 품질 레이블(예: 'pass', 'fail', 'review'), 식별자(예: 카메라 ID, 배치 번호), 또는 사용 사례와 관련된 기타 문맥 정보..

  • fire_and_forget (boolean): 실행 모드 플래그입니다. True(기본값)인 경우 블록은 백그라운드에서 비동기적으로 실행되어 API 호출이 완료될 때까지 기다리지 않고 워크플로가 계속 처리될 수 있습니다. 이는 더 빠른 워크플로 실행을 제공하지만 오류가 즉시 표시되지는 않습니다. False인 경우 블록은 동기적으로 실행되어 API 호출이 완료될 때까지 기다린 뒤 즉시 상태와 오류 정보를 반환합니다. 디버깅 및 오류 처리에는 False를, 성능이 우선인 프로덕션 워크플로에는 True를 사용하세요..

• 출력

  • 오류 상태 (boolean): 불리언 플래그.

  • 메시지 (문자열): 문자열 값.

예시 JSON 정의

{
	    "name": "<your_step_name_here>",
	    "type": "roboflow_core/roboflow_custom_metadata@v1",
	    "predictions": "$steps.object_detection.predictions",
	    "field_name": "location",
	    "field_value": "toronto",
	    "fire_and_forget": true
	}