다음을 통해 공유

데이터 원본 - Pinecone(미리 보기)

  • 아티클

Azure OpenAI On Your Data를 사용하는 경우 Pinecone의 구성 가능한 옵션입니다. 이 데이터 원본은 API 버전 2024-02-15-preview에서 지원됩니다.

속성 Type 필수 설명
parameters 매개 변수 True Pinecone을 구성할 때 사용할 매개 변수입니다.
type string True pinecone이어야 합니다.

매개 변수

이름 Type 필수 설명
environment string True Pinecone의 환경 이름입니다.
index_name string True Pinecone 데이터베이스 인덱스의 이름입니다.
fields_mapping FieldsMappingOptions True 검색 인덱스와 상호 작용할 때 사용할 사용자 지정된 필드 매핑 동작입니다.
authentication ApiKeyAuthenticationOptions True 정의된 데이터 원본에 액세스할 때 사용할 인증 방법입니다.
embedding_dependency DeploymentNameVectorizationSource True 벡터 검색에 포함되는 종속성입니다.
in_scope 부울 값 False 쿼리를 인덱싱된 데이터 사용으로 제한해야 하는지 여부입니다. 기본값은 True입니다.
role_information string False 응답을 생성할 때 참조해야 하는 컨텍스트와 작동 방식에 대한 지침을 모델에 제공합니다. 도우미의 성격을 설명하고 응답 형식을 지정하는 방법을 알려줄 수 있습니다.
strictness 정수 False 검색 관련성 필터링의 구성된 엄격성입니다. 엄격성이 높을수록 정밀도가 높지만 대답의 재현율이 낮습니다. 기본값은 3입니다.
top_n_documents 정수 False 구성된 쿼리에 대해 기능할 구성된 상위 문서 수입니다. 기본값은 5입니다.

API 키 인증 옵션

API 키를 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다.

속성 Type 필수 설명
key string True 인증에 사용할 API 키입니다.
type string True api_key이어야 합니다.

배포 이름 벡터화 원본

벡터 검색을 적용하는 경우 Azure OpenAI On Your Data에서 사용하는 벡터화 원본의 세부 정보입니다. 이 벡터화 원본은 동일한 Azure OpenAI 리소스의 내부 포함 모델 배포 이름을 기반으로 합니다. 이 벡터화 원본을 사용하면 Azure OpenAI api-key 없이 Azure OpenAI 공용 네트워크에 액세스하지 않고도 벡터 검색을 사용할 수 있습니다.

속성 Type 필수 설명
deployment_name string True 동일한 Azure OpenAI 리소스 내의 포함 모델의 배포 이름입니다.
type string True deployment_name이어야 합니다.

필드 매핑 옵션

필드 처리 방법을 제어하는 설정입니다.

속성 Type 필수 설명
content_fields string[] True 콘텐츠로 처리해야 하는 인덱스 필드의 이름입니다.
content_fields_separator string False 콘텐츠 필드에서 사용해야 하는 구분 기호 패턴입니다. 기본값은 \n입니다.
filepath_field string False 파일 경로로 사용할 인덱스 필드의 이름입니다.
title_field string False 제목으로 사용할 인덱스 필드의 이름입니다.
url_field string False URL로 사용할 인덱스 필드의 이름입니다.

예제

필수 조건:

  • 사용자에서 Azure OpenAI 리소스로 역할 할당을 구성합니다. 필요한 역할: Cognitive Services OpenAI User.
  • Az CLI를 설치하고 az login을 실행합니다.
  • AzureOpenAIEndpoint, ChatCompletionsDeploymentName,Environment, IndexName, Key, EmbeddingDeploymentName과 같은 환경 변수를 정의합니다.
export AzureOpenAIEndpoint=https://example.openai.azure.com/
export ChatCompletionsDeploymentName=turbo
export Environment=testenvironment
export Key=***
export IndexName=pinecone-test-index
export EmbeddingDeploymentName=ada

최신 pip 패키지 openai, azure-identity를 설치합니다.

import os
from openai import AzureOpenAI
from azure.identity import DefaultAzureCredential, get_bearer_token_provider

endpoint = os.environ.get("AzureOpenAIEndpoint")
deployment = os.environ.get("ChatCompletionsDeploymentName")
environment = os.environ.get("Environment")
key = os.environ.get("Key")
index_name = os.environ.get("IndexName")
embedding_deployment_name = os.environ.get("EmbeddingDeploymentName")

token_provider = get_bearer_token_provider(
    DefaultAzureCredential(), "https://cognitiveservices.azure.com/.default")

client = AzureOpenAI(
    azure_endpoint=endpoint,
    azure_ad_token_provider=token_provider,
    api_version="2024-02-15-preview",
)

completion = client.chat.completions.create(
    model=deployment,
    messages=[
        {
            "role": "user",
            "content": "Who is DRI?",
        },
    ],
    extra_body={
        "data_sources": [
            {
                "type": "pinecone",
                "parameters": {
                    "environment": environment,
                    "authentication": {
                        "type": "api_key",
                        "key": key
                    },
                    "index_name": index_name,
                    "fields_mapping": {
                        "content_fields": [
                            "content"
                        ]
                    },
                    "embedding_dependency": {
                        "type": "deployment_name",
                        "deployment_name": embedding_deployment_name
                    }
                }}
        ],
    }
)

print(completion.model_dump_json(indent=2))