Microsoft Foundry

API 버전: v1

Authentication

흐름: 암시적

권한 부여 URL:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

범위:

• https://ai.azure.com/.default

Agents

에이전트 - 에이전트 만들기

POST {endpoint}/agents?api-version=v1

에이전트를 만듭니다.

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 - 에이전트 나열

GET {endpoint}/agents?api-version=v1

모든 에이전트의 목록을 반환합니다.

URI 매개 변수

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 - 에이전트 가져오기

GET {endpoint}/agents/{agent_name}?api-version=v1

에이전트를 검색합니다.

URI 매개 변수

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 - 에이전트 업데이트

POST {endpoint}/agents/{agent_name}?api-version=v1

에이전트 정의에 변경 사항이 있는 경우 새 버전을 추가하여 에이전트를 업데이트합니다. 변경 사항이 없으면 기존 에이전트 버전을 반환합니다.

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 - 에이전트 삭제

DELETE {endpoint}/agents/{agent_name}?api-version=v1

에이전트를 삭제합니다.

URI 매개 변수

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 - 매니페스트에서 에이전트 업데이트

POST {endpoint}/agents/{agent_name}/import?api-version=v1

에이전트 정의가 변경된 경우 새 버전을 추가하여 매니페스트에서 에이전트를 업데이트합니다. 변경 사항이 없으면 기존 에이전트 버전을 반환합니다.

URI 매개 변수

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 - 에이전트 버전 만들기

POST {endpoint}/agents/{agent_name}/versions?api-version=v1

새 에이전트 버전을 만듭니다.

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 - 에이전트 버전 나열

GET {endpoint}/agents/{agent_name}/versions?api-version=v1

에이전트의 버전 목록을 반환합니다.

URI 매개 변수

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 - 에이전트 버전 가져오기

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

에이전트의 특정 버전을 검색합니다.

URI 매개 변수

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 - 에이전트 버전 삭제

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

특정 버전의 에이전트를 삭제합니다.

URI 매개 변수

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 - 매니페스트에서 에이전트 버전 만들기

POST {endpoint}/agents/{agent_name}/versions:import?api-version=v1

매니페스트에서 새 에이전트 버전을 생성합니다.

URI 매개 변수

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 - 매니페스트에서 에이전트 만들기

POST {endpoint}/agents:import?api-version=v1

매니페스트에서 에이전트를 만듭니다.

URI 매개 변수

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 컨테이너

에이전트 컨테이너 - 에이전트 컨테이너 작업 나열

GET {endpoint}/agents/{agent_name}/operations?api-version=v1

에이전트에 대한 컨테이너 작업을 나열합니다.

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 컨테이너 - 에이전트 컨테이너 작업 가져오기

GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=v1

에이전트에 대한 컨테이너 작업의 상태를 가져옵니다.

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 컨테이너 - 에이전트 컨테이너 가져오기

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=v1

특정 버전의 에이전트에 대한 컨테이너를 가져옵니다.

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 컨테이너 - 에이전트 버전 컨테이너 작업 나열

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=v1

특정 버전의 에이전트에 대한 컨테이너 작업을 나열합니다.

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 컨테이너 - 에이전트 컨테이너 삭제

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=v1

특정 버전의 에이전트에 대한 컨테이너를 삭제합니다. 컨테이너가 없으면 작업이 no-op. 작업은 장기 실행 작업입니다. Azure REST API에서 장기 실행 작업에 대한 디자인 지침에 따릅니다. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI 매개 변수

요청 헤더

Responses

상태 코드: 202

설명: 처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다.

응답 헤더:

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 컨테이너 - 스트림 에이전트 컨테이너 로그

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:logstream?api-version=v1

컨테이너에서 텍스트 청크로 스트리밍된 컨테이너 로그 항목입니다. 각 청크는 스트리밍되는 컨테이너 로그의 유형에 따라 일반 텍스트 로그 줄 또는 JSON 형식 로그 항목일 수 있는 UTF-8 문자열입니다. 클라이언트는 각 청크를 불투명 텍스트로 처리하고 필요한 경우 로깅 요구 사항에 따라 JSON으로 구문 분석하려고 시도해야 합니다.

시스템 로그의 경우 형식은 다음과 같은 구조의 JSON입니다. {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"이벤트 수집기 연결...","Reason":"StartingGettingEvents","EventSource":"ContainerAppController","Count":1} {"TimeStamp":"2025-12-15T16:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"성공적으로 이벤트에 연결됨 server","Reason":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1}

콘솔 로그의 경우 형식은 컨테이너의 stdout/stderr에서 내보낸 일반 텍스트입니다. 2025-12-15T08:43:48.72656 컨테이너 'agent-container'에 연결... 2025-12-15T08:43:48.75451 Successfully Connected to container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replica: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 컨테이너 - 에이전트 컨테이너 시작

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=v1

특정 버전의 에이전트에 대한 컨테이너를 시작합니다. 컨테이너가 이미 실행 중인 경우 작업이 no-op. 작업은 장기 실행 작업입니다. Azure REST API에서 장기 실행 작업에 대한 디자인 지침에 따릅니다. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

Responses

상태 코드: 202

설명: 처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다.

응답 헤더:

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 컨테이너 - 에이전트 컨테이너 중지

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=v1

특정 버전의 에이전트에 대한 컨테이너를 중지합니다. 컨테이너가 실행되고 있지 않거나 이미 중지된 경우 작업이 no-op. 작업은 장기 실행 작업입니다. Azure REST API에서 장기 실행 작업에 대한 디자인 지침에 따릅니다. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI 매개 변수

요청 헤더

Responses

상태 코드: 202

설명: 처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다.

응답 헤더:

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

에이전트 컨테이너 - 에이전트 컨테이너 업데이트

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=v1

특정 버전의 에이전트에 대한 컨테이너를 업데이트합니다. 컨테이너가 실행되고 있지 않으면 작업이 no-op. 작업은 장기 실행 작업입니다. Azure REST API에서 장기 실행 작업에 대한 디자인 지침에 따릅니다. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

Responses

상태 코드: 202

설명: 처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다.

응답 헤더:

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

Connections

연결 - 목록

GET {endpoint}/connections?api-version=v1

연결 자격 증명을 채웁니다. 프로젝트의 모든 연결 나열

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

응답 헤더:

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

연결 - 가져오기

GET {endpoint}/connections/{name}?api-version=v1

연결 자격 증명을 채지 않고 이름으로 연결 가져오기

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

응답 헤더:

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

연결 - 자격 증명으로 가져오기

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=v1

연결 자격 증명을 사용하여 이름으로 연결 가져오기

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

응답 헤더:

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

Datasets

데이터 세트 - 최신 목록

GET {endpoint}/datasets?api-version=v1

각 DatasetVersion의 최신 버전 나열

URI 매개 변수

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

데이터 세트 - 버전 나열

GET {endpoint}/datasets/{name}/versions?api-version=v1

지정된 DatasetVersion의 모든 버전 나열

URI 매개 변수

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

데이터 세트 - 버전 가져오기

GET {endpoint}/datasets/{name}/versions/{version}?api-version=v1

특정 버전의 DatasetVersion을 가져옵니다. DatasetVersion이 없으면 서비스에서 404 찾을 수 없음 오류를 반환합니다.

URI 매개 변수

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

데이터 세트 - 버전 삭제

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=v1

특정 버전의 DatasetVersion을 삭제합니다. DatasetVersion이 성공적으로 삭제되었거나 DatasetVersion이 없는 경우 서비스에서 204 콘텐츠 없음을 반환합니다.

URI 매개 변수

Responses

상태 코드: 204

설명: 이 요청에 대해 보낼 콘텐츠는 없지만 헤더가 유용할 수 있습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

데이터 세트 - 버전 만들기 또는 업데이트

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=v1

지정된 버전 ID로 새 DatasetVersion을 만들거나 기존 DatasetVersion을 업데이트합니다.

URI 매개 변수

요청 본문

Content-Type: application/merge-patch+json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 201

설명: 요청이 성공했고 결과적으로 새 리소스가 생성되었습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

데이터 세트 - 자격 증명 가져오기

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=v1

SAS 자격 증명을 가져와 데이터 세트 버전과 연결된 스토리지 계정에 액세스합니다.

URI 매개 변수

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

데이터 세트 - 업로드 버전 보류 중 시작

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=v1

새 버전을 시작하거나 특정 버전에 대한 데이터 세트의 보류 중인 기존 업로드를 가져옵니다.

URI 매개 변수

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

배포

배포 - 목록

GET {endpoint}/deployments?api-version=v1

프로젝트에 배포된 모든 모델 나열

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

응답 헤더:

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

배포 - 가져오기

GET {endpoint}/deployments/{name}?api-version=v1

배포된 모델을 가져옵니다.

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

응답 헤더:

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

평가 분류

평가 분류 - 목록

GET {endpoint}/evaluationtaxonomies?api-version=v1

평가 분류 나열

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

평가 분류 - 가져오기

GET {endpoint}/evaluationtaxonomies/{name}?api-version=v1

이름으로 실행되는 평가를 가져옵니다.

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

평가 분류 - 삭제

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=v1

이름으로 평가 분류를 삭제합니다.

URI 매개 변수

요청 헤더

Responses

상태 코드: 204

설명: 이 요청에 대해 보낼 콘텐츠는 없지만 헤더가 유용할 수 있습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

평가 분류 - 만들기

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=v1

평가 분류를 만듭니다.

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 201

설명: 요청이 성공했고 결과적으로 새 리소스가 생성되었습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

평가 분류 - 업데이트

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=v1

평가 분류를 업데이트합니다.

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

평가 규칙

평가 규칙 - 목록

GET {endpoint}/evaluationrules?api-version=v1

모든 평가 규칙을 나열합니다.

URI 매개 변수

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

평가 규칙 - 가져오기

GET {endpoint}/evaluationrules/{id}?api-version=v1

평가 규칙을 가져옵니다.

URI 매개 변수

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

평가 규칙 - 삭제

DELETE {endpoint}/evaluationrules/{id}?api-version=v1

평가 규칙을 삭제합니다.

URI 매개 변수

Responses

상태 코드: 204

설명: 이 요청에 대해 보낼 콘텐츠는 없지만 헤더가 유용할 수 있습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

평가 규칙 - 만들기 또는 업데이트

PUT {endpoint}/evaluationrules/{id}?api-version=v1

평가 규칙을 만들거나 업데이트합니다.

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 201

설명: 요청이 성공했고 결과적으로 새 리소스가 생성되었습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

평가자

계산기 - 최신 버전 나열

GET {endpoint}/evaluators?api-version=v1

각 평가자의 최신 버전 나열

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

계산기 - 버전 나열

GET {endpoint}/evaluators/{name}/versions?api-version=v1

지정된 평가자의 모든 버전 나열

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

계산기 - 버전 만들기

POST {endpoint}/evaluators/{name}/versions?api-version=v1

자동 증가된 버전 ID를 사용하여 새 EvaluatorVersion 만들기

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

Responses

상태 코드: 201

설명: 요청이 성공했고 결과적으로 새 리소스가 생성되었습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

평가자 - 버전 가져오기

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

EvaluatorVersion의 특정 버전을 가져옵니다. EvaluatorVersion이 없는 경우 서비스는 404 찾을 수 없음 오류를 반환합니다.

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

계산기 - 버전 삭제

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

EvaluatorVersion의 특정 버전을 삭제합니다. EvaluatorVersion이 성공적으로 삭제되었거나 EvaluatorVersion이 없는 경우 서비스는 204 No Content를 반환합니다.

URI 매개 변수

요청 헤더

Responses

상태 코드: 204

설명: 이 요청에 대해 보낼 콘텐츠는 없지만 헤더가 유용할 수 있습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

계산기 - 버전 업데이트

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

지정된 버전 ID로 기존 EvaluatorVersion을 업데이트합니다.

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

Indexes

인덱스 - 최신 목록

GET {endpoint}/indexes?api-version=v1

각 인덱스의 최신 버전 나열

URI 매개 변수

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

인덱스 - 버전 나열

GET {endpoint}/indexes/{name}/versions?api-version=v1

지정된 인덱스의 모든 버전 나열

URI 매개 변수

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

인덱스 - 버전 가져오기

GET {endpoint}/indexes/{name}/versions/{version}?api-version=v1

인덱스의 특정 버전을 가져옵니다. 인덱스가 없으면 서비스에서 404 찾을 수 없음 오류를 반환합니다.

URI 매개 변수

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

인덱스 - 버전 삭제

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=v1

인덱스의 특정 버전을 삭제합니다. 인덱스가 성공적으로 삭제되었거나 인덱스가 없는 경우 서비스에서 204 콘텐츠 없음을 반환합니다.

URI 매개 변수

Responses

상태 코드: 204

설명: 이 요청에 대해 보낼 콘텐츠는 없지만 헤더가 유용할 수 있습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

인덱스 - 버전 만들기 또는 업데이트

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=v1

새 인덱스 만들기 또는 지정된 버전 ID로 기존 인덱스 업데이트

URI 매개 변수

요청 본문

Content-Type: application/merge-patch+json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 201

설명: 요청이 성공했고 결과적으로 새 리소스가 생성되었습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

Insights

인사이트 - 생성

POST {endpoint}/insights?api-version=v1

인사이트 생성

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

Responses

상태 코드: 201

설명: 요청이 성공했고 결과적으로 새 리소스가 생성되었습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

인사이트 - 목록

GET {endpoint}/insights?api-version=v1

모든 인사이트를 역순으로 나열합니다(최신 첫 번째).

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

인사이트 - 가져오기

GET {endpoint}/insights/{id}?api-version=v1

ID별로 특정 인사이트를 가져옵니다.

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

응답 헤더:

메모리 저장소

메모리 저장소 만들기

POST {endpoint}/memory_stores?api-version=v1

메모리 저장소를 만듭니다.

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

메모리 저장소 나열

GET {endpoint}/memory_stores?api-version=v1

모든 메모리 저장소를 나열합니다.

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

메모리 저장소 업데이트

POST {endpoint}/memory_stores/{name}?api-version=v1

메모리 저장소를 업데이트합니다.

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

메모리 저장소 가져오기

GET {endpoint}/memory_stores/{name}?api-version=v1

메모리 저장소를 검색합니다.

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

메모리 저장소 삭제

DELETE {endpoint}/memory_stores/{name}?api-version=v1

메모리 저장소를 삭제합니다.

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

업데이트 결과 가져오기

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=v1

메모리 저장소 업데이트 결과를 가져옵니다.

URI 매개 변수

요청 헤더

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

범위 메모리 삭제

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=v1

메모리 저장소에서 특정 범위와 연결된 모든 메모리를 삭제합니다.

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

추억 검색

POST {endpoint}/memory_stores/{name}:search_memories?api-version=v1

대화 컨텍스트를 기반으로 메모리 저장소에서 관련 메모리를 검색합니다.

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

추억 업데이트

POST {endpoint}/memory_stores/{name}:update_memories?api-version=v1

대화 메모리로 메모리 저장소를 업데이트합니다.

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

Responses

상태 코드: 202

설명: 처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다.

응답 헤더:

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

대화

대화 만들기

POST {endpoint}/openai/v1/conversations

대화를 만듭니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

대화 나열

GET {endpoint}/openai/v1/conversations

모든 대화 목록을 반환합니다.

URI 매개 변수

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

대화 업데이트

POST {endpoint}/openai/v1/conversations/{conversation_id}

대화를 업데이트합니다.

URI 매개 변수

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

대화 가져오기

GET {endpoint}/openai/v1/conversations/{conversation_id}

대화를 검색합니다.

URI 매개 변수

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.