mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 13:48:09 +00:00
Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com>
279 lines
12 KiB
Plaintext
279 lines
12 KiB
Plaintext
---
|
|
title: Google Contacts 통합
|
|
description: "CrewAI를 위한 Google Contacts 통합으로 연락처 및 디렉토리 관리."
|
|
icon: "address-book"
|
|
mode: "wide"
|
|
---
|
|
|
|
## 개요
|
|
|
|
에이전트가 Google Contacts를 통해 연락처와 디렉토리 정보를 관리할 수 있도록 합니다. 개인 연락처에 액세스하고, 디렉토리 사람들을 검색하고, 연락처 정보를 생성 및 업데이트하고, AI 기반 자동화로 연락처 그룹을 관리합니다.
|
|
|
|
## 전제 조건
|
|
|
|
Google Contacts 통합을 사용하기 전에 다음 사항을 확인하세요:
|
|
|
|
- 활성 구독이 있는 [CrewAI AMP](https://app.crewai.com) 계정
|
|
- Google Contacts 액세스 권한이 있는 Google 계정
|
|
- [통합 페이지](https://app.crewai.com/crewai_plus/connectors)를 통해 Google 계정 연결
|
|
|
|
## Google Contacts 통합 설정
|
|
|
|
### 1. Google 계정 연결
|
|
|
|
1. [CrewAI AMP 통합](https://app.crewai.com/crewai_plus/connectors)으로 이동
|
|
2. 인증 통합 섹션에서 **Google Contacts** 찾기
|
|
3. **연결**을 클릭하고 OAuth 플로우 완료
|
|
4. 연락처 및 디렉토리 액세스에 필요한 권한 부여
|
|
5. [통합 설정](https://app.crewai.com/crewai_plus/settings/integrations)에서 Enterprise Token 복사
|
|
|
|
### 2. 필요한 패키지 설치
|
|
|
|
```bash
|
|
uv add crewai-tools
|
|
```
|
|
|
|
### 3. 환경 변수 설정
|
|
|
|
<Note>
|
|
`Agent(apps=[])`와 함께 통합을 사용하려면 Enterprise Token으로
|
|
`CREWAI_PLATFORM_INTEGRATION_TOKEN` 환경 변수를 설정해야 합니다.
|
|
</Note>
|
|
|
|
```bash
|
|
export CREWAI_PLATFORM_INTEGRATION_TOKEN="your_enterprise_token"
|
|
```
|
|
|
|
또는 `.env` 파일에 추가하세요:
|
|
|
|
```
|
|
CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
|
|
```
|
|
|
|
## 사용 가능한 작업
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="google_contacts/get_contacts">
|
|
**설명:** Google Contacts에서 사용자의 연락처를 검색합니다.
|
|
|
|
**매개변수:**
|
|
- `pageSize` (integer, 선택사항): 반환할 연락처 수 (최대 1000). 최소: 1, 최대: 1000
|
|
- `pageToken` (string, 선택사항): 검색할 페이지의 토큰.
|
|
- `personFields` (string, 선택사항): 포함할 필드 (예: 'names,emailAddresses,phoneNumbers'). 기본값: names,emailAddresses,phoneNumbers
|
|
- `requestSyncToken` (boolean, 선택사항): 응답에 동기화 토큰을 포함할지 여부. 기본값: false
|
|
- `sortOrder` (string, 선택사항): 연결을 정렬할 순서. 옵션: LAST_MODIFIED_ASCENDING, LAST_MODIFIED_DESCENDING, FIRST_NAME_ASCENDING, LAST_NAME_ASCENDING
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_contacts/search_contacts">
|
|
**설명:** 쿼리 문자열을 사용하여 연락처를 검색합니다.
|
|
|
|
**매개변수:**
|
|
- `query` (string, 필수): 검색 쿼리 문자열
|
|
- `readMask` (string, 필수): 읽을 필드 (예: 'names,emailAddresses,phoneNumbers')
|
|
- `pageSize` (integer, 선택사항): 반환할 결과 수. 최소: 1, 최대: 30
|
|
- `pageToken` (string, 선택사항): 반환할 결과 페이지를 지정하는 토큰.
|
|
- `sources` (array, 선택사항): 검색할 소스. 옵션: READ_SOURCE_TYPE_CONTACT, READ_SOURCE_TYPE_PROFILE. 기본값: READ_SOURCE_TYPE_CONTACT
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_contacts/list_directory_people">
|
|
**설명:** 인증된 사용자의 디렉토리에 있는 사람들을 나열합니다.
|
|
|
|
**매개변수:**
|
|
- `sources` (array, 필수): 검색할 디렉토리 소스. 옵션: DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE, DIRECTORY_SOURCE_TYPE_DOMAIN_CONTACT. 기본값: DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE
|
|
- `pageSize` (integer, 선택사항): 반환할 사람 수. 최소: 1, 최대: 1000
|
|
- `pageToken` (string, 선택사항): 반환할 결과 페이지를 지정하는 토큰.
|
|
- `readMask` (string, 선택사항): 읽을 필드 (예: 'names,emailAddresses')
|
|
- `requestSyncToken` (boolean, 선택사항): 응답에 동기화 토큰을 포함할지 여부. 기본값: false
|
|
- `mergeSources` (array, 선택사항): 디렉토리 사람 응답에 병합할 추가 데이터. 옵션: CONTACT
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_contacts/search_directory_people">
|
|
**설명:** 디렉토리에서 사람을 검색합니다.
|
|
|
|
**매개변수:**
|
|
- `query` (string, 필수): 검색 쿼리
|
|
- `sources` (string, 필수): 디렉토리 소스 ('DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE' 사용)
|
|
- `pageSize` (integer, 선택사항): 반환할 결과 수
|
|
- `readMask` (string, 선택사항): 읽을 필드
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_contacts/list_other_contacts">
|
|
**설명:** 기타 연락처를 나열합니다 (사용자의 개인 연락처에 없는).
|
|
|
|
**매개변수:**
|
|
- `pageSize` (integer, 선택사항): 반환할 연락처 수. 최소: 1, 최대: 1000
|
|
- `pageToken` (string, 선택사항): 반환할 결과 페이지를 지정하는 토큰.
|
|
- `readMask` (string, 선택사항): 읽을 필드
|
|
- `requestSyncToken` (boolean, 선택사항): 응답에 동기화 토큰을 포함할지 여부. 기본값: false
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_contacts/search_other_contacts">
|
|
**설명:** 기타 연락처를 검색합니다.
|
|
|
|
**매개변수:**
|
|
- `query` (string, 필수): 검색 쿼리
|
|
- `readMask` (string, 필수): 읽을 필드 (예: 'names,emailAddresses')
|
|
- `pageSize` (integer, 선택사항): 결과 수
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_contacts/get_person">
|
|
**설명:** 리소스 이름으로 한 사람의 연락처 정보를 가져옵니다.
|
|
|
|
**매개변수:**
|
|
- `resourceName` (string, 필수): 가져올 사람의 리소스 이름 (예: 'people/c123456789')
|
|
- `personFields` (string, 선택사항): 포함할 필드 (예: 'names,emailAddresses,phoneNumbers'). 기본값: names,emailAddresses,phoneNumbers
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_contacts/create_contact">
|
|
**설명:** 사용자의 주소록에 새 연락처를 만듭니다.
|
|
|
|
**매개변수:**
|
|
- `names` (array, 선택사항): 사람의 이름들. 각 항목은 `givenName` (string), `familyName` (string), `displayName` (string)이 있는 객체.
|
|
- `emailAddresses` (array, 선택사항): 이메일 주소들. 각 항목은 `value` (string, 이메일 주소)와 `type` (string, 'home', 'work', 'other', 기본값 'other')이 있는 객체.
|
|
- `phoneNumbers` (array, 선택사항): 전화번호들. 각 항목은 `value` (string, 전화번호)와 `type` (string, 'home', 'work', 'mobile', 'other', 기본값 'other')이 있는 객체.
|
|
- `addresses` (array, 선택사항): 우편 주소들. 각 항목은 `formattedValue` (string, 형식화된 주소)와 `type` (string, 'home', 'work', 'other', 기본값 'other')이 있는 객체.
|
|
- `organizations` (array, 선택사항): 조직/회사들. 각 항목은 `name` (string, 조직 이름), `title` (string, 직책), `type` (string, 'work', 'other', 기본값 'work')이 있는 객체.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_contacts/update_contact">
|
|
**설명:** 기존 연락처의 정보를 업데이트합니다.
|
|
|
|
**매개변수:**
|
|
- `resourceName` (string, 필수): 업데이트할 사람의 리소스 이름 (예: 'people/c123456789').
|
|
- `updatePersonFields` (string, 필수): 업데이트할 필드 (예: 'names,emailAddresses,phoneNumbers').
|
|
- `names` (array, 선택사항): 사람의 이름들. 각 항목은 `givenName` (string), `familyName` (string), `displayName` (string)이 있는 객체.
|
|
- `emailAddresses` (array, 선택사항): 이메일 주소들. 각 항목은 `value` (string, 이메일 주소)와 `type` (string, 'home', 'work', 'other')이 있는 객체.
|
|
- `phoneNumbers` (array, 선택사항): 전화번호들. 각 항목은 `value` (string, 전화번호)와 `type` (string, 'home', 'work', 'mobile', 'other')이 있는 객체.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_contacts/delete_contact">
|
|
**설명:** 사용자의 주소록에서 연락처를 삭제합니다.
|
|
|
|
**매개변수:**
|
|
- `resourceName` (string, 필수): 삭제할 사람의 리소스 이름 (예: 'people/c123456789').
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_contacts/batch_get_people">
|
|
**설명:** 한 번의 요청으로 여러 사람에 대한 정보를 가져옵니다.
|
|
|
|
**매개변수:**
|
|
- `resourceNames` (array, 필수): 가져올 사람들의 리소스 이름 (최대 200개 항목).
|
|
- `personFields` (string, 선택사항): 포함할 필드 (예: 'names,emailAddresses,phoneNumbers'). 기본값: names,emailAddresses,phoneNumbers
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_contacts/list_contact_groups">
|
|
**설명:** 사용자의 연락처 그룹(라벨)을 나열합니다.
|
|
|
|
**매개변수:**
|
|
- `pageSize` (integer, 선택사항): 반환할 연락처 그룹 수. 최소: 1, 최대: 1000
|
|
- `pageToken` (string, 선택사항): 반환할 결과 페이지를 지정하는 토큰.
|
|
- `groupFields` (string, 선택사항): 포함할 필드 (예: 'name,memberCount,clientData'). 기본값: name,memberCount
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_contacts/get_contact_group">
|
|
**설명:** 리소스 이름으로 특정 연락처 그룹을 가져옵니다.
|
|
|
|
**매개변수:**
|
|
- `resourceName` (string, 필수): 연락처 그룹의 리소스 이름 (예: 'contactGroups/myContactGroup').
|
|
- `maxMembers` (integer, 선택사항): 포함할 최대 멤버 수. 최소: 0, 최대: 20000
|
|
- `groupFields` (string, 선택사항): 포함할 필드 (예: 'name,memberCount,clientData'). 기본값: name,memberCount
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_contacts/create_contact_group">
|
|
**설명:** 새 연락처 그룹(라벨)을 만듭니다.
|
|
|
|
**매개변수:**
|
|
- `name` (string, 필수): 연락처 그룹의 이름.
|
|
- `clientData` (array, 선택사항): 클라이언트별 데이터. 각 항목은 `key` (string)와 `value` (string)가 있는 객체.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_contacts/update_contact_group">
|
|
**설명:** 연락처 그룹의 정보를 업데이트합니다.
|
|
|
|
**매개변수:**
|
|
- `resourceName` (string, 필수): 연락처 그룹의 리소스 이름 (예: 'contactGroups/myContactGroup').
|
|
- `name` (string, 필수): 연락처 그룹의 이름.
|
|
- `clientData` (array, 선택사항): 클라이언트별 데이터. 각 항목은 `key` (string)와 `value` (string)가 있는 객체.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_contacts/delete_contact_group">
|
|
**설명:** 연락처 그룹을 삭제합니다.
|
|
|
|
**매개변수:**
|
|
- `resourceName` (string, 필수): 삭제할 연락처 그룹의 리소스 이름 (예: 'contactGroups/myContactGroup').
|
|
- `deleteContacts` (boolean, 선택사항): 그룹 내 연락처도 삭제할지 여부. 기본값: false
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## 사용 예제
|
|
|
|
### 기본 Google Contacts 에이전트 설정
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Google Contacts 기능을 가진 에이전트 생성
|
|
contacts_agent = Agent(
|
|
role="연락처 관리자",
|
|
goal="Google Contacts를 효율적으로 관리",
|
|
backstory="연락처 관리 및 조직 전문 AI 어시스턴트.",
|
|
apps=['google_contacts'] # 모든 Google Contacts 작업을 사용할 수 있습니다
|
|
)
|
|
|
|
# 새 연락처 생성 작업
|
|
create_contact_task = Task(
|
|
description="'김철수'라는 이름으로 이메일 'kim.chulsoo@example.com'과 전화번호 '010-1234-5678'로 새 연락처를 만드세요",
|
|
agent=contacts_agent,
|
|
expected_output="새 연락처가 성공적으로 생성됨"
|
|
)
|
|
|
|
# 작업 실행
|
|
crew = Crew(
|
|
agents=[contacts_agent],
|
|
tasks=[create_contact_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
## 문제 해결
|
|
|
|
### 일반적인 문제
|
|
|
|
**인증 오류**
|
|
|
|
- Google 계정이 연락처 및 디렉토리 액세스에 필요한 권한을 가지고 있는지 확인하세요.
|
|
- OAuth 연결이 Google People API에 필요한 모든 범위를 포함하는지 확인하세요.
|
|
|
|
**연락처 생성/업데이트 문제**
|
|
|
|
- 연락처 생성 시 `email`과 같은 필수 필드가 제공되는지 확인하세요.
|
|
- 연락처를 업데이트하거나 삭제할 때 `resourceName`이 올바른지 확인하세요.
|
|
|
|
### 도움 받기
|
|
|
|
<Card
|
|
title="도움이 필요하신가요?"
|
|
icon="headset"
|
|
href="mailto:support@crewai.com"
|
|
>
|
|
Google Contacts 통합 설정 또는 문제 해결에 대한 지원이 필요하시면 지원팀에
|
|
문의하세요.
|
|
</Card>
|