스키마 파일

스키마 파일 (Schema files)

기계 판독 가능한 스키마, 그 주소, 사용법 — 1.0 버전을 설명드릴게요.

출처: 문서

본문

스키마는 구조에 대해 권위가 있습니다: 어떤 필드가 존재하는지, 어떤 것이 필수인지, 각각이 어떤 타입을 담는지, 판별자가 취할 수 있는 값이 무엇인지. 이 페이지가 그것을 가져오는 곳이에요.

파일 (The file)

schema.json — 완전한 1.0 스키마: 모든 이벤트, 메시지, run input.

https://ag-ui.com/spec/1.0/schema.json

이 파일은 그 주소를 자신의 $id에 진술하므로, 참조를 따르는 검증기는 구성 없이 그것에 대해 참조를 해석해요. 그 주소는 파일을 직접 서빙합니다: 도구와 스키마 사이에 리다이렉트가 없으며, 응답은 크로스-오리진 헤더를 담아 브라우저 기반 도구가 읽을 수 있어요.

그것은 JSON Schema draft 2020-12입니다. #TextMessageStartEvent, #RunAgentInput처럼 모든 정의가 앵커로 도달 가능해서, 도구는 파일을 잘라내지 않고 하나의 형태를 주소로 지정할 수 있어요.

사용하기 (Using it)

curl -sS https://ag-ui.com/spec/1.0/schema.json -o ag-ui-1.0.json

전체 스키마에 대해 이벤트를 검증해 판별자가 멤버를 선택하게 하거나, 이미 형태를 알 때는 단일 앵커에 대해 검증하세요.

스키마는 프로토콜이 엄격한 곳에서 엄격해요: 형태를 고정하는 객체를 닫으므로, 그것에 대해 실행되는 검증기는 프로토콜이 기술하지 않는 자료를 거부해요. 설계상 개방된 객체는 개방된 채로 있어요 — metadata와 JSON Patch 연산을 포함해서 — 왜냐하면 프로토콜은 소비자가 거기에 두는 어떤 것이든 담기 때문이에요. 그 엄격함은 작성과 테스트를 위한 것입니다. 런타임 소비자는 반대로 합니다 — 인식하지 못한 자료를 받아들이고 벗겨내며, Processing model이 요구하는 대로요. 엄격한 스키마를 수신 경로에 연결하고 그 결과를 적합(conformance)이라 부르지 마세요.

스키마가 말하지 않는 것 (What the schema does not say)

순서, 수명주기, 귀속, 오류 처리, 호환성은 행동적이며 어떤 JSON Schema도 이를 표현할 수 없어요. 그것들은 개요에서 시작하는 이 문서의 다른 페이지에 명시되어 있어요.

더 알아보기 (Learn more)