File Search Stores

파일 검색 API는 Google 인프라를 사용하여 검색 증강 생성 (RAG) 시스템을 빌드하기 위한 호스팅 질의 응답 서비스를 제공합니다.

메서드: media.uploadToFileSearchStore

데이터를 FileSearchStore에 업로드하고, FileSearchStore 문서에 저장하기 전에 전처리하고 청크로 나눕니다.

엔드포인트

  • 미디어 업로드 요청을 위한 업로드 URI:
 post https://generativelanguage.googleapis.com/upload/v1beta/{fileSearchStoreName=fileSearchStores/*}:uploadToFileSearchStore
  • 메타데이터 전용 요청을 위한 메타데이터 URI:
 post https://generativelanguage.googleapis.com/v1beta/{fileSearchStoreName=fileSearchStores/*}:uploadToFileSearchStore

경로 매개변수

fileSearchStoreName string

필수 항목입니다. 변경할 수 없습니다. 파일을 업로드할 FileSearchStore의 이름입니다. 예: fileSearchStores/my-file-search-store-123 fileSearchStores/{filesearchstore} 형식이 사용됩니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

필드
displayName string

선택사항입니다. 생성된 문서의 표시 이름입니다.

customMetadata[] object (CustomMetadata)

데이터와 연결할 맞춤 메타데이터입니다.

chunkingConfig object (ChunkingConfig)

선택사항입니다. 서비스에 데이터를 청크하는 방법을 알려주는 구성입니다. 제공되지 않으면 서비스에서 기본 매개변수를 사용합니다.

mimeType string

선택사항입니다. 데이터의 MIME 유형입니다. 제공되지 않으면 업로드된 콘텐츠에서 추론됩니다.

응답 본문

이는 google.longrunning.Operation의 사본입니다. scotty와 상호작용하려면 최상위 작업 프로토에 추가할 수 없는 scotty 특정 필드를 추가해야 하므로 복사해야 합니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

필드
name string

서버에 할당된 이름으로, 해당 이름을 최초로 반환한 서비스 내에서만 고유합니다. 기본 HTTP 매핑을 사용하는 경우 name은 operations/{unique_id}로 끝나는 리소스 이름이어야 합니다.

metadata object

작업과 관련된 서비스별 메타데이터입니다. 일반적으로 진행률 정보 및 생성 시간과 같은 일반 메타데이터가 포함됩니다. 일부 서비스는 이러한 메타데이터를 제공하지 않을 수 있습니다. 장기 실행 작업을 반환하는 메소드는 메타데이터 유형이 있는 경우 이를 문서화해야 합니다.

임의 유형의 필드를 포함하는 객체입니다. 추가 필드 "@type"은 유형을 식별하는 URI를 포함합니다. 예: { "id": 1234, "@type": "types.example.com/standard/id" }

done boolean

값이 false이면 작업이 아직 진행 중이라는 의미입니다. true이면 작업이 완료된 것이며, error 또는 response를 사용할 수 있습니다.

result Union type
작업 결과로, error 또는 유효한 response일 수 있습니다. done == false이면 error와 response가 모두 설정되지 않습니다. done == true이면 error 또는 response 중 정확히 하나를 설정할 수 있습니다. 일부 서비스는 결과를 제공하지 않을 수 있습니다. result은 다음 중 하나여야 합니다.
error object (Status)

실패하거나 취소된 작업의 오류 결과입니다.

response object

정상적이며 성공한 작업 응답입니다. Delete와 같이 원래 메서드가 성공 시 데이터를 반환하지 않는 경우 응답은 google.protobuf.Empty입니다. 원래 메서드가 표준 Get/Create/Update이면 응답은 리소스여야 합니다. 다른 메서드의 경우 응답은 XxxResponse 유형이어야 하며, 여기에서 Xxx는 원래 메서드의 이름입니다. 예를 들어 원래 메서드 이름이 TakeSnapshot()이면 추론된 응답 유형은 TakeSnapshotResponse입니다.

임의 유형의 필드를 포함하는 객체입니다. 추가 필드 "@type"은 유형을 식별하는 URI를 포함합니다. 예: { "id": 1234, "@type": "types.example.com/standard/id" }

JSON 표현 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

메서드: fileSearchStores.create

빈 FileSearchStore를 만듭니다.

엔드포인트

post https://generativelanguage.googleapis.com/v1beta/fileSearchStores

요청 본문

요청 본문에 FileSearchStore의 인스턴스가 포함됩니다.

필드
displayName string

선택사항입니다. FileSearchStore의 사람이 읽을 수 있는 표시 이름입니다. 표시 이름은 공백을 포함하여 512자(영문 기준) 이하여야 합니다. 예: '시맨틱 리트리버의 문서'

응답 본문

성공한 경우 응답 본문에 새로 생성된 FileSearchStore의 인스턴스가 포함됩니다.

메서드: fileSearchStores.delete

FileSearchStore를 삭제합니다.

엔드포인트

delete https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*}

경로 매개변수

name string

필수 항목입니다. FileSearchStore의 리소스 이름입니다. 예: fileSearchStores/my-file-search-store-123 fileSearchStores/{filesearchstore} 형식이 사용됩니다.

쿼리 매개변수

force boolean

선택사항입니다. true로 설정하면 이 FileSearchStore와 관련된 모든 Document 및 객체도 삭제됩니다.

false (기본값)인 경우 FileSearchStore에 Document가 포함되어 있으면 FAILED_PRECONDITION 오류가 반환됩니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공하면 응답 본문은 빈 JSON 객체입니다.

메서드: fileSearchStores.get

특정 FileSearchStore에 관한 정보를 가져옵니다.

엔드포인트

get https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*}

경로 매개변수

name string

필수 항목입니다. FileSearchStore의 이름입니다. 예: fileSearchStores/my-file-search-store-123 fileSearchStores/{filesearchstore} 형식이 사용됩니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공한 경우 응답 본문에 FileSearchStore의 인스턴스가 포함됩니다.

메서드: fileSearchStores.list

사용자가 소유한 모든 FileSearchStores를 나열합니다.

엔드포인트

get https://generativelanguage.googleapis.com/v1beta/fileSearchStores

쿼리 매개변수

pageSize integer

선택사항입니다. 반환할 최대 FileSearchStores 수 (페이지당)입니다. 서비스가 FileSearchStores보다 적게 반환할 수 있습니다.

지정하지 않으면 최대 10개의 FileSearchStores가 반환됩니다. 최대 크기 제한은 페이지당 20FileSearchStores입니다.

pageToken string

선택사항입니다. 이전 fileSearchStores.list 호출에서 받은 페이지 토큰입니다.

다음 페이지를 가져오기 위한 다음 요청의 인수로 응답에서 반환된 nextPageToken을 제공합니다.

페이지를 매길 때 fileSearchStores.list에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

FileSearchStores의 페이지로 나누어진 목록이 포함된 fileSearchStores.list의 응답입니다. 결과는 오름차순 fileSearchStore.create_time로 정렬됩니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

필드
fileSearchStores[] object (FileSearchStore)

반환된 ragStores입니다.

nextPageToken string

다음 페이지를 검색하기 위해 pageToken으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 더 이상 페이지가 없습니다.

JSON 표현 
{
  "fileSearchStores": [
    {
      object (FileSearchStore)
    }
  ],
  "nextPageToken": string
}

메서드: fileSearchStores.importFile

파일 서비스에서 FileSearchStore로 File를 가져옵니다.

엔드포인트

post https://generativelanguage.googleapis.com/v1beta/{fileSearchStoreName=fileSearchStores/*}:importFile

경로 매개변수

fileSearchStoreName string

필수 항목입니다. 변경할 수 없습니다. 파일을 가져올 FileSearchStore의 이름입니다. 예: fileSearchStores/my-file-search-store-123 fileSearchStores/{filesearchstore} 형식이 사용됩니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

필드
fileName string

필수 항목입니다. 가져올 File의 이름입니다. 예를 들면 files/abc-123입니다.

customMetadata[] object (CustomMetadata)

파일과 연결할 맞춤 메타데이터입니다.

chunkingConfig object (ChunkingConfig)

선택사항입니다. 서비스에 파일을 청크하는 방법을 알려주는 구성입니다. 제공되지 않으면 서비스에서 기본 매개변수를 사용합니다.

응답 본문

성공한 경우 응답 본문에 Operation의 인스턴스가 포함됩니다.

REST 리소스: fileSearchStores.operations

리소스: 작업

이 리소스는 네트워크 API 호출의 결과인 장기 실행 작업을 나타냅니다.

필드
name string

서버에 할당된 이름으로, 해당 이름을 최초로 반환한 서비스 내에서만 고유합니다. 기본 HTTP 매핑을 사용하는 경우 name은 operations/{unique_id}로 끝나는 리소스 이름이어야 합니다.

metadata object

작업과 관련된 서비스별 메타데이터입니다. 일반적으로 진행률 정보 및 생성 시간과 같은 일반 메타데이터가 포함됩니다. 일부 서비스는 이러한 메타데이터를 제공하지 않을 수 있습니다. 장기 실행 작업을 반환하는 메소드는 메타데이터 유형이 있는 경우 이를 문서화해야 합니다.

임의 유형의 필드를 포함하는 객체입니다. 추가 필드 "@type"은 유형을 식별하는 URI를 포함합니다. 예: { "id": 1234, "@type": "types.example.com/standard/id" }

done boolean

값이 false이면 작업이 아직 진행 중이라는 의미입니다. true이면 작업이 완료된 것이며, error 또는 response를 사용할 수 있습니다.

result Union type
작업 결과로, error 또는 유효한 response일 수 있습니다. done == false이면 error와 response가 모두 설정되지 않습니다. done == true이면 error 또는 response 중 정확히 하나를 설정할 수 있습니다. 일부 서비스는 결과를 제공하지 않을 수 있습니다. result은 다음 중 하나여야 합니다.
error object (Status)

실패하거나 취소된 작업의 오류 결과입니다.

response object

정상적이며 성공한 작업 응답입니다. Delete와 같이 원래 메서드가 성공 시 데이터를 반환하지 않는 경우 응답은 google.protobuf.Empty입니다. 원래 메서드가 표준 Get/Create/Update이면 응답은 리소스여야 합니다. 다른 메서드의 경우 응답은 XxxResponse 유형이어야 하며, 여기에서 Xxx는 원래 메서드의 이름입니다. 예를 들어 원래 메서드 이름이 TakeSnapshot()이면 추론된 응답 유형은 TakeSnapshotResponse입니다.

임의 유형의 필드를 포함하는 객체입니다. 추가 필드 "@type"은 유형을 식별하는 URI를 포함합니다. 예: { "id": 1234, "@type": "types.example.com/standard/id" }

JSON 표현 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

메서드: fileSearchStores.operations.get

장기 실행 작업의 최신 상태를 가져옵니다. 클라이언트는 이 메서드를 사용하여 API 서비스가 권장하는 간격으로 작업 결과를 폴링할 수 있습니다.

엔드포인트

get https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*/operations/*}

경로 매개변수

name string

작업 리소스의 이름입니다. fileSearchStores/{filesearchstore}/operations/{operation} 형식이 사용됩니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공한 경우 응답 본문에 Operation의 인스턴스가 포함됩니다.

REST 리소스: fileSearchStores.upload.operations

리소스: 작업

이 리소스는 네트워크 API 호출의 결과인 장기 실행 작업을 나타냅니다.

필드
name string

서버에 할당된 이름으로, 해당 이름을 최초로 반환한 서비스 내에서만 고유합니다. 기본 HTTP 매핑을 사용하는 경우 name은 operations/{unique_id}로 끝나는 리소스 이름이어야 합니다.

metadata object

작업과 관련된 서비스별 메타데이터입니다. 일반적으로 진행률 정보 및 생성 시간과 같은 일반 메타데이터가 포함됩니다. 일부 서비스는 이러한 메타데이터를 제공하지 않을 수 있습니다. 장기 실행 작업을 반환하는 메소드는 메타데이터 유형이 있는 경우 이를 문서화해야 합니다.

임의 유형의 필드를 포함하는 객체입니다. 추가 필드 "@type"은 유형을 식별하는 URI를 포함합니다. 예: { "id": 1234, "@type": "types.example.com/standard/id" }

done boolean

값이 false이면 작업이 아직 진행 중이라는 의미입니다. true이면 작업이 완료된 것이며, error 또는 response를 사용할 수 있습니다.

result Union type
작업 결과로, error 또는 유효한 response일 수 있습니다. done == false이면 error와 response가 모두 설정되지 않습니다. done == true이면 error 또는 response 중 정확히 하나를 설정할 수 있습니다. 일부 서비스는 결과를 제공하지 않을 수 있습니다. result은 다음 중 하나여야 합니다.
error object (Status)

실패하거나 취소된 작업의 오류 결과입니다.

response object

정상적이며 성공한 작업 응답입니다. Delete와 같이 원래 메서드가 성공 시 데이터를 반환하지 않는 경우 응답은 google.protobuf.Empty입니다. 원래 메서드가 표준 Get/Create/Update이면 응답은 리소스여야 합니다. 다른 메서드의 경우 응답은 XxxResponse 유형이어야 하며, 여기에서 Xxx는 원래 메서드의 이름입니다. 예를 들어 원래 메서드 이름이 TakeSnapshot()이면 추론된 응답 유형은 TakeSnapshotResponse입니다.

임의 유형의 필드를 포함하는 객체입니다. 추가 필드 "@type"은 유형을 식별하는 URI를 포함합니다. 예: { "id": 1234, "@type": "types.example.com/standard/id" }

JSON 표현 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

메서드: fileSearchStores.upload.operations.get

장기 실행 작업의 최신 상태를 가져옵니다. 클라이언트는 이 메서드를 사용하여 API 서비스가 권장하는 간격으로 작업 결과를 폴링할 수 있습니다.

엔드포인트

get https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*/upload/operations/*}

경로 매개변수

name string

작업 리소스의 이름입니다. fileSearchStores/{filesearchstore}/upload/operations/{operation} 형식이 사용됩니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공한 경우 응답 본문에 Operation의 인스턴스가 포함됩니다.

REST 리소스: fileSearchStores

리소스: FileSearchStore

FileSearchStore은 Document의 모음입니다.

필드
name string

출력 전용입니다. 변경할 수 없습니다. 식별자. FileSearchStore 리소스 이름입니다. 소문자 영숫자 또는 대시(-)로 구성된 최대 40자 길이의 ID입니다('fileSearchStores/' 접두사 제외). 출력 전용입니다. 고유 이름은 displayName와 12자리 무작위 서픽스에서 파생됩니다. 예: fileSearchStores/my-awesome-file-search-store-123a456b789c displayName을 제공하지 않으면 이름이 무작위로 생성됩니다.

displayName string

선택사항입니다. FileSearchStore의 사람이 읽을 수 있는 표시 이름입니다. 표시 이름은 공백을 포함하여 512자(영문 기준) 이하여야 합니다. 예: '시맨틱 리트리버의 문서'

createTime string (Timestamp format)

출력 전용입니다. FileSearchStore이 생성된 시점의 타임스탬프입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.

updateTime string (Timestamp format)

출력 전용입니다. FileSearchStore가 마지막으로 업데이트된 시간의 타임스탬프입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.

activeDocumentsCount string (int64 format)

출력 전용입니다. FileSearchStore에서 활성 상태이며 검색할 준비가 된 문서 수입니다.

pendingDocumentsCount string (int64 format)

출력 전용입니다. 처리 중인 FileSearchStore의 문서 수입니다.

failedDocumentsCount string (int64 format)

출력 전용입니다. 처리에 실패한 FileSearchStore의 문서 수입니다.

sizeBytes string (int64 format)

출력 전용입니다. FileSearchStore에 수집된 원시 바이트의 크기입니다. FileSearchStore에 있는 모든 문서의 총 크기입니다.

JSON 표현 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "activeDocumentsCount": string,
  "pendingDocumentsCount": string,
  "failedDocumentsCount": string,
  "sizeBytes": string
}