개요
개요
OpenAI라이브러리는 사용자가 OpenAI 서버와 연동하여 TextCompletion, ChatCompletion 등의 작업을 수행할 수 있습니다.
OpenAI라이브러리에서 사용할 수 있는 기능은 다음과 같습니다.
Completion 기능: TextCompletion, ChatCompletion
해당 라이브러리 및 각 라이브러리 카드 속성은 OpenAI 정책에 따라 변경될 수 있으며 v3.1의 경우 출시 시점인 2023년 6월 기준으로 생성되었습니다.
공통 속성
공통 속성
MORE OPTION
속성 | 유형 | 필수여부 | 단위 | 자동입력여부 | 설명 |
---|---|---|---|---|---|
On Error | 콤보박스 | N | - | N | 오류 발생 시 수행할 동작을 지정합니다. - 미지정: 오류를 출력하고 작업을 종료합니다. - Ignore: 해당 오류를 무시합니다. - Retry: 해당 액티비티를 1회 재시도합니다. - Goto: 해당 엑티비티가 실패한 경우 지정한 엑티비티로 이동하여 시나리오를 수행합니다. - Event: 프로젝트에 등록된 이벤트를 호출합니다. |
DESCRIPTION
속성 | 유형 | 필수여부 | 단위 | 자동입력여부 | 설명 |
---|---|---|---|---|---|
Description | 문자 | N | - | N | 해당 액티비티 카드에 대한 설명을 추가합니다. Description이 입력되면 플로차트의 해당 액티비티 설명에 표시되고, Description이 없는 경우에는 대푯값이 해당 액티비티 설명에 표시됩니다. |
MaxTokens는 호출시 설정 가능한 token 범위를 사전에 1차 체크하는 역할을 합니다.
Header,Prompt등을 포함한 전체 Tokens은 솔루션이 판단해주며 전체 Tokens은 호출의 결과로 알 수 있습니다.
TextCompletion
TextCompletion
개요
OpenAI Text Completion API를 호출합니다.
사용 절차
[Output] RESULT에 응답결과 전체를 저장할 변수를 지정합니다.
[Output] TextRESULT에 응답결과 중 choices내 첫번째 text 결과를 가져옵니다.
API Token에 API Token을 입력합니다.
API Token은 Open AI Sign Up 이후 아래 URL에서 확인합니다.
https://platform.openai.com/account/api-keys
카드 속성
공통여부 | 속성 | 유형 | 필수여부 | 단위 | 자동입력여부 | 설명 |
---|---|---|---|---|---|---|
N | [Output] RESULT | 변수 | Y | - | Y | 응답결과 전체를 저장할 변수를 지정합니다. |
N | [Output] TextRESULT | 변수 | Y | - | Y | 응답결과 중 choices내 첫번째 text 결과를 저장할 변수를 지정합니다. |
N | API Token | 변수 | Y | - | N | API Token을 입력합니다. - Normal: 입력한 API Token이 일반 텍스트로 저장됩니다. - Credential: 입력한 API Token이 암호화됩니다. (공유 리소스에서 검색됩니다.) - Secure: 입력한 API Token이 암호화되고, 저장됩니다. |
N | Model | 콤보박스 | Y | - | Y | 사용할 Model을 선택합니다. - text-ada-001 - text-babbage-001 - text-curie-001 - text-davinci-002 - text-davinci-003 |
N | MaxTokens | 숫자 | N | - | Y | MaxTokens를 입력합니다. |
N | Prompt | 문자열 or 문자 배열 | N | - | Y | Prompt를 입력합니다. |
N | Suffix | 문자열 | N | - | N | Suffix(삽입된 텍스트가 완료된 뒤에 오는 접미사)를 입력합니다. Model이 text-davinci-002, text-davinci-003인 경우에만 보입니다. |
N | Temperature | 숫자 | N | - | Y | Temperature(무작위성)를 입력합니다. |
N | TopP | 숫자 | N | - | Y | TopP(상위 확률 질량에 토큰을 고려하는 정도)를 입력합니다. |
N | N | 숫자 | N | - | Y | N(각 Prompt에 대해 생성할 완료 수)를 입력합니다. |
N | LogProbs | 숫자 | N | - | N | LogProbs(가장 가능성이 높은 토큰과 선택한 토큰에 대한 로그 확률을 포함)를 입력합니다. |
N | Echo | 토글 | N | - | N | Echo(완료와 함께 Prompt 되풀이 여부)를 선택합니다. |
N | Stop | 문자열 or 문자 배열 | N | - | N | Stop(토큰 생성 중지를 하는 토큰 목록)을 입력합니다. |
N | PresencePenalty | 숫자 | N | - | Y | PresencePenalty(새 주제에 대해 이야기할 가능성을 높임)를 입력합니다. |
N | FrequencyPenalty | 숫자 | N | - | Y | FrequencyPenalty(동일한 줄을 그대로 반복할 가능성을 줄임)를 입력합니다. |
N | BestOf | 숫자 | N | - | Y | BestOf(토큰당 로그 확률이 가장 높은 항목 후보 완료 수)를 입력합니다. |
N | User | 문자열 | N | - | N | User를 입력합니다. |
Y | - | - | - | - | OpenAI 라이브러리의 공통 속성입니다. | |
Y | - | - | - | - | OpenAI 라이브러리의 공통 속성입니다. |
상세한 속성 설명은 아래 Open AI url을 참고합니다.
https://platform.openai.com/docs/api-reference/completions/create
활용 예시
OpenAI Text Completion API를 호출합니다.
예제 파일
메뉴 > 도움말 > 샘플 > Sample > OpenAI
사용된 변수
RESULT = 응답결과 전체를 저장할 변수 TextRESULT = 응답결과 중 choices내 첫번째 text 결과를 저장할 변수 Global.apiToken = API Token
사용된 속성
[Output] RESULT = RESULT
[Output] TextRESULT = TextRESULT
API Token = Global.apiToken
Model = text-ada-001
MaxTokens = 16
Prompt = 'Say this is a test'
Temperature = 1
TopP = 1
N = 1
PresencePenalty = 0
FrequencyPenalty = 0
BestOf = 1
연관/유사 액티비티
ChatCompletion
ChatCompletion
개요
OpenAI Chat Completion API를 호출합니다.
사용 절차
[Output] RESULT에 응답결과 전체를 저장할 변수를 지정합니다.
[Output] TextRESULT에 응답결과 중 choices내 첫번째 text 결과를 가져옵니다.
API Token에 API Token을 입력합니다.
API Token은 Open AI Sign Up 이후 아래 URL에서 확인합니다.
https://platform.openai.com/account/api-keys
카드 속성
공통여부 | 속성 | 유형 | 필수여부 | 단위 | 자동입력여부 | 설명 |
---|---|---|---|---|---|---|
N | [Output] RESULT | 변수 | Y | - | Y | 응답결과 전체를 저장할 변수를 지정합니다. |
N | [Output] TextRESULT | 변수 | Y | - | Y | 응답결과 중 choices내 첫번째 text 결과를 저장할 변수를 지정합니다. |
N | API Token | 변수 | Y | - | N | API Token을 입력합니다. - Normal: 입력한 API Token이 일반 텍스트로 저장됩니다. - Credential: 입력한 API Token이 암호화됩니다. (공유 리소스에서 검색됩니다.) - Secure: 입력한 API Token이 암호화되고, 저장됩니다. |
N | Model | 콤보박스 | Y | - | Y | 사용할 Model을 선택합니다. - gpt-3.5-turbo - gpt-3.5-turbo-0301 - gpt-4 - gpt-4-0314 - gpt-4-32k - gpt-4-32k-0314 |
N | MaxTokens | 숫자 | N | - | Y | MaxTokens를 입력합니다. |
N | Prompt | 문자열 | Y | - | Y | Prompt를 입력합니다. |
N | Instruction | 문자열 | N | - | N | 시스템 역할에 대한 설명,지침을 입력합니다. |
N | Temperature | 숫자 | N | - | Y | Temperature(무작위성)를 입력합니다. |
N | TopP | 숫자 | N | - | Y | TopP(상위 확률 질량에 토큰을 고려하는 정도)를 입력합니다. |
N | N | 숫자 | N | - | Y | N(각 Prompt에 대해 생성할 완료 수)를 입력합니다. |
N | Stop | 문자열 or 문자 배열 | N | - | N | Stop(토큰 생성 중지를 하는 토큰 목록)을 입력합니다. |
N | PresencePenalty | 숫자 | N | - | Y | PresencePenalty(새 주제에 대해 이야기할 가능성을 높임)를 입력합니다. |
N | FrequencyPenalty | 숫자 | N | - | Y | FrequencyPenalty(동일한 줄을 그대로 반복할 가능성을 줄임)를 입력합니다. |
N | User | 문자열 | N | - | N | User를 입력합니다. |
Y | - | - | - | - | OpenAI 라이브러리의 공통 속성입니다. | |
Y | - | - | - | - | OpenAI 라이브러리의 공통 속성입니다. |
상세한 속성 설명은 아래 Open AI url을 참고합니다.
https://platform.openai.com/docs/api-reference/chat/create
활용 예시
OpenAI Text Completion API를 호출합니다.
예제 파일
메뉴 > 도움말 > 샘플 > Sample > OpenAI
사용된 변수
RESULT = 응답결과 전체를 저장할 변수 TextRESULT = 응답결과 중 choices내 첫번째 text 결과를 저장할 변수 Global.apiToken = API Token
사용된 속성
[Output] RESULT = RESULT
[Output] TextRESULT = TextRESULT
API Token = Global.apiToken
Model = text-3.5-turbo
MaxTokens = 16
Prompt = 'Hello!'
Temperature = 1
TopP = 1
N = 1
PresencePenalty = 0
FrequencyPenalty = 0
연관/유사 액티비티