메인 콘텐츠로 건너뛰기

생성형 AI를 활용한 개발

AmiVoice API의 공식 문서를 생성형 AI나 코딩 에이전트가 참조하도록 하여, 인터페이스 선정, 규격 조사, 샘플 코드 생성 등에 활용하는 방법을 설명합니다.

What is llms.txt

llms.txt는 AmiVoice API의 주요 규격과 문서로의 링크를 하나로 모은, 생성형 AI를 위한 색인 파일입니다. 다음 URL에서 공개하고 있습니다.

사이트 전체의 페이지를 나열한 것은 아닙니다. 방식 선정, 구현, 운용에서 먼저 읽어야 할 페이지를 골라 정리한 것입니다. 링크 대상은 생성형 AI가 가져오기 쉬운 Markdown 버전 문서입니다.

What You Can Do

llms.txt를 생성형 AI에 전달하면 다음과 같은 작업에 활용할 수 있습니다.

  • 사용할 인터페이스나 파라미터 조사
  • 요건에 맞는 방식 선정
  • 샘플 코드 생성
  • 새로운 기능을 사용한 개발 지원

상기 항목들은 모두 공식 문서를 근거로 참조할 수 있도록 하는 것을 목적으로 합니다.

How to Use

생성형 AI에 대한 지시에 llms.txt의 URL을 추가하여 사용합니다. "이 URL을 기점으로 링크 대상의 공식 문서를 참조하세요"라고 전달하면, 생성형 AI가 필요한 페이지를 열어 답변합니다.

정확한 답변을 얻기 위해 다음 두 가지도 지시에 추가하십시오.

  • 파라미터 이름이나 규격을 추측하지 말 것
  • 답변에 참조한 공식 문서의 URL을 제시할 것

프롬프트 예시

그대로 복사하여 사용할 수 있는 프롬프트 예시입니다. 목적에 따라 음성 조건이나 구현하고 싶은 내용을 바꿔 주시기 바랍니다.

인터페이스 선정

녹음이 완료된 파일을 다루는 경우의 예시입니다.

https://docs.amivoice.com/llms.txt 를 시작점으로 하여,
링크 대상의 AmiVoice API 공식 문서만을 근거로 답변해 주세요.

녹음된 30분 정도의 음성 파일을 텍스트로 변환하는 경우에,
사용해야 할 인터페이스, 연결 엔진, 필요한 요청 파라미터를 정리해 주세요.

파라미터 이름이나 규격을 추측하지 말고,
답변에는 참조한 공식 문서의 URL을 제시해 주세요.

실시간으로 음성을 전송하는 경우의 예시입니다.

https://docs.amivoice.com/llms.txt 를 시작점으로 하여,
링크 대상의 AmiVoice API 공식 문서만을 근거로 답변해 주세요.

브라우저에서 마이크 음성을 실시간으로 전송하고,
인식 중간 결과를 화면에 표시하려고 합니다.

동기 HTTP, 비동기 HTTP, WebSocket 중 어떤 인터페이스를 선택해야 하는지,
이유, 구현 절차, 반드시 읽어야 하는 공식 문서 목록를 정리해 주세요.

샘플 코드를 생성한다

https://docs.amivoice.com/llms.txt 를 시작점으로 하여,
링크 대상의 AmiVoice API 공식 문서만을 근거로 답변해 주세요.

16kHz, 모노, WAV 형식의 음성 파일을 동기 HTTP 인터페이스로
텍스트로 변환하는 Python 코드를 작성해 주세요.

API key는 환경 변수에서 가져오고,
HTTP 오류와 응답 본문의 결과 코드를 처리해 주세요.
존재하지 않는 엔드포인트나 파라미터를 추측하지 마세요.

답변에는 참조한 공식 문서의 URL도 제시해 주세요.

음성 인식 정확도의 개선

https://docs.amivoice.com/llms.txt 를 시작점으로 하여,
링크 대상의 AmiVoice API 공식 문서만을 근거로 답변해 주세요.

전문 용어를 많이 포함하는 음성의 인식 정확도를 높이고 싶습니다.
사용자 사전이나 연결 엔진 선택 등 이용할 수 있는 방법을 정리하고,
각각의 설정 절차와 반드시 읽어야 하는 공식 문서 목록를 정리해 주세요.

규격을 추측하지 말고, 답변에는 참조한 공식 문서의 URL을 제시해 주세요.

오류 조사

https://docs.amivoice.com/llms.txt 를 시작점으로 하여,
링크 대상의 AmiVoice API 공식 문서만을 근거로 답변해 주세요.

동기 HTTP 인터페이스의 응답으로 반환되는 결과 코드의 의미와,
예상되는 원인, 대처 방법을 정리해 주세요.

HTTP 상태뿐만 아니라 응답 본문의 결과 코드도 확인하는 것을 전제로,
규격을 추측하지 말고, 참조한 공식 문서의 URL을 제시해 주세요.

웹 페이지를 참조할 수 없는 AI에서의 이용 방법

llms.txt를 URL로 참조하려면 생성형 AI에 웹 페이지를 읽는 기능이 필요합니다. 이러한 기능이 없는 경우에는 내용을 직접 프롬프트에 붙여 넣어 사용합니다.

다만 llms.txt는 링크 목록입니다. 붙여 넣기만 해서는 링크 대상의 자세한 규격까지는 전달되지 않습니다. 다음 순서로 사용하십시오.

  1. llms.txt의 내용을 붙여 넣어, 목적에 필요한 페이지를 특정하도록 한다.
  2. 특정한 페이지의 Markdown 버전 문서도 이어서 붙여 넣는다.

Markdown 버전은 페이지 URL의 끝에 .md를 붙이면 가져올 수 있습니다. 예를 들어 시작하기 페이지(일본어)는 https://docs.amivoice.com/amivoice-api/manual/getting-started.md입니다.

llms.txt로 할 수 없는 일

llms.txt는 공식 문서를 찾아 참조하기 쉽게 하기 위한 것입니다. 다음과 같은 일은 할 수 없습니다.

  • 생성형 AI가 AmiVoice API에 자동으로 연결한다
  • 생성형 AI가 AmiVoice API를 도구로서 직접 실행한다
  • 생성된 코드의 정확성을 보증한다

생성된 코드는 반드시 공식 레퍼런스와 대조한 후에 사용하십시오.

이용상의 주의

음성 인식 API를 다루므로 특히 다음 사항에 주의하십시오.

API 키와 음성 데이터의 취급
  • API 키, 음성 데이터, 개인정보 등을 생성형 AI에 입력하는 경우에는 이용약관이나 소속 조직 등의 보안 규칙을 확인하십시오. 또한 코드나 오류 로그를 입력할 때에도 이러한 정보가 의도치 않게 포함되어 있지 않은지 반드시 확인하십시오.
  • API 키 자체를 제시할 필요가 없는 경우에는 더미 값이나 환경 변수 이름으로 바꾸십시오.
  • 생성된 코드는 공식 레퍼런스와 대조한 후에 사용하십시오.
  • 요금, 제한 사항, 이용약관, SLA는 반드시 현행 공식 페이지에서 확인하십시오.