PyKakao package
Subpackages
Submodules
PyKakao.api module
- class PyKakao.api.DaumSearch(service_key=None)
기반 클래스:
object
카카오 다음 검색 API 클래스
- 매개변수
service_key (str) – 카카오 개발자 센터에서 발급받은 애플리케이션의 REST API 키
- search_blog(query, dataframe=False, **kwargs)
블로그 검색
- 매개변수
query (str) – 검색어
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- search_book(query, dataframe=False, **kwargs)
책 검색
- 매개변수
query (str) – 검색어
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- search_cafe(query, dataframe=False, **kwargs)
카페 검색
- 매개변수
query (str) – 검색어
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- search_image(query, dataframe=False, **kwargs)
이미지 검색
- 매개변수
query (str) – 검색어
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- search_vclip(query, dataframe=False, **kwargs)
동영상 검색
- 매개변수
query (str) – 검색어
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- search_web(query, dataframe=False, **kwargs)
웹문서 검색
- 매개변수
query (str) – 검색어
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- class PyKakao.api.KakaoLocal(service_key=None)
기반 클래스:
object
(구) 카카오 로컬 API 클래스
- 매개변수
service_key (string) – 카카오 개발자 센터에서 발급받은 애플리케이션의 REST API 키
- geo_coord2address(x, y, input_coord=None)
좌표로 주소 변환하기
- 매개변수
x (str) – X 좌표값, 경위도인 경우 경도(longitude)
y (str) – Y 좌표값, 경위도인 경우 위도(latitude)
input_coords (str) – x, y 로 입력되는 값에 대한 좌표계. 지원 좌표계: WGS84, WCONGNAMUL, CONGNAMUL, WTM, TM (기본값: WGS84)
- geo_coord2regioncode(x, y, input_coord=None, output_coord=None)
좌표로 행정구역정보 받기
- 매개변수
x (str) – X 좌표값, 경위도인 경우 경도(longitude)
y (str) – Y 좌표값, 경위도인 경우 위도(latitude)
input_coord (str) – x, y 로 입력되는 값에 대한 좌표계. 지원 좌표계: WGS84, WCONGNAMUL, CONGNAMUL, WTM, TM (기본값: WGS84)
output_coord (str) – 결과에 출력될 좌표계. 지원 좌표계: WGS84, WCONGNAMUL, CONGNAMUL, WTM, TM (기본값: WGS84)
- geo_transcoord(x, y, output_coord, input_coord=None)
좌표계 변환하기
- 매개변수
x (str) – X 좌표값, 경위도인 경우 longitude(경도)
y (str) – Y 좌표값, 경위도인 경우 latitude(위도)
output_coord (str) – x, y 값의 좌표계. 지원 좌표계: WGS84, WCONGNAMUL, CONGNAMUL, WTM, TM, KTM, UTM, BESSEL, WKTM, WUTM (기본값: WGS84)
input_coord (str) – 변환할 좌표계. 지원 좌표계:WGS84, WCONGNAMUL, CONGNAMUL, WTM, TM, KTM, UTM, BESSEL, WKTM, WUTM (기본값: WGS84)
- search_address(query, analyze_type=None, page=None, size=None)
주소 검색하기
- 매개변수
query (str) – 검색을 원하는 질의어
- search_category(category_group_code, x, y, radius=None, rect=None, page=None, size=None, sort=None)
카테고리로 장소 검색하기
- 매개변수
category_group_code (str) – [카테고리 코드](https://developers.kakao.com/docs/latest/ko/local/dev-guide#search-by-category-request-category-group-code)
x (str) – 중심 좌표의 X값 혹은 longitude. 특정 지역을 중심으로 검색하려고 할 경우 radius와 함께 사용 가능.
y (str) – 중심 좌표의 Y값 혹은 latitude. 특정 지역을 중심으로 검색하려고 할 경우 radius와 함께 사용 가능.
radius (str) – 중심 좌표부터의 반경거리. 특정 지역을 중심으로 검색하려고 할 경우 중심좌표로 쓰일 x,y와 함께 사용. 단위 meter, 0~20000 사이의 값
rect (str) – 사각형 범위내에서 제한 검색을 위한 좌표. 지도 화면 내 검색시 등 제한 검색에서 사용 가능. 좌측 X 좌표, 좌측 Y 좌표, 우측 X 좌표, 우측 Y 좌표 형식. x, y, radius 또는 rect 필수
page (str) – 결과 페이지 번호. 1~45 사이의 값 (기본값: 1)
size (str) – 한 페이지에 보여질 문서의 개수. 1~15 사이의 값 (기본값: 15)
sort (str) – 결과 정렬 순서, distance 정렬을 원할 때는 기준좌표로 쓰일 x, y 파라미터 필요. distance 또는 accuracy (기본값: accuracy)
- search_keyword(query, category_group_code=None, x=None, y=None, radius=None, rect=None, page=None, size=None, sort=None)
키워드로 장소 검색하기
- 매개변수
query (str) – 검색을 원하는 질의어
category_group_code (str) – [카테고리 그룹 코드](https://developers.kakao.com/docs/latest/ko/local/dev-guide#search-by-keyword-request-category-group-code) 카테고리로 결과 필터링을 원하는 경우 사용
x (str) – 중심 좌표의 X 혹은 경도(longitude) 값. 특정 지역을 중심으로 검색할 경우 radius와 함께 사용 가능
y (str) – 중심 좌표의 Y 혹은 위도(latitude) 값. 특정 지역을 중심으로 검색할 경우 radius와 함께 사용 가능
radius (str) – 중심 좌표부터의 반경거리. 특정 지역을 중심으로 검색하려고 할 경우 중심좌표로 쓰일 x,y와 함께 사용. (단위: 미터(m), 최소: 0, 최대: 20000)
rect (str) – 사각형의 지정 범위 내 제한 검색을 위한 좌표. 지도 화면 내 검색 등 제한 검색에서 사용 가능. 좌측 X 좌표, 좌측 Y 좌표, 우측 X 좌표, 우측 Y 좌표 형식
page (str) – 결과 페이지 번호. (최소: 1, 최대: 45, 기본값: 1)
size (str) – 한 페이지에 보여질 문서의 개수. (최소: 1, 최대: 45, 기본값: 15)
sort (str) – 결과 정렬 순서. distance 정렬을 원할 때는 기준 좌표로 쓰일 x, y와 함께 사용 distance 또는 accuracy(기본값: accuracy)
- class PyKakao.api.Karlo(service_key=None)
기반 클래스:
object
카카오 Karlo API 클래스
- 매개변수
service_key (str) – 카카오 개발자 센터에서 발급받은 애플리케이션의 REST API 키
- image_to_string(img)
이미지를 base64 string으로 변환
- 매개변수
img (PIL.Image) – 이미지
- 반환
base64 string
- 반환 형식
str
- inpaint_image(image, mask, text='', batch_size=1)
이미지 편집하기
- 매개변수
image (str) – 원본 이미지를 Base64 인코딩한 값 참고: - 이미지 파일 규격(https://developers.kakao.com/docs/latest/ko/karlo/rest-api#before-you-begin-image-requirement) - 이미지 인코딩 및 디코딩(https://developers.kakao.com/docs/latest/ko/karlo/rest-api#before-you-begin-encode-and-decode)
mask (str) – 편집할 부분을 표시한 원본 이미지를 Base64 인코딩한 값 편집할 부분을 검은색(Grayscale, RGB 기준 0)으로 가려서 표시 이미지의 여러 곳 마스킹 가능 참고: - 이미지 파일 규격(https://developers.kakao.com/docs/latest/ko/karlo/rest-api#before-you-begin-image-requirement) - 이미지 인코딩 및 디코딩(https://developers.kakao.com/docs/latest/ko/karlo/rest-api#before-you-begin-encode-and-decode)
text (str, optional) – 편집해 넣을 이미지를 묘사하는 제시어, 영문만 지원(최대: 256자) text 값이 설정되지 않으면 편집할 부분의 주변과 어울리도록 사물을 삭제하거나 대체함 (기본값: “”, 빈 문자열) 참고: - 활용 가이드(https://developers.kakao.com/docs/latest/ko/karlo/how-to-use)
batch_size (int, optional) – 생성할 이미지 수(기본값: 1, 최대: 8)
- 반환
생성된 이미지의 정보
- 반환 형식
dict
- string_to_image(base64_string, mode='RGBA')
base64 string을 이미지로 변환
- 매개변수
base64_string (str) – base64 string
mode (str, optional) – 이미지 모드(기본값: RGBA)
- 반환
이미지
- 반환 형식
PIL.Image
- text_to_image(text, batch_size=1)
이미지 생성하기 API
- 매개변수
text (str) – 생성할 이미지를 묘사하는 제시어, 영문만 지원(최대: 256자) 참고: - 활용 가이드(https://developers.kakao.com/docs/latest/ko/karlo/how-to-use)
batch_size (int, optional) – 생성할 이미지 수(기본값: 1, 최대: 8)
- 반환
생성된 이미지의 정보
- 반환 형식
dict
- transform_image(image, batch_size=1)
이미지 변환하기
- 매개변수
image (str) – 변환할 원본 이미지를 Base64 인코딩한 값 참고: - 이미지 파일 규격(https://developers.kakao.com/docs/latest/ko/karlo/rest-api#before-you-begin-image-requirement) - 이미지 인코딩 및 디코딩(https://developers.kakao.com/docs/latest/ko/karlo/rest-api#before-you-begin-encode-and-decode)
batch_size (int, optional) – 생성할 이미지 수(기본값: 1, 최대: 8)
- 반환
생성된 이미지의 정보
- 반환 형식
dict
- class PyKakao.api.KoGPT(service_key=None)
기반 클래스:
object
카카오 KoGPT API 클래스
- 매개변수
service_key (str) – 카카오 개발자 센터에서 발급받은 애플리케이션의 REST API 키
- generate(prompt, max_tokens, **kwargs)
문장 생성
- 매개변수
prompt (str) – 문장 생성에 사용할 문장
max_tokens (int) – 생성할 문장의 최대 길이
**kwargs (dict) – 기타 파라미터
- 반환
생성된 문장
- 반환 형식
dict
- class PyKakao.api.Local(service_key=None)
기반 클래스:
object
카카오 로컬 API 클래스
- 매개변수
service_key (str) – 카카오 서비스 키
- geo_coord2address(x, y, dataframe=False, **kwargs)
좌표로 주소 변환하기
- 매개변수
x (float) – 경도
y (float) – 위도
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
**kwargs (dict) – https://developers.kakao.com/docs/latest/ko/local/dev-guide#coord-to-address 참고
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- geo_coord2regioncode(x, y, dataframe=False, **kwargs)
좌표로 행정구역정보 받기
- 매개변수
x (float) – 경도
y (float) – 위도
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
**kwargs (dict) – https://developers.kakao.com/docs/latest/ko/local/dev-guide#coord-to-district 참고
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- geo_transcoord(x, y, output_coord, dataframe=False, **kwargs)
좌표계 변환하기
- 매개변수
x (float) – 경도
y (float) – 위도
output_coord (str) – 변환할 좌표계
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
**kwargs (dict) – https://developers.kakao.com/docs/latest/ko/local/dev-guide#trans-coord 참고
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- search_address(query, dataframe=False, **kwargs)
주소 검색하기
- 매개변수
query (string) – 검색을 원하는 질의어
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
**kwargs (dict) – https://developers.kakao.com/docs/latest/ko/local/dev-guide#address-coord 참고
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- search_category(category_group_code, dataframe=False, **kwargs)
카테고리로 장소 검색하기
- 매개변수
category_group_code (str) – 카테고리 코드
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
**kwargs (dict) – https://developers.kakao.com/docs/latest/ko/local/dev-guide#search-by-category 참고
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- search_keyword(query, dataframe=False, **kwargs)
키워드로 장소 검색하기
- 매개변수
query (str) – 검색을 원하는 질의어
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
**kwargs (dict) – https://developers.kakao.com/docs/latest/ko/local/dev-guide#search-by-keyword 참고
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- class PyKakao.api.Message(service_key=None, redirect_uri='https://localhost:5000', scope='talk_message')
기반 클래스:
object
카카오 메시지 API 클래스
- 매개변수
service_key (str) – 카카오 개발자 센터에서 발급받은 애플리케이션의 REST API 키
- get_access_token_by_code(code)
카카오 인증코드로 액세스 토큰 발급
- 매개변수
code (str) – 카카오 인증코드
- 반환
액세스 토큰
- 반환 형식
str
- get_access_token_by_redirected_url(url)
카카오 인증코드 발급 URL 접속 후 리다이렉트된 URL로 액세스 토큰 발급
- 매개변수
url (str) – 카카오 인증코드 발급 URL 접속 후 리다이렉트된 URL
- 반환
액세스 토큰
- 반환 형식
str
- get_code_by_redirected_url(url)
카카오 인증코드 추출
- 매개변수
url (str) – 카카오 인증코드 발급 URL 접속 후 리다이렉트된 URL
- 반환
카카오 인증코드
- 반환 형식
str
- get_url_for_generating_code()
카카오 인증코드 발급 URL 생성
- 반환
카카오 인증코드 발급 URL
- 반환 형식
str
- send_commerce(content, commerce, **kwargs)
커머스 메시지 전송
- 매개변수
content (dict) – 커머스 정보
commerce (dict) – 상품 정보
- send_feed(content, **kwargs)
피드 메시지 전송
- 매개변수
content (dict) – 피드 내용
- send_list(header_title, header_link, contents, **kwargs)
리스트 메시지 전송
- 매개변수
header_title (str) – 리스트 제목
header_link (dict) – 리스트 링크
contents (list) – 리스트 내용
- send_location(address, address_title, content, **kwargs)
위치 메시지 전송
- 매개변수
address (str) – 주소
address_title (str) – 주소 제목
content (dict) – 위치 정보
- send_text(text, link, **kwargs)
텍스트 메시지 전송
- 매개변수
text (str) – 전송할 메시지 (최대 200자)
- set_access_token(access_token)
액세스 토큰 설정
- 매개변수
access_token (str) – 액세스 토큰
Module contents
- class PyKakao.DaumSearch(service_key=None)
기반 클래스:
object
카카오 다음 검색 API 클래스
- 매개변수
service_key (str) – 카카오 개발자 센터에서 발급받은 애플리케이션의 REST API 키
- search_blog(query, dataframe=False, **kwargs)
블로그 검색
- 매개변수
query (str) – 검색어
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- search_book(query, dataframe=False, **kwargs)
책 검색
- 매개변수
query (str) – 검색어
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- search_cafe(query, dataframe=False, **kwargs)
카페 검색
- 매개변수
query (str) – 검색어
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- search_image(query, dataframe=False, **kwargs)
이미지 검색
- 매개변수
query (str) – 검색어
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- search_vclip(query, dataframe=False, **kwargs)
동영상 검색
- 매개변수
query (str) – 검색어
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- search_web(query, dataframe=False, **kwargs)
웹문서 검색
- 매개변수
query (str) – 검색어
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- class PyKakao.KakaoLocal(service_key=None)
기반 클래스:
object
(구) 카카오 로컬 API 클래스
- 매개변수
service_key (string) – 카카오 개발자 센터에서 발급받은 애플리케이션의 REST API 키
- geo_coord2address(x, y, input_coord=None)
좌표로 주소 변환하기
- 매개변수
x (str) – X 좌표값, 경위도인 경우 경도(longitude)
y (str) – Y 좌표값, 경위도인 경우 위도(latitude)
input_coords (str) – x, y 로 입력되는 값에 대한 좌표계. 지원 좌표계: WGS84, WCONGNAMUL, CONGNAMUL, WTM, TM (기본값: WGS84)
- geo_coord2regioncode(x, y, input_coord=None, output_coord=None)
좌표로 행정구역정보 받기
- 매개변수
x (str) – X 좌표값, 경위도인 경우 경도(longitude)
y (str) – Y 좌표값, 경위도인 경우 위도(latitude)
input_coord (str) – x, y 로 입력되는 값에 대한 좌표계. 지원 좌표계: WGS84, WCONGNAMUL, CONGNAMUL, WTM, TM (기본값: WGS84)
output_coord (str) – 결과에 출력될 좌표계. 지원 좌표계: WGS84, WCONGNAMUL, CONGNAMUL, WTM, TM (기본값: WGS84)
- geo_transcoord(x, y, output_coord, input_coord=None)
좌표계 변환하기
- 매개변수
x (str) – X 좌표값, 경위도인 경우 longitude(경도)
y (str) – Y 좌표값, 경위도인 경우 latitude(위도)
output_coord (str) – x, y 값의 좌표계. 지원 좌표계: WGS84, WCONGNAMUL, CONGNAMUL, WTM, TM, KTM, UTM, BESSEL, WKTM, WUTM (기본값: WGS84)
input_coord (str) – 변환할 좌표계. 지원 좌표계:WGS84, WCONGNAMUL, CONGNAMUL, WTM, TM, KTM, UTM, BESSEL, WKTM, WUTM (기본값: WGS84)
- search_address(query, analyze_type=None, page=None, size=None)
주소 검색하기
- 매개변수
query (str) – 검색을 원하는 질의어
- search_category(category_group_code, x, y, radius=None, rect=None, page=None, size=None, sort=None)
카테고리로 장소 검색하기
- 매개변수
category_group_code (str) – [카테고리 코드](https://developers.kakao.com/docs/latest/ko/local/dev-guide#search-by-category-request-category-group-code)
x (str) – 중심 좌표의 X값 혹은 longitude. 특정 지역을 중심으로 검색하려고 할 경우 radius와 함께 사용 가능.
y (str) – 중심 좌표의 Y값 혹은 latitude. 특정 지역을 중심으로 검색하려고 할 경우 radius와 함께 사용 가능.
radius (str) – 중심 좌표부터의 반경거리. 특정 지역을 중심으로 검색하려고 할 경우 중심좌표로 쓰일 x,y와 함께 사용. 단위 meter, 0~20000 사이의 값
rect (str) – 사각형 범위내에서 제한 검색을 위한 좌표. 지도 화면 내 검색시 등 제한 검색에서 사용 가능. 좌측 X 좌표, 좌측 Y 좌표, 우측 X 좌표, 우측 Y 좌표 형식. x, y, radius 또는 rect 필수
page (str) – 결과 페이지 번호. 1~45 사이의 값 (기본값: 1)
size (str) – 한 페이지에 보여질 문서의 개수. 1~15 사이의 값 (기본값: 15)
sort (str) – 결과 정렬 순서, distance 정렬을 원할 때는 기준좌표로 쓰일 x, y 파라미터 필요. distance 또는 accuracy (기본값: accuracy)
- search_keyword(query, category_group_code=None, x=None, y=None, radius=None, rect=None, page=None, size=None, sort=None)
키워드로 장소 검색하기
- 매개변수
query (str) – 검색을 원하는 질의어
category_group_code (str) – [카테고리 그룹 코드](https://developers.kakao.com/docs/latest/ko/local/dev-guide#search-by-keyword-request-category-group-code) 카테고리로 결과 필터링을 원하는 경우 사용
x (str) – 중심 좌표의 X 혹은 경도(longitude) 값. 특정 지역을 중심으로 검색할 경우 radius와 함께 사용 가능
y (str) – 중심 좌표의 Y 혹은 위도(latitude) 값. 특정 지역을 중심으로 검색할 경우 radius와 함께 사용 가능
radius (str) – 중심 좌표부터의 반경거리. 특정 지역을 중심으로 검색하려고 할 경우 중심좌표로 쓰일 x,y와 함께 사용. (단위: 미터(m), 최소: 0, 최대: 20000)
rect (str) – 사각형의 지정 범위 내 제한 검색을 위한 좌표. 지도 화면 내 검색 등 제한 검색에서 사용 가능. 좌측 X 좌표, 좌측 Y 좌표, 우측 X 좌표, 우측 Y 좌표 형식
page (str) – 결과 페이지 번호. (최소: 1, 최대: 45, 기본값: 1)
size (str) – 한 페이지에 보여질 문서의 개수. (최소: 1, 최대: 45, 기본값: 15)
sort (str) – 결과 정렬 순서. distance 정렬을 원할 때는 기준 좌표로 쓰일 x, y와 함께 사용 distance 또는 accuracy(기본값: accuracy)
- class PyKakao.Karlo(service_key=None)
기반 클래스:
object
카카오 Karlo API 클래스
- 매개변수
service_key (str) – 카카오 개발자 센터에서 발급받은 애플리케이션의 REST API 키
- image_to_string(img)
이미지를 base64 string으로 변환
- 매개변수
img (PIL.Image) – 이미지
- 반환
base64 string
- 반환 형식
str
- inpaint_image(image, mask, text='', batch_size=1)
이미지 편집하기
- 매개변수
image (str) – 원본 이미지를 Base64 인코딩한 값 참고: - 이미지 파일 규격(https://developers.kakao.com/docs/latest/ko/karlo/rest-api#before-you-begin-image-requirement) - 이미지 인코딩 및 디코딩(https://developers.kakao.com/docs/latest/ko/karlo/rest-api#before-you-begin-encode-and-decode)
mask (str) – 편집할 부분을 표시한 원본 이미지를 Base64 인코딩한 값 편집할 부분을 검은색(Grayscale, RGB 기준 0)으로 가려서 표시 이미지의 여러 곳 마스킹 가능 참고: - 이미지 파일 규격(https://developers.kakao.com/docs/latest/ko/karlo/rest-api#before-you-begin-image-requirement) - 이미지 인코딩 및 디코딩(https://developers.kakao.com/docs/latest/ko/karlo/rest-api#before-you-begin-encode-and-decode)
text (str, optional) – 편집해 넣을 이미지를 묘사하는 제시어, 영문만 지원(최대: 256자) text 값이 설정되지 않으면 편집할 부분의 주변과 어울리도록 사물을 삭제하거나 대체함 (기본값: “”, 빈 문자열) 참고: - 활용 가이드(https://developers.kakao.com/docs/latest/ko/karlo/how-to-use)
batch_size (int, optional) – 생성할 이미지 수(기본값: 1, 최대: 8)
- 반환
생성된 이미지의 정보
- 반환 형식
dict
- string_to_image(base64_string, mode='RGBA')
base64 string을 이미지로 변환
- 매개변수
base64_string (str) – base64 string
mode (str, optional) – 이미지 모드(기본값: RGBA)
- 반환
이미지
- 반환 형식
PIL.Image
- text_to_image(text, batch_size=1)
이미지 생성하기 API
- 매개변수
text (str) – 생성할 이미지를 묘사하는 제시어, 영문만 지원(최대: 256자) 참고: - 활용 가이드(https://developers.kakao.com/docs/latest/ko/karlo/how-to-use)
batch_size (int, optional) – 생성할 이미지 수(기본값: 1, 최대: 8)
- 반환
생성된 이미지의 정보
- 반환 형식
dict
- transform_image(image, batch_size=1)
이미지 변환하기
- 매개변수
image (str) – 변환할 원본 이미지를 Base64 인코딩한 값 참고: - 이미지 파일 규격(https://developers.kakao.com/docs/latest/ko/karlo/rest-api#before-you-begin-image-requirement) - 이미지 인코딩 및 디코딩(https://developers.kakao.com/docs/latest/ko/karlo/rest-api#before-you-begin-encode-and-decode)
batch_size (int, optional) – 생성할 이미지 수(기본값: 1, 최대: 8)
- 반환
생성된 이미지의 정보
- 반환 형식
dict
- class PyKakao.KoGPT(service_key=None)
기반 클래스:
object
카카오 KoGPT API 클래스
- 매개변수
service_key (str) – 카카오 개발자 센터에서 발급받은 애플리케이션의 REST API 키
- generate(prompt, max_tokens, **kwargs)
문장 생성
- 매개변수
prompt (str) – 문장 생성에 사용할 문장
max_tokens (int) – 생성할 문장의 최대 길이
**kwargs (dict) – 기타 파라미터
- 반환
생성된 문장
- 반환 형식
dict
- class PyKakao.Local(service_key=None)
기반 클래스:
object
카카오 로컬 API 클래스
- 매개변수
service_key (str) – 카카오 서비스 키
- geo_coord2address(x, y, dataframe=False, **kwargs)
좌표로 주소 변환하기
- 매개변수
x (float) – 경도
y (float) – 위도
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
**kwargs (dict) – https://developers.kakao.com/docs/latest/ko/local/dev-guide#coord-to-address 참고
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- geo_coord2regioncode(x, y, dataframe=False, **kwargs)
좌표로 행정구역정보 받기
- 매개변수
x (float) – 경도
y (float) – 위도
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
**kwargs (dict) – https://developers.kakao.com/docs/latest/ko/local/dev-guide#coord-to-district 참고
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- geo_transcoord(x, y, output_coord, dataframe=False, **kwargs)
좌표계 변환하기
- 매개변수
x (float) – 경도
y (float) – 위도
output_coord (str) – 변환할 좌표계
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
**kwargs (dict) – https://developers.kakao.com/docs/latest/ko/local/dev-guide#trans-coord 참고
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- search_address(query, dataframe=False, **kwargs)
주소 검색하기
- 매개변수
query (string) – 검색을 원하는 질의어
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
**kwargs (dict) – https://developers.kakao.com/docs/latest/ko/local/dev-guide#address-coord 참고
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- search_category(category_group_code, dataframe=False, **kwargs)
카테고리로 장소 검색하기
- 매개변수
category_group_code (str) – 카테고리 코드
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
**kwargs (dict) – https://developers.kakao.com/docs/latest/ko/local/dev-guide#search-by-category 참고
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- search_keyword(query, dataframe=False, **kwargs)
키워드로 장소 검색하기
- 매개변수
query (str) – 검색을 원하는 질의어
dataframe (bool) – True로 설정하면 DataFrame으로 반환, False로 설정하면 dict로 반환, 기본값은 False
**kwargs (dict) – https://developers.kakao.com/docs/latest/ko/local/dev-guide#search-by-keyword 참고
- 반환
DataFrame으로 반환하려면 dataframe=True로 설정
- 반환 형식
DataFrame or dict
- class PyKakao.Message(service_key=None, redirect_uri='https://localhost:5000', scope='talk_message')
기반 클래스:
object
카카오 메시지 API 클래스
- 매개변수
service_key (str) – 카카오 개발자 센터에서 발급받은 애플리케이션의 REST API 키
- get_access_token_by_code(code)
카카오 인증코드로 액세스 토큰 발급
- 매개변수
code (str) – 카카오 인증코드
- 반환
액세스 토큰
- 반환 형식
str
- get_access_token_by_redirected_url(url)
카카오 인증코드 발급 URL 접속 후 리다이렉트된 URL로 액세스 토큰 발급
- 매개변수
url (str) – 카카오 인증코드 발급 URL 접속 후 리다이렉트된 URL
- 반환
액세스 토큰
- 반환 형식
str
- get_code_by_redirected_url(url)
카카오 인증코드 추출
- 매개변수
url (str) – 카카오 인증코드 발급 URL 접속 후 리다이렉트된 URL
- 반환
카카오 인증코드
- 반환 형식
str
- get_url_for_generating_code()
카카오 인증코드 발급 URL 생성
- 반환
카카오 인증코드 발급 URL
- 반환 형식
str
- send_commerce(content, commerce, **kwargs)
커머스 메시지 전송
- 매개변수
content (dict) – 커머스 정보
commerce (dict) – 상품 정보
- send_feed(content, **kwargs)
피드 메시지 전송
- 매개변수
content (dict) – 피드 내용
- send_list(header_title, header_link, contents, **kwargs)
리스트 메시지 전송
- 매개변수
header_title (str) – 리스트 제목
header_link (dict) – 리스트 링크
contents (list) – 리스트 내용
- send_location(address, address_title, content, **kwargs)
위치 메시지 전송
- 매개변수
address (str) – 주소
address_title (str) – 주소 제목
content (dict) – 위치 정보
- send_text(text, link, **kwargs)
텍스트 메시지 전송
- 매개변수
text (str) – 전송할 메시지 (최대 200자)
- set_access_token(access_token)
액세스 토큰 설정
- 매개변수
access_token (str) – 액세스 토큰