Package google.cloud.discoveryengine.v1

QueryClassificationInfo

최근 재검색이 발생한 시간입니다.

score

double

각 제안의 점수입니다. 점수는 [0, 1] 범위에 있습니다.

AdvancedSiteSearchConfig

고급 사이트 검색의 구성 데이터입니다.

필드

disable_initial_index

bool

true로 설정하면 DataStore의 초기 색인 생성이 사용 중지됩니다.

disable_automatic_refresh

bool

true로 설정하면 DataStore의 자동 새로고침이 사용 중지됩니다.

AlertPolicyConfig

커넥터 수준 알림 구성입니다.

필드

alert_policy_name

string

변경할 수 없습니다. AlertPolicy의 정규화된 리소스 이름입니다.

alert_enrollments[]

AlertEnrollment

(선택사항) 각 알림의 등록 상태입니다.

AlertEnrollment

알림 등록 상태입니다.

필드

alert_id

string

변경할 수 없습니다. 알림의 ID입니다.

enroll_state

EnrollStates

필수 항목입니다. 고객의 등록 상태입니다.

EnrollStates

알림의 등록 상태 열거형입니다.

열거형
`ENROLL_STATES_UNSPECIFIED`	기본값 알림 정책에 응답하지 않은 고객에게 사용됩니다.
`ENROLLED`	고객이 이 정책에 등록되어 있습니다.
`DECLINED`	고객이 이 정책을 거부했습니다.

AlertPolicyResourceConfig

리소스 수준 알림 구성입니다. 사용처: * UserLicense * EngineUserData 데이터 커넥터의 AlertPolicyConfig는 동일한 용도로 사용됩니다. 마이그레이션할 수 있는 간단한 방법이 없습니다.

필드
`alert_policy`	`string` 변경할 수 없습니다. AlertPolicy의 정규화된 리소스 이름입니다.
`alert_enrollments[]`	`AlertEnrollment` (선택사항) 각 알림의 등록 상태입니다.
`contact_details[]`	`ContactDetails` (선택사항) 각 알림 정책의 연락처 세부정보입니다.
`language_code`	`string` (선택사항) 알림에 사용되는 언어 코드

AlertEnrollment

알림 등록 상태입니다.

필드

alert_id

string

변경할 수 없습니다. 알림의 ID입니다.

enroll_state

EnrollState

필수 항목입니다. 고객의 등록 상태입니다.

notification_params

map<string, string>

(선택사항) 알림을 인스턴스화하는 데 사용되는 매개변수입니다. 등록 시 트리거되는 알림에 사용됩니다. 저장되지 않습니다. * Gemini Business 환영 이메일 * Gemini Business 사용자 초대 이메일

EnrollState

알림의 등록 상태 열거형입니다.

열거형
`ENROLL_STATE_UNSPECIFIED`	기본값 알림 정책에 응답하지 않은 고객에게 사용됩니다.
`ENROLLED`	고객이 이 정책에 등록되어 있습니다.
`DECLINED`	고객이 이 정책을 거부했습니다.

AlloyDbSource

AlloyDB 소스에서 데이터를 가져옵니다.

필드
`project_id`	`string` AlloyDB 소스가 포함된 프로젝트 ID입니다. 길이 제한은 128자(영문 기준)입니다. 지정하지 않으면 상위 요청에서 프로젝트 ID를 상속합니다.
`location_id`	`string` 필수 항목입니다. 데이터를 복사할 AlloyDB 위치입니다(길이 제한: 256자).
`cluster_id`	`string` 필수 항목입니다. 데이터를 복사할 AlloyDB 클러스터입니다(길이 제한: 256자).
`database_id`	`string` 필수 항목입니다. 데이터를 복사할 AlloyDB 데이터베이스입니다. 길이는 256자로 제한됩니다.
`table_id`	`string` 필수 항목입니다. 데이터를 복사할 AlloyDB 테이블입니다. 길이는 256자로 제한됩니다.
`gcs_staging_dir`	`string` 가져오기에 사용되는 중간 Cloud Storage 디렉터리입니다. 길이는 2,000자로 제한됩니다. 특정 Cloud Storage 디렉터리로 AlloyDB 내보내기를 사용하려는 경우에 지정할 수 있습니다. AlloyDB 서비스 계정에 지정된 Cloud Storage 디렉터리에 액세스하는 데 필요한 Cloud Storage 관리자 권한이 있는지 확인합니다.

답변

답변을 정의합니다.

필드
`name`	`string` 변경할 수 없습니다. 정규화된 이름 `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions//answers/`
`state`	`State` 답변 생성 상태입니다.
`answer_text`	`string` 텍스트 답변입니다.
`citations[]`	`Citation` 인용입니다.
`grounding_supports[]`	`GroundingSupport` (선택사항) 그라운딩 지원
`references[]`	`Reference` 참고 문헌
`related_questions[]`	`string` 추천 관련 질문
`steps[]`	`Step` 대답 생성 단계입니다.
`query_understanding_info`	`QueryUnderstandingInfo` 질문 이해 정보입니다.
`answer_skipped_reasons[]`	`AnswerSkippedReason` 추가 답변 건너뜀 이유입니다. 무시된 케이스의 이유를 제공합니다. 건너뛴 항목이 없으면 이 필드가 설정되지 않습니다.
`create_time`	`Timestamp` 출력 전용입니다. 대답 생성 타임스탬프입니다.
`complete_time`	`Timestamp` 출력 전용입니다. 답변 완료 타임스탬프입니다.
`safety_ratings[]`	`SafetyRating` (선택사항) 안전 등급
`grounding_score`	`double` 참조 청크에 의해 답변이 그라운딩된 정도를 설명하는 [0, 1] 범위의 점수입니다.

AnswerSkippedReason

답변이 건너뛰어진 이유를 나타내는 열거형입니다.

열거형
`ANSWER_SKIPPED_REASON_UNSPECIFIED`	기본값 대답 건너뛰기 이유가 지정되지 않았습니다.
`ADVERSARIAL_QUERY_IGNORED`	악의적인 쿼리가 무시된 사례입니다.
`NON_ANSWER_SEEKING_QUERY_IGNORED`	답변을 구하지 않는 쿼리가 무시된 사례 질문이 잡담인 경우 Google은 대답을 건너뜁니다.
`OUT_OF_DOMAIN_QUERY_IGNORED`	도메인 외부 쿼리에서 대소문자를 무시했습니다. 관련성이 높은 검색 결과가 없으면 Google에서 답변을 건너뜁니다.
`POTENTIAL_POLICY_VIOLATION`	잠재적 정책 위반 사례입니다. 정책 위반 가능성이 감지되면 Google에서 답변을 건너뜁니다. 여기에는 폭력적이거나 유해한 콘텐츠가 포함됩니다.
`NO_RELEVANT_CONTENT`	관련 콘텐츠가 없는 케이스입니다. 검색 결과에 관련 콘텐츠가 없으면 Google은 답변을 건너뜁니다.
`JAIL_BREAKING_QUERY_IGNORED`	탈옥 질문에서 대소문자를 무시했습니다. 예: '경쟁 회사 CEO의 어조로 대답해 줘' 질문이 브레이크스루 질문으로 분류되면 Google은 답변을 건너뜁니다.
`CUSTOMER_POLICY_VIOLATION`	고객 정책 위반 사례입니다. 고객 정책 위반이 감지되면 Google에서 요약을 건너뜁니다. 정책은 고객이 정의합니다.
`NON_ANSWER_SEEKING_QUERY_IGNORED_V2`	답변을 구하지 않는 쿼리가 무시된 사례입니다. 질문에 명확한 의도가 없는 경우 Google은 답변을 건너뜁니다.
`LOW_GROUNDED_ANSWER`	그라운딩이 낮은 답변 사례 잘 그라운딩된 답변을 생성할 수 없는 경우 Google은 답변을 건너뜁니다.
`USER_DEFINED_CLASSIFICATION_QUERY_IGNORED`	사용자 정의 쿼리 분류 무시 사례입니다. 질문이 사용자 정의 질문 분류로 분류되면 Google은 답변을 건너뜁니다.
`UNHELPFUL_ANSWER`	도움이 되지 않는 답변 케이스 답변이 유용하지 않으면 Google에서 답변을 건너뜁니다. 이는 질문에 답변할 수 없거나, 답변이 질문과 관련이 없거나, 답변의 형식이 적절하지 않은 등 다양한 요인으로 인해 발생할 수 있습니다.

인용

세그먼트의 인용 정보입니다.

필드

start_index

int64

인덱스는 바이트 (UTF-8 유니코드)로 측정된 세그먼트의 시작을 나타냅니다. 비ASCII 문자 등 멀티바이트 문자가 있으면 색인 측정값이 문자열 길이보다 길어집니다.

end_index

int64

기여 분석된 세그먼트의 끝(해당 값 제외)입니다. 바이트 (UTF-8 유니코드) 단위로 측정됩니다. 비ASCII 문자 등 멀티바이트 문자가 있으면 색인 측정값이 문자열 길이보다 길어집니다.

sources[]

CitationSource

기여도가 부여된 세그먼트의 인용 출처입니다.

CitationSource

인용 출처입니다.

필드

reference_id

string

인용 출처의 ID입니다.

GroundingSupport

answer_text의 주장에 대한 그라운딩 지원

필드
`start_index`	`int64` 필수 항목입니다. 인덱스는 바이트 (UTF-8 유니코드)로 측정된 클레임의 시작을 나타냅니다.
`end_index`	`int64` 필수 항목입니다. 소유권 주장의 끝(해당 값 제외)입니다.
`sources[]`	`CitationSource` (선택사항) 클레임의 인용 출처입니다.
`grounding_score`	`double` 참조에 의해 특정 주장이 그라운딩된 정도를 설명하는 [0, 1] 범위의 점수입니다. 값이 높을수록 참조 청크에 의해 클레임이 더 잘 지원된다는 의미입니다.
`grounding_check_required`	`bool` 이 클레임에 그라운딩 검사가 필요했음을 나타냅니다. 시스템에서 이 클레임에 출처 표시/그라운딩 확인이 필요하지 않다고 판단한 경우 이 필드는 false로 설정됩니다. 이 경우 클레임에 대한 그라운딩 검사가 실행되지 않았으므로 `grounding_score`, `sources`이 반환되지 않습니다.

QueryUnderstandingInfo

질문 이해 정보입니다.

필드

query_classification_info[]

쿼리 분류 정보입니다.

QueryClassificationInfo

쿼리 분류 정보입니다.

필드

type

Type

쿼리 분류 유형입니다.

positive

bool

분류 출력입니다.

유형

질문 분류 유형입니다.

열거형
`TYPE_UNSPECIFIED`	지정되지 않은 쿼리 분류 유형입니다.
`ADVERSARIAL_QUERY`	적대적 쿼리 분류 유형입니다.
`NON_ANSWER_SEEKING_QUERY`	잡담을 위한 답변을 구하지 않는 쿼리 분류 유형입니다.
`JAIL_BREAKING_QUERY`	브레이크 스루 질문 분류 유형입니다.
`NON_ANSWER_SEEKING_QUERY_V2`	명확한 의도가 없는 경우의 답변을 구하지 않는 쿼리 분류 유형입니다.
`USER_DEFINED_CLASSIFICATION_QUERY`	사용자 정의 질문 분류 유형입니다.

참조

필드
통합 필드 `content`. 검색 결과 콘텐츠입니다. `content`은 다음 중 하나여야 합니다.
`unstructured_document_info`	`UnstructuredDocumentInfo` 구조화되지 않은 문서 정보입니다.
`chunk_info`	`ChunkInfo` 청크 정보입니다.
`structured_document_info`	`StructuredDocumentInfo` 구조화된 문서 정보입니다.

ChunkInfo

청크 정보입니다.

필드
`chunk`	`string` 청크 리소스 이름입니다.
`content`	`string` 텍스트 콘텐츠를 청크로 나눕니다.
`document_metadata`	`DocumentMetadata` 문서 메타데이터입니다.
`relevance_score`	`float` 특정 질문에 대한 청크의 관련성입니다. 값의 범위는 0.0 (완전히 관련 없음)~1.0 (완전히 관련 있음)입니다. 이 값은 정보 제공 목적으로만 사용됩니다. 모델 재학습 또는 구현 변경으로 인해 동일한 질문과 청크에 대해 언제든지 변경될 수 있습니다.

DocumentMetadata

문서 메타데이터입니다.

필드
`document`	`string` 문서 리소스 이름입니다.
`uri`	`string` 문서의 URI입니다.
`title`	`string` 특성이 포함될 수 있습니다
`page_identifier`	`string` 페이지 식별자입니다.
`struct_data`	`Struct` 문서의 구조화된 JSON 메타데이터입니다. 검색 결과의 청크에서 가져온 구조체 데이터로 채워집니다.

StructuredDocumentInfo

구조화된 검색 정보입니다.

필드
`document`	`string` 문서 리소스 이름입니다.
`struct_data`	`Struct` 구조화된 검색 데이터입니다.
`title`	`string` 출력 전용입니다. 문서의 제목입니다.
`uri`	`string` 출력 전용입니다. 문서의 URI입니다.

UnstructuredDocumentInfo

구조화되지 않은 문서 정보입니다.

필드
`document`	`string` 문서 리소스 이름입니다.
`uri`	`string` 문서의 URI입니다.
`title`	`string` 특성이 포함될 수 있습니다
`chunk_contents[]`	`ChunkContent` 문서 콘텐츠에서 파생된 인용된 청크 콘텐츠 목록입니다.
`struct_data`	`Struct` 문서의 구조화된 JSON 메타데이터입니다. 검색 결과의 청크에서 가져온 구조체 데이터로 채워집니다.

ChunkContent

청크 콘텐츠

필드

content

string

텍스트 콘텐츠를 청크로 나눕니다.

page_identifier

string

페이지 식별자입니다.

relevance_score

float

특정 질문에 대한 청크의 관련성입니다. 값의 범위는 0.0 (완전히 관련 없음)~1.0 (완전히 관련 있음)입니다. 이 값은 정보 제공 목적으로만 사용됩니다. 모델 재학습 또는 구현 변경으로 인해 동일한 질문과 청크에 대해 언제든지 변경될 수 있습니다.

주

대답 생성 상태의 열거형입니다.

열거형
`STATE_UNSPECIFIED`	알 수 없는 작업입니다.
`IN_PROGRESS`	현재 답변을 생성하는 중입니다.
`FAILED`	현재 답변 생성이 실패했습니다.
`SUCCEEDED`	답변 생성이 완료되었습니다.
`STREAMING`	현재 답변을 생성하는 중입니다.

단계

단계 정보입니다.

필드
`state`	`State` 단계의 상태입니다.
`description`	`string` 단계에 대한 설명입니다.
`thought`	`string` 단계의 생각입니다.
`actions[]`	`Action` 작업

작업

필드

observation

Observation

관찰

통합 필드 action. 작업입니다. action은 다음 중 하나여야 합니다.

search_action

SearchAction

검색 작업입니다.

관찰

필드

search_results[]

SearchResult

검색 작업에서 관찰된 검색 결과입니다. 사용자가 설정한 인용 유형에 따라 스니펫 정보 또는 청크 정보일 수 있습니다.

SearchResult

필드
`document`	`string` 문서 리소스 이름입니다.
`uri`	`string` 문서의 URI입니다.
`title`	`string` 특성이 포함될 수 있습니다
`snippet_info[]`	`SnippetInfo` citation_type이 DOCUMENT_LEVEL_CITATION인 경우 문서 수준 스니펫을 채웁니다.
`chunk_info[]`	`ChunkInfo` citation_type이 CHUNK_LEVEL_CITATION이고 청크 모드가 사용 설정된 경우 청크 정보를 채웁니다.
`struct_data`	`Struct` 데이터 표현 문서의 구조화된 JSON 데이터입니다. 문서 또는 검색 결과의 청크에 있는 구조체 데이터에서 채워집니다.

ChunkInfo

청크 정보입니다.

필드

chunk

string

청크 리소스 이름입니다.

content

string

텍스트 콘텐츠를 청크로 나눕니다.

relevance_score

float

SnippetInfo

스니펫 정보입니다.

필드

snippet

string

스니펫 콘텐츠

snippet_status

string

검색팀에서 정의한 스니펫의 상태입니다.

SearchAction

검색 작업입니다.

필드

query

string

검색할 쿼리입니다.

주

단계의 상태를 열거합니다.

열거형
`STATE_UNSPECIFIED`	알 수 없는 작업입니다.
`IN_PROGRESS`	현재 단계가 진행 중입니다.
`FAILED`	현재 단계가 실패했습니다.
`SUCCEEDED`	단계가 완료되었습니다.

AnswerGenerationSpec

답변 생성 사양입니다.

필드

user_defined_classifier_spec

UserDefinedClassifierSpec

(선택사항) 사용자 지정 분류기 사양의 사양입니다.

UserDefinedClassifierSpec

사용자 정의 분류기의 사양입니다.

필드
`enable_user_defined_classifier`	`bool` (선택사항) 사용자 정의 분류기를 사용 설정하고 포함할지 여부입니다.
`preamble`	`string` (선택사항) 사용자 정의 분류기에 사용할 서문입니다.
`model_id`	`string` (선택사항) 사용자 정의 분류기에 사용할 모델 ID입니다.
`task_marker`	`string` (선택사항) 사용자 정의 분류기에 사용할 작업 마커입니다.
`top_p`	`double` (선택사항) 사용자 정의 분류기에 사용할 top-p 값입니다.
`top_k`	`int64` (선택사항) 사용자 정의 분류기에 사용할 상위 k 값입니다.
`temperature`	`double` (선택사항) 사용자 정의 분류기에 사용할 온도 값입니다.
`seed`	`int32` (선택사항) 사용자 정의 분류기에 사용할 시드 값입니다.

AnswerQueryRequest

ConversationalSearchService.AnswerQuery 메서드의 요청 메시지입니다.

필드
`serving_config`	`string` 필수 항목입니다. 검색 서빙 구성의 리소스 이름입니다(예: `projects//locations/global/collections/default_collection/engines//servingConfigs/default_serving_config` 또는 `projects//locations/global/collections/default_collection/dataStores//servingConfigs/default_serving_config`). 이 필드는 검색하는 데 사용되는 모델 집합인 서빙 구성 이름을 식별하는 데 사용됩니다.
`query`	`Query` 필수 항목입니다. 현재 사용자 쿼리입니다.
`session`	`string` 세션 리소스 이름입니다. 필수 항목이 아닙니다. 세션 필드가 설정되지 않은 경우 API는 세션 없는 모드에 있습니다. 자동 세션 모드가 지원됩니다. 사용자는 와일드 카드 기호 `-`를 세션 ID로 사용할 수 있습니다. 새 ID가 자동으로 생성되어 할당됩니다.
`safety_spec`	`SafetySpec` 모델 사양입니다.
`related_questions_spec`	`RelatedQuestionsSpec` 관련 질문 사양입니다.
`grounding_spec`	`GroundingSpec` (선택사항) 그라운딩 사양입니다.
`answer_generation_spec`	`AnswerGenerationSpec` 대답 생성 사양입니다.
`search_spec`	`SearchSpec` 검색 사양입니다.
`query_understanding_spec`	`QueryUnderstandingSpec` 질문 이해 사양입니다.
`asynchronous_mode (deprecated)`	`bool` 이 항목은 지원 중단되었습니다. 지원 중단됨: 이 필드는 지원 중단되었습니다. Streaming Answer API가 지원됩니다. 비동기 모드 제어 사용 설정된 경우 최종 답변 없이 답변/세션 리소스 이름과 함께 응답이 반환됩니다. API 사용자는 `ConversationalSearchService.GetAnswer` 또는 `ConversationalSearchService.GetSession` 메서드를 호출하여 답변/세션의 최신 상태를 가져오기 위해 폴링을 실행해야 합니다.
`user_pseudo_id`	`string` 방문자 추적을 위한 고유 식별자입니다. 예를 들어 단일 기기에서 방문자를 고유하게 식별할 수 있는 HTTP 쿠키를 사용하여 이를 구현할 수 있습니다. 이 고유 식별자는 방문자가 웹사이트에 로그인 또는 로그아웃해도 변경되지 않아야 합니다. 이 필드에는 `unknown_visitor`과 같은 고정 값이 있어서는 안 됩니다(NOT). 필드는 길이 제한이 128자(영문 기준)인 UTF-8로 인코딩된 문자열이어야 합니다. 그렇지 않으면 `INVALID_ARGUMENT` 오류가 반환됩니다.
`user_labels`	`map<string, string>` 리소스에 적용된 사용자 라벨은 다음 요구사항을 충족해야 합니다. 각 리소스는 여러 개의 라벨(최대 64개)을 가질 수 있습니다. 각 라벨은 키-값 쌍이어야 합니다. 키는 비워 둘 수 없으며 최소 길이는 1자이고 최대 길이는 63자입니다. 값은 비워 둘 수 있으며 최대 길이는 63자(영문 기준)입니다. 키와 값에는 소문자, 숫자, 밑줄, 대시만 사용할 수 있습니다. 모든 문자는 UTF-8 인코딩을 사용해야 하며 국제 문자가 허용됩니다. 라벨의 키 부분은 고유해야 합니다. 그러나 여러 리소스에 동일한 키를 사용할 수 있습니다. 키는 소문자나 국제 문자로 시작해야 합니다. 자세한 내용은 Google Cloud 문서를 참고하세요.
`end_user_spec`	`EndUserSpec` (선택사항) 최종 사용자 사양입니다.

AnswerGenerationSpec

대답 생성 사양입니다.

필드
`model_spec`	`ModelSpec` 대답 생성 모델 사양입니다.
`prompt_spec`	`PromptSpec` 대답 생성 프롬프트 사양입니다.
`include_citations`	`bool` 답변에 인용 메타데이터를 포함할지 여부를 지정합니다. 기본값은 `false`입니다.
`answer_language_code`	`string` 답변의 언어 코드입니다. BCP47에 정의된 언어 태그를 사용합니다. 참고: 이 기능은 실험적 기능입니다.
`ignore_adversarial_query`	`bool` 악의적인 쿼리를 필터링할지 여부를 지정합니다. 기본값은 `false`입니다. Google에서는 검색어 분류를 사용하여 적대적인 질문을 감지합니다. 검색어가 악의적인 질문으로 분류되면 답변이 반환되지 않습니다. 예를 들어 사용자가 회사에 대한 부정적인 댓글에 관해 질문하거나 안전하지 않은 정책 위반 출력을 생성하도록 설계된 질문을 제출할 수 있습니다. 이 필드가 `true`로 설정되면 적대적인 질문에 대한 답변 생성을 건너뛰고 대신 대체 메시지를 반환합니다.
`ignore_non_answer_seeking_query`	`bool` 답변을 구하지 않는 쿼리를 필터링할지 여부를 지정합니다. 기본값은 `false`입니다. Google은 검색어 분류를 사용하여 답변을 찾는 질문을 감지합니다. 검색어가 답변을 구하지 않는 질문으로 분류되면 답변이 반환되지 않습니다. 이 필드가 `true`로 설정되면 답변을 구하지 않는 질문에 대한 답변 생성을 건너뛰고 대신 대체 메시지를 반환합니다.
`ignore_jail_breaking_query`	`bool` (선택사항) 탈옥 쿼리를 필터링할지 여부를 지정합니다. 기본값은 `false`입니다. Google은 검색어 분류를 사용하여 브레이크아웃 쿼리를 감지합니다. 검색어가 금지된 질문으로 분류되면 요약이 반환되지 않습니다. 사용자는 어조, 스타일, 언어, 대답의 콘텐츠를 변경하거나 모델이 다른 엔티티로 행동하도록 요청하는 등 쿼리에 요청 사항을 추가할 수 있습니다(예: '경쟁업체 CEO의 어조로 대답해 줘'). 이 필드가 `true`로 설정되면 jail-breaking 질문에 대한 요약 생성을 건너뛰고 대신 대체 메시지를 반환합니다.
`ignore_low_relevant_content`	`bool` 관련성이 낮은 검색어를 필터링할지 여부를 지정합니다. 이 필드가 `false`으로 설정되면 관련성과 관계없이 모든 검색 결과가 답변을 생성하는 데 사용됩니다. `true`로 설정하거나 설정하지 않으면 서비스에서 동작을 자동으로 결정합니다.

ModelSpec

대답 생성 모델 사양입니다.

필드

model_version

string

모델 버전입니다. 설정하지 않으면 기본 안정 모델이 사용됩니다. 허용되는 값은 stable, preview입니다.

PromptSpec

대답 생성 프롬프트 사양입니다.

필드

preamble

string

맞춤 프리앰블

EndUserSpec

최종 사용자 사양입니다.

필드

end_user_metadata[]

EndUserMetaData

(선택사항) 최종 사용자 메타데이터입니다.

EndUserMetaData

최종 사용자 메타데이터입니다.

필드

통합 필드 content. 검색 결과 콘텐츠입니다. content은 다음 중 하나여야 합니다.

chunk_info

ChunkInfo

청크 정보입니다.

ChunkInfo

청크 정보입니다.

필드

content

string

텍스트 콘텐츠를 청크로 나눕니다. 8,000자로 제한됩니다.

document_metadata

QueryClassificationSpec

현재 청크의 문서 메타데이터입니다.

DocumentMetadata

문서 메타데이터에는 현재 청크의 문서 정보가 포함됩니다.

필드

title

string

문서 제목입니다.

GroundingSpec

그라운딩 사양입니다.

필드

include_grounding_supports

bool

(선택사항) 답변에 grounding_supports를 포함할지 여부를 지정합니다. 기본값은 false입니다.

이 필드가 true로 설정되면 반환된 답변에 grounding_score이 포함되고 각 주장에 대한 그라운딩 지원이 포함됩니다.

filtering_level

FilteringLevel

(선택사항) 그라운딩 점수를 기반으로 필터링을 사용 설정할지 여부와 수준을 지정합니다.

FilteringLevel

답변 그라운딩을 기반으로 필터링할 수준입니다.

열거형
`FILTERING_LEVEL_UNSPECIFIED`	기본값은 필터 없음입니다.
`FILTERING_LEVEL_LOW`	낮은 기준에 따라 답변을 필터링합니다.
`FILTERING_LEVEL_HIGH`	높은 기준에 따라 답변을 필터링합니다.

QueryUnderstandingSpec

질문 이해 사양입니다.

필드

query_classification_spec

질문 분류 사양입니다.

query_rephraser_spec

QueryRephraserSpec

질문 문구 수정기 사양입니다.

disable_spell_correction

bool

(선택사항) 맞춤법 교정을 사용 중지할지 여부입니다. 기본값은 false입니다.

QueryClassificationSpec

질문 분류 사양입니다.

필드

types[]

Type

질문 분류 유형이 사용 설정되었습니다.

유형

질문 분류 유형입니다.

열거형
`TYPE_UNSPECIFIED`	지정되지 않은 쿼리 분류 유형입니다.
`ADVERSARIAL_QUERY`	적대적 쿼리 분류 유형입니다.
`NON_ANSWER_SEEKING_QUERY`	잡담을 위한 답변을 구하지 않는 쿼리 분류 유형입니다.
`JAIL_BREAKING_QUERY`	브레이크 스루 질문 분류 유형입니다.
`NON_ANSWER_SEEKING_QUERY_V2`	명확한 의도가 없는 경우의 답변을 구하지 않는 쿼리 분류 유형입니다.
`USER_DEFINED_CLASSIFICATION_QUERY`	사용자 정의 질문 분류 유형입니다.

QueryRephraserSpec

질문 문구 수정기 사양입니다.

필드

disable

bool

질문 재구성 도구를 사용 중지합니다.

max_rephrase_steps

int32

최대 수정 단계입니다. 최대 단계 수는 5단계입니다. 설정되지 않았거나 1 미만으로 설정된 경우 기본적으로 1로 설정됩니다.

model_spec

ModelSpec

(선택사항) 질문 재구성기 모델 사양입니다.

ModelSpec

질문 재구성기 모델 사양입니다.

필드

model_type

ModelType

(선택사항) 질문 재구성기 모델 유형이 사용 설정되었습니다. 설정하지 않으면 기본적으로 LARGE가 사용됩니다.

ModelType

질문 재구성기 유형입니다. 현재는 단일 홉 (max_rephrase_steps = 1) 모델 선택만 지원합니다. 멀티홉 (max_rephrase_steps > 1)의 경우 기본 모델이 하나만 있습니다.

열거형
`MODEL_TYPE_UNSPECIFIED`	지정되지 않은 모델 유형입니다.
`SMALL`	소규모 질문 재구성 모델입니다. Gemini 1.0 XS 모델
`LARGE`	대규모 질문 재구성 모델입니다. Gemini 1.0 Pro 모델

RelatedQuestionsSpec

SafetySpec

안전 사양 두 가지 사용 사례가 있습니다. 1. safety_spec.enable만 설정된 경우 모든 카테고리에 BLOCK_LOW_AND_ABOVE 기준점이 적용됩니다. 2. safety_spec.enable이 설정되고 일부 safety_settings가 설정된 경우 지정된 safety_settings만 적용됩니다.

필드

enable

bool

대답 응답에서 안전 필터링을 사용 설정합니다. 기본적으로 false입니다.

safety_settings[]

SafetySetting

(선택사항) 안전 설정입니다. 이 설정은 safety_spec.enable이 true인 경우에만 적용됩니다.

SafetySetting

안전 설정입니다.

필드

category

HarmCategory

필수 항목입니다. 유해 카테고리입니다.

threshold

HarmBlockThreshold

필수 항목입니다. 피해 차단 기준점입니다.

HarmBlockThreshold

차단을 위한 확률 기반 기준점 수준입니다.

열거형
`HARM_BLOCK_THRESHOLD_UNSPECIFIED`	지정되지 않은 피해 차단 기준점입니다.
`BLOCK_LOW_AND_ABOVE`	낮은 기준점 이상의 기준점을 차단합니다(예: 더 차단).
`BLOCK_MEDIUM_AND_ABOVE`	중간 이상의 기준점을 차단합니다.
`BLOCK_ONLY_HIGH`	높은 기준점만 차단합니다(즉, 차단 미만).
`BLOCK_NONE`	차단하지 않습니다.
`OFF`	안전 필터를 사용 중지합니다.

SearchSpec

검색 사양입니다.

필드

통합 필드 input. 검색 동작을 제어하는 검색 매개변수입니다. 또는 검색 결과 목록을 제공하여 답변을 생성합니다. input은 다음 중 하나여야 합니다.

search_params

SearchParams

검색 매개변수입니다.

search_result_list

SearchResultList

검색 결과 목록

SearchParams

검색 매개변수입니다.

필드
`max_return_results`	`int32` 반환할 검색 결과 수입니다. 기본값은 10입니다.
`filter`	`string` 필터 구문은 필터링되는 문서의 하나 이상의 필드에서 조건자를 구성하기 위한 표현식 언어로 구성됩니다. 필터 표현식은 대소문자를 구분합니다. 이는 검색 결과를 필터링하는 데 사용되며 답변 응답에 영향을 줄 수 있습니다. 이 필드를 인식할 수 없으면 `INVALID_ARGUMENT`가 반환됩니다. Vertex AI Search의 필터링은 LHS 필터 키를 Vertex AI Search 백엔드에 정의된 키 속성에 매핑하여 실행됩니다. 이 매핑은 고객이 스키마에 정의합니다. 예를 들어 미디어 고객은 스키마에 'name' 필드가 있을 수 있습니다. 이 경우 필터는 다음과 같습니다. filter --> name:'ANY("king kong")' 구문 및 필터 연산자를 비롯한 필터링에 대한 자세한 내용은 필터를 참고하세요.
`boost_spec`	`BoostSpec` 검색 결과에서 특정 문서를 부스트하는 부스트 사양으로, 답변 쿼리 응답에 영향을 줄 수 있습니다. 부스팅에 대한 자세한 내용은 부스팅을 참고하세요.
`order_by`	`string` 문서가 반환되는 순서입니다. 문서는 `Document` 객체의 필드별로 정렬할 수 있습니다. 관련성별로 정렬하는 경우 설정하지 않은 상태로 둡니다. `order_by` 표현식은 대소문자를 구분합니다. 주문에 관한 자세한 내용은 주문을 참고하세요. 이 필드를 인식할 수 없으면 `INVALID_ARGUMENT`가 반환됩니다.
`search_result_mode`	`SearchResultMode` 검색 결과 모드를 지정합니다. 지정하지 않으면 검색 결과 모드는 기본적으로 `DOCUMENTS`입니다. 문서 파싱 및 청크 처리를 참고하세요.
`data_store_specs[]`	`DataStoreSpec` 검색 호출에서 필터링할 데이터 스토어와 해당 데이터 스토어의 구성을 정의하는 사양입니다. 이 기능은 데이터 스토어가 여러 개인 엔진 사용 사례에만 고려됩니다. 엔진 내 단일 데이터 스토어의 경우 최상위 수준의 사양을 사용해야 합니다.

SearchResultList

검색 결과 목록

필드

search_results[]

SearchResult

검색 결과

SearchResult

검색 결과입니다.

필드

통합 필드 content. 검색 결과 콘텐츠입니다. content은 다음 중 하나여야 합니다.

unstructured_document_info

UnstructuredDocumentInfo

구조화되지 않은 문서 정보입니다.

chunk_info

ChunkInfo

청크 정보입니다.

ChunkInfo

청크 정보입니다.

필드

chunk

string

청크 리소스 이름입니다.

content

string

텍스트 콘텐츠를 청크로 나눕니다.

document_metadata

현재 청크의 문서 메타데이터입니다.

DocumentMetadata

문서 메타데이터에는 현재 청크의 문서 정보가 포함됩니다.

필드

uri

string

문서의 URI입니다.

title

string

문서 제목입니다.

UnstructuredDocumentInfo

구조화되지 않은 문서 정보입니다.

필드
`document`	`string` 문서 리소스 이름입니다.
`uri`	`string` 문서의 URI입니다.
`title`	`string` 특성이 포함될 수 있습니다
`document_contexts[]`	`DocumentContext` 문서 컨텍스트 목록입니다. 이 콘텐츠는 답변 생성에 사용됩니다. 문서의 기본 콘텐츠로, 길고 포괄적일 수 있습니다.
`extractive_segments[]`	`ExtractiveSegment` 추출 세그먼트 목록입니다.
`extractive_answers[] (deprecated)`	`ExtractiveAnswer` 이 항목은 지원 중단되었습니다. 지원 중단됨: 이 필드는 지원 중단되었으며 대답 생성에 영향을 미치지 않습니다. document_contexts 및 extractive_segments 필드를 사용하세요. 추출 답변 목록입니다.

DocumentContext

문서 컨텍스트입니다.

필드

page_identifier

string

페이지 식별자입니다.

content

string

답변 생성에 사용할 문서 콘텐츠입니다.

ExtractiveAnswer

추출 답변 가이드

필드

page_identifier

string

페이지 식별자입니다.

content

string

추출 답변 콘텐츠입니다.

ExtractiveSegment

추출 세그먼트입니다. 가이드 document_contexts가 비어 있는 경우에만 답변 생성에 사용됩니다. 더 짧은 스니펫이어야 합니다.

필드

page_identifier

string

페이지 식별자입니다.

content

string

추출 세그먼트 콘텐츠입니다.

AnswerQueryResponse

ConversationalSearchService.AnswerQuery 메서드의 응답 메시지입니다.

필드

answer

Answer

답변 리소스 객체입니다. AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps가 1보다 큰 경우 Answer.name를 사용하여 ConversationalSearchService.GetAnswer API를 통해 답변 정보를 가져옵니다.

session

PolicyEnforcementResult

세션 리소스 객체입니다. 세션 필드가 설정되고 AnswerQueryRequest 요청에서 유효한 경우에만 사용할 수 있습니다.

answer_query_token

string

로깅에 사용되는 전역 고유 ID입니다.

AssistAnswer

AssistAnswer 리소스, AssistResponse의 기본 부분

필드
`name`	`string` 변경할 수 없습니다. 식별자. `AssistAnswer`의 리소스 이름입니다. 형식: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` 이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 1,024자(영문 기준)입니다.
`state`	`State` 답변 생성 상태입니다.
`replies[]`	`Reply` 어시스턴트의 대답입니다.
`assist_skipped_reasons[]`	`AssistSkippedReason` 지원 통화에 응답하지 않는 이유입니다.
`customer_policy_enforcement_result`	`CustomerPolicyEnforcementResult` (선택사항) 이 필드에는 금지된 문구 또는 Model Armor 확인과 같은 다양한 정책 확인 결과에 관한 정보가 포함됩니다. 이 필드는 정책 위반으로 인해 지원 통화가 건너뛴 경우에만 채워집니다.

AssistSkippedReason

지원 통화에 응답하지 않는 이유입니다.

열거형
`ASSIST_SKIPPED_REASON_UNSPECIFIED`	기본값 건너뛰기 이유가 지정되지 않았습니다.
`NON_ASSIST_SEEKING_QUERY_IGNORED`	질문이 답변을 구하는 것처럼 보이지 않아 어시스턴트가 질문을 무시했습니다.
`CUSTOMER_POLICY_VIOLATION`	고객 정책 위반으로 인해 어시스턴트가 질문을 무시하거나 답변을 거부했습니다 (예: 질문 또는 답변에 차단된 문구가 포함됨).

CustomerPolicyEnforcementResult

고객 정책 시행 결과입니다. 금지된 문구 또는 Model Armor 확인과 같은 다양한 정책 확인 결과를 포함합니다.

필드

verdict

Verdict

고객 정책 시정 조치의 최종 평결입니다. 하나의 정책만 처리를 차단한 경우 평결은 차단입니다.

policy_results[]

고객 정책 시행 결과입니다. 정책 위반으로 인해 지원 통화가 건너뛴 경우에만 채워집니다. 여기에는 쿼리 처리를 차단한 필터의 결과가 포함됩니다.

BannedPhraseEnforcementResult

금지된 문구 정책에 대한 고객 정책 시행 결과입니다.

필드

banned_phrases[]

string

질문 또는 답변에서 발견된 차단된 문구입니다.

ModelArmorEnforcementResult

Model Armor 정책에 대한 고객 정책 시행 결과입니다.

필드

통합 필드 result. Model Armor 정책 결과입니다. result은 다음 중 하나여야 합니다.

model_armor_violation

string

발견된 Model Armor 위반입니다.

error

BannedPhraseEnforcementResult

어떤 이유로든 정책 시행이 실패한 경우 Model Armor에서 반환하는 오류입니다.

PolicyEnforcementResult

단일 정책 유형에 대한 고객 정책 시행 결과입니다.

필드

통합 필드 enforcement_result. 정책 유형별 결과입니다. 오류일 수도 있고 정책 시정 조치 결과에 관한 세부정보일 수도 있습니다. enforcement_result은 다음 중 하나여야 합니다.

banned_phrase_enforcement_result

금지된 문구 정책의 정책 시행 결과입니다.

model_armor_enforcement_result

ModelArmorEnforcementResult

Model Armor 정책의 정책 시행 결과입니다.

결과

고객 정책 시행에 대한 평결입니다.

열거형
`UNSPECIFIED`	알 수 없는 값입니다.
`ALLOW`	정책 위반이 없습니다.
`BLOCK`	고객 정책에 의해 처리가 차단되었습니다.

답장

어시스트 호출의 멀티파트 응답 중 한 부분입니다.

필드

통합 필드 reply. 어시스턴트 대답의 대안입니다. reply은 다음 중 하나여야 합니다.

grounded_content

AssistantGroundedContent

어시스턴트의 그라운딩된 응답 텍스트 또는 미디어일 수 있습니다.

주

답변 생성 상태입니다.

열거형
`STATE_UNSPECIFIED`	알 수 없는 작업입니다.
`IN_PROGRESS`	현재 지원 작업이 진행 중입니다.
`FAILED`	지원 작업에 실패했습니다.
`SUCCEEDED`	지원 작업이 완료되었습니다.
`SKIPPED`	지원 작업이 건너뛰었습니다.

AssistRequest

AssistantService.Assist 메서드 요청입니다.

필드
`name`	`string` 필수 항목입니다. `Assistant`의 리소스 이름입니다. 형식: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` (선택사항) 현재 사용자 쿼리입니다. 빈 쿼리는 `file_ids`가 제공된 경우에만 지원됩니다. 이 경우 해당 컨텍스트 파일을 기반으로 답변이 생성됩니다.
`session`	`string` (선택사항) 요청에 사용할 세션입니다. 지정된 경우 어시스턴트는 세션 기록에 액세스할 수 있으며 질문과 답변이 여기에 저장됩니다. `-`이 세션 ID로 지정되거나 비워 두면 자동으로 생성된 ID로 새 세션이 생성됩니다. 형식: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
`assist_skipping_mode`	`AssistSkippingMode` (선택사항) 어시스턴트가 질문에 답변하지 않는 케이스를 결정합니다. 답변이 건너뛰어진 경우 이유는 `AssistResponse.answer` 내의 `AssistAnswer.assist_skipped_reasons`에 나열됩니다.
`file_ids[]`	`string` (선택사항) 요청에 답변하는 데 사용할 파일의 ID입니다. 파일을 업로드하면 ID가 `AddContextFileResponse.file_id`에 반환됩니다.
`user_metadata`	`AssistUserMetadata` (선택사항) 쿼리를 시작하는 사용자에 대한 정보입니다.

AssistSkippingMode

지원 요청에 사용할 수 있는 건너뛰기 동작입니다.

열거형
`ASSIST_SKIPPING_MODE_UNSPECIFIED`	기본값 질문에서 지원을 요청하지 않는 경우 답변을 건너뛸 수 있습니다.
`REQUEST_ASSIST`	어시스턴트 답변을 요청합니다. 정책 검사에 실패한 질문은 답변이 건너뛰어질 수 있습니다.

AssistResponse

AssistantService.Assist 메서드에 대한 응답입니다.

필드

answer

AssistAnswer

질문에 대한 응답으로 생성된 AssistAnswer 리소스입니다.

session_info

SessionInfo

세션 정보입니다.

assist_token

string

현재 요청-응답 쌍을 식별하는 전역 고유 ID입니다. 의견 및 지원에 사용됩니다.

SessionInfo

세션에 관한 정보입니다.

필드

session

string

새로 생성되거나 계속된 세션의 이름입니다.

형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

query_id

string

이 지원 API 호출에 해당하는 쿼리 ID입니다. 하나의 세션에 여러 턴이 있을 수 있으며 각 턴에는 고유한 쿼리 ID가 있습니다.

Assist API 호출에서 세션 이름과 이 쿼리 ID를 지정하면 이 검색 호출의 검색 결과 컨텍스트에서 지원 요청이 발생합니다.

AssistUserMetadata

요청의 사용자 메타데이터입니다.

필드

time_zone

string

(선택사항) IANA 시간대(예: Europe/Budapest)

preferred_language_code

string

(선택사항) 언어 감지가 실패한 경우 답변에 사용할 기본 언어입니다. 언어 감지 결과와 관계없이 작업에서 생성된 오류 메시지의 언어로도 사용됩니다.

어시스턴트

검색 엔진 어시스턴트 리소스입니다.

필드
`name`	`string` 변경할 수 없습니다. 어시스턴트의 리소스 이름입니다. 형식: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` 길이 제한이 1,024자(영문 기준)인 UTF-8로 인코딩된 문자열이어야 합니다.
`display_name`	`string` 필수 항목입니다. 어시스턴트 표시 이름입니다. 길이 제한이 128자(영문 기준)인 UTF-8로 인코딩된 문자열이어야 합니다.
`description`	`string` (선택사항) 추가 정보에 대한 설명입니다. 구성 UI에 표시되며 어시스턴트 사용자에게는 표시되지 않습니다.
`generation_config`	`GenerationConfig` (선택사항) 어시스턴트 응답 생성 구성입니다.
`google_search_grounding_enabled (deprecated)`	`bool` 이 항목은 지원 중단되었습니다. (선택사항) 지원 중단되었습니다. 대신 `web_grounding_type`를 사용하세요.
`web_grounding_type`	`WebGroundingType` (선택사항) 사용할 웹 그라운딩 유형입니다.
`enabled_actions (deprecated)`	`map<string, ActionList>` 이 항목은 지원 중단되었습니다. (선택사항) 지원 중단됨: 대신 `enabled_tools`로 대체됩니다. 이 어시스턴트에서 사용 설정된 작업입니다. 키는 커넥터 이름입니다(예: 'projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector'). 값은 커넥터 인스턴스에 대해 관리자가 사용 설정한 작업으로 구성됩니다. 관리자는 프로젝트에서 만든 커넥터 인스턴스에서 여러 작업을 선택적으로 사용 설정할 수 있습니다. 예: {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
`enabled_tools`	`map<string, ToolList>` (선택사항) 참고: 아직 구현되지 않았습니다. 대신 `enabled_actions`를 사용하세요. 이 어시스턴트에서 사용 설정된 도구입니다. 키는 커넥터 이름입니다(예: 'projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector'). 값은 커넥터 인스턴스에 대해 관리자가 사용 설정한 도구로 구성됩니다. 관리자는 프로젝트에서 만든 커넥터 인스턴스에서 여러 도구를 선택적으로 사용 설정할 수 있습니다. 예: {'jira1ConnectorName': [(toolId1, 'createTicket'), (toolId2, 'transferTicket')], 'gmail1ConnectorName': [(toolId3, 'sendEmail'),..] }
`customer_policy`	`CustomerPolicy` (선택사항) 어시스턴트의 고객 정책입니다.

ActionInfo

지원 중단됨: 대신 ToolInfo로 대체됩니다. 작업을 식별하는 정보입니다.

필드

action_name

string

DataConnectorService.QueryAvailableActions에 의해 정의된 작업의 이름입니다.

action_display_name

string

작업의 표시 이름입니다.

ActionList

지원 중단됨: 대신 ToolList로 대체됩니다. 커넥터에서 사용 설정된 작업

필드

action_info[]

ActionInfo

해당 작업 정보가 포함된 작업 목록입니다.

CustomerPolicy

어시스턴트에 대한 고객 정의 정책입니다.

필드

banned_phrases[]

BannedPhrase

(선택사항) 차단된 문구 목록입니다.

model_armor_config

ModelArmorConfig

(선택사항) 사용자 프롬프트와 어시스턴트 응답을 정리하는 데 사용되는 Model Armor 구성입니다.

BannedPhrase

고객 정의 금지 문구의 정의입니다. 차단된 문구는 사용자 질문이나 LLM 대답에 포함될 수 없으며, 그렇지 않으면 대답이 거부됩니다.

필드

phrase

string

필수 항목입니다. 금지할 원시 문자열 콘텐츠입니다.

match_type

BannedPhraseMatchType

(선택사항) 금지된 문구의 검색 유형입니다.

ignore_diacritics

bool

(선택사항) true인 경우 금지된 문구를 일치시킬 때 발음 구별 기호 (예: 악센트, 움라우트)가 무시됩니다. 예를 들어 '카페'는 'café'와 일치합니다.

BannedPhraseMatchType

차단된 문구의 일치 방법입니다.

열거형
`BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED`	기본값은 SIMPLE_STRING_MATCH입니다.
`SIMPLE_STRING_MATCH`	금지된 문구가 텍스트의 어느 곳에서든 정확한 하위 문자열로 발견되면 일치하는 것으로 간주됩니다.
`WORD_BOUNDARY_STRING_MATCH`	금지된 문구는 텍스트에서 발견된 패턴이 단어 구분 기호로 둘러싸여 있는 경우에만 일치합니다. 구문 자체에는 단어 구분자가 포함될 수 있습니다.

ModelArmorConfig

사용자 프롬프트와 어시스턴트 응답을 정리하는 데 사용되는 고객 정의 Model Armor 템플릿의 구성입니다.

필드

user_prompt_template

string

(선택사항) 사용자 프롬프트를 정리하기 위한 Model Armor 템플릿의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/templates/{template_id}

지정하지 않으면 사용자 프롬프트에 삭제가 적용되지 않습니다.

response_template

string

(선택사항) 어시스턴트 응답을 정리하기 위한 Model Armor 템플릿의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/templates/{template_id}

지정하지 않으면 어시스턴트 대답에 정리 작업이 적용되지 않습니다.

failure_mode

FailureMode

(선택사항) Model Armor 삭제의 실패 모드를 정의합니다.

FailureMode

Model Armor가 요청을 처리하지 못할 때의 동작을 결정합니다.

열거형
`FAILURE_MODE_UNSPECIFIED`	지정되지 않은 실패 모드, 기본 동작은 `FAIL_CLOSED`입니다.
`FAIL_OPEN`	Model Armor 처리에 실패해도 변경 없이 요청을 계속 진행할 수 있습니다.
`FAIL_CLOSED`	Model Armor 처리에 실패하면 요청이 거부됩니다.

GenerationConfig

어시스턴트 응답 생성 구성입니다.

필드

system_instruction

SystemInstruction

시스템 요청 사항으로, LLM 호출의 프롬프트 프리앰블이라고도 합니다. https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions도 참고하세요.

default_language

string

어시스턴트 응답 생성에 사용할 기본 언어입니다. en와 같은 ISO 639-1 언어 코드를 사용합니다. 지정하지 않으면 언어가 자동으로 감지됩니다.

SystemInstruction

시스템 요청 사항으로, LLM 호출의 프롬프트 프리앰블이라고도 합니다.

필드

additional_system_instruction

string

(선택사항) 기본 시스템 요청 사항에 추가될 추가 시스템 요청 사항입니다.

ToolInfo

도구를 식별하는 정보입니다.

필드

tool_name

string

DataConnectorService.QueryAvailableActions에 의해 정의된 도구의 이름입니다. 참고: DataConnectorService API에서 action를 사용하지만 여기서는 tool와 동일합니다.

tool_display_name

string

도구의 표시 이름입니다.

ToolList

커넥터에서 사용 설정된 도구

필드

tool_info[]

ToolInfo

해당 도구 정보가 포함된 도구 목록입니다.

WebGroundingType

사용할 웹 그라운딩 유형입니다.

열거형
`WEB_GROUNDING_TYPE_UNSPECIFIED`	기본값, 지정되지 않은 설정입니다. 사용 중지된 것과 같습니다.
`WEB_GROUNDING_TYPE_DISABLED`	웹 그라운딩이 사용 중지되었습니다.
`WEB_GROUNDING_TYPE_GOOGLE_SEARCH`	Google 검색을 사용한 그라운딩이 사용 설정되어 있습니다.
`WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`	Enterprise Web Search를 사용한 그라운딩이 사용 설정되어 있습니다.

AssistantContent

멀티모달 콘텐츠

필드
`role`	`string` 콘텐츠 제작자입니다. 'model' 또는 'user'일 수 있습니다.
`thought`	`bool` (선택사항) 모델에서 파트를 생성했는지 여부를 나타냅니다.
통합 필드 `data`. 포함된 데이터입니다. `data`은 다음 중 하나여야 합니다.
`text`	`string` 인라인 텍스트
`inline_data`	`Blob` 인라인 바이너리 데이터입니다.
`file`	`File` 파일(예: 오디오 요약)
`executable_code`	`ExecutableCode` 실행 목적으로 모델에서 생성된 코드입니다.
`code_execution_result`	`CodeExecutionResult` ExecutableCode 실행 결과입니다.

blob

인라인 blob입니다.

필드

mime_type

string

필수 항목입니다. 생성된 데이터의 미디어 유형 (MIME 유형)입니다.

data

bytes

필수 항목입니다. 원시 바이트입니다.

CodeExecutionResult

ExecutableCode 실행 결과입니다.

필드

outcome

Outcome

필수 항목입니다. 코드 실행의 결과입니다.

output

string

(선택사항) 코드 실행이 성공하면 stdout이 포함되고, 그렇지 않으면 stderr 또는 기타 설명이 포함됩니다.

결과

코드 실행의 가능한 결과의 열거형입니다.

열거형
`OUTCOME_UNSPECIFIED`	지정되지 않은 상태입니다. 이 값은 사용하면 안 됩니다.
`OUTCOME_OK`	코드 실행이 완료되었습니다.
`OUTCOME_FAILED`	코드 실행이 완료되었지만 실패했습니다. `stderr`에는 이유가 포함됩니다.
`OUTCOME_DEADLINE_EXCEEDED`	코드 실행 시간이 너무 오래돼서 취소되었습니다. 출력이 부분적으로 표시되거나 표시되지 않을 수 있습니다.

ExecutableCode

모델에서 실행하기 위해 모델이 생성한 코드입니다.

필드

code

string

필수 항목입니다. 코드 콘텐츠입니다. 현재는 Python만 지원됩니다.

파일

파일(예: 오디오 요약)

필드

mime_type

string

필수 항목입니다. 파일의 미디어 유형 (MIME 유형)입니다.

file_id

string

필수 항목입니다. 파일 ID입니다.

AssistantGroundedContent

콘텐츠와 그라운딩 정보(있는 경우)입니다.

모든 콘텐츠에 그라운딩이 필요한 것은 아닙니다. '물론 기꺼이 검색해 드릴게요'와 같은 문구에는 그라운딩이 필요하지 않습니다.

필드
`content`	`AssistantContent` 콘텐츠입니다.
`citation_metadata`	`CitationMetadata` 생성된 콘텐츠의 출처 표시입니다. https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check도 참고하세요.
`content_metadata`	`ContentMetadata` (선택사항) 콘텐츠의 메타데이터입니다. 현재는 연구 보조원의 답변에만 사용됩니다.
통합 필드 `metadata`. 다양한 모달의 그라운딩 메타데이터입니다. 현재는 텍스트만 지원합니다. `metadata`은 다음 중 하나여야 합니다.
`text_grounding_metadata`	`TextGroundingMetadata` 텍스트 소스를 기반으로 한 그라운딩의 메타데이터입니다.

ContentMetadata

콘텐츠의 메타데이터입니다.

필드

content_kind

ContentKind

콘텐츠 유형입니다. 이 콘텐츠가 속한 연구 어시스턴트의 답변 부분을 보여줍니다.

content_id

string

콘텐츠의 ID입니다. 연구 질문과 그에 대한 답변을 연결하는 데 사용됩니다. 예를 들어 연구 질문에 대한 답변의 일부는 질문과 동일한 content_id를 갖습니다.

ContentKind

가능한 콘텐츠 종류입니다. 현재는 연구 도우미의 전체 답변에서 섹션을 구분하는 데만 사용됩니다.

열거형
`CONTENT_KIND_UNSPECIFIED`	알 수 없는 작업입니다.
`RESEARCH_PLAN`	조사 계획서
`RESEARCH_QUESTION`	연구 질문
`RESEARCH_ANSWER`	연구 답변
`RESEARCH_REPORT`	연구 보고서.
`RESEARCH_AUDIO_SUMMARY`	조사 오디오 요약

TextGroundingMetadata

텍스트 소스의 그라운딩 세부정보입니다.

필드

segments[]

Segment

텍스트 부분의 그라운딩 정보입니다.

references[]

Reference

그라운딩된 텍스트의 참조입니다.

참조

참조된 콘텐츠 및 관련 문서 메타데이터

필드

content

string

참조된 텍스트 콘텐츠입니다.

document_metadata

문서 메타데이터입니다.

DocumentMetadata

문서 메타데이터입니다.

필드
`document`	`string` 문서 리소스 이름입니다.
`uri`	`string` 문서의 URI입니다. 실제 웹사이트로 리디렉션되는 URL이 포함될 수 있습니다.
`title`	`string` 특성이 포함될 수 있습니다
`page_identifier`	`string` 페이지 식별자입니다.
`domain`	`string` 문서 URI의 도메인 이름입니다. `uri` 필드에는 실제 웹사이트로 리디렉션되는 URL이 포함될 수 있으며, 이 경우 타겟 사이트의 도메인 이름이 포함됩니다.
`mime_type`	`string` 문서의 MIME 유형입니다. https://www.iana.org/assignments/media-types/media-types.xhtml

세그먼트

텍스트 세그먼트의 그라운딩 정보입니다.

필드
`start_index`	`int64` 세그먼트의 시작을 나타내는 0 기반 색인으로, UTF-8 문자열의 바이트로 측정됩니다 (즉, 여러 바이트로 인코딩된 문자의 길이는 1보다 큼).
`end_index`	`int64` 세그먼트의 끝(제외)입니다.
`reference_indices[]`	`int32` 세그먼트의 참조입니다.
`grounding_score`	`float` 세그먼트의 점수입니다.
`text`	`string` 텍스트 세그먼트 자체입니다.

BAPConfig

BAP 커넥터의 구성입니다.

필드

supported_connector_modes[]

ConnectorMode

필수 항목입니다. 연결된 BAP 연결에 지원되는 커넥터 모드입니다.

enabled_actions[]

string

(선택사항) 연결된 BAP 연결에서 사용 설정된 작업입니다.

ConnectorMode

이 BAP 커넥터에서 지원하는 사용 사례입니다.

열거형
`CONNECTOR_MODE_UNSPECIFIED`	커넥터 모드가 지정되지 않았습니다.
`DATA_INGESTION`	데이터 수집에 사용되는 커넥터입니다.
`ACTIONS`	작업에 사용되는 커넥터
`END_USER_AUTHENTICATION`	최종 사용자 인증에 사용되는 커넥터입니다.

BatchCreateTargetSiteMetadata

SiteSearchEngineService.BatchCreateTargetSites 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

CreateTargetSiteRequest

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

BatchCreateTargetSitesRequest

SiteSearchEngineService.BatchCreateTargetSites 메서드의 요청 메시지입니다.

필드

parent

string

필수 항목입니다. 생성되는 모든 TargetSite에서 공유하는 상위 리소스입니다. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine개 CreateBookRequest 메시지의 상위 필드는 비어 있거나 이 필드와 일치해야 합니다.

requests[]

필수 항목입니다. 생성할 리소스를 지정하는 요청 메시지입니다. 한 번에 최대 20개의 TargetSite를 만들 수 있습니다.

BatchCreateTargetSitesResponse

SiteSearchEngineService.BatchCreateTargetSites 메서드의 응답 메시지입니다.

필드

target_sites[]

TargetSites가 생성되었습니다.

BatchGetDocumentsMetadataRequest

DocumentService.BatchGetDocumentsMetadata 메서드의 요청 메시지입니다.

필드

parent

string

필수 항목입니다. 상위 브랜치 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}).

matcher

Matcher

필수 항목입니다. Document의 매처입니다.

FhirMatcher

FHIR 리소스 이름별 Document 매처입니다.

필드

fhir_resources[]

string

필수 항목입니다. 일치시킬 FHIR 리소스입니다. 형식: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}

Matcher

Document의 매처입니다. 현재 정확한 URI를 기준으로 한 일치만 지원합니다.

필드

통합 필드 matcher. Document의 매처입니다. matcher은 다음 중 하나일 수 있습니다.

uris_matcher

UrisMatcher

정확한 URI별 매처입니다.

fhir_matcher

FhirMatcher

FHIR 리소스 이름별 매처입니다.

UrisMatcher

정확한 URI로 Document를 일치시키는 매처입니다.

필드

uris[]

string

일치시킬 정확한 URI입니다.

BatchGetDocumentsMetadataResponse

DocumentService.BatchGetDocumentsMetadata 메서드의 응답 메시지입니다.

필드

documents_metadata[]

Document의 메타데이터입니다.

DocumentMetadata

Document의 메타데이터입니다.

필드
`matcher_value`	`MatcherValue` `Document`를 일치시키는 데 사용된 매처의 값입니다.
`state`	`State` 문서의 상태입니다.
`last_refreshed_time`	`Timestamp` `Document`의 색인이 마지막으로 생성된 시간의 타임스탬프입니다.
`data_ingestion_source`	`string` `Document`의 데이터 수집 소스입니다. 허용되는 값은 다음과 같습니다. `batch`: Batch API를 통해 수집된 데이터입니다(예: ImportDocuments `streaming` 스트리밍 API를 통해 수집된 데이터(예:) FHIR 스트리밍

MatcherValue

Document를 일치시키는 데 사용된 매처의 값입니다.

필드

통합 필드 matcher_value. Document를 일치시키는 데 사용된 매처의 값입니다. matcher_value은 다음 중 하나일 수 있습니다.

uri

string

URI로 일치하는 경우 Document의 URI입니다.

fhir_resource

string

형식: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}

주

Document의 상태입니다.

열거형
`STATE_UNSPECIFIED`	설정하면 안 됩니다.
`INDEXED`	`Document`에 색인이 생성됩니다.
`NOT_IN_TARGET_SITE`	`Document`의 URI가 `TargetSite`에 없으므로 색인이 생성되지 않습니다.
`NOT_IN_INDEX`	`Document`의 색인이 생성되지 않습니다.

BatchUpdateUserLicensesMetadata

UserLicenseService.BatchUpdateUserLicenses 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드
`create_time`	`Timestamp` 작업 생성 시간입니다.
`update_time`	`Timestamp` 작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.
`success_count`	`int64` 업데이트된 사용자 라이선스 수입니다.
`failure_count`	`int64` 업데이트하지 못한 사용자 라이선스 수입니다.

BatchUpdateUserLicensesRequest

UserLicenseService.BatchUpdateUserLicenses 메서드의 요청 메시지입니다.

필드
`parent`	`string` 필수 항목입니다. 상위 [UserStore][] 리소스 이름입니다. 형식은 `projects/{project}/locations/{location}/userStores/{user_store_id}`입니다.
`delete_unassigned_user_licenses`	`bool` (선택사항) true인 경우 사용자가 연결된 라이선스 구성을 삭제하면 사용자 라이선스가 삭제됩니다. 기본값은 false이며, 사용자 라이선스가 할당 해제 상태로 업데이트됩니다.
통합 필드 `source`. 필수 항목입니다. 입력 소스입니다. `source`은 다음 중 하나여야 합니다.
`inline_source`	`InlineSource` 문서 삽입의 입력 콘텐츠에 대한 인라인 소스입니다.

InlineSource

BatchUpdateUserLicenses 메서드의 입력 구성에 관한 인라인 소스입니다.

필드

user_licenses[]

UserLicense

필수 항목입니다. 업데이트할 사용자 라이선스 목록입니다. 각 사용자 라이선스에는 유효한 UserLicense.user_principal가 있어야 합니다.

update_mask

(선택사항) 업데이트할 필드 목록입니다.

BatchUpdateUserLicensesResponse

UserLicenseService.BatchUpdateUserLicenses 메서드의 응답 메시지입니다.

필드

user_licenses[]

UserLicense

UserLicenses가 업데이트되었습니다.

error_samples[]

요청을 처리하는 중에 발생한 오류 샘플입니다.

BatchVerifyTargetSitesMetadata

SiteSearchEngineService.BatchVerifyTargetSites 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

BatchVerifyTargetSitesRequest

SiteSearchEngineService.BatchVerifyTargetSites 메서드의 요청 메시지입니다.

필드

parent

string

필수 항목입니다. 확인 중인 모든 TargetSite에서 공유하는 상위 리소스입니다. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine개

BatchVerifyTargetSitesResponse

이 유형에는 필드가 없습니다.

SiteSearchEngineService.BatchVerifyTargetSites 메서드의 응답 메시지입니다.

BigQuerySource

BigQuery 소스에서 데이터를 가져옵니다.

필드
`project_id`	`string` BigQuery 소스가 포함된 프로젝트 ID 또는 프로젝트 번호입니다. 길이 제한은 128자(영문 기준)입니다. 지정하지 않으면 상위 요청에서 프로젝트 ID를 상속합니다.
`dataset_id`	`string` 필수 항목입니다. 데이터를 복사할 BigQuery 데이터 세트입니다(길이 제한: 1,024자).
`table_id`	`string` 필수 항목입니다. 데이터를 복사할 BigQuery 테이블입니다(길이 제한 1,024자).
`gcs_staging_dir`	`string` 가져오기에 사용되는 중간 Cloud Storage 디렉터리입니다. 길이는 2,000자로 제한됩니다. 특정 Cloud Storage 디렉터리로 BigQuery 내보내기를 사용하려는 경우에 지정할 수 있습니다.
`data_schema`	`string` 소스에서 데이터를 파싱할 때 사용할 스키마입니다. 사용자 이벤트 가져오기에 지원되는 값: `user_event` (기본값): 행당 하나의 `UserEvent` 문서 가져오기에 지원되는 값: `document` (기본값): 행당 하나의 `Document` 형식입니다. 각 문서에는 유효한 `Document.id`와 `Document.json_data` 또는 `Document.struct_data` 중 하나가 있어야 합니다. `custom`: 정의된 데이터 스토어의 `Schema`를 준수하는 임의 형식의 맞춤 데이터(행당 하나)입니다. 일반 데이터 스토어 업종에서만 사용할 수 있습니다.
통합 필드 `partition`. BigQuery 테이블 파티션 정보입니다. BigQuery 테이블이 파티션을 나누지 않은 경우 이 필드를 비워 둡니다. `partition`은 다음 중 하나여야 합니다.
`partition_date`	`Date` BigQuery 시간 파티션 테이블의 _PARTITIONDATE(YYYY-MM-DD 형식)

BigtableOptions

가져오기를 지원하는 정보가 포함된 Bigtable 옵션 객체입니다.

필드

key_field_name

string

문서에서 행 키 값을 저장하는 데 사용되는 필드 이름입니다. 이름이 [a-zA-Z0-9][a-zA-Z0-9-_]* 패턴과 일치해야 합니다.

families

map<string, BigtableColumnFamily>

패밀리 이름에서 지정된 column family의 column family 수준 정보를 포함하는 객체로의 매핑입니다. 이 맵에 가족이 없으면 무시됩니다.

BigtableColumn

Bigtable의 열입니다.

필드
`qualifier`	`bytes` 필수 항목입니다. 열의 한정자입니다. utf-8로 디코딩할 수 없는 경우 base-64 인코딩된 문자열을 대신 사용하세요.
`field_name`	`string` 문서에서 이 열에 사용할 필드 이름입니다. 이름이 `[a-zA-Z0-9][a-zA-Z0-9-_]*` 패턴과 일치해야 합니다. 설정되지 않은 경우 최선을 다해 한정자 바이트에서 파싱됩니다. 하지만 명명 패턴이 다르기 때문에 파싱 동작이 정의되지 않은 필드 이름 충돌이 발생할 수 있습니다.
`encoding`	`Encoding` 유형이 `STRING`이 아닌 경우 값의 인코딩 모드입니다. 허용되는 인코딩 값은 다음과 같습니다. `TEXT`: 값이 영숫자 텍스트 문자열임을 나타냅니다. `BINARY`: 값이 `HBase Bytes.toBytes` 함수 패밀리를 사용하여 인코딩되었음을 나타냅니다. `columns`에 해당 열을 나열하고 인코딩을 지정하여 특정 열을 재정의할 수 있습니다.
`type`	`Type` 이 열 패밀리의 값 유형입니다. 인코딩 값이 `BINARY`로 설정된 경우 값은 `HBase Bytes.toBytes` 함수를 사용하여 인코딩되어야 합니다.

BigtableColumnFamily

Bigtable의 column family입니다.

필드
`field_name`	`string` 문서에서 이 열 패밀리에 사용할 필드 이름입니다. 이름이 `[a-zA-Z0-9][a-zA-Z0-9-_]*` 패턴과 일치해야 합니다. 설정하지 않으면 최선을 다해 가족 이름에서 파싱됩니다. 하지만 명명 패턴이 다르기 때문에 파싱 동작이 정의되지 않은 필드 이름 충돌이 발생할 수 있습니다.
`encoding`	`Encoding` 유형이 STRING이 아닌 경우 값의 인코딩 모드입니다. 허용되는 인코딩 값은 다음과 같습니다. `TEXT`: 값이 영숫자 텍스트 문자열임을 나타냅니다. `BINARY`: 값이 `HBase Bytes.toBytes` 함수 패밀리를 사용하여 인코딩되었음을 나타냅니다. `columns`에 해당 열을 나열하고 인코딩을 지정하여 특정 열을 재정의할 수 있습니다.
`type`	`Type` 이 열 패밀리의 값 유형입니다. 인코딩 값이 `BINARY`로 설정된 경우 값은 `HBase Bytes.toBytes` 함수를 사용하여 인코딩되어야 합니다.
`columns[]`	`BigtableColumn` 각 열의 열 수준 정보를 포함하는 객체 목록입니다. 이 목록에 없는 열은 무시됩니다.

인코딩

Bigtable 열 또는 열 그룹의 인코딩 모드입니다.

열거형
`ENCODING_UNSPECIFIED`	인코딩이 지정되지 않았습니다.
`TEXT`	텍스트 인코딩입니다.
`BINARY`	바이너리 인코딩입니다.

유형

Bigtable 열 또는 column family의 값 유형입니다. 인코딩 값이 BINARY로 설정된 경우 값은 HBase Bytes.toBytes 함수를 사용하여 인코딩되어야 합니다.

열거형
`TYPE_UNSPECIFIED`	유형이 지정되지 않았습니다.
`STRING`	문자열 유형입니다.
`NUMBER`	숫자 유형입니다.
`INTEGER`	정수 유형입니다.
`VAR_INTEGER`	가변 길이 정수 유형입니다.
`BIG_NUMERIC`	BigDecimal 유형입니다.
`BOOLEAN`	불리언 유형입니다.
`JSON`	JSON 유형입니다.

BigtableSource

데이터를 가져올 Cloud Bigtable 소스입니다.

필드
`project_id`	`string` Bigtable 소스가 포함된 프로젝트 ID입니다. 길이 제한은 128자(영문 기준)입니다. 지정하지 않으면 상위 요청에서 프로젝트 ID를 상속합니다.
`instance_id`	`string` 필수 항목입니다. 가져와야 하는 Cloud Bigtable의 인스턴스 ID입니다.
`table_id`	`string` 필수 항목입니다. 가져와야 하는 Cloud Bigtable의 테이블 ID입니다.
`bigtable_options`	`BigtableOptions` 필수 항목입니다. 데이터를 유형이 지정된 구조로 파싱할 때 필요한 정보가 포함된 Bigtable 옵션입니다. 예를 들어 열 유형 주석이 있습니다.

CheckGroundingRequest

GroundedGenerationService.CheckGrounding 메서드의 요청 메시지입니다.

필드
`grounding_config`	`string` 필수 항목입니다. 그라운딩 구성의 리소스 이름입니다(예: `projects/*/locations/global/groundingConfigs/default_grounding_config`).
`answer_candidate`	`string` 확인할 답변 후보입니다. 최대 길이는 4096개 토큰입니다.
`facts[]`	`GroundingFact` 그라운딩 확인을 위한 사실 목록입니다. 최대 200개의 사실을 지원합니다.
`grounding_spec`	`CheckGroundingSpec` 그라운딩 확인 구성입니다.
`user_labels`	`map<string, string>` 리소스에 적용된 사용자 라벨은 다음 요구사항을 충족해야 합니다. 각 리소스는 여러 개의 라벨(최대 64개)을 가질 수 있습니다. 각 라벨은 키-값 쌍이어야 합니다. 키는 비워 둘 수 없으며 최소 길이는 1자이고 최대 길이는 63자입니다. 값은 비워 둘 수 있으며 최대 길이는 63자(영문 기준)입니다. 키와 값에는 소문자, 숫자, 밑줄, 대시만 사용할 수 있습니다. 모든 문자는 UTF-8 인코딩을 사용해야 하며 국제 문자가 허용됩니다. 라벨의 키 부분은 고유해야 합니다. 그러나 여러 리소스에 동일한 키를 사용할 수 있습니다. 키는 소문자나 국제 문자로 시작해야 합니다. 자세한 내용은 Google Cloud 문서를 참고하세요.

CheckGroundingResponse

GroundedGenerationService.CheckGrounding 메서드에 대한 응답 메시지입니다.

필드
`cited_chunks[]`	`FactChunk` 답변 후보의 모든 주장에서 인용된 사실 목록입니다. 이는 요청에 제공된 사실에서 파생됩니다.
`cited_facts[]`	`CheckGroundingFactChunk` 답변 후보의 모든 주장에서 인용된 사실 목록입니다. 이는 요청에 제공된 사실에서 파생됩니다.
`claims[]`	`Claim` 대답 후보의 모든 주장에 걸친 주장 텍스트 및 인용 정보
`support_score`	`float` 입력 답변 후보의 지원 점수입니다. 점수가 높을수록 제공된 사실에 의해 뒷받침되는 클레임의 비율이 높습니다. 이 값은 응답이 반환될 때 항상 설정됩니다.

CheckGroundingFactChunk

그라운딩 확인을 위한 사실 청크입니다.

필드

chunk_text

string

사실 청크의 텍스트 콘텐츠입니다. 최대 10,000자(영문 기준)까지 가능합니다.

클레임

답변 후보의 주장에 대한 텍스트 및 인용 정보입니다.

필드
`claim_text`	`string` 답변 후보의 주장에 대한 텍스트입니다. 인용 또는 반대 인용이 발견되었는지 여부와 관계없이 항상 제공됩니다.
`citation_indices[]`	`int32` 주장과 관련된 인용을 지정하는 색인 목록입니다('cited_chunks'). 예를 들어 [1,3,4] 는 인용된_청크[1], 인용된_청크[3], 인용된_청크[4] 가 주장을 뒷받침하는 인용된 사실임을 의미합니다. 사실에 대한 인용은 주장이 사실에 의해 뒷받침됨을 나타냅니다.
`start_pos`	`int32` 답변 후보에서 클레임이 시작되는 위치입니다(바이트 단위). 이는 문자 수로 측정되지 않으므로 일부 문자는 1바이트 이상을 차지할 수 있다는 점을 염두에 두고 사용자 인터페이스에 렌더링해야 합니다. 예를 들어 클레임 텍스트에 비ASCII 문자가 포함된 경우 문자 (프로그래밍 언어에 따라 다름)로 측정할 때와 바이트 (프로그래밍 언어에 관계없음)로 측정할 때 시작 및 종료 위치가 달라집니다.
`end_pos`	`int32` 답변 후보에서 클레임의 끝을 나타내는 위치입니다(바이트 단위, 제외). 이는 문자로 측정되지 않으므로 문자로 렌더링해야 합니다. 예를 들어 클레임 텍스트에 비ASCII 문자가 포함된 경우 문자 (프로그래밍 언어에 따라 다름)로 측정할 때와 바이트 (프로그래밍 언어에 관계없음)로 측정할 때 시작 및 종료 위치가 달라집니다.
`grounding_check_required`	`bool` 이 클레임에 그라운딩 검사가 필요했음을 나타냅니다. 시스템에서 이 주장에 출처 표시/그라운딩 확인이 필요하지 않다고 판단한 경우 이 필드는 false로 설정됩니다. 이 경우 클레임에 대한 그라운딩 검사가 실행되지 않았으므로 `citation_indices`이 반환되지 않아야 합니다.
`score`	`double` 답변 후보의 주장에 대한 신뢰도 점수입니다. 범위는 [0, 1]입니다. `CheckGroundingRequest.grounding_spec.enable_claim_level_score`이 true인 경우에만 설정됩니다.

CheckGroundingSpec

그라운딩 확인 사양입니다.

필드

citation_threshold

double

답변 후보에서 클레임에 대해 팩트를 인용해야 하는지 여부를 결정하는 데 사용되는 임곗값([0,1])입니다. 기준점을 높게 선택하면 인용 횟수는 적지만 매우 강력한 인용이 발생하고, 기준점을 낮게 선택하면 인용 횟수는 많지만 다소 약한 인용이 발생할 수 있습니다. 설정하지 않으면 기준점이 기본적으로 0.6으로 설정됩니다.

enable_claim_level_score

bool

대답에서 클레임 수준 그라운딩 점수를 사용 설정하는 제어 플래그입니다.

청크

청크는 청크 모드에서 추천하거나 검색할 항목의 모든 원시 메타데이터 정보를 캡처합니다.

필드
`name`	`string` 청크의 전체 리소스 이름입니다. 형식은 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`입니다. 이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 1,024자(영문 기준)입니다.
`id`	`string` 현재 청크의 고유 청크 ID입니다.
`content`	`string` 콘텐츠는 문서의 문자열입니다 (파싱된 콘텐츠).
`document_metadata`	`DocumentMetadata` 현재 청크의 문서 메타데이터입니다.
`derived_struct_data`	`Struct` 출력 전용입니다. 이 필드는 OUTPUT_ONLY입니다. 원래 입력 문서에 없는 파생 데이터가 포함되어 있습니다.
`page_span`	`PageSpan` 청크의 페이지 범위입니다.
`chunk_metadata`	`ChunkMetadata` 출력 전용입니다. 현재 청크의 메타데이터입니다.
`data_urls[]`	`string` 출력 전용입니다. 현재 청크에 이미지가 포함된 경우 이미지 데이터 URL입니다. 데이터 URL은 접두사 (data:), 데이터 유형을 나타내는 MIME 유형, 텍스트가 아닌 경우 선택적 base64 토큰, 데이터 자체의 네 부분으로 구성됩니다. data:[][;base64],
`annotation_contents[]`	`string` 출력 전용입니다. 현재 청크에 주석이 포함된 경우 주석 콘텐츠입니다.
`annotation_metadata[]`	`AnnotationMetadata` 출력 전용입니다. 주석 메타데이터에는 현재 청크의 구조화된 콘텐츠가 포함됩니다.
`relevance_score`	`double` 출력 전용입니다. 유사성을 기반으로 한 관련성 점수를 나타냅니다. 점수가 높을수록 청크 관련성이 높습니다. 점수는 [-1.0, 1.0] 범위에 속합니다. `SearchResponse`에서만 채워집니다.

AnnotationMetadata

주석 메타데이터에는 현재 청크의 구조화된 콘텐츠가 포함됩니다.

필드

structured_content

StructuredContent

출력 전용입니다. 구조화된 콘텐츠 정보입니다.

image_id

string

출력 전용입니다. 구조화된 콘텐츠가 이미지를 기반으로 하는 경우 이미지 ID가 제공됩니다.

ChunkMetadata

현재 청크의 메타데이터입니다. 이 필드는 SearchService.Search API에서만 채워집니다.

필드

previous_chunks[]

Chunk

현재 청크의 이전 청크입니다. 이 숫자는 SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks에 의해 제어됩니다. 이 필드는 SearchService.Search API에서만 채워집니다.

next_chunks[]

Chunk

현재 청크의 다음 청크입니다. 이 숫자는 SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks에 의해 제어됩니다. 이 필드는 SearchService.Search API에서만 채워집니다.

DocumentMetadata

문서 메타데이터에는 현재 청크의 문서 정보가 포함됩니다.

필드
`uri`	`string` 문서의 URI입니다.
`title`	`string` 문서 제목입니다.
`mime_type`	`string` 문서의 MIME 유형입니다. https://www.iana.org/assignments/media-types/media-types.xhtml
`struct_data`	`Struct` 데이터 표현 문서의 구조화된 JSON 데이터입니다. 등록된 `Schema`를 준수해야 합니다. 그렇지 않으면 `INVALID_ARGUMENT` 오류가 발생합니다.

PageSpan

청크의 페이지 범위입니다.

필드

page_start

int32

청크의 시작 페이지입니다.

page_end

int32

청크의 종료 페이지입니다.

StructureType

추출할 수 있는 구조화된 콘텐츠의 유형을 정의합니다.

열거형
`STRUCTURE_TYPE_UNSPECIFIED`	기본값
`SHAREHOLDER_STRUCTURE`	주주 구조입니다.
`SIGNATURE_STRUCTURE`	서명 구조입니다.
`CHECKBOX_STRUCTURE`	체크박스 구조입니다.

StructuredContent

구조화된 콘텐츠 정보입니다.

필드

structure_type

StructureType

출력 전용입니다. 구조화된 콘텐츠의 구조 유형입니다.

content

string

출력 전용입니다. 구조화된 콘텐츠의 콘텐츠입니다.

인용

콘텐츠의 소스 저작자 표시입니다.

필드
`start_index`	`int32` 출력 전용입니다. 콘텐츠의 시작 색인입니다.
`end_index`	`int32` 출력 전용입니다. 콘텐츠의 끝 색인입니다.
`uri`	`string` 출력 전용입니다. 기여도의 URL 참조입니다.
`title`	`string` 출력 전용입니다. 저작자 표시의 제목입니다.
`license`	`string` 출력 전용입니다. 저작자 표시의 라이선스입니다.
`publication_date`	`Date` 출력 전용입니다. 저작자 표시의 게시일입니다.

CitationMetadata

콘텐츠의 소스 저작자 표시 모음입니다.

필드

citations[]

Citation

출력 전용입니다. 인용 목록입니다.

CloudSqlSource

Cloud SQL 소스에서 가져올 데이터입니다.

필드
`project_id`	`string` Cloud SQL 소스가 포함된 프로젝트 ID입니다. 길이 제한은 128자(영문 기준)입니다. 지정하지 않으면 상위 요청에서 프로젝트 ID를 상속합니다.
`instance_id`	`string` 필수 항목입니다. 데이터를 복사할 Cloud SQL 인스턴스입니다(길이 제한 256자).
`database_id`	`string` 필수 항목입니다. 데이터를 복사할 Cloud SQL 데이터베이스입니다(길이 제한: 256자).
`table_id`	`string` 필수 항목입니다. 데이터를 복사할 Cloud SQL 테이블입니다(길이 제한 256자).
`gcs_staging_dir`	`string` 가져오기에 사용되는 중간 Cloud Storage 디렉터리입니다. 길이는 2,000자로 제한됩니다. 특정 Cloud Storage 디렉터리로 Cloud SQL 내보내기를 사용하려는 경우에 지정할 수 있습니다. Cloud SQL 서비스 계정에 지정된 Cloud Storage 디렉터리에 액세스하는 데 필요한 Cloud Storage 관리자 권한이 있는지 확인합니다.
`offload`	`bool` 서버리스 내보내기 옵션입니다. 이 옵션을 사용 설정하면 추가 비용이 발생합니다. 자세한 내용은 여기에서 확인하실 수 있습니다.

CmekConfig

Cloud KMS 키로 CMEK 데이터 암호화를 사용 설정하는 데 사용되는 구성입니다.

필드
`name`	`string` 필수 항목입니다. `projects/{project}/locations/{location}/cmekConfig` 또는 `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}` 형식의 CmekConfig 이름입니다.
`kms_key`	`string` 필수 항목입니다. `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}` 리소스를 암호화하는 데 사용될 KMS 키 리소스 이름입니다.
`kms_key_version`	`string` 출력 전용입니다. `<kms_key>/cryptoKeyVersions/{keyVersion}` 리소스를 암호화하는 데 사용될 KMS 키 버전 리소스 이름입니다.
`state`	`State` 출력 전용입니다. CmekConfig의 상태입니다.
`is_default`	`bool` 출력 전용입니다. 고객의 기본 CmekConfig입니다.
`last_rotation_timestamp_micros`	`int64` 출력 전용입니다. 마지막 키 순환의 타임스탬프입니다.
`single_region_keys[]`	`SingleRegionKey` (선택사항) 일부 VAIS 기능에 필요한 단일 지역 CMEK
`notebooklm_state`	`NotebookLMState` 출력 전용입니다. NotebookLM 코퍼스를 사용할 준비가 되었는지 여부입니다.

NotebookLMState

NotebookLM의 상태입니다.

열거형
`NOTEBOOK_LM_STATE_UNSPECIFIED`	NotebookLM 상태를 알 수 없습니다.
`NOTEBOOK_LM_NOT_READY`	NotebookLM이 준비되지 않았습니다.
`NOTEBOOK_LM_READY`	NotebookLM을 사용할 준비가 되었습니다.
`NOTEBOOK_LM_NOT_ENABLED`	NotebookLM이 사용 설정되어 있지 않습니다.

주

CmekConfig의 상태입니다.

열거형
`STATE_UNSPECIFIED`	CmekConfig 상태를 알 수 없습니다.
`CREATING`	CmekConfig를 만드는 중입니다.
`ACTIVE`	CmekConfig는 데이터 스토어와 함께 사용할 수 있습니다.
`KEY_ISSUE`	CmekConfig를 사용할 수 없습니다. KMS 키가 취소되었기 때문일 가능성이 높습니다.
`DELETING`	CmekConfig가 삭제되고 있습니다.
`DELETE_FAILED`	CmekConfig 삭제 프로세스가 실패했습니다.
`UNUSABLE`	CmekConfig를 사용할 수 없습니다. 내부 문제 때문일 수 있습니다.
`ACTIVE_ROTATING`	KMS 키 버전이 순환되고 있습니다.
`DELETED`	KMS 키가 소프트 삭제되었습니다. 결국 일부 삭제 정책이 적용됩니다.
`EXPIRED`	KMS 키가 만료되었습니다. 즉, 키가 30일 이상 사용 중지되었습니다. 고객은 DeleteCmekConfig를 호출하여 상태를 DELETED로 변경할 수 있습니다.

CollectUserEventRequest

CollectUserEvent 메서드의 요청 메시지입니다.

필드
`parent`	`string` 필수 항목입니다. 상위 리소스 이름입니다. 사용자 이벤트 수집 작업이 `DataStore` 수준에서 적용되는 경우 형식은 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`입니다. 사용자 이벤트 수집 작업이 `Location` 수준에서 적용되는 경우(예: 여러 `DataStore`에 걸쳐 `Document`이 있는 이벤트) 형식은 `projects/{project}/locations/{location}`입니다.
`user_event`	`string` 필수 항목입니다. 길이 제한이 2,000,000자인 URL 인코딩된 UserEvent proto입니다.
`uri`	`string` cgi 파라미터를 포함하고 해시 프래그먼트를 제외한 URL입니다. 길이는 5,000자로 제한됩니다. 많은 브라우저가 서드 파티 요청에 대해서만 도메인을 전송하므로 이는 리퍼러 URL보다 유용할 때가 많습니다.
`ets`	`int64` 이벤트 타임스탬프(밀리초)입니다. 이렇게 하면 동일한 GET 요청이 브라우저에서 캐싱되는 것을 방지합니다. 페이로드 바이트를 줄이기 위해 이름이 축약됩니다.

컬렉션

컬렉션은 리소스와 데이터 스토어 세트에 대한 액세스를 구성하기 위한 컨테이너입니다.

필드

name

string

변경할 수 없습니다. 컬렉션의 전체 리소스 이름입니다. 형식은 projects/{project}/locations/{location}/collections/{collection_id}입니다.

이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 1,024자(영문 기준)입니다.

display_name

string

필수 항목입니다. 컬렉션 표시 이름입니다.

이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 128자(영문 기준)입니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.

create_time

출력 전용입니다. Collection이 생성된 타임스탬프입니다.

CompleteQueryRequest

CompletionService.CompleteQuery 메서드의 요청 메시지입니다.

필드
`data_store`	`string` 필수 항목입니다. 완료가 실행되는 상위 데이터 저장소 리소스 이름입니다(예: `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`).
`query`	`string` 필수 항목입니다. 추천을 가져오는 데 사용되는 typeahead 입력입니다. 최대 길이는 128자(영문 기준)입니다.
`query_model`	`string` 자동 완성 데이터 모델을 지정합니다. 이렇게 하면 Cloud 콘솔의 구성 > 자동 완성 섹션에 지정된 모델이 재정의됩니다. 현재 지원되는 값: `document` - 사용자가 가져온 문서에서 생성된 추천 사용 `search-history` - `SearchService.Search` API 호출의 이전 기록에서 생성된 추천 사용 Search API에 트래픽이 없는 경우에는 사용하지 마세요. `user-event` - 사용자가 가져온 검색 이벤트에서 생성된 추천 사용 `document-completable` - 완성 가능으로 표시된 사용자 가져오기 문서 필드에서 직접 가져온 추천을 사용합니다. 기본값: `document`은 일반 dataStore의 기본 모델입니다. `search-history`은 사이트 검색 데이터 스토어의 기본 모델입니다.
`user_pseudo_id`	`string` 방문자 추적을 위한 고유 식별자입니다. 예를 들어 단일 기기에서 방문자를 고유하게 식별할 수 있는 HTTP 쿠키를 사용하여 이를 구현할 수 있습니다. 이 고유 식별자는 방문자가 웹사이트에 로그인 또는 로그아웃해도 변경되지 않아야 합니다. 이 필드에는 `unknown_visitor`과 같은 고정 값이 있어서는 안 됩니다(NOT). `UserEvent.user_pseudo_id` 및 `SearchRequest.user_pseudo_id`과 동일한 식별자여야 합니다. 필드는 길이 제한이 128자(영문 기준)인 UTF-8로 인코딩된 문자열이어야 합니다. 그렇지 않으면 `INVALID_ARGUMENT` 오류가 반환됩니다.
`include_tail_suggestions`	`bool` 전체 검색어와 일치하는 추천이 없는 경우 꼬리 추천을 반환해야 하는지 여부를 나타냅니다. true로 설정된 경우에도 전체 검색어와 일치하는 추천이 있으면 해당 추천이 반환되고 꼬리 추천은 반환되지 않습니다.

CompleteQueryResponse

CompletionService.CompleteQuery 메서드의 응답 메시지입니다.

필드

query_suggestions[]

QuerySuggestion

일치하는 쿼리 추천의 결과입니다. 결과 목록이 정렬되고 첫 번째 결과가 추천입니다.

tail_match_triggered

bool

반환된 추천이 모두 꼬리 추천인 경우 true입니다.

테일 일치가 트리거되려면 요청의 include_tail_suggestions가 true여야 하고 전체 쿼리와 일치하는 추천이 없어야 합니다.

QuerySuggestion

검색어로 추천

필드

suggestion

string

쿼리에 대한 제안입니다.

completable_field_paths[]

string

완성 가능한 필드에서 생성된 경우 이 추천의 소스로 사용되는 고유한 문서 필드 경로입니다.

이 필드는 문서 완성 가능 모델에 대해서만 채워집니다.

CompletionInfo

완료 기여 분석 토큰 및 클릭된 완료 정보를 포함한 자세한 완료 정보입니다.

필드

selected_suggestion

string

최종 사용자가 CompleteQueryResponse.QuerySuggestion.suggestion를 선택했습니다.

selected_position

int32

최종 사용자가 선택한 CompleteQueryResponse.QuerySuggestion.suggestion 위치입니다(0부터 시작).

CompletionSuggestion

고객으로부터 가져온 자동 완성 제안입니다.

필드
`suggestion`	`string` 필수 항목입니다. 추천 텍스트입니다.
`language_code`	`string` 이 추천의 BCP-47 언어 코드입니다.
`group_id`	`string` 두 추천의 groupId가 동일하면 함께 반환되지 않습니다. 대신 순위가 더 높은 항목이 반환됩니다. 이는 의미적으로 동일한 제안의 중복을 삭제하는 데 사용할 수 있습니다.
`group_score`	`double` 그룹 내에서 이 추천의 점수입니다.
`alternative_phrases[]`	`string` 이 추천의 대체 일치 문구입니다.
통합 필드 `ranking_info`. 이 추천의 순위 측정항목입니다. `ranking_info`은 다음 중 하나여야 합니다.
`global_score`	`double` 이 제안의 전역 점수입니다. 이 제안의 점수 / 순위를 관리합니다.
`frequency`	`int64` 이 추천의 빈도입니다. 점수를 사용할 수 없는 경우 추천의 순위를 지정하는 데 사용됩니다.

조건

동작을 허용하기 전에 확인해야 하는 상황을 정의합니다.

필드

query_terms[]

QueryTerm

검색어 목록만 검색하여 쿼리와 일치시킵니다. Condition.query_regex가 설정된 경우 설정할 수 없습니다.

최대 10개의 쿼리 용어

active_time_range[]

TimeRange

조건이 활성 상태인 시간을 지정하는 시간 범위입니다.

시간 범위는 최대 10개입니다.

query_regex

string

(선택사항) 전체 검색어와 일치하는 정규식을 쿼리합니다. Condition.query_terms가 설정된 경우 설정할 수 없습니다. 기본 사이트 검색 프로모션 게재 관리 기능에만 지원됩니다.

QueryTerm

검색 요청 쿼리의 매처

필드

value

string

일치시킬 특정 쿼리 값

소문자여야 하며 UTF-8이어야 합니다. full_match가 true인 경우 공백으로 구분된 최대 3개의 용어가 있을 수 있습니다. 빈 문자열일 수 없습니다. 최대 길이는 5,000자(영문 기준)입니다.

full_match

bool

검색어가 검색어와 정확하게 일치해야 하는지 여부입니다.

TimeRange

시간 종속 조건에 사용됩니다.

필드

start_time

기간의 시작입니다.

범위는 경계값을 포함합니다.

end_time

기간의 종료 시간입니다.

범위는 경계값을 포함합니다. 미래 시간이어야 합니다.

ConnectorType

커넥터 유형입니다.

열거형
`CONNECTOR_TYPE_UNSPECIFIED`	기본값
`THIRD_PARTY`	서드 파티 애플리케이션에 연결하는 서드 파티 커넥터입니다.
`GCP_FHIR`	데이터 커넥터는 FHIR 스토어와 VAIS 데이터 스토어를 연결합니다.
`BIG_QUERY`	BigQuery 커넥터
`GCS`	Google Cloud Storage 커넥터
`GOOGLE_MAIL`	Gmail 커넥터
`GOOGLE_CALENDAR`	Google Calendar 커넥터
`GOOGLE_DRIVE`	Google Drive 커넥터
`NATIVE_CLOUD_IDENTITY`	People API로 구동되는 사용자 검색을 위한 네이티브 Cloud ID 커넥터입니다.
`THIRD_PARTY_FEDERATED`	제휴 커넥터는 데이터를 수집하지 않는 서드 파티 커넥터이며 검색은 서드 파티 애플리케이션의 API로 구동됩니다.
`THIRD_PARTY_EUA`	최종 사용자 인증 기능에 사용되는 커넥터입니다.
`GCNV`	Google Cloud NetApp Volumes 커넥터입니다.

ContactDetails

리소스 수준에 저장된 연락처 정보입니다. 프로젝트 수준과 리소스 수준이 모두 입력된 경우 리소스 수준 연락처 정보가 프로젝트 수준 연락처 정보보다 우선합니다.

필드

email_address

string

(선택사항) 연락처의 이메일 주소입니다.

컨트롤

서빙 중에 사용할 조건부 동작을 정의합니다. 게재 시간에 고려되려면 ServingConfig에 연결되어야 합니다. SolutionType에 따라 허용되는 작업

필드
`name`	`string` 변경할 수 없습니다. 정규화된 이름 `projects//locations/global/dataStore//controls/*`
`display_name`	`string` 필수 항목입니다. 사람이 읽을 수 있는 이름입니다. UI 뷰에서 사용되는 식별자입니다. UTF-8로 인코딩된 문자열이어야 합니다. 길이 제한은 128자(영문 기준)입니다. 그렇지 않으면 INVALID ARGUMENT 오류가 발생합니다.
`associated_serving_config_ids[]`	`string` 출력 전용입니다. 이 컨트롤이 연결된 모든 `ServingConfig` ID의 목록입니다. 변경 후 업데이트되는 데 최대 10분이 걸릴 수 있습니다.
`solution_type`	`SolutionType` 필수 항목입니다. 변경할 수 없습니다. 컨트롤이 속한 솔루션입니다. 리소스의 업종과 호환되어야 합니다. 그렇지 않으면 INVALID ARGUMENT 오류가 발생합니다.
`use_cases[]`	`SearchUseCase` 제어의 사용 사례를 지정합니다. 설정할 수 있는 조건 필드에 영향을 미칩니다. `SOLUTION_TYPE_SEARCH`에만 적용됩니다. 현재 컨트롤당 하나의 사용 사례만 허용됩니다. solution_type이 `SolutionType.SOLUTION_TYPE_SEARCH`인 경우 설정해야 합니다.
`conditions[]`	`Condition` 연결된 작업이 트리거되는 시점을 결정합니다. 항상 작업을 적용하려면 생략하세요. 현재는 단일 조건만 지정할 수 있습니다. 그렇지 않으면 INVALID ARGUMENT 오류가 발생합니다.
통합 필드 `action`. 작업이 업종 및 솔루션에 따라 제한됨 필수 항목입니다. `action`는 다음 중 하나여야 합니다.
`boost_action`	`BoostAction` 부스트 유형 컨트롤을 정의합니다.
`filter_action`	`FilterAction` 필터 유형 컨트롤을 정의합니다. 현재 추천에서 지원되지 않습니다.
`redirect_action`	`RedirectAction` 리디렉션 유형 컨트롤을 정의합니다.
`synonyms_action`	`SynonymsAction` 일련의 용어를 서로의 동의어로 취급합니다.
`promote_action`	`PromoteAction` 사전 정의된 트리거 쿼리를 기반으로 특정 링크를 홍보합니다.

BoostAction

반환된 목록에서 제품의 순서를 조정합니다.

필드
`boost (deprecated)`	`float` 이 항목은 지원 중단되었습니다. 부스트의 강도이며, 범위는 [-1, 1]입니다. 음수 부스팅은 순위를 내리는 것을 의미합니다. 기본값은 0.0 (작업 없음)입니다.
`filter`	`string` 필수 항목입니다. 부스트를 적용할 제품을 지정합니다. 필터를 제공하지 않으면 모든 제품이 부스팅됩니다 (작업 없음). 구문 문서: https://cloud.google.com/retail/docs/filter-and-order 최대 길이는 5,000자(영문 기준)입니다. 그렇지 않으면 INVALID ARGUMENT 오류가 발생합니다.
`data_store`	`string` 필수 항목입니다. 이 컨트롤로 확장할 수 있는 데이터 스토어의 문서를 지정합니다. 전체 데이터 스토어 이름(예: projects/123/locations/global/collections/default_collection/dataStores/default_data_store)
통합 필드 `boost_spec`. 상수 값 부스트 또는 맞춤 순위 지정 기반 부스트 사양입니다. `boost_spec`은 다음 중 하나여야 합니다.
`fixed_boost`	`float` (선택사항) 부스트의 강도이며, 범위는 [-1, 1]입니다. 음수 부스팅은 순위를 내리는 것을 의미합니다. 기본값은 0.0 (작업 없음)입니다.
`interpolation_boost_spec`	`InterpolationBoostSpec` (선택사항) 고객 정의 속성 값을 기반으로 하는 맞춤 순위 지정의 복잡한 사양입니다.

InterpolationBoostSpec

고객이 지정한 속성 값을 기반으로 한 맞춤 순위 지정 사양입니다. 위의 간단한 (조건, 부스트) 조합보다 맞춤설정된 순위 지정에 더 많은 제어 기능을 제공합니다.

필드
`field_name`	`string` (선택사항) 값이 부스트 금액을 결정하는 데 사용되는 필드의 이름입니다.
`attribute_type`	`AttributeType` (선택사항) 부스트 금액을 결정하는 데 사용할 속성 유형입니다. 속성 값은 지정된 field_name의 필드 값에서 파생될 수 있습니다. 숫자의 경우 attribute_value = numerical_field_value와 같이 간단합니다. 하지만 신선도의 경우 attribute_value = (time.now() - datetime_field_value)입니다.
`interpolation_type`	`InterpolationType` (선택사항) 아래에 나열된 제어점을 연결하는 데 적용할 보간 유형입니다.
`control_points[]`	`ControlPoint` (선택사항) 곡선을 정의하는 데 사용되는 제어점입니다. 단조 함수 (위의 interpolation_type을 통해 정의됨)는 여기에 나열된 제어점을 통과합니다.

AttributeType

맞춤 순위가 적용될 속성(또는 함수)입니다.

열거형
`ATTRIBUTE_TYPE_UNSPECIFIED`	지정되지 않은 AttributeType입니다.
`NUMERICAL`	숫자 필드의 값은 부스트 금액을 동적으로 업데이트하는 데 사용됩니다. 이 경우 관리 포인트의 attribute_value (x 값)는 boost_amount가 지정된 숫자 필드의 실제 값이 됩니다.
`FRESHNESS`	최신성 사용 사례의 경우 속성 값은 현재 시간과 지정된 datetime 필드의 날짜 사이의 기간입니다. 값은 XSD `dayTimeDuration` 값 (ISO 8601 기간 값의 제한된 하위 집합)으로 형식이 지정되어야 합니다. 이 패턴은 `[nD][T[nH][nM][nS]]`입니다. 예를 들면 `5D`, `3DT12H30M`, `T24H`입니다.

ControlPoint

곡선을 정의하는 데 사용되는 제어점입니다. 이러한 제어점을 통해 정의된 곡선은 단조 증가 또는 단조 감소만 가능합니다(상수 값은 허용됨).

필드

attribute_value

string

(선택사항) 다음 중 하나일 수 있습니다. 1. 숫자 필드 값입니다. 2. 새로고침 기간 사양입니다. 값은 XSD dayTimeDuration 값 (ISO 8601 기간 값의 제한된 하위 집합)으로 형식이 지정되어야 합니다. 이 패턴은 [nD][T[nH][nM][nS]]입니다.

boost_amount

float

(선택사항) attribute_value가 위에 지정된 값으로 평가되는 경우 점수를 높이는 데 사용할 -1~1 사이의 값입니다.

InterpolationType

적용할 보간 유형입니다. 기본값은 선형 (구간별 선형)입니다.

열거형
`INTERPOLATION_TYPE_UNSPECIFIED`	보간 유형이 지정되지 않았습니다. 이 경우 기본값은 선형입니다.
`LINEAR`	구간별 선형 보간이 적용됩니다.

FilterAction

결과에 포함될 수 있는 제품을 지정했습니다. 부스트와 동일한 필터를 사용합니다.

필드

filter

string

필수 항목입니다. 일치 조건 결과에 적용할 필터입니다.

필수 구문 문서: https://cloud.google.com/retail/docs/filter-and-order 최대 길이는 5,000자(영문 기준)입니다. 그렇지 않으면 INVALID ARGUMENT 오류가 발생합니다.

data_store

string

필수 항목입니다. 이 컨트롤로 필터링할 수 있는 데이터 스토어의 문서를 지정합니다. 전체 데이터 스토어 이름(예: projects/123/locations/global/collections/default_collection/dataStores/default_data_store)

PromoteAction

일부 트리거 쿼리를 기반으로 특정 링크를 홍보합니다.

예: shoe 키워드를 검색할 때 신발 매장 링크를 홍보합니다. 링크는 연결된 데이터 스토어 외부에 있을 수 있습니다.

필드

data_store

string

필수 항목입니다. 이 프로모션이 연결된 데이터 스토어입니다.

search_link_promotion

SearchLinkPromotion

필수 항목입니다. 이 작업에 연결된 프로모션입니다.

RedirectAction

쇼핑객을 제공된 URI로 리디렉션합니다.

필드

redirect_uri

string

필수 항목입니다. 쇼핑객이 리디렉션될 URI입니다.

필수 항목입니다. URI의 길이는 2,000자(영문 기준) 이하여야 합니다. 그렇지 않으면 INVALID ARGUMENT 오류가 발생합니다.

SynonymsAction

서로 동의어로 작동하는 용어 집합을 만듭니다.

예: 'happy'는 'glad'로도 간주되고 'glad'는 'happy'로도 간주됩니다.

필드

synonyms[]

string

동의어 집합을 정의합니다. 최대 100개의 동의어를 지정할 수 있습니다. 동의어를 2개 이상 지정해야 합니다. 그렇지 않으면 INVALID ARGUMENT 오류가 발생합니다.

대화

외부 대화 프로토 정의입니다.

필드
`name`	`string` 변경할 수 없습니다. 정규화된 이름 `projects/{project}/locations/global/collections/{collection}/dataStore//conversations/` 또는 `projects/{project}/locations/global/collections/{collection}/engines//conversations/`입니다.
`state`	`State` 대화의 상태입니다.
`user_pseudo_id`	`string` 사용자 추적을 위한 고유 식별자입니다.
`messages[]`	`ConversationMessage` 대화 메시지
`start_time`	`Timestamp` 출력 전용입니다. 대화가 시작된 시간입니다.
`end_time`	`Timestamp` 출력 전용입니다. 대화가 종료된 시간입니다.

주

대화 상태의 열거형입니다.

열거형
`STATE_UNSPECIFIED`	알 수 없는 작업입니다.
`IN_PROGRESS`	현재 대화가 열려 있습니다.
`COMPLETED`	대화가 완료되었습니다.

ConversationContext

대화의 컨텍스트를 정의합니다.

필드

context_documents[]

string

사용자에게 표시되는 현재 문서 목록입니다. 문서 리소스 참조가 포함되어 있습니다.

active_document

string

사용자가 연 현재 활성 문서입니다. 문서 리소스 참조가 포함되어 있습니다.

ConversationMessage

대화 메시지를 정의합니다.

필드
`create_time`	`Timestamp` 출력 전용입니다. 메시지 생성 타임스탬프입니다.
통합 필드 `message`. `message`는 다음 중 하나여야 합니다.
`user_input`	`TextInput` 사용자 텍스트 입력입니다.
`reply`	`Reply` 답장 검색

ConverseConversationRequest

ConversationalSearchService.ConverseConversation 메서드의 요청 메시지입니다.

필드
`name`	`string` 필수 항목입니다. 가져올 대화의 리소스 이름입니다. 형식은 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`입니다. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`을 사용하여 ConverseConversation 세션 내에서 새 대화를 자동으로 만드는 자동 세션 모드를 활성화합니다.
`query`	`TextInput` 필수 항목입니다. 현재 사용자 입력입니다.
`serving_config`	`string` 사용할 서빙 구성의 리소스 이름입니다. 형식: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` 설정하지 않으면 기본 제공 구성이 사용됩니다.
`conversation`	`Conversation` 자동 세션에서만 사용할 대화입니다. 자동 세션에서 대화에 새 이름을 자동으로 할당하므로 이름 필드는 무시됩니다.
`safe_search`	`bool` 세이프 서치를 사용 설정할지 여부입니다.
`user_labels`	`map<string, string>` 리소스에 적용된 사용자 라벨은 다음 요구사항을 충족해야 합니다. 각 리소스는 여러 개의 라벨(최대 64개)을 가질 수 있습니다. 각 라벨은 키-값 쌍이어야 합니다. 키는 비워 둘 수 없으며 최소 길이는 1자이고 최대 길이는 63자입니다. 값은 비워 둘 수 있으며 최대 길이는 63자(영문 기준)입니다. 키와 값에는 소문자, 숫자, 밑줄, 대시만 사용할 수 있습니다. 모든 문자는 UTF-8 인코딩을 사용해야 하며 국제 문자가 허용됩니다. 라벨의 키 부분은 고유해야 합니다. 그러나 여러 리소스에 동일한 키를 사용할 수 있습니다. 키는 소문자나 국제 문자로 시작해야 합니다. 자세한 내용은 Google Cloud 문서를 참고하세요.
`summary_spec`	`SummarySpec` 대답에 반환되는 요약을 구성하기 위한 사양입니다.
`filter`	`string` 필터 구문은 필터링되는 문서의 하나 이상의 필드에서 조건자를 구성하기 위한 표현식 언어로 구성됩니다. 필터 표현식은 대소문자를 구분합니다. 요약 대답에 영향을 줄 수 있는 검색 결과를 필터링하는 데 사용됩니다. 이 필드를 인식할 수 없으면 `INVALID_ARGUMENT`가 반환됩니다. Vertex AI Search의 필터링은 LHS 필터 키를 Vertex AI Search 백엔드에 정의된 키 속성에 매핑하여 실행됩니다. 이 매핑은 고객이 스키마에 정의합니다. 예를 들어 미디어 고객의 스키마에 'name' 필드가 있을 수 있습니다. 이 경우 필터는 다음과 같습니다. filter --> name:'ANY("king kong")' 구문 및 필터 연산자를 비롯한 필터링에 대한 자세한 내용은 필터를 참고하세요.
`boost_spec`	`BoostSpec` 검색 결과에서 특정 문서를 부스팅하는 부스트 사양으로, 대화 응답에 영향을 줄 수 있습니다. 부스팅에 대한 자세한 내용은 부스팅을 참고하세요.

ConverseConversationResponse

ConversationalSearchService.ConverseConversation 메서드의 응답 메시지입니다.

필드

reply

Reply

현재 질문에 대한 답변입니다.

conversation

답변을 포함한 업데이트된 대화

search_results[]

SearchResult

검색 결과

CreateAssistantRequest

AssistantService.CreateAssistant 메서드 요청입니다.

필드

parent

string

필수 항목입니다. 상위 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

assistant

Assistant

필수 항목입니다. 만들 Assistant입니다.

assistant_id

string

필수 항목입니다. Assistant에 사용할 ID이며, Assistant의 리소스 이름에서 마지막 구성요소가 됩니다.

이 필드는 RFC-1034를 준수해야 하며 길이 제한은 63자(영문 기준)입니다.

CreateControlRequest

CreateControl 메서드 요청입니다.

필드

parent

string

필수 항목입니다. 상위 데이터 스토어의 전체 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} 또는 projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}

control

Control

필수 항목입니다. 만들 컨트롤입니다.

control_id

string

필수 항목입니다. Control에 사용할 ID이며, Control의 리소스 이름의 마지막 구성요소가 됩니다.

이 값은 1~63자(영문 기준)여야 합니다. 유효한 문자는 /[az][0-9]-_/.

CreateConversationRequest

CreateConversation 메서드 요청입니다.

필드

parent

string

필수 항목입니다. 상위 데이터 스토어의 전체 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

conversation

필수 항목입니다. 생성할 대화입니다.

CreateDataStoreMetadata

DataStoreService.CreateDataStore 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

CreateDataStoreRequest

DataStoreService.CreateDataStore 메서드 요청입니다.

필드
`parent`	`string` 필수 항목입니다. 상위 리소스 이름입니다(예: `projects/{project}/locations/{location}/collections/{collection}`).
`data_store`	`DataStore` 필수 항목입니다. 만들 `DataStore`입니다.
`data_store_id`	`string` 필수 항목입니다. `DataStore`에 사용할 ID이며, `DataStore`의 리소스 이름에서 마지막 구성요소가 됩니다. 이 필드는 RFC-1034 표준을 준수해야 하며 길이 제한은 63자(영문 기준)입니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.
`create_advanced_site_search`	`bool` 사용자가 사이트 검색을 위한 고급 데이터 스토어를 직접 만들고 싶어 하는지 나타내는 불리언 플래그입니다. 데이터 스토어가 사이트 검색 (일반 업종 및 PUBLIC_WEBSITE content_config)으로 구성되지 않은 경우 이 플래그는 무시됩니다.
`skip_default_schema_creation`	`bool` 데이터 스토어의 기본 스키마 생성을 건너뛸지 여부를 나타내는 불리언 플래그입니다. 기본 스키마가 사용 사례와 호환되지 않는다고 확신하는 경우에만 이 플래그를 사용 설정하세요. true로 설정하면 문서를 수집하기 전에 데이터 저장소의 스키마를 수동으로 만들어야 합니다. `data_store.starting_schema`이 지정된 경우 이 플래그를 지정할 수 없습니다.
통합 필드 `cmek_options`. DataStore의 CMEK 옵션입니다. 이 필드를 설정하면 프로젝트에 설정된 경우 기본 CmekConfig가 재정의됩니다. `cmek_options`은 다음 중 하나여야 합니다.
`cmek_config_name`	`string` 이 DataStore를 보호하는 데 사용할 CmekConfig의 리소스 이름입니다.
`disable_cmek`	`bool` CMEK 보호 기능이 없는 DataStore입니다. 프로젝트에 기본 CmekConfig가 설정된 경우 이 필드를 설정하면 기본 CmekConfig도 재정의됩니다.

CreateDocumentRequest

DocumentService.CreateDocument 메서드의 요청 메시지입니다.

필드

parent

string

필수 항목입니다. 상위 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}).

document

필수 항목입니다. 만들 Document입니다.

document_id

string

필수 항목입니다. Document에 사용할 ID이며, Document.name의 마지막 구성요소가 됩니다.

호출자에게 Document를 만들 권한이 없으면 Document의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

이 필드는 동일한 parent을 갖는 모든 Document 간에 고유해야 합니다. 그렇지 않으면 ALREADY_EXISTS 오류가 반환됩니다.

이 필드는 RFC-1034 표준을 준수해야 하며 길이 제한은 128자(영문 기준)입니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.

CreateEngineMetadata

EngineService.CreateEngine 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

CreateEngineRequest

EngineService.CreateEngine 메서드 요청입니다.

필드

parent

string

필수 항목입니다. 상위 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection}).

engine

Engine

필수 항목입니다. 만들 Engine입니다.

engine_id

string

필수 항목입니다. Engine에 사용할 ID이며, Engine의 리소스 이름에서 마지막 구성요소가 됩니다.

이 필드는 RFC-1034 표준을 준수해야 하며 길이 제한은 63자(영문 기준)입니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.

CreateIdentityMappingStoreRequest

IdentityMappingStoreService.CreateIdentityMappingStore의 요청 메시지

필드
`parent`	`string` 필수 항목입니다. 상위 컬렉션 리소스 이름입니다(예: `projects/{project}/locations/{location}`).
`identity_mapping_store_id`	`string` 필수 항목입니다. 생성할 ID 매핑 저장소의 ID입니다. ID에는 문자 (a~z, A~Z), 숫자 (0~9), 밑줄 (_), 하이픈 (-)만 포함해야 합니다. 최대 길이는 63자입니다.
`identity_mapping_store`	`IdentityMappingStore` 필수 항목입니다. 생성할 ID 매핑 저장소입니다.
통합 필드 `cmek_options`. ID 매핑 스토어의 CMEK 옵션입니다. 이 필드를 설정하면 프로젝트에 설정된 경우 기본 CmekConfig가 재정의됩니다. `cmek_options`은 다음 중 하나여야 합니다.
`cmek_config_name`	`string` 이 ID 매핑 저장소를 보호하는 데 사용할 CmekConfig의 리소스 이름입니다.
`disable_cmek`	`bool` CMEK 보호가 없는 ID 매핑 스토어입니다. 프로젝트에 기본 CmekConfig가 설정된 경우 이 필드를 설정하면 기본 CmekConfig도 재정의됩니다.

CreateLicenseConfigRequest

LicenseConfigService.CreateLicenseConfig 메서드의 요청 메시지입니다.

필드

parent

string

필수 항목입니다. 상위 리소스 이름입니다(예: projects/{project}/locations/{location}).

license_config

LicenseConfig

필수 항목입니다. 만들 LicenseConfig입니다.

license_config_id

string

(선택사항) LicenseConfig에 사용할 ID이며, LicenseConfig의 리소스 이름에서 마지막 구성요소가 됩니다. search 또는 search_and_assistant과 같은 등급 (제품 버전) 이름을 라이선스 구성 ID로 사용하고 있습니다.

CreateSchemaMetadata

스키마 생성 LRO의 메타데이터입니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

CreateSchemaRequest

SchemaService.CreateSchema 메서드의 요청 메시지입니다.

필드

parent

string

필수 항목입니다. 상위 데이터 스토어 리소스 이름입니다(projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} 형식).

schema

Schema

필수 항목입니다. 만들 Schema입니다.

schema_id

string

필수 항목입니다. Schema에 사용할 ID이며, Schema.name의 마지막 구성요소가 됩니다.

이 필드는 길이 제한이 63자인 RFC-1034 표준을 준수해야 합니다.

CreateSessionRequest

CreateSession 메서드 요청입니다.

필드

parent

string

필수 항목입니다. 상위 데이터 스토어의 전체 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

session

필수 항목입니다. 만들 세션입니다.

CreateSitemapMetadata

SiteSearchEngineService.CreateSitemap 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

CreateSitemapRequest

SiteSearchEngineService.CreateSitemap 메서드의 요청 메시지입니다.

필드

parent

string

필수 항목입니다. SiteSearchEngine의 상위 리소스 이름입니다(예: projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine).

sitemap

Sitemap

필수 항목입니다. 만들 Sitemap입니다.

CreateTargetSiteMetadata

SiteSearchEngineService.CreateTargetSite 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

CreateTargetSiteRequest

SiteSearchEngineService.CreateTargetSite 메서드의 요청 메시지입니다.

필드

parent

string

필수 항목입니다. TargetSite의 상위 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine).

target_site

필수 항목입니다. 만들 TargetSite입니다.

CustomAttribute

리소스(예: UserEvent)에서 명시적으로 모델링되지 않은 맞춤 속성입니다.

필드

text[]

string

이 맞춤 속성의 텍스트 값입니다. 예를 들어 키가 'color'인 경우 ["yellow", "green"]입니다.

빈 문자열은 허용되지 않습니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.

CustomAttribute.text 또는 CustomAttribute.numbers 중 정확히 하나만 설정해야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.

numbers[]

double

이 맞춤 속성의 숫자 값입니다. 예를 들어 키가 'lengths_cm'인 경우 [2.3, 15.4]입니다.

CustomAttribute.text 또는 CustomAttribute.numbers 중 정확히 하나만 설정해야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.

CustomTuningModel

맞춤 조정된 모델을 설명하는 메타데이터입니다.

필드
`name`	`string` 필수 항목입니다. 모델의 정규화된 리소스 이름입니다. 형식은 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`입니다. 모델은 40자 제한이 있는 영숫자 문자열이어야 합니다.
`display_name`	`string` 모델의 표시 이름입니다.
`model_version`	`int64` 모델의 버전입니다.
`model_state`	`ModelState` 모델의 상태입니다 (예: `TRAINING` 또는 `TRAINING_FAILED`).
`create_time (deprecated)`	`Timestamp` 이 항목은 지원 중단되었습니다. 지원 중단됨: 모델이 생성된 타임스탬프입니다.
`training_start_time`	`Timestamp` 모델 학습이 시작된 타임스탬프입니다.
`metrics`	`map<string, double>` 학습된 모델의 측정항목입니다.
`error_message`	`string` 현재 모델 상태가 `INPUT_VALIDATION_FAILED`인 경우에만 채워집니다.

ModelState

모델의 상태입니다.

열거형
`MODEL_STATE_UNSPECIFIED`	기본값
`TRAINING_PAUSED`	모델이 일시중지된 학습 상태입니다.
`TRAINING`	모델이 현재 학습 중입니다.
`TRAINING_COMPLETE`	모델이 학습을 완료했습니다.
`READY_FOR_SERVING`	모델이 서빙할 준비가 되었습니다.
`TRAINING_FAILED`	모델 학습에 실패했습니다.
`NO_IMPROVEMENT`	모델 학습이 완료되었지만 측정항목이 개선되지 않았습니다.
`INPUT_VALIDATION_FAILED`	입력 데이터 유효성 검사에 실패했습니다. 모델 학습이 시작되지 않았습니다.

DataConnector

Collection 아래에 그룹화된 모든 데이터 스토어의 외부 데이터 소스 연결을 관리합니다. Collection의 싱글톤 리소스입니다. 초기화는 DataConnectorService.SetUpDataConnector 메서드를 통해서만 지원되며, 이 메서드는 새 Collection를 만들고 DataConnector를 초기화합니다.

필드
`name`	`string` 출력 전용입니다. 데이터 커넥터의 전체 리소스 이름입니다. 형식은 `projects//locations//collections/*/dataConnector`입니다.
`state`	`State` 출력 전용입니다. 커넥터의 상태입니다.
`data_source`	`string` 필수 항목입니다. 데이터 소스의 이름입니다. 지원되는 값: `salesforce`, `jira`, `confluence`, `bigquery`
`remove_param_keys[]`	`string` (선택사항) 'params' 필드에서 삭제할 키를 지정합니다. 이는 UpdateDataConnectorRequest의 'update_mask'에 'params'가 포함된 경우에만 활성화됩니다. 키가 'remove_param_keys'에 있고 요청의 'params' 필드에도 있는 경우 삭제가 우선 적용됩니다.
`refresh_interval`	`Duration` 필수 항목입니다. 데이터 동기화의 새로고침 간격입니다. 기간이 0으로 설정되면 데이터가 실시간으로 동기화됩니다. 스트리밍 기능은 아직 지원되지 않습니다. 최솟값은 30분, 최댓값은 7일입니다. 새로고침 간격이 증분 새로고침 간격과 동일한 값으로 설정되면 증분 동기화가 사용 중지됩니다.
`next_sync_time`	`DateTime` 다음 데이터 동기화의 예약된 시간을 정의합니다. 이 필드에는 IANA 시간대 데이터베이스의 hour , minute, time_zone이 필요합니다. 데이터 커넥터의 새로고침 간격이 1일을 초과하는 경우에 사용됩니다. 시간 또는 분이 지정되지 않으면 동기화 시간이 0:00인 것으로 가정합니다. 사용자는 모호성을 방지하기 위해 시간대를 제공해야 합니다.
`entities[]`	`SourceEntity` 연결된 데이터 소스에서 가져올 항목 목록입니다.
`create_time`	`Timestamp` 출력 전용입니다. `DataConnector`이 생성된 타임스탬프입니다.
`latest_pause_time`	`Timestamp` 출력 전용입니다. 이 `DataConnector`가 일시중지된 가장 최근 타임스탬프로, 데이터 동기화와 같은 모든 기능에 영향을 미칩니다. 커넥터를 일시중지하면 다음과 같은 효과가 발생합니다. - 데이터 동기화를 비롯한 모든 기능이 중지됩니다. - 진행 중인 데이터 동기화 작업이 취소됩니다. - 향후 데이터 동기화 실행이 예약되거나 트리거될 수 없습니다.
`last_sync_time`	`Timestamp` 출력 전용입니다. 주기적 커넥터에만 해당하며, 데이터 동기화가 완료된 마지막 시간입니다.
`update_time`	`Timestamp` 출력 전용입니다. `DataConnector`가 마지막으로 업데이트된 타임스탬프입니다.
`errors[]`	`Status` 출력 전용입니다. 초기화 또는 최신 커넥터 실행에서 발생한 오류입니다.
`sync_mode`	`SyncMode` 데이터 커넥터에서 지원하는 데이터 동기화 모드입니다.
`kms_key_name`	`string` 입력 전용입니다. 이 커넥터가 관리하는 데이터 스토어를 보호하는 데 사용할 KMS 키입니다. CMEK 조직 정책 보호를 준수해야 하는 요청에 대해 설정해야 합니다. 이 필드가 설정되고 성공적으로 처리되면 이 커넥터로 생성된 DataStore가 KMS 키로 보호됩니다.
`destination_configs[]`	`DestinationConfig` (선택사항) 서드 파티 서비스에 연결하는 데 사용되는 대상입니다.
`action_state`	`State` 출력 전용입니다. 작업 커넥터의 상태입니다. 작업 커넥터가 초기화 중인지, 활성 상태인지, 오류가 발생했는지를 반영합니다.
`action_config`	`ActionConfig` (선택사항) 커넥터가 작업을 지원하도록 하는 작업 구성입니다.
`end_user_config`	`EndUserConfig` (선택사항) EUA 커넥터에만 사용되는 매개변수와 사용자 인증 정보입니다.
`federated_config`	`FederatedConfig` (선택사항) 연합 모드를 지원하는 하이브리드 커넥터에만 사용되는 매개변수와 사용자 인증 정보입니다. 이 필드는 커넥터가 하이브리드 커넥터이고 연합 모드를 사용 설정하려는 경우에만 설정해야 합니다.
`connector_modes[]`	`ConnectorMode` (선택사항) 이 커넥터에 사용 설정된 모드입니다. 기본 상태는 CONNECTOR_MODE_UNSPECIFIED입니다.
`static_ip_enabled`	`bool` (선택사항) 고객이 이 커넥터에 고정 IP 주소를 사용 설정했는지 여부입니다.
`static_ip_addresses[]`	`string` 출력 전용입니다. 이 커넥터에서 사용하는 고정 IP 주소입니다.
`blocking_reasons[]`	`BlockingReason` 출력 전용입니다. 커넥터가 데이터 동기화를 시작하기 전에 완료해야 하는 사용자 작업입니다.
`identity_refresh_interval (deprecated)`	`Duration` 이 항목은 지원 중단되었습니다. 이 커넥터로 수집된 문서의 액세스 제어 목록 정보를 동기화하는 새로고침 간격입니다. 설정하지 않으면 액세스 제어 목록이 기본 간격인 30분마다 새로고침됩니다. ID 새로고침 간격은 최소 30분에서 최대 7일입니다.
`identity_schedule_config`	`IdentityScheduleConfig` ID 데이터 동기화 실행의 구성입니다. 이 커넥터에서 수집한 문서의 액세스 제어 목록 정보를 동기화하는 새로고침 간격이 포함됩니다.
`private_connectivity_project_id`	`string` 출력 전용입니다. 비공개 연결 커넥터와 연결된 테넌트 프로젝트 ID입니다. 커넥터가 작동하려면 이 프로젝트가 허용 목록에 추가되어야 합니다.
`bap_config`	`BAPConfig` (선택사항) BAP 연결을 설정하기 위한 구성입니다.
`connector_type`	`ConnectorType` 출력 전용입니다. 커넥터 유형입니다. 각 소스는 하나의 유형에만 매핑될 수 있습니다. 예를 들어 Salesforce, Confluence, Jira에는 THIRD_PARTY 커넥터 유형이 있습니다. 시스템에서 설정한 후에는 변경할 수 없습니다.
`realtime_state`	`State` 출력 전용입니다. 실시간 동기화 상태입니다.
`alert_policy_configs[]`	`AlertPolicyConfig` (선택사항) 커넥터 수준 알림 구성입니다.
`realtime_sync_config`	`RealtimeSyncConfig` (선택사항) 실시간 동기화 구성입니다.
`acl_enabled`	`bool` (선택사항) 커넥터가 ACL 구성으로 생성되는지 여부입니다. 현재 이 필드는 Cloud Storage 및 BigQuery 커넥터에만 영향을 미칩니다.
`create_eua_saas`	`bool` (선택사항) 최종 사용자 인증 커넥터가 SaaS에 생성되는지 여부입니다.
`auto_run_disabled`	`bool` (선택사항) 커넥터가 자동 실행에 사용 중지되었는지 여부를 나타냅니다. 주기적 동기화 및 실시간 동기화를 일시중지하는 데 사용할 수 있습니다. 업데이트: incremental_sync_disabled가 도입됨에 따라 auto_run_disabled는 전체 동기화만 일시중지/사용 중지하는 데 사용됩니다.
`incremental_sync_disabled`	`bool` (선택사항) 이 커넥터의 증분 동기화가 일시중지되었는지 여부를 나타냅니다. 이는 auto_run_disabled와는 별개입니다. 서드 파티 커넥터에만 적용됩니다. 새로고침 간격이 증분 새로고침 간격과 동일한 값으로 설정되면 증분 동기화가 사용 중지됩니다(즉, true로 설정됨).
`incremental_refresh_interval`	`Duration` (선택사항) 증분 데이터 동기화의 새로고침 간격입니다. 설정되지 않은 경우 증분 동기화는 환경의 기본값을 사용하며 3시간으로 설정됩니다. 최솟값은 30분, 최댓값은 7일입니다. 서드 파티 커넥터에만 적용됩니다. 새로고침 간격이 증분 새로고침 간격과 동일한 값으로 설정되면 증분 동기화가 사용 중지됩니다.
`hybrid_ingestion_disabled`	`bool` (선택사항) 커넥터가 하이브리드 커넥터인 경우 커넥터 생성 중에 수집이 사용 설정되고 적절한 리소스가 프로비저닝되는지 확인합니다. 커넥터가 하이브리드 커넥터가 아닌 경우 이 필드는 무시됩니다.
통합 필드 `data_connector_params`. (키, 값) 쌍 형식으로 소스에 액세스하는 데 필요한 매개변수입니다. `projects//[locations//]secrets//versions/` 형식의 문자열 값은 Secret Manager에서 읽어옵니다. 모든 데이터 소스에 필요한 매개변수: 키: `instance_uri` 값: 문자열 유형입니다. 데이터 소스에 액세스하는 URI입니다. OAuth를 지원하는 소스(예: `salesforce`)의 필수 매개변수: 키: `client_id` 값: 문자열 유형입니다. 애플리케이션을 식별하는 서드 파티 서비스 제공업체의 클라이언트 ID입니다. 키: `client_secret` 값:유형 STRING 서드 파티 승인 서버에서 생성된 클라이언트 보안 비밀번호입니다. 키: `access_token` 값: 문자열 유형입니다. 보호된 리소스에 액세스하기 위한 UCS의 OAuth 토큰입니다. 키: `refresh_token` 값: 문자열 유형입니다. 사용자 상호작용 없이 새 액세스 토큰을 가져오는 UCS의 OAuth 갱신 토큰입니다. 기본 API 토큰 인증을 지원하는 소스(예: `jira`, `confluence`)에 필요한 매개변수: 키: `user_account` 값: 문자열 유형입니다. 소스가 있는 사용자 이름 또는 이메일입니다. 키: `api_token` 값: 문자열 유형입니다. 비밀번호를 사용했을 모든 곳에서 인증하는 데 사용되는 소스 계정에 대해 생성된 API 토큰입니다. 예: `{ "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" }` 여러 승인 유형 지원에 사용할 승인 유형을 지정하는 선택적 매개변수입니다. 키: `auth_type` 값: 문자열 유형입니다. 데이터 소스의 승인 유형입니다. 지원되는 값: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL` `data_connector_params`은 다음 중 하나여야 합니다.
`params`	`Struct` 구조화된 JSON 형식의 필수 데이터 커넥터 매개변수입니다.
`json_params`	`string` 필수 데이터 커넥터 매개변수(json 문자열 형식)입니다.

BlockingReason

커넥터가 데이터 동기화를 시작하기 전에 완료해야 하는 사용자 작업입니다.

열거형
`BLOCKING_REASON_UNSPECIFIED`	기본값
`ALLOWLIST_STATIC_IP`	커넥터를 사용하려면 고객이 고정 IP를 허용 목록에 추가해야 합니다.
`ALLOWLIST_IN_SERVICE_ATTACHMENT`	커넥터를 사용하려면 고객이 서비스 연결에서 Google 프로젝트를 허용 목록에 추가해야 합니다.
`ALLOWLIST_SERVICE_ACCOUNT`	커넥터를 사용하려면 고객이 프로젝트에서 서비스 계정을 허용 목록에 추가해야 합니다.

ConnectorMode

이 커넥터에 사용 설정된 모드입니다. 수집, 작업, 제휴 또는 EUA

열거형
`CONNECTOR_MODE_UNSPECIFIED`	커넥터 모드가 지정되지 않았습니다.
`DATA_INGESTION`	데이터 수집에 사용되는 커넥터입니다.
`ACTIONS`	작업에 활용되는 커넥터입니다.
`FEDERATED`	제휴 검색에 사용되는 커넥터입니다.
`EUA`	최종 사용자 인증에 사용되는 커넥터입니다.
`FEDERATED_AND_EUA`	제휴 검색 및 최종 사용자 인증에 사용되는 하이브리드 커넥터입니다.

EndUserConfig

EUA 커넥터에만 사용되는 매개변수와 사용자 인증 정보입니다.

필드
`additional_params`	`Struct` (선택사항) EUA에 필요한 추가 매개변수입니다.
`tenant`	`Tenant` (선택사항) 커넥터가 연결된 테넌트 프로젝트입니다.
통합 필드 `auth_config`. EUA 커넥터의 인증 구성입니다. `auth_config`은 다음 중 하나여야 합니다.
`auth_params`	`Struct` (선택사항) EUA 커넥터에 특정한 인증 매개변수입니다.
`json_auth_params`	`string` (선택사항) json 문자열 형식의 EUA 커넥터에 특정한 인증 매개변수입니다.

FederatedConfig

연합 모드를 지원하는 하이브리드 커넥터에만 사용되는 매개변수와 사용자 인증 정보입니다.

필드
`additional_params`	`Struct` (선택사항) 연합에 필요한 추가 매개변수입니다.
통합 필드 `auth_config`. 연합 커넥터의 인증 구성입니다. `auth_config`은 다음 중 하나여야 합니다.
`auth_params`	`Struct` (선택사항) 연합 커넥터에 특정한 인증 매개변수입니다.
`json_auth_params`	`string` (선택사항) json 문자열 형식의 제휴 커넥터에 특정한 인증 매개변수입니다.

RealtimeSyncConfig

실시간 동기화의 추가 매개변수를 저장하는 실시간 동기화 구성입니다.

필드

webhook_uri

string

(선택사항) 커넥터가 실시간 동기화의 추가 매개변수를 지정하는 데 사용하는 웹훅 URL입니다.

realtime_sync_secret

string

(선택사항) 웹훅 보안 비밀에 사용되는 Secret Manager 보안 비밀의 ID입니다.

streaming_error

StreamingError

(선택사항) 스트리밍 오류 세부정보

StreamingError

스트리밍 오류 세부정보

필드

streaming_error_reason

StreamingErrorReason

(선택사항) 스트리밍 오류입니다.

error

(선택사항) 오류 세부정보입니다.

StreamingErrorReason

광범위한 스트리밍 오류 유형입니다.

열거형
`STREAMING_ERROR_REASON_UNSPECIFIED`	스트리밍 오류 이유가 지정되지 않았습니다.
`STREAMING_SETUP_ERROR`	실시간 동기화를 위한 리소스를 설정하는 중에 오류가 발생했습니다.
`STREAMING_SYNC_ERROR`	커넥터의 실시간 동기화를 실행하는 중에 오류가 발생했습니다.
`INGRESS_ENDPOINT_REQUIRED`	비공개 연결에서 실시간 동기화를 설정할 때는 인그레스 엔드포인트가 필요합니다.

SourceEntity

데이터 소스의 항목을 나타냅니다. 예를 들어 Salesforce의 Account 객체입니다.

필드
`entity_name`	`string` 항목 이름입니다. 데이터 소스별 지원되는 값: Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` Jira: `Issue` Confluence: `Content`, `Space`
`key_property_mappings`	`map<string, string>` 색인 생성 속성입니다. 키: 필드 이름입니다. 값: 필드를 매핑할 키 속성입니다(예: `title`, `description`). 지원되는 키 속성: `title`: 데이터 레코드의 제목입니다. 이 정보는 검색 결과에 표시됩니다. `description`: 데이터 레코드에 대한 설명입니다. 이 정보는 검색 결과에 표시됩니다.
`data_store`	`string` 출력 전용입니다. 소스 항목의 연결된 데이터 스토어의 전체 리소스 이름입니다. 형식은 `projects//locations//collections//dataStores/`입니다. 커넥터가 `DataConnectorService.SetUpDataConnector` 메서드로 초기화되면 각 소스 항목에 대해 `DataStore`가 자동으로 생성됩니다.
`starting_schema`	`Schema` (선택사항) 이 SourceEntity에서 생성된 `DataStore`에 사용할 시작 스키마입니다. 설정하지 않으면 기본 업종별 스키마가 사용됩니다. 이 필드는 [SetUpDataConnector][] API에서만 사용되며 다른 API에서 사용하면 무시됩니다. 이 필드는 [GetDataConnector][] API를 비롯한 모든 API 응답에서 생략됩니다. `DataStore`의 스키마를 가져오려면 `SchemaService.GetSchema` API를 대신 사용하세요. 제공된 스키마는 스키마에 관한 특정 규칙에 따라 검증됩니다. 이 문서에서 자세히 알아보세요.
`healthcare_fhir_config`	`HealthcareFhirConfig` (선택사항) `HEALTHCARE_FHIR` 세로의 구성입니다.
통합 필드 `entity_params`. 데이터 수집을 용이하게 하는 항목의 매개변수입니다. 예를 들어 BigQuery 커넥터의 경우: 키: `document_id_column` 값: 문자열 유형입니다. 열 ID의 값입니다. `entity_params`는 다음 중 하나여야 합니다.
`params`	`Struct` 구조화된 json 형식으로 데이터 수집을 용이하게 하는 항목의 매개변수입니다.
`json_params`	`string` 데이터 수집을 용이하게 하는 항목의 매개변수(json 문자열 형식)입니다.

주

커넥터의 상태입니다.

열거형
`STATE_UNSPECIFIED`	기본값
`CREATING`	커넥터를 설정하는 중입니다.
`ACTIVE`	커넥터가 설정되었으며 다음 동기화 실행을 기다리는 중입니다.
`FAILED`	커넥터에 오류가 있습니다. 오류 세부정보는 `DataConnector.errors`에서 확인할 수 있습니다. 오류를 수정할 수 없는 경우 [CollectionService.DeleteCollection] API로 `DataConnector`를 삭제할 수 있습니다.
`RUNNING`	커넥터가 데이터 소스의 레코드를 적극적으로 동기화하고 있습니다.
`WARNING`	커넥터에서 동기화 실행을 완료했지만 심각하지 않은 오류가 발생했습니다.
`INITIALIZATION_FAILED`	커넥터 초기화에 실패했습니다. 런타임 오류 또는 비동기 파이프라인의 문제로 인해 요청이 일부 커넥터 유형을 제외한 다운스트림 서비스에 도달하지 못할 수 있습니다.
`UPDATING`	커넥터가 업데이트되는 중입니다.

SyncMode

데이터 커넥터에서 지원하는 데이터 동기화 모드를 정의합니다.

열거형
`PERIODIC`	커넥터는 refresh_interval을 기반으로 데이터를 주기적으로 동기화합니다. auto_run_disabled와 함께 사용하여 주기적 동기화를 일시중지하거나 일회성 동기화를 나타냅니다.
`STREAMING`	데이터는 실시간으로 동기화됩니다.
`UNSPECIFIED`	데이터를 수집하지 않는 커넥터는 이 값을 갖습니다.

DataStore

DataStore는 DataStore 수준에서 전역 설정과 구성을 캡처합니다.

필드
`name`	`string` 변경할 수 없습니다. 식별자. 데이터 스토어의 전체 리소스 이름입니다. 형식은 `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`입니다. 이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 1,024자(영문 기준)입니다.
`display_name`	`string` 필수 항목입니다. 데이터 스토어 표시 이름입니다. 이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 128자(영문 기준)입니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.
`industry_vertical`	`IndustryVertical` 변경할 수 없습니다. 데이터 스토어가 등록하는 업종입니다.
`solution_types[]`	`SolutionType` 데이터 스토어가 등록되는 솔루션입니다. 각 `industry_vertical`에 사용할 수 있는 솔루션: `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` 및 `SOLUTION_TYPE_SEARCH` `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH`이 자동으로 등록됩니다. 다른 솔루션은 등록할 수 없습니다.
`default_schema_id`	`string` 출력 전용입니다. 이 데이터 저장소와 연결된 기본 `Schema`의 ID입니다.
`content_config`	`ContentConfig` 변경할 수 없습니다. 데이터 스토어의 콘텐츠 구성입니다. 이 필드를 설정하지 않으면 서버 동작은 기본적으로 `ContentConfig.NO_CONTENT`입니다.
`create_time`	`Timestamp` 출력 전용입니다. `DataStore`이 생성된 타임스탬프입니다.
`advanced_site_search_config`	`AdvancedSiteSearchConfig` (선택사항) 고급 사이트 검색 구성입니다.
`kms_key_name`	`string` 입력 전용입니다. 생성 시 이 데이터 스토어를 보호하는 데 사용되는 KMS 키입니다. CMEK 조직 정책 보호를 준수해야 하는 요청에 대해 설정해야 합니다. 이 필드가 설정되고 성공적으로 처리되면 cmek_config 필드에 표시된 대로 데이터 저장소가 KMS 키로 보호됩니다.
`cmek_config`	`CmekConfig` 출력 전용입니다. DataStore의 CMEK 관련 정보입니다.
`billing_estimation`	`BillingEstimation` 출력 전용입니다. 청구를 위한 데이터 크기 추정치입니다.
`acl_enabled`	`bool` 변경할 수 없습니다. `DataStore`의 데이터에 ACL 정보가 있는지 여부 `true`로 설정하면 소스 데이터에 ACL이 있어야 합니다. ACL은 `DocumentService.ImportDocuments` 메서드로 데이터를 수집할 때 수집됩니다. `DataStore`에 ACL이 사용 설정된 경우 `DocumentService.GetDocument` 또는 `DocumentService.ListDocuments`를 호출하여 `Document`에 액세스할 수 없습니다. 현재 ACL은 `PUBLIC_WEBSITE` 콘텐츠 구성이 아닌 `GENERIC` 업종에서만 지원됩니다.
`workspace_config`	`WorkspaceConfig` 작업공간 데이터의 데이터 스토어 유형 구성을 저장하는 구성입니다. `DataStore.content_config`이 `DataStore.ContentConfig.GOOGLE_WORKSPACE`로 설정된 경우 설정해야 합니다.
`document_processing_config`	`DocumentProcessingConfig` 문서 이해 및 보강을 위한 구성입니다.
`starting_schema`	`Schema` 이 `DataStore`를 프로비저닝할 때 사용할 시작 스키마입니다. 설정하지 않으면 기본 업종별 스키마가 사용됩니다. 이 필드는 `CreateDataStore` API에서만 사용되며 다른 API에서 사용하면 무시됩니다. 이 필드는 `CreateDataStore` API를 비롯한 모든 API 응답에서 생략됩니다. `DataStore`의 스키마를 가져오려면 `SchemaService.GetSchema` API를 대신 사용하세요. 제공된 스키마는 스키마에 관한 특정 규칙에 따라 검증됩니다. 이 문서에서 자세히 알아보세요.
`healthcare_fhir_config`	`HealthcareFhirConfig` (선택사항) `HEALTHCARE_FHIR` 세로의 구성입니다.
`serving_config_data_store`	`ServingConfigDataStore` (선택사항) DataStore 수준에서 서빙 구성을 저장합니다.
`identity_mapping_store`	`string` 변경할 수 없습니다. 연결된 `IdentityMappingStore`의 정규화된 리소스 이름입니다. 이 필드는 `THIRD_PARTY` 또는 `GSUITE` IdP가 있는 acl_enabled DataStore에 대해서만 설정할 수 있습니다. 형식은 `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`입니다.
`is_infobot_faq_data_store`	`bool` (선택사항) 설정된 경우 이 데이터 스토어는 Infobot FAQ 데이터 스토어입니다.
`configurable_billing_approach`	`ConfigurableBillingApproach` (선택사항) 구성 가능한 결제 접근 방식의 구성입니다. 다음과 같이 표시됩니다.

BillingEstimation

데이터 스토어별 데이터 크기 추정치입니다.

필드
`structured_data_size`	`int64` 구조화된 데이터의 데이터 크기(바이트)입니다.
`unstructured_data_size`	`int64` 비정형 데이터의 데이터 크기(바이트)입니다.
`website_data_size`	`int64` 웹사이트의 데이터 크기(바이트)입니다.
`structured_data_update_time`	`Timestamp` 구조화된 데이터의 마지막 업데이트 타임스탬프입니다.
`unstructured_data_update_time`	`Timestamp` 비정형 데이터의 마지막 업데이트 타임스탬프입니다.
`website_data_update_time`	`Timestamp` 웹사이트의 마지막 업데이트 타임스탬프입니다.

ConfigurableBillingApproach

구성 가능한 결제 접근 방식의 구성입니다.

열거형
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	기본값 Spark 및 비Spark 구성 불가능한 결제 접근 방식
`CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE`	비임베딩 스토리지를 위한 색인 코어에 구독 기본 요금 + 초과분 청구를 사용합니다.
`CONFIGURABLE_CONSUMPTION_EMBEDDING`	스토리지 부가기능을 삽입하는 데 사용량 기반 종량제 청구를 사용합니다.

ContentConfig

데이터 스토어의 콘텐츠 구성입니다.

열거형
`CONTENT_CONFIG_UNSPECIFIED`	기본값
`NO_CONTENT`	`Document.content`이 없는 문서만 포함합니다.
`CONTENT_REQUIRED`	`Document.content`이(가) 있는 문서만 포함합니다.
`PUBLIC_WEBSITE`	데이터 스토어는 공개 웹사이트 검색에 사용됩니다.
`GOOGLE_WORKSPACE`	데이터 스토어는 작업공간 검색에 사용됩니다. 작업공간 데이터 저장소의 세부정보는 `WorkspaceConfig`에 명시되어 있습니다.

ServingConfigDataStore

DataStore 수준의 서빙 구성에 관한 정보를 저장합니다.

필드

disabled_for_serving

bool

(선택사항) true로 설정하면 DataStore를 사용하여 검색 요청을 처리할 수 없습니다.

DeleteAssistantRequest

AssistantService.DeleteAssistant 메서드에 대한 요청 메시지입니다.

필드

name

string

필수 항목입니다. Assistant의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

호출자에게 Assistant를 삭제할 권한이 없으면 Assistant의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

삭제할 Assistant이 존재하지 않으면 NOT_FOUND 오류가 반환됩니다.

DeleteCmekConfigMetadata

CmekConfigService.DeleteCmekConfig 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

DeleteCmekConfigRequest

CmekConfigService.DeleteCmekConfig 메서드의 요청 메시지입니다.

필드

name

string

필수 항목입니다. 삭제할 CmekConfig의 리소스 이름입니다(예: projects/{project}/locations/{location}/cmekConfigs/{cmek_config}).

DeleteCollectionMetadata

[CollectionService.UpdateCollection][] 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

DeleteCollectionRequest

CollectionService.DeleteCollection 메서드의 요청 메시지입니다.

필드

name

string

필수 항목입니다. projects/{project}/locations/{location}/collections/{collection} 형식의 컬렉션 전체 리소스 이름입니다.

DeleteControlRequest

DeleteControl 메서드 요청입니다.

필드

name

string

필수 항목입니다. 삭제할 컨트롤의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

DeleteConversationRequest

DeleteConversation 메서드 요청입니다.

필드

name

string

필수 항목입니다. 삭제할 대화의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

DeleteDataStoreMetadata

DataStoreService.DeleteDataStore 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

DeleteDataStoreRequest

DataStoreService.DeleteDataStore 메서드의 요청 메시지입니다.

필드

name

string

필수 항목입니다. DataStore의 전체 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}).

호출자에게 DataStore를 삭제할 권한이 없으면 DataStore의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

삭제할 DataStore이 존재하지 않으면 NOT_FOUND 오류가 반환됩니다.

DeleteDocumentRequest

DocumentService.DeleteDocument 메서드의 요청 메시지입니다.

필드

name

string

필수 항목입니다. Document의 전체 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}).

호출자에게 Document를 삭제할 권한이 없으면 Document의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

삭제할 Document가 없으면 NOT_FOUND 오류가 반환됩니다.

DeleteEngineMetadata

EngineService.DeleteEngine 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

DeleteEngineRequest

EngineService.DeleteEngine 메서드의 요청 메시지입니다.

필드

name

string

필수 항목입니다. Engine의 전체 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}).

호출자에게 Engine를 삭제할 권한이 없으면 Engine의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

삭제할 Engine이 존재하지 않으면 NOT_FOUND 오류가 반환됩니다.

DeleteIdentityMappingStoreMetadata

IdentityMappingStoreService.DeleteIdentityMappingStore 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

DeleteIdentityMappingStoreRequest

IdentityMappingStoreService.DeleteIdentityMappingStore의 요청 메시지

필드

name

string

필수 항목입니다. 삭제할 ID 매핑 저장소의 이름입니다. 형식: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

DeleteSchemaMetadata

DeleteSchema LRO의 메타데이터입니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

DeleteSchemaRequest

SchemaService.DeleteSchema 메서드의 요청 메시지입니다.

필드

name

string

필수 항목입니다. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema} 형식의 스키마 전체 리소스 이름입니다.

DeleteSessionRequest

DeleteSession 메서드 요청입니다.

필드

name

string

필수 항목입니다. 삭제할 세션의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

DeleteSitemapMetadata

SiteSearchEngineService.DeleteSitemap 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

DeleteSitemapRequest

SiteSearchEngineService.DeleteSitemap 메서드의 요청 메시지입니다.

필드

name

string

필수 항목입니다. Sitemap의 전체 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}).

호출자에게 Sitemap에 액세스할 권한이 없으면 Sitemap의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

요청된 Sitemap이 없으면 NOT_FOUND 오류가 반환됩니다.

DeleteTargetSiteMetadata

SiteSearchEngineService.DeleteTargetSite 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

DeleteTargetSiteRequest

SiteSearchEngineService.DeleteTargetSite 메서드의 요청 메시지입니다.

필드

name

string

필수 항목입니다. TargetSite의 전체 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}).

호출자에게 TargetSite에 액세스할 권한이 없으면 TargetSite의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

요청된 TargetSite이 없으면 NOT_FOUND 오류가 반환됩니다.

DestinationConfig

서드 파티 소스에 연결하는 데 사용되는 타겟 엔드포인트를 정의합니다.

필드
`key`	`string` (선택사항) 커넥터에서 지원하는 고유한 대상 식별자입니다.
`destinations[]`	`Destination` (선택사항) 해당 키의 대상입니다.
통합 필드 `destination_config_params`. 이 대상 구성의 추가 매개변수입니다. `destination_config_params`은 다음 중 하나여야 합니다.
`params`	`Struct` (선택사항) 구조화된 JSON 형식의 이 대상 구성에 대한 추가 매개변수입니다.
`json_params`	`string` json 문자열 형식의 이 대상 구성에 대한 추가 매개변수입니다.

대상

타겟 엔드포인트를 정의합니다.

필드

port

int32

(선택사항) 대상에서 허용하는 대상 포트 번호입니다.

통합 필드 destination. 엔드포인트 대상입니다. destination은 다음 중 하나여야 합니다.

host

string

공개적으로 라우팅 가능한 호스트입니다.

DisableAdvancedSiteSearchMetadata

SiteSearchEngineService.DisableAdvancedSiteSearch 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

DisableAdvancedSiteSearchRequest

SiteSearchEngineService.DisableAdvancedSiteSearch 메서드의 요청 메시지입니다.

필드

site_search_engine

string

필수 항목입니다. SiteSearchEngine의 전체 리소스 이름입니다(예: projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine).

DisableAdvancedSiteSearchResponse

이 유형에는 필드가 없습니다.

SiteSearchEngineService.DisableAdvancedSiteSearch 메서드의 응답 메시지입니다.

문서

Document는 추천하거나 검색할 항목의 모든 원시 메타데이터 정보를 캡처합니다.

필드
`name`	`string` 변경할 수 없습니다. 문서의 전체 리소스 이름입니다. 형식은 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`입니다. 이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 1,024자(영문 기준)입니다.
`id`	`string` 변경할 수 없습니다. 문서의 식별자입니다. ID는 RFC-1034 표준을 준수해야 하며 길이 제한은 128자(영문 기준)입니다.
`schema_id`	`string` 같은 데이터 스토어에 있는 스키마의 식별자입니다.
`content`	`Content` 이 문서에 연결된 비정형 데이터입니다. 콘텐츠는 `CONTENT_REQUIRED` 데이터 스토어에 있는 경우에만 설정할 수 있으며 설정해야 합니다.
`parent_document_id`	`string` 상위 문서의 식별자입니다. 현재 최대 2단계 문서 계층 구조를 지원합니다. ID는 RFC-1034 표준을 준수해야 하며 길이 제한은 63자(영문 기준)입니다.
`derived_struct_data`	`Struct` 출력 전용입니다. 이 필드는 OUTPUT_ONLY입니다. 원래 입력 문서에 없는 파생 데이터가 포함되어 있습니다.
`acl_info`	`AclInfo` 문서의 액세스 제어 정보입니다.
`index_time`	`Timestamp` 출력 전용입니다. 문서의 색인이 마지막으로 생성된 시간입니다. 이 필드가 설정되면 문서가 검색 결과에 반환될 수 있습니다. 이 필드는 OUTPUT_ONLY입니다. 이 필드가 채워지지 않으면 문서가 색인 생성된 적이 없다는 의미입니다.
`index_status`	`IndexStatus` 출력 전용입니다. 문서의 색인 상태입니다. 문서의 색인이 생성되면 index_time 필드가 채워집니다. 오류로 인해 문서의 색인이 생성되지 않은 경우 error_samples 필드가 채워집니다. 그렇지 않으면 문서의 색인이 진행 중인 경우 pending_message 필드가 채워집니다.
통합 필드 `data`. 데이터 표현 `struct_data` 또는 `json_data` 중 하나를 제공해야 합니다. 그렇지 않으면 `INVALID_ARGUMENT` 오류가 발생합니다. `data`은 다음 중 하나여야 합니다.
`struct_data`	`Struct` 문서의 구조화된 JSON 데이터입니다. 등록된 `Schema`를 준수해야 합니다. 그렇지 않으면 `INVALID_ARGUMENT` 오류가 발생합니다.
`json_data`	`string` 문서의 JSON 문자열 표현입니다. 등록된 `Schema`를 준수해야 합니다. 그렇지 않으면 `INVALID_ARGUMENT` 오류가 발생합니다.

AclInfo

문서의 ACL 정보입니다.

필드

readers[]

AccessRestriction

문서의 독자입니다.

AccessRestriction

복잡한 상속 제한을 모델링하는 AclRestriction

예: 사용자가 하위 문서에 액세스하려면 상위 문서에 대한 액세스 권한이 있어야 하는 '모두 허용' 상속을 모델링합니다.

문서 계층 구조 - Space_S --> Page_P

리더: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2

Space_S ACL 제한 - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } }

Page_P ACL 제한 { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } }

필드

principals[]

Principal

주 구성원 목록입니다.

idp_wide

bool

ID 공급업체 내의 모든 사용자입니다.

콘텐츠

이 문서에 연결된 비정형 데이터입니다.

필드
`mime_type`	`string` 콘텐츠의 MIME 유형입니다. 지원되는 유형: `application/pdf` (PDF, 현재 기본 PDF만 지원됨) `text/html` (HTML) `text/plain` (TXT) `application/xml` 또는 `text/xml` (XML) `application/json`(JSON) `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) 다음 유형은 데이터 스토어에서 레이아웃 파서가 사용 설정된 경우에만 지원됩니다. `image/bmp` (BMP) `image/gif` (GIF) `image/jpeg` (JPEG) `image/png` (PNG) `image/tiff` (TIFF) https://www.iana.org/assignments/media-types/media-types.xhtml을 참고하세요.
통합 필드 `content`. 구조화되지 않은 문서의 콘텐츠입니다. `content`은 다음 중 하나여야 합니다.
`raw_bytes`	`bytes` 바이트 스트림으로 표현된 콘텐츠입니다. 최대 길이는 1,000,000바이트 (1MB / ~0.95MiB)입니다. 참고: 모든 `bytes` 필드와 마찬가지로 이 필드는 프로토콜 버퍼에서는 순수 바이너리로, JSON에서는 base64로 인코딩된 문자열로 표현됩니다. 예를 들어 `abc123!?$*&()'-=@~`은 JSON에서 `YWJjMTIzIT8kKiYoKSctPUB+`로 표현되어야 합니다. https://developers.google.com/protocol-buffers/docs/proto3#json을 참고하세요.
`uri`	`string` 콘텐츠의 URI입니다. Cloud Storage URI (예: `gs://bucket-name/path/to/file`)만 지원됩니다. 최대 파일 크기는 텍스트 기반 형식의 경우 2.5MB, 다른 형식의 경우 200MB입니다.

IndexStatus

문서의 색인 상태입니다.

필드

index_time

문서의 색인이 생성된 시간입니다. 이 필드에 값이 입력되어 있으면 문서의 색인이 생성된 것입니다.

error_samples[]

LayoutBasedChunkingConfig

문서를 색인 생성하는 중에 발생한 오류 샘플입니다. 이 필드가 채워져 있으면 오류로 인해 문서의 색인이 생성되지 않습니다.

pending_message

string

변경할 수 없습니다. 메시지는 문서 색인이 진행 중임을 나타냅니다. 이 필드가 채워지면 문서 색인이 대기 중입니다.

DocumentInfo

사용자 이벤트와 연결된 세부적인 문서 정보입니다.

필드
`promotion_ids[]`	`string` 이 문서와 연결된 프로모션 ID입니다. 현재 이 필드는 ID가 최대 1개로 제한됩니다.
`joined`	`bool` 출력 전용입니다. 참조된 문서를 데이터 스토어에서 찾을 수 있는지 여부입니다.
통합 필드 `document_descriptor`. 연결된 `Document`의 필수 설명자입니다. `id`가 지정되면 저장된 문서로 주석을 달 때 `{location}`, `{collection_id}`, `{data_store_id}`, `{branch_id}`의 기본값이 사용됩니다. `name`가 지정되면 저장된 문서로 주석을 달 때 `{location}`, `{collection_id}`, `{data_store_id}`, `{branch_id}`에 제공된 값 (기본값 허용)이 사용됩니다. `document_descriptor`은 다음 중 하나여야 합니다.
`id`	`string` `Document` 리소스 ID입니다.
`name`	`string` `Document` 리소스 전체 이름으로, 형식은 `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`입니다.
`uri`	`string` `Document` URI - 웹사이트 데이터 스토어에만 허용됩니다.
`quantity`	`int32` 사용자 이벤트와 연결된 문서의 수량입니다. 기본값은 1입니다. 예를 들어 동일한 문서의 수량이 2개인 경우 `add-to-cart` 이벤트에 참여하면 이 필드는 2가 됩니다. 다음 이벤트 유형의 이벤트에 필요합니다. `add-to-cart` `purchase`
`conversion_value`	`float` (선택사항) 이 문서와 연결된 전환 가치입니다. `UserEvent.event_type`이 'conversion'인 경우 설정해야 합니다. 예를 들어 값 1000은 `watch` 전환 유형의 문서를 보는 데 1, 000초가 소요되었음을 나타냅니다.

DocumentProcessingConfig

DataStore의 싱글톤 리소스입니다. DataStore이 생성되고 DataStore이 DataStore.ContentConfig.CONTENT_REQUIRED로 설정될 때 비어 있으면 기본 파서는 디지털 파서로 기본 설정됩니다.

필드
`name`	`string` 문서 처리 구성의 전체 리소스 이름입니다. 형식은 `projects//locations//collections//dataStores//documentProcessingConfig`입니다.
`chunking_config`	`ChunkingConfig` 청크 모드 사용 설정 여부입니다.
`default_parsing_config`	`ParsingConfig` 기본 문서 파서의 구성입니다. 지정하지 않으면 기본 DigitalParsingConfig로 구성되며 기본 파싱 구성이 문서 파싱의 모든 파일 형식에 적용됩니다.
`parsing_config_overrides`	`map<string, ParsingConfig>` 파일 형식에 따라 기본 파싱 구성을 재정의하는 파일 형식의 매핑입니다. 지원되는 키: `pdf`: PDF 파일의 파싱 구성을 재정의합니다. 디지털 파싱, OCR 파싱 또는 레이아웃 파싱이 지원됩니다. `html`: HTML 파일의 파싱 구성을 재정의합니다. 디지털 파싱과 레이아웃 파싱만 지원됩니다. `docx`: DOCX 파일의 파싱 구성을 재정의합니다. 디지털 파싱과 레이아웃 파싱만 지원됩니다. `pptx`: PPTX 파일의 파싱 구성을 재정의합니다. 디지털 파싱과 레이아웃 파싱만 지원됩니다. `xlsm`: XLSM 파일의 파싱 구성을 재정의합니다. 디지털 파싱과 레이아웃 파싱만 지원됩니다. `xlsx`: XLSX 파일의 파싱 구성을 재정의합니다. 디지털 파싱과 레이아웃 파싱만 지원됩니다.

ChunkingConfig

청크 생성 구성의 구성입니다.

필드

통합 필드 chunk_mode. 청크의 동작을 정의하는 추가 구성입니다. chunk_mode은 다음 중 하나여야 합니다.

layout_based_chunking_config

레이아웃 기반 청킹의 구성입니다.

LayoutBasedChunkingConfig

레이아웃 기반 청킹의 구성입니다.

필드

chunk_size

int32

각 청크의 토큰 크기 제한입니다.

지원되는 값: 100~500 (양 끝값 포함) 기본값: 500

include_ancestor_headings

bool

컨텍스트 손실을 방지하기 위해 문서 중간에서 청크에 여러 수준의 제목을 추가할지 여부입니다.

기본값은 False입니다.

ParsingConfig

특정 유형의 문서 파서에 적용되는 관련 구성입니다.

필드
통합 필드 `type_dedicated_config`. 문서 처리 유형의 구성입니다. `type_dedicated_config`은 다음 중 하나여야 합니다.
`digital_parsing_config`	`DigitalParsingConfig` 디지털 파서에 적용된 구성입니다.
`ocr_parsing_config`	`OcrParsingConfig` OCR 파서에 적용된 구성입니다. 현재는 PDF에만 적용됩니다.
`layout_parsing_config`	`LayoutParsingConfig` 레이아웃 파서에 적용된 구성입니다.

DigitalParsingConfig

이 유형에는 필드가 없습니다.

문서의 디지털 파싱 구성입니다.

LayoutParsingConfig

문서의 레이아웃 파싱 구성입니다.

필드
`enable_table_annotation`	`bool` (선택사항) true인 경우 파싱 중에 LLM 기반 주석이 표에 추가됩니다.
`enable_image_annotation`	`bool` (선택사항) true인 경우 파싱 중에 LLM 기반 주석이 이미지에 추가됩니다.
`structured_content_types[]`	`string` (선택사항) 문서에서 추출할 필수 구조 유형을 포함합니다. 지원되는 값: `shareholder-structure`
`exclude_html_elements[]`	`string` (선택사항) 파싱된 콘텐츠에서 제외할 HTML 요소 목록입니다.
`exclude_html_classes[]`	`string` (선택사항) 파싱된 콘텐츠에서 제외할 HTML 클래스 목록입니다.
`exclude_html_ids[]`	`string` (선택사항) 파싱된 콘텐츠에서 제외할 HTML ID 목록입니다.
`enable_get_processed_document`	`bool` (선택사항) true인 경우 처리된 문서를 GetProcessedDocument API에서 사용할 수 있습니다.

OcrParsingConfig

문서의 OCR 파싱 구성입니다.

필드

enhanced_document_elements[]
(deprecated)

string

[지원 중단됨] 이 필드는 지원 중단되었습니다. 추가 향상된 문서 요소 처리를 사용하려면 layout_parsing_config로 전환하세요.

use_native_text

bool

true인 경우 기본 텍스트가 포함된 페이지에서 OCR 텍스트 대신 기본 텍스트를 사용합니다.

DoubleList

이중 목록

필드

values[]

double

double 값입니다.

EnableAdvancedSiteSearchMetadata

SiteSearchEngineService.EnableAdvancedSiteSearch 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

RecommendedForYouFeatureConfig

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

EnableAdvancedSiteSearchRequest

SiteSearchEngineService.EnableAdvancedSiteSearch 메서드의 요청 메시지입니다.

필드

site_search_engine

string

필수 항목입니다. SiteSearchEngine의 전체 리소스 이름입니다(예: projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine).

EnableAdvancedSiteSearchResponse

이 유형에는 필드가 없습니다.

SiteSearchEngineService.EnableAdvancedSiteSearch 메서드의 응답 메시지입니다.

엔진

Engine의 학습 및 서빙 매개변수를 설명하는 메타데이터입니다.

필드
`name`	`string` 변경할 수 없습니다. 식별자. 엔진의 정규화된 리소스 이름입니다. 이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 1,024자(영문 기준)입니다. 형식: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` 엔진은 1~63자(영문 기준)여야 하며 유효한 문자는 /[a-z0-9][a-z0-9-_]*/입니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.
`display_name`	`string` 필수 항목입니다. 엔진의 표시 이름입니다. 사람이 읽을 수 있어야 합니다. 길이 제한이 1,024자인 UTF-8로 인코딩된 문자열입니다.
`create_time`	`Timestamp` 출력 전용입니다. 추천 엔진이 생성된 타임스탬프입니다.
`update_time`	`Timestamp` 출력 전용입니다. 추천 엔진이 마지막으로 업데이트된 타임스탬프입니다.
`data_store_ids[]`	`string` (선택사항) 이 엔진과 연결된 데이터 스토어입니다. `SOLUTION_TYPE_SEARCH` 및 `SOLUTION_TYPE_RECOMMENDATION` 유형의 엔진은 최대 하나의 데이터 스토어와만 연결할 수 있습니다. `solution_type`이 `SOLUTION_TYPE_CHAT`인 경우 동일한 `Collection`의 여러 `DataStore`를 여기에 연결할 수 있습니다. `CreateEngineRequest`에서 사용되는 경우 시스템에서 필요한 초기화에 사용하므로 하나의 DataStore ID를 제공해야 합니다.
`solution_type`	`SolutionType` 필수 항목입니다. 엔진의 솔루션입니다.
`industry_vertical`	`IndustryVertical` (선택사항) 엔진이 등록하는 업종 카테고리입니다. 엔진 업종 카테고리 제한은 `DataStore`에 기반합니다. 엔진의 업종 카테고리는 엔진에 연결된 데이터 스토어의 업종 카테고리와 일치해야 합니다.
`common_config`	`CommonConfig` 엔진의 메타데이터를 지정하는 일반 구성 사양입니다.
`app_type`	`AppType` (선택사항) 변경할 수 없습니다. 이 엔진 리소스가 나타내는 애플리케이션 유형입니다. 참고: 이는 기존 업종 카테고리 또는 솔루션 유형과 별개의 새로운 개념입니다.
`disable_analytics`	`bool` (선택사항) 이 엔진에서 실행된 검색의 분석을 사용 중지할지 여부입니다.
`features`	`map<string, FeatureState>` (선택사항) 엔진이 기능을 선택하거나 선택 해제하는 기능 구성 지원되는 키: `*`: 모든 기능입니다. 이 값이 있으면 다른 모든 기능 상태 설정은 무시됩니다. `agent-gallery` `no-code-agent-builder` `prompt-gallery` `model-selector` `notebook-lm` `people-search` `people-search-org-chart` `bi-directional-audio` `feedback` `session-sharing` `personalization-memory` `disable-agent-sharing` `disable-image-generation` `disable-video-generation` `disable-onedrive-upload` `disable-talk-to-content` `disable-google-drive-upload`
`configurable_billing_approach`	`ConfigurableBillingApproach` (선택사항) 구성 가능한 결제 접근 방식의 구성입니다.
통합 필드 `engine_config`. 엔진의 동작을 정의하는 추가 구성 사양입니다. `engine_config`은 다음 중 하나여야 합니다.
`chat_engine_config`	`ChatEngineConfig` Chat Engine 구성입니다. `solution_type`이 `SOLUTION_TYPE_CHAT`인 경우에만 적용됩니다.
`search_engine_config`	`SearchEngineConfig` 검색 엔진의 구성입니다. `solution_type`이 `SOLUTION_TYPE_SEARCH`인 경우에만 적용됩니다.
`media_recommendation_engine_config`	`MediaRecommendationEngineConfig` 미디어 엔진 구성입니다. `solution_type` `SOLUTION_TYPE_RECOMMENDATION` 및 `IndustryVertical.MEDIA` 업종이 있는 데이터 스토어에만 적용됩니다.
통합 필드 `engine_metadata`. 엔진 상태를 모니터링하는 엔진 메타데이터입니다. `engine_metadata`은 다음 중 하나여야 합니다.
`chat_engine_metadata`	`ChatEngineMetadata` 출력 전용입니다. Chat Engine의 추가 정보입니다. `solution_type`이 `SOLUTION_TYPE_CHAT`인 경우에만 적용됩니다.

AppType

엔진의 앱입니다.

열거형
`APP_TYPE_UNSPECIFIED`	지정되지 않은 모든 앱
`APP_TYPE_INTRANET`	인트라넷 검색 및 Agentspace의 앱 유형입니다.

ChatEngineConfig

Chat Engine의 구성입니다.

필드

agent_creation_config

AgentCreationConfig

이 엔진과 연결된 Dialogflow 에이전트를 생성하는 구성입니다.

이러한 구성은 Dialogflow 서비스에서 한 번 사용되고 전달됩니다. 즉, 엔진을 만든 후에는 EngineService.GetEngine 또는 EngineService.ListEngines API를 사용하여 검색할 수 없습니다.

dialogflow_agent_to_link

string

이 Chat Engine에 연결할 기존 Dialogflow 에이전트의 리소스 이름입니다. 고객은 agent_creation_config를 제공하여 에이전트를 만들거나 에이전트를 채팅 엔진에 연결하는 에이전트 이름을 제공할 수 있습니다.

형식은 projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>입니다.

dialogflow_agent_to_link는 Dialogflow 서비스에서 한 번 사용되고 전달됩니다. 즉, 엔진을 만든 후에는 EngineService.GetEngine 또는 EngineService.ListEngines API를 사용하여 검색할 수 없습니다. 엔진이 생성된 후 실제 에이전트 연결에는 ChatEngineMetadata.dialogflow_agent를 사용합니다.

allow_cross_region

bool

(선택사항) 플래그가 true로 설정된 경우 에이전트와 엔진이 서로 다른 위치에 있을 수 있습니다. 그렇지 않으면 에이전트와 엔진이 동일한 위치에 있어야 합니다. 플래그는 기본적으로 false로 설정됩니다.

allow_cross_region는 EngineService.CreateEngine에 의해 일회성으로 사용되고 전달됩니다. 즉, 엔진을 만든 후에는 EngineService.GetEngine 또는 EngineService.ListEngines API를 사용하여 검색할 수 없습니다.

AgentCreationConfig

Dialogflow 에이전트 생성 구성입니다.

필드
`business`	`string` 대리인이 대표하는 회사, 조직 또는 기타 법인의 이름입니다. 지식 커넥터 LLM 프롬프트 및 지식 검색에 사용됩니다.
`default_language_code`	`string` 필수 항목입니다. 에이전트 기본 언어로, 언어 태그로 사용됩니다. 현재 지원되는 언어 코드 목록은 언어 지원을 참조하세요.
`time_zone`	`string` 필수 항목입니다. 시간대 데이터베이스의 에이전트 시간대입니다(예: America/New_York, Europe/Paris).
`location`	`string` 에이전트 생성의 에이전트 위치입니다. 지원되는 값은 global/us/eu입니다. 제공되지 않으면 미국 엔진은 기본적으로 us-central-1을 사용하여 에이전트를 생성하고, EU 엔진은 기본적으로 eu-west-1을 사용하여 에이전트를 생성합니다.

ChatEngineMetadata

Chat Engine의 추가 정보입니다. 이 메시지의 필드는 출력 전용입니다.

필드

dialogflow_agent

string

이 Chat Engine이 참조하는 Dialogflow 에이전트의 리소스 이름입니다.

형식은 projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>입니다.

CommonConfig

엔진의 일반 구성

필드

company_name

string

엔진과 연결된 회사, 비즈니스 또는 법인의 이름입니다. 이 설정을 사용하면 LLM 관련 기능을 개선하는 데 도움이 될 수 있습니다.

ConfigurableBillingApproach

구성 가능한 결제 접근 방식의 구성입니다.

열거형
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	기본값 Spark 및 비Spark 구성 불가능한 결제 접근 방식 일반 가격 책정 모델입니다.
`CONFIGURABLE_BILLING_APPROACH_ENABLED`	청구 접근 방식은 고객이 지정한 구성을 따릅니다.

FeatureState

엔진의 기능 상태입니다.

열거형
`FEATURE_STATE_UNSPECIFIED`	기능 상태가 지정되지 않았습니다.
`FEATURE_STATE_ON`	이 기능은 액세스할 수 있도록 사용 설정되어 있습니다.
`FEATURE_STATE_OFF`	이 기능은 액세스할 수 없도록 사용 중지되어 있습니다.

MediaRecommendationEngineConfig

미디어 추천 엔진의 추가 구성 사양입니다.

필드
`type`	`string` 필수 항목입니다. 엔진 유형입니다. 예를 들면 `recommended-for-you`개 이 필드는 `optimization_objective`와 함께 엔진 학습 및 제공을 제어하는 데 사용할 엔진 메타데이터를 설명합니다. 현재 지원되는 값: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`
`optimization_objective`	`string` 최적화 목표입니다. 예: `cvr`개 이 필드는 `optimization_objective`와 함께 엔진 학습 및 제공을 제어하는 데 사용할 엔진 메타데이터를 설명합니다. 현재 지원되는 값은 `ctr`, `cvr`입니다. 지정하지 않으면 엔진 유형에 따라 기본값이 선택됩니다. 기본값은 추천 유형에 따라 다릅니다. `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
`optimization_objective_config`	`OptimizationObjectiveConfig` cvr 최적화_목표의 맞춤 기준점의 이름과 값입니다. target_field `watch-time`의 경우 target_field_value는 [0, 86400] (0은 제외, 86400은 포함) 사이의 미디어 진행 시간을 초 단위로 나타내는 정수여야 합니다(예: 90). target_field `watch-percentage`의 경우 target_field_value는 (0, 1.0] (0은 제외, 1.0은 포함) 사이의 유효한 부동 소수점 값이어야 합니다(예: 0.5).
`training_state`	`TrainingState` 엔진의 학습 상태입니다 (예: `TRAINING` 또는 `PAUSED`). 서비스 실행 비용의 일부는 학습 빈도이므로 이를 사용하여 비용을 관리하기 위해 엔진을 학습할 시기를 결정할 수 있습니다. 지정되지 않은 경우: `CreateEngine` 메서드의 기본값은 `TRAINING`입니다. `UpdateEngine` 메서드의 기본값은 이전과 동일한 상태를 유지하는 것입니다.
`engine_features_config`	`EngineFeaturesConfig` (선택사항) 추가 엔진 기능 구성입니다.

EngineFeaturesConfig

선택한 엔진 유형의 추가 기능 구성입니다.

필드

통합 필드 type_dedicated_config. 특정 유형의 미디어 추천 엔진에 적용되는 기능 관련 구성입니다. type_dedicated_config은 다음 중 하나여야 합니다.

recommended_for_you_config

엔진 기능 구성에 권장됩니다.

most_popular_config

MostPopularFeatureConfig

가장 인기 있는 엔진 기능 구성입니다.

MostPopularFeatureConfig

최고 인기 엔진을 만드는 데 필요한 기능 구성입니다.

필드

time_window_days

int64

학습 및 예측 시간에 엔진이 쿼리되는 시간 창입니다. 양의 정수만 허용됩니다. 이 값은 지난 X일 동안의 이벤트로 변환됩니다. 현재 most-popular-items 엔진에 필요합니다.

OptimizationObjectiveConfig

cvr optimization_objective의 맞춤 기준입니다.

필드

target_field

string

필수 항목입니다. 타겟팅할 필드의 이름입니다. 현재 지원되는 값은 watch-percentage, watch-time입니다.

target_field_value_float

float

필수 항목입니다. 타겟에 적용할 기준점입니다 (예: 0.5).

RecommendedForYouFeatureConfig

recommended-for-you 엔진을 만들기 위한 추가 기능 구성입니다.

필드

context_event_type

string

예측 시간에 엔진이 쿼리되는 이벤트 유형입니다. generic로 설정하면 엔진 학습에서 view-item, media-play, media-complete만 context-event로 사용됩니다. view-home-page로 설정된 경우 view-home-page는 view-item, media-play, media-complete 외에 context-events로도 사용됩니다. 현재 recommended-for-you 엔진에서 지원됩니다. 현재 지원되는 값은 view-home-page, generic입니다.

TrainingState

엔진의 학습 상태입니다.

열거형
`TRAINING_STATE_UNSPECIFIED`	지정되지 않은 학습 상태입니다.
`PAUSED`	엔진 학습이 일시중지되었습니다.
`TRAINING`	엔진이 학습 중입니다.

SearchEngineConfig

검색 엔진의 구성입니다.

필드

search_tier

SearchTier

이 엔진의 검색 기능 등급입니다.

요금제마다 가격이 다를 수 있습니다. 자세한 내용은 가격 책정 문서를 참고하세요.

지정하지 않을 경우 기본값은 SearchTier.SEARCH_TIER_STANDARD입니다.

search_add_ons[]

SearchAddOn

이 검색엔진이 사용 설정하는 부가기능입니다.

FactChunk

사실 청크입니다.

필드
`chunk_text`	`string` 사실 청크의 텍스트 콘텐츠입니다. 최대 10,000자(영문 기준)까지 가능합니다.
`source`	`string` 이 사실 청크가 검색된 소스입니다. 요청에 제공된 GroundingFacts에서 가져온 경우 이 필드에는 이 청크가 가져온 특정 사실의 색인이 포함됩니다.
`index`	`int32` 이 청크의 색인입니다. 현재 스트리밍 모드에만 사용됩니다.
`source_metadata`	`map<string, string>` 소스 참조에 대한 더 세부적인 정보입니다.
`uri`	`string` 소스의 URI입니다.
`title`	`string` 소스의 제목입니다.
`domain`	`string` 소스의 도메인입니다.

FetchDomainVerificationStatusRequest

SiteSearchEngineService.FetchDomainVerificationStatus 메서드의 요청 메시지입니다.

필드

site_search_engine

string

필수 항목입니다. 모든 도메인 확인 상태를 가져오는 사이트 검색엔진 리소스입니다. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine개

page_size

int32

요청한 페이지 크기입니다. 서버에서 요청한 것보다 적은 항목을 반환할 수 있습니다. 지정하지 않으면 서버에서 적절한 기본값을 선택합니다. 최댓값은 1,000이며, 1,000을 초과하는 값은 1,000으로 변환됩니다.

이 필드가 음수이면 INVALID_ARGUMENT 오류가 반환됩니다.

page_token

string

이전 FetchDomainVerificationStatus 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

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

FetchDomainVerificationStatusResponse

SiteSearchEngineService.FetchDomainVerificationStatus 메서드의 응답 메시지입니다.

필드

target_sites[]

사이트 인증 상태가 포함된 TargetSite 목록입니다.

next_page_token

string

다음 페이지를 검색하기 위해 page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

total_size

int32

요청과 일치하는 항목의 총수입니다. 이 필드는 항상 응답에 채워집니다.

FetchSitemapsRequest

SiteSearchEngineService.FetchSitemaps 메서드의 요청 메시지입니다.

필드

parent

string

필수 항목입니다. SiteSearchEngine의 상위 리소스 이름입니다(예: projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine).

matcher

Matcher

(선택사항) 지정된 경우 일치하는 Sitemap를 가져옵니다. 지정하지 않으면 DataStore의 모든 Sitemap를 가져옵니다.

Matcher

Sitemap의 매처입니다. 현재는 URI 매처만 지원합니다.

필드

통합 필드 matcher. Sitemap의 매처입니다. matcher은 다음 중 하나일 수 있습니다.

uris_matcher

UrisMatcher

사이트맵 URI별 매처입니다.

UrisMatcher

URI별 Sitemap 매처입니다.

필드

uris[]

string

Sitemap URI

FetchSitemapsResponse

SiteSearchEngineService.FetchSitemaps 메서드의 응답 메시지입니다.

필드

sitemaps_metadata[]

SitemapMetadata

가져온 Sitemap 목록입니다.

SitemapMetadata

Sitemap 및 해당 메타데이터가 포함되어 있습니다.

필드

sitemap

Sitemap

FhirStoreSource

데이터를 가져올 Cloud FhirStore 소스입니다.

필드
`fhir_store`	`string` 필수 항목입니다. 데이터를 가져올 FHIR 저장소의 전체 리소스 이름입니다(`projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}` 형식).
`gcs_staging_dir`	`string` 가져오기에 사용되는 중간 Cloud Storage 디렉터리입니다. 길이는 2,000자로 제한됩니다. 특정 Cloud Storage 디렉터리로 FhirStore 내보내기를 사용하려는 경우에 지정할 수 있습니다.
`resource_types[]`	`string` 가져올 FHIR 리소스 유형입니다. 리소스 유형은 모든 지원되는 FHIR 리소스 유형의 하위 집합이어야 합니다. 비어 있는 경우 지원되는 모든 FHIR 리소스 유형으로 기본 설정됩니다.
`update_from_latest_predefined_schema`	`bool` (선택사항) DataStore 스키마를 최신 사전 정의된 스키마로 업데이트할지 여부입니다. true인 경우 마지막 가져오기 이후에 추가된 FHIR 필드 또는 리소스 유형을 포함하도록 DataStore 스키마가 업데이트되고 해당 FHIR 리소스가 FHIR 스토어에서 가져옵니다. 이 필드는 `resource_types`와 함께 사용할 수 없습니다. 초기 가져오기 후에 사용해야 합니다.

FirestoreSource

Firestore 소스에서 데이터를 가져옵니다.

필드
`project_id`	`string` Cloud SQL 소스가 있는 프로젝트 ID입니다(길이 제한 128자). 지정하지 않으면 상위 요청에서 프로젝트 ID를 상속합니다.
`database_id`	`string` 필수 항목입니다. 데이터를 복사할 Firestore 데이터베이스입니다(길이 제한 256자).
`collection_id`	`string` 필수 항목입니다. 데이터를 복사할 Firestore 컬렉션(또는 항목)입니다(길이 제한: 1,500자).
`gcs_staging_dir`	`string` 가져오기에 사용되는 중간 Cloud Storage 디렉터리입니다. 길이는 2,000자로 제한됩니다. 특정 Cloud Storage 디렉터리로 Firestore 내보내기를 사용하려는 경우에 지정할 수 있습니다. Firestore 서비스 계정에 지정된 Cloud Storage 디렉터리에 액세스하는 데 필요한 Cloud Storage 관리자 권한이 있는지 확인합니다.

GcsSource

입력 콘텐츠의 Cloud Storage 위치입니다.

필드

input_uris[]

string

필수 항목입니다. 입력 파일을 가리키는 Cloud Storage URI입니다. 각 URI는 최대 2,000자(영문 기준)일 수 있습니다. URI는 전체 객체 경로(예: gs://bucket/directory/object.json) 또는 하나 이상의 파일을 일치시키는 패턴(예: gs://bucket/directory/*.json)과 일치할 수 있습니다.

요청은 최대 100개의 파일을 포함할 수 있습니다 (data_schema이 content인 경우 100,000개). 각 파일의 최대 크기는 2GB입니다 (data_schema이 content인 경우 100MB).

data_schema

string

소스에서 데이터를 파싱할 때 사용할 스키마입니다.

문서 가져오기에 지원되는 값:

document (기본값): 줄당 하나의 JSON Document입니다. 각 문서에는 유효한 Document.id가 있어야 합니다.
content: 구조화되지 않은 데이터 (예: PDF, HTML) input_uris와 일치하는 각 파일은 문서가 되며, ID는 16진수 문자열로 인코딩된 SHA256(URI)의 처음 128비트로 설정됩니다.
custom: 데이터 스토어의 정의된 Schema을 준수하는 임의 형식의 행당 맞춤 데이터 JSON 하나입니다. 일반 데이터 스토어 업종에서만 사용할 수 있습니다.
csv: 데이터 저장소의 정의된 Schema을 준수하는 헤더가 있는 CSV 파일입니다. 헤더 뒤의 각 항목은 문서로 가져옵니다. 일반 데이터 스토어 업종에서만 사용할 수 있습니다.

사용자 이벤트 가져오기에 지원되는 값:

user_event (기본값): 줄당 하나의 JSON UserEvent입니다.

GetAclConfigRequest

GetAclConfigRequest 메서드의 요청 메시지입니다.

필드

name

string

필수 항목입니다. AclConfig의 리소스 이름(예: projects/*/locations/*/aclConfig)

호출자에게 AclConfig에 액세스할 권한이 없으면 AclConfig의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

GetAnswerRequest

GetAnswer 메서드 요청입니다.

필드

name

string

필수 항목입니다. 가져올 대답의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}

GetAssistAnswerRequest

AssistAnswerService.GetAssistAnswer 메서드에 대한 요청 메시지입니다.

필드

name

string

필수 항목입니다. AssistAnswer의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}

GetAssistantRequest

AssistantService.GetAssistant 메서드에 대한 요청 메시지입니다.

필드

name

string

필수 항목입니다. Assistant의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

GetCmekConfigRequest

GetCmekConfigRequest 메서드의 요청 메시지입니다.

필드

name

string

필수 항목입니다. CmekConfig의 리소스 이름(예: projects/*/locations/*/cmekConfig 또는 projects/*/locations/*/cmekConfigs/*)

호출자에게 CmekConfig에 액세스할 권한이 없으면 CmekConfig의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

GetControlRequest

GetControl 메서드 요청입니다.

필드

name

string

필수 항목입니다. 가져올 컨트롤의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

GetConversationRequest

GetConversation 메서드 요청입니다.

필드

name

string

필수 항목입니다. 가져올 대화의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

GetDataConnectorRequest

DataConnectorService.GetDataConnector 메서드 요청입니다.

필드

name

string

필수 항목입니다. DataConnector의 전체 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection_id}/dataConnector).

호출자에게 DataConnector에 액세스할 권한이 없으면 DataConnector의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

요청된 DataConnector이 없으면 NOT_FOUND 오류가 반환됩니다.

GetDataStoreRequest

DataStoreService.GetDataStore 메서드의 요청 메시지입니다.

필드

name

string

필수 항목입니다. DataStore의 전체 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}).

호출자에게 DataStore에 액세스할 권한이 없으면 DataStore의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

요청된 DataStore이 없으면 NOT_FOUND 오류가 반환됩니다.

GetDocumentRequest

DocumentService.GetDocument 메서드의 요청 메시지입니다.

필드

name

string

호출자에게 Document에 액세스할 권한이 없으면 Document의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

요청된 Document가 없으면 NOT_FOUND 오류가 반환됩니다.

GetEngineRequest

EngineService.GetEngine 메서드의 요청 메시지입니다.

필드

name

string

필수 항목입니다. Engine의 전체 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}).

GetIdentityMappingStoreRequest

IdentityMappingStoreService.GetIdentityMappingStore의 요청 메시지

필드

name

string

필수 항목입니다. 가져올 ID 매핑 저장소의 이름입니다. 형식: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

GetLicenseConfigRequest

LicenseConfigService.GetLicenseConfig 메서드의 요청 메시지입니다.

필드

name

string

필수 항목입니다. LicenseConfig의 전체 리소스 이름입니다(예: projects/{project}/locations/{location}/licenseConfigs/*).

호출자에게 LicenseConfig에 액세스할 권한이 없으면 LicenseConfig의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

요청된 LicenseConfig이 없으면 NOT_FOUND 오류가 반환됩니다.

GetSchemaRequest

SchemaService.GetSchema 메서드의 요청 메시지입니다.

필드

name

string

필수 항목입니다. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema} 형식의 스키마 전체 리소스 이름입니다.

GetSessionRequest

GetSession 메서드 요청입니다.

필드

name

string

필수 항목입니다. 가져올 세션의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

include_answer_details

bool

(선택사항) true로 설정하면 모든 답변 세부정보를 포함한 전체 세션이 반환됩니다.

GetSiteSearchEngineRequest

SiteSearchEngineService.GetSiteSearchEngine 메서드의 요청 메시지입니다.

필드

name

string

필수 항목입니다. SiteSearchEngine의 리소스 이름(예: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine)

호출자에게 [SiteSearchEngine]에 액세스할 권한이 없으면 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

GetTargetSiteRequest

SiteSearchEngineService.GetTargetSite 메서드의 요청 메시지입니다.

필드

name

string

호출자에게 TargetSite에 액세스할 권한이 없으면 TargetSite의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

요청된 TargetSite이 없으면 NOT_FOUND 오류가 반환됩니다.

GroundingFact

그라운딩 사실

필드

fact_text

string

사실의 텍스트 콘텐츠입니다. 최대 10,000자(영문 기준)까지 가능합니다.

attributes

map<string, string>

사실과 연결된 속성입니다. 일반적인 속성에는 source (사실의 출처를 나타냄), author (사실의 작성자를 나타냄) 등이 있습니다.

HarmCategory

콘텐츠를 차단하는 유해 카테고리입니다.

열거형
`HARM_CATEGORY_UNSPECIFIED`	피해 카테고리가 지정되지 않았습니다.
`HARM_CATEGORY_HATE_SPEECH`	피해 카테고리는 증오심 표현입니다.
`HARM_CATEGORY_DANGEROUS_CONTENT`	피해 카테고리는 위험한 콘텐츠입니다.
`HARM_CATEGORY_HARASSMENT`	피해 카테고리는 괴롭힘입니다.
`HARM_CATEGORY_SEXUALLY_EXPLICIT`	피해 카테고리는 음란물입니다.
`HARM_CATEGORY_CIVIC_INTEGRITY`	피해 카테고리는 시민적 무결성입니다.

HealthcareFhirConfig

HEALTHCARE_FHIR 세로의 데이터 스토어 구성

필드

enable_configurable_schema

bool

HEALTHCARE_FHIR 세로의 구성 가능한 스키마를 사용 설정할지 여부입니다.

true로 설정하면 사전 정의된 의료 fhir 스키마를 확장하여 더 맞춤화된 검색 및 필터링을 할 수 있습니다.

enable_static_indexing_for_batch_ingestion

bool

HEALTHCARE_FHIR 일괄 수집에 정적 색인 생성을 사용 설정할지 여부입니다.

true로 설정하면 일괄 수집이 정적 색인 모드로 처리됩니다. 이 모드는 속도는 느리지만 더 많은 양을 처리할 수 있습니다.

IdentityMappingEntry

외부 ID를 내부 ID에 매핑하는 ID 매핑 항목입니다.

필드
`external_identity`	`string` 필수 항목입니다. 고객 ID 공급업체 외부의 ID입니다. 외부 ID의 길이 제한은 100자입니다.
통합 필드 `identity_provider_id`. 통합 필드 identity_provider_id입니다. ID 공급자 ID는 사용자 또는 그룹일 수 있습니다. `identity_provider_id`은 다음 중 하나여야 합니다.
`user_id`	`string` 사용자 식별자입니다. Google Workspace 사용자 계정의 경우 user_id는 Google Workspace 사용자 이메일이어야 합니다. Google 이외의 ID 공급업체의 경우 user_id는 workforcepool 구성 중에 구성된 매핑된 사용자 식별자입니다.
`group_id`	`string` 그룹 식별자입니다. Google Workspace 사용자 계정의 경우 group_id는 Google Workspace 그룹 이메일이어야 합니다. Google 이외의 ID 공급업체의 경우 group_id는 workforcepool 구성 중에 구성된 매핑된 그룹 식별자입니다.

IdentityMappingEntryOperationMetadata

IdentityMappingStoreService.ImportIdentityMappings 및 IdentityMappingStoreService.PurgeIdentityMappings의 IdentityMappingEntry LongRunningOperation 메타데이터

필드

success_count

int64

성공적으로 처리된 IdentityMappingEntry의 수입니다.

failure_count

int64

처리하지 못한 IdentityMappingEntry의 수입니다.

total_count

int64

처리된 IdentityMappingEntry의 총수입니다.

IdentityMappingStore

ID 매핑 항목이 포함된 ID 매핑 저장소입니다.

필드

name

string

변경할 수 없습니다. ID 매핑 저장소의 전체 리소스 이름입니다. 형식은 projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}입니다. 이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 1,024자(영문 기준)입니다.

kms_key_name

string

입력 전용입니다. 생성 시 이 ID 매핑 저장소를 보호하는 데 사용할 KMS 키입니다.

CMEK 조직 정책 보호를 준수해야 하는 요청에 대해 설정해야 합니다.

이 필드가 설정되고 성공적으로 처리되면 cmek_config 필드에 표시된 대로 ID 매핑 저장소가 KMS 키로 보호됩니다.

cmek_config

CmekConfig

출력 전용입니다. ID 매핑 스토어의 CMEK 관련 정보입니다.

IdentityScheduleConfig

ID 데이터 동기화 실행의 구성입니다.

필드

refresh_interval

Duration

(선택사항) 이 커넥터로 수집된 문서의 액세스 제어 목록 정보를 동기화하는 새로고침 간격입니다. 설정하지 않으면 액세스 제어 목록이 기본 간격인 30분마다 새로고침됩니다. ID 새로고침 간격은 최소 30분에서 최대 7일입니다.

next_sync_time

DateTime

(선택사항) 데이터 커넥터의 다음 데이터 동기화가 시작될 것으로 예상되는 UTC 시간입니다. 고객은 데이터 동기화를 예약할 시간과 분만 지정할 수 있습니다. 데이터 커넥터의 새로고침 간격이 1일을 초과하는 경우에 사용됩니다.

IdpConfig

ID 공급업체 구성

필드

idp_type

IdpType

ID 공급업체 유형이 구성되었습니다.

external_idp_config

ExternalIdpConfig

외부 ID 공급업체 구성입니다.

ExternalIdpConfig

서드 파티 IDP 구성입니다.

필드

workforce_pool_name

string

직원 풀 이름입니다. 예: 'locations/global/workforcePools/pool_id'

IdpType

ID 공급업체 유형입니다.

열거형
`IDP_TYPE_UNSPECIFIED`	기본값 ACL 검색이 사용 설정되지 않았습니다.
`GSUITE`	Google 퍼스트 파티 제공업체입니다.
`THIRD_PARTY`	서드 파티 제공업체

ImportCompletionSuggestionsMetadata

ImportCompletionSuggestions 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드
`create_time`	`Timestamp` 작업 생성 시간입니다.
`update_time`	`Timestamp` 작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.
`success_count`	`int64` 성공적으로 가져온 `CompletionSuggestion`의 수입니다.
`failure_count`	`int64` 가져오지 못한 `CompletionSuggestion`의 수입니다.

ImportCompletionSuggestionsRequest

CompletionService.ImportCompletionSuggestions 메서드의 요청 메시지입니다.

필드
`parent`	`string` 필수 항목입니다. 고객 자동 완성 추천을 가져올 상위 데이터 스토어 리소스 이름입니다. `projects//locations//collections//dataStores/` 패턴 사용
`error_config`	`ImportErrorConfig` 가져오기 중에 발생하는 오류의 원하는 위치입니다.
통합 필드 `source`. 자동 완성 추천의 소스입니다. `source`은 다음 중 하나여야 합니다.
`inline_source`	`InlineSource` 추천 항목의 인라인 소스입니다.
`gcs_source`	`GcsSource` 입력 콘텐츠의 Cloud Storage 위치입니다.
`bigquery_source`	`BigQuerySource` BigQuery 입력 소스입니다.

InlineSource

CompletionSuggestions의 인라인 소스입니다.

필드

suggestions[]

CompletionSuggestion

필수 항목입니다. 가져올 모든 차단 목록 항목의 목록입니다. 최대 1,000개 항목

ImportCompletionSuggestionsResponse

CompletionService.ImportCompletionSuggestions 메서드의 응답입니다. 장기 실행 작업이 완료되면 작업이 성공한 경우 google.longrunning.Operations.response 필드에서 이 메시지가 반환됩니다.

필드

error_samples[]

요청을 처리하는 중에 발생한 오류 샘플입니다.

error_config

ImportErrorConfig

가져오기 중에 발생하는 오류의 원하는 위치입니다.

ImportDocumentsMetadata

ImportDocuments 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드
`create_time`	`Timestamp` 작업 생성 시간입니다.
`update_time`	`Timestamp` 작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.
`success_count`	`int64` 성공적으로 처리된 항목 수입니다.
`failure_count`	`int64` 처리 중에 오류가 발생한 항목의 수입니다.
`total_count`	`int64` 처리된 항목의 총 개수입니다.

ImportDocumentsRequest

가져오기 메서드의 요청 메시지입니다.

필드
`parent`	`string` 필수 항목입니다. 상위 브랜치 리소스 이름입니다(예: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`). 생성/업데이트 권한이 필요합니다.
`error_config`	`ImportErrorConfig` 가져오기 중에 발생하는 오류의 원하는 위치입니다.
`reconciliation_mode`	`ReconciliationMode` 기존 문서와 가져올 문서 간의 조정 모드입니다. 기본값은 `ReconciliationMode.INCREMENTAL`입니다.
`update_mask`	`FieldMask` 제공된 가져온 문서에서 업데이트할 필드를 나타냅니다. 설정하지 않으면 모든 필드가 업데이트됩니다.
`auto_generate_ids`	`bool` 문서에 ID가 없는 경우 자동으로 생성할지 여부입니다. `true`로 설정하면 여러 가져오기에서 ID가 일관되지 않을 수 있는 페이로드의 해시에 따라 `Document.id`가 자동으로 생성됩니다. 이 경우 중복 콘텐츠를 방지하기 위해 `ReconciliationMode.FULL`를 사용하는 것이 좋습니다. 설정되지 않았거나 `false`로 설정된 경우 `id_field`를 사용하여 `Document.id`를 지정해야 합니다. 그렇지 않으면 ID가 없는 문서를 가져올 수 없습니다. 지원되는 데이터 소스: `GcsSource`: `GcsSource.data_schema`은 `custom` 또는 `csv`이어야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 발생합니다. `BigQuerySource`: `BigQuerySource.data_schema`은 `custom` 또는 `csv`이어야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 발생합니다. `SpannerSource`개 `CloudSqlSource`. `FirestoreSource`. `BigtableSource`개
`id_field`	`string` 이 필드는 문서의 고유 ID로 사용할 ID 필드 또는 열을 나타냅니다. `GcsSource`의 경우 JSON 필드의 키입니다. 예를 들어 JSON `{"my_id": "some_uuid"}`의 경우 `my_id`입니다. 다른 경우에는 고유 ID가 저장된 테이블의 열 이름일 수 있습니다. JSON 필드 또는 표 열의 값이 `Document.id`로 사용됩니다. JSON 필드 또는 테이블 열은 문자열 유형이어야 하며 값은 1~63자(영문 기준)의 RFC-1034를 준수하는 유효한 문자열로 설정해야 합니다. 그렇지 않으면 유효한 ID가 없는 문서를 가져올 수 없습니다. `auto_generate_ids`이 설정되지 않았거나 `false`으로 설정된 경우에만 이 필드를 설정합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 발생합니다. 설정되지 않은 경우 허용된 데이터 소스에서 가져올 때 기본값 `_id`이 사용됩니다. 지원되는 데이터 소스: `GcsSource`: `GcsSource.data_schema`은 `custom` 또는 `csv`이어야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 발생합니다. `BigQuerySource`: `BigQuerySource.data_schema`은 `custom` 또는 `csv`이어야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 발생합니다. `SpannerSource`개 `CloudSqlSource`. `BigtableSource`개
`force_refresh_content`	`bool` (선택사항) 문서의 비구조화 콘텐츠를 강제로 새로고침할지 여부입니다. `true`로 설정된 경우 참조 콘텐츠의 업데이트 상태와 관계없이 문서의 콘텐츠 부분이 새로고침됩니다.
통합 필드 `source`. 필수 항목입니다. 입력 소스입니다. `source`은 다음 중 하나여야 합니다.
`inline_source`	`InlineSource` 문서의 입력 콘텐츠에 대한 인라인 소스입니다.
`gcs_source`	`GcsSource` 입력 콘텐츠의 Cloud Storage 위치입니다.
`bigquery_source`	`BigQuerySource` BigQuery 입력 소스입니다.
`fhir_store_source`	`FhirStoreSource` FhirStore 입력 소스입니다.
`spanner_source`	`SpannerSource` Spanner 입력 소스입니다.
`cloud_sql_source`	`CloudSqlSource` Cloud SQL 입력 소스입니다.
`firestore_source`	`FirestoreSource` Firestore 입력 소스입니다.
`alloy_db_source`	`AlloyDbSource` AlloyDB 입력 소스입니다.
`bigtable_source`	`BigtableSource` Cloud Bigtable 입력 소스입니다.

InlineSource

ImportDocuments 메서드의 입력 구성에 관한 인라인 소스입니다.

필드

documents[]

필수 항목입니다. 업데이트하거나 생성할 문서 목록입니다. 각 문서에는 유효한 Document.id가 있어야 합니다. 권장되는 최대 항목 개수는 100개입니다.

ReconciliationMode

가져온 문서가 이전에 생성되거나 가져온 기존 문서와 조정되는 방식을 나타냅니다.

열거형
`RECONCILIATION_MODE_UNSPECIFIED`	기본값은 `INCREMENTAL`입니다.
`INCREMENTAL`	새 문서를 삽입하거나 기존 문서를 업데이트합니다.
`FULL`	차이를 계산하고 전체 문서 데이터 세트를 대체합니다. 기존 문서가 소스 위치에 없으면 삭제될 수 있습니다. 이 모드를 사용하면 타겟 데이터 세트의 다운타임이 발생하지 않습니다. 변경되지 않아야 하거나 업데이트되어야 하는 문서는 작업이 실행되는 동안 계속 게재됩니다.

ImportDocumentsResponse

ImportDocumentsRequest의 응답입니다. 장기 실행 작업이 완료되면 작업이 성공한 경우 google.longrunning.Operations.response 필드에서 이 메시지가 반환됩니다.

필드

error_samples[]

요청을 처리하는 중에 발생한 오류 샘플입니다.

error_config

ImportErrorConfig

설정된 경우 요청의 전체 오류에 대한 대상을 반환합니다.

ImportErrorConfig

가져오기 관련 오류의 대상 구성입니다.

필드

통합 필드 destination. 필수 항목입니다. 오류 대상입니다. destination은 다음 중 하나여야 합니다.

gcs_prefix

string

가져오기 오류의 Cloud Storage 접두사입니다. 기존의 빈 Cloud Storage 디렉터리여야 합니다. 가져오기 오류는 이 디렉터리의 샤딩된 파일에 JSON으로 인코딩된 google.rpc.Status 메시지로 한 줄에 하나씩 작성됩니다.

ImportIdentityMappingsRequest

IdentityMappingStoreService.ImportIdentityMappings의 요청 메시지

필드

identity_mapping_store

string

필수 항목입니다. ID 매핑 항목을 가져올 ID 매핑 저장소의 이름입니다. 형식: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

통합 필드 source. 입력 소스입니다. source은 다음 중 하나여야 합니다.

inline_source

InlineSource

ID 매핑 항목을 가져올 인라인 소스입니다.

InlineSource

ID 매핑 항목을 가져올 인라인 소스입니다.

필드

identity_mapping_entries[]

IdentityMappingEntry

한 번에 최대 10,000개의 항목을 가져올 수 있습니다.

ImportIdentityMappingsResponse

IdentityMappingStoreService.ImportIdentityMappings의 응답 메시지입니다.

필드

error_samples[]

요청을 처리하는 중에 발생한 오류 샘플입니다.

ImportSuggestionDenyListEntriesMetadata

ImportSuggestionDenyListEntries 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

SuggestionDenyListEntry

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

ImportSuggestionDenyListEntriesRequest

CompletionService.ImportSuggestionDenyListEntries 메서드의 요청 메시지입니다.

필드
`parent`	`string` 필수 항목입니다. 차단 목록 항목을 가져올 상위 데이터 스토어 리소스 이름입니다. projects//locations//collections//dataStores/ 패턴을 따릅니다.
통합 필드 `source`. 업데이트된 SuggestionDenyList의 소스입니다. `source`은 다음 중 하나여야 합니다.
`inline_source`	`InlineSource` 추천 거부 목록 항목의 입력 콘텐츠에 대한 인라인 소스입니다.
`gcs_source`	`GcsSource` 입력 콘텐츠의 Cloud Storage 위치입니다. 가져올 모든 항목이 포함된 파일은 1개만 지정할 수 있습니다. 자동 완성 추천 거부 목록 항목 가져오기에 지원되는 값 `gcs_source.schema`: `suggestion_deny_list` (기본값): 줄당 하나의 JSON [SuggestionDenyListEntry] 입니다.

InlineSource

SuggestionDenyListEntry의 인라인 소스입니다.

필드

entries[]

필수 항목입니다. 가져올 모든 차단 목록 항목의 목록입니다. 최대 1,000개 항목

ImportSuggestionDenyListEntriesResponse

CompletionService.ImportSuggestionDenyListEntries 메서드의 응답 메시지입니다.

필드

error_samples[]

요청을 처리하는 중에 발생한 오류 샘플입니다.

imported_entries_count

int64

성공적으로 가져온 차단 목록 항목의 수입니다.

failed_entries_count

int64

가져오지 못한 거부 목록 항목의 수입니다.

ImportUserEventsMetadata

가져오기 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드
`create_time`	`Timestamp` 작업 생성 시간입니다.
`update_time`	`Timestamp` 작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.
`success_count`	`int64` 성공적으로 처리된 항목 수입니다.
`failure_count`	`int64` 처리 중에 오류가 발생한 항목의 수입니다.

ImportUserEventsRequest

ImportUserEvents 요청의 요청 메시지입니다.

필드
`parent`	`string` 필수 항목입니다. 상위 DataStore 리소스 이름입니다(`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` 형식).
`error_config`	`ImportErrorConfig` 가져오기 중에 발생하는 오류의 원하는 위치입니다. 인라인 사용자 이벤트 가져오기에는 설정할 수 없습니다.
통합 필드 `source`. 필수 - 사용자 이벤트 데이터의 원하는 입력 소스입니다. `source`은 다음 중 하나여야 합니다.
`inline_source`	`InlineSource` UserEvents의 입력 콘텐츠에 대한 인라인 소스입니다.
`gcs_source`	`GcsSource` 입력 콘텐츠의 Cloud Storage 위치입니다.
`bigquery_source`	`BigQuerySource` BigQuery 입력 소스입니다.

InlineSource

ImportUserEvents 메서드의 입력 구성에 관한 인라인 소스입니다.

필드

user_events[]

UserEvent

필수 항목입니다. 가져올 사용자 이벤트 목록입니다. 권장되는 최대 항목 개수는 10,000개입니다.

ImportUserEventsResponse

ImportUserEventsRequest의 응답입니다. 장기 실행 작업이 성공하면, google.longrunning.Operations.response 필드에서 이 메시지를 반환합니다.

필드
`error_samples[]`	`Status` 요청을 처리하는 중에 발생한 오류 샘플입니다.
`error_config`	`ImportErrorConfig` 이 필드가 요청에 설정된 경우 전체 오류의 대상을 반환합니다.
`joined_events_count`	`int64` 기존의 전체 문서와 함께 가져온 사용자 이벤트 수입니다.
`unjoined_events_count`	`int64` 가져온 사용자 이벤트 중 기존 지점에서 문서 정보를 찾을 수 없는 이벤트 수입니다.

IndustryVertical

DataStore와 관련된 업종입니다.

열거형
`INDUSTRY_VERTICAL_UNSPECIFIED`	설정되지 않은 경우 사용되는 값입니다.
`GENERIC`	특정 업종 카테고리에 속하지 않는 문서의 일반 업종입니다.
`MEDIA`	미디어 업종 카테고리입니다.
`HEALTHCARE_FHIR`	의료 FHIR 업종입니다.

간격

부동 소수점 간격입니다.

필드

통합 필드 min. 간격의 하한입니다. min 필드가 모두 설정되지 않은 경우 하한값은 음수의 무한대입니다.

이 필드는 최댓값보다 크면 안 됩니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다. min은 다음 중 하나여야 합니다.

minimum

double

하한값을 포함합니다.

exclusive_minimum

double

하한값을 제외합니다.

통합 필드 max. 간격의 상한입니다. max 필드가 모두 설정되지 않은 경우 상한값은 양수의 무한대입니다.

이 필드는 최솟값보다 작으면 안 됩니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다. max은 다음 중 하나여야 합니다.

maximum

double

상한값을 포함합니다.

exclusive_maximum

double

상한값을 제외합니다.

LicenseConfig

사용자 라이선스에 관한 정보입니다.

필드
`name`	`string` 변경할 수 없습니다. 식별자. 라이선스 구성의 정규화된 리소스 이름입니다. 형식: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
`license_count`	`int64` 필수 항목입니다. 구매한 라이선스 수입니다.
`subscription_tier`	`SubscriptionTier` 필수 항목입니다. 라이선스 구성의 정기 결제 등급 정보입니다.
`state`	`State` 출력 전용입니다. 라이선스 구성의 상태입니다.
`auto_renew`	`bool` (선택사항) 라이선스 구성이 종료일에 도달했을 때 자동으로 갱신되어야 하는지 여부입니다.
`start_date`	`Date` 필수 항목입니다. 시작일입니다.
`end_date`	`Date` (선택사항) 계획된 종료일입니다.
`subscription_term`	`SubscriptionTerm` 필수 항목입니다. 구독 기간입니다.
`free_trial`	`bool` (선택사항) 라이선스 구성이 무료 체험판용인지 여부입니다.
`alert_policy_resource_config`	`AlertPolicyResourceConfig` (선택사항) 이 라이선스 구성의 알림 정책 구성입니다.
`gemini_bundle`	`bool` 출력 전용입니다. 라이선스 구성이 Gemini 번들용인지 여부입니다.

주

라이선스 구성 상태 열거형입니다.

열거형
`STATE_UNSPECIFIED`	기본값 라이선스 구성이 존재하지 않습니다.
`ACTIVE`	라이선스 구성이 유효하며 사용 중입니다.
`EXPIRED`	라이선스 구성이 만료되었습니다.
`NOT_STARTED`	라이선스 구성이 아직 시작되지 않았으며 시작일이 미래입니다.

ListAssistantsRequest

AssistantService.ListAssistants 메서드에 대한 요청 메시지입니다.

필드

parent

string

필수 항목입니다. 상위 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

page_size

int32

반환할 최대 Assistant 수입니다. 지정하지 않으면 기본값은 100입니다. 허용되는 최댓값은 1,000이며, 이 값을 초과하는 값은 1,000으로 변환됩니다.

page_token

string

이전 AssistantService.ListAssistants 호출에서 받은 ListAssistantsResponse.next_page_token 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

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

ListAssistantsResponse

AssistantService.ListAssistants 메서드에 대한 응답 메시지입니다.

필드

assistants[]

Assistant

모든 고객의 Assistant입니다.

next_page_token

string

다음 페이지를 검색하기 위해 ListAssistantsRequest.page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

ListCmekConfigsRequest

CmekConfigService.ListCmekConfigs 메서드의 요청 메시지입니다.

필드

parent

string

필수 항목입니다. 상위 위치 리소스 이름입니다(예: projects/{project}/locations/{location}).

호출자에게 이 위치의 CmekConfig를 나열할 권한이 없는 경우 CmekConfig가 있는지 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

ListCmekConfigsResponse

CmekConfigService.ListCmekConfigs 메서드의 응답 메시지입니다.

필드

cmek_configs[]

CmekConfig

모든 고객의 CmekConfig입니다.

ListControlsRequest

ListControls 메서드 요청입니다.

필드
`parent`	`string` 필수 항목입니다. 데이터 스토어 리소스 이름입니다. 형식: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` 또는 `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`
`page_size`	`int32` (선택사항) 반환할 결과의 최대 수입니다. 지정하지 않으면 기본값은 50입니다. 허용되는 최댓값은 1000입니다.
`page_token`	`string` (선택사항) 이전 `ListControls` 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.
`filter`	`string` (선택사항) 목록 결과에 적용할 필터입니다. 지원되는 기능: `filter`가 설정되지 않은 경우 상위 브랜치 아래의 모든 제품을 나열합니다. 현재 이 필드는 지원되지 않습니다.

ListControlsResponse

ListControls 메서드의 응답입니다.

필드

controls[]

Control

지정된 데이터 스토어의 모든 컨트롤입니다.

next_page_token

string

페이지로 나누기 토큰입니다. 반환되지 않으면 마지막 페이지를 나타냅니다.

ListConversationsRequest

ListConversations 메서드의 요청입니다.

필드
`parent`	`string` 필수 항목입니다. 데이터 스토어 리소스 이름입니다. 형식: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` 반환할 결과의 최대 수입니다. 지정하지 않으면 기본값은 50입니다. 허용되는 최댓값은 1000입니다.
`page_token`	`string` 이전 `ListConversations` 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.
`filter`	`string` 목록 결과에 적용할 필터입니다. 지원되는 기능은 user_pseudo_id, state입니다. 예: 'user_pseudo_id = some_id'
`order_by`	`string` 정렬할 필드의 쉼표로 구분된 목록입니다. 오름차순으로 정렬됩니다. 필드 이름 뒤에 'desc'를 사용하여 내림차순으로 정렬합니다. 지원되는 필드: * `update_time` * `create_time` * `conversation_name` 예: 'update_time desc' 'create_time'

ListConversationsResponse

ListConversations 메서드의 응답입니다.

필드

conversations[]

지정된 데이터 스토어의 모든 대화

next_page_token

string

페이지로 나누기 토큰입니다. 반환되지 않으면 마지막 페이지를 나타냅니다.

ListCustomModelsRequest

SearchTuningService.ListCustomModels 메서드의 요청 메시지입니다.

필드

data_store

string

필수 항목입니다. 상위 데이터 스토어의 리소스 이름입니다(예: projects/*/locations/global/collections/default_collection/dataStores/default_data_store). 이 필드는 모델을 가져올 데이터 저장소를 식별하는 데 사용됩니다.

ListCustomModelsResponse

SearchTuningService.ListCustomModels 메서드의 응답 메시지입니다.

필드

models[]

CustomTuningModel

맞춤 조정 모델 목록입니다.

ListDataStoresRequest

DataStoreService.ListDataStores 메서드의 요청 메시지입니다.

필드
`parent`	`string` 필수 항목입니다. 상위 브랜치 리소스 이름입니다(예: `projects/{project}/locations/{location}/collections/{collection_id}`). 호출자에게 이 위치에 있는 `DataStore`를 나열할 권한이 없는 경우 이 데이터 스토어가 있는지 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.
`page_size`	`int32` 반환할 최대 `DataStore` 수입니다. 지정하지 않으면 기본값은 10입니다. 허용되는 최댓값은 50입니다. 50을 초과하는 값은 50으로 변환됩니다. 이 필드가 음수이면 INVALID_ARGUMENT가 반환됩니다.
`page_token`	`string` 이전 `DataStoreService.ListDataStores` 호출에서 받은 `ListDataStoresResponse.next_page_token` 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다. 페이지를 매길 때 `DataStoreService.ListDataStores`에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.
`filter`	`string` 솔루션 유형별로 필터링합니다 . 예: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`

ListDataStoresResponse

DataStoreService.ListDataStores 메서드의 응답 메시지입니다.

필드

data_stores[]

DataStore

모든 고객의 DataStore입니다.

next_page_token

string

다음 페이지를 검색하기 위해 ListDataStoresRequest.page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

ListDocumentsRequest

DocumentService.ListDocuments 메서드의 요청 메시지입니다.

필드

parent

string

필수 항목입니다. 상위 브랜치 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}). default_branch를 브랜치 ID로 사용하여 기본 브랜치 아래에 문서를 표시합니다.

호출자에게 이 브랜치에 속한 Document를 나열할 권한이 없으면 이 브랜치의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

page_size

int32

반환할 최대 Document 수입니다. 지정하지 않으면 기본값은 100입니다. 허용되는 최댓값은 1000입니다. 1,000을 초과하는 값은 1,000으로 설정됩니다.

이 필드가 음수이면 INVALID_ARGUMENT 오류가 반환됩니다.

page_token

string

이전 DocumentService.ListDocuments 호출에서 받은 ListDocumentsResponse.next_page_token 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

페이지를 매길 때 DocumentService.ListDocuments에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.

ListDocumentsResponse

DocumentService.ListDocuments 메서드의 응답 메시지입니다.

필드

documents[]

Document입니다.

next_page_token

string

다음 페이지를 검색하기 위해 ListDocumentsRequest.page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

ListEnginesRequest

EngineService.ListEngines 메서드의 요청 메시지입니다.

필드
`parent`	`string` 필수 항목입니다. 상위 리소스 이름입니다(예: `projects/{project}/locations/{location}/collections/{collection_id}`).
`page_size`	`int32` (선택사항) 지원되지 않음.
`page_token`	`string` (선택사항) 지원되지 않음.
`filter`	`string` (선택사항) 솔루션 유형별로 필터링합니다. 예: solution_type=SOLUTION_TYPE_SEARCH

ListEnginesResponse

EngineService.ListEngines 메서드의 응답 메시지입니다.

필드

engines[]

Engine

모든 고객의 Engine입니다.

next_page_token

string

지원되지 않음.

ListIdentityMappingStoresRequest

IdentityMappingStoreService.ListIdentityMappingStores의 요청 메시지

필드

parent

string

필수 항목입니다. 나열할 ID 매핑 저장소의 상위 요소입니다. 형식은 projects/{project}/locations/{location}입니다.

page_size

int32

반환할 최대 IdentityMappingStore 수입니다. 지정하지 않으면 기본값은 100입니다. 허용되는 최댓값은 1000입니다. 1,000을 초과하는 값은 1,000으로 변환됩니다.

page_token

string

이전 ListIdentityMappingStores 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

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

ListIdentityMappingStoresResponse

IdentityMappingStoreService.ListIdentityMappingStores의 응답 메시지입니다.

필드

identity_mapping_stores[]

IdentityMappingStore

ID 매핑 저장소입니다.

next_page_token

string

다음 페이지를 검색하기 위해 page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

ListIdentityMappingsRequest

IdentityMappingStoreService.ListIdentityMappings의 요청 메시지

필드

identity_mapping_store

string

필수 항목입니다. ID 매핑 항목을 나열할 ID 매핑 스토어의 이름입니다. 형식: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

page_size

int32

반환할 IdentityMapping의 최대 개수입니다. 지정하지 않으면 기본값은 2000입니다. 허용되는 최댓값은 10000입니다. 10,000을 초과하는 값은 10,000으로 변환됩니다.

page_token

string

이전 ListIdentityMappings 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

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

ListIdentityMappingsResponse

IdentityMappingStoreService.ListIdentityMappings의 응답 메시지입니다.

필드

identity_mapping_entries[]

IdentityMappingEntry

ID 매핑 항목입니다.

next_page_token

string

다음 페이지를 검색하기 위해 page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

ListSchemasRequest

SchemaService.ListSchemas 메서드의 요청 메시지입니다.

필드

parent

string

필수 항목입니다. 상위 데이터 스토어 리소스 이름입니다(projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} 형식).

page_size

int32

반환할 최대 Schema 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다.

지정하지 않으면 최대 100개의 Schema가 반환됩니다.

최댓값은 1,000이며, 1,000을 초과하는 값은 1,000으로 설정됩니다.

page_token

string

이전 SchemaService.ListSchemas 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

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

ListSchemasResponse

SchemaService.ListSchemas 메서드의 응답 메시지입니다.

필드

schemas[]

Schema

Schema입니다.

next_page_token

string

다음 페이지를 검색하기 위해 ListSchemasRequest.page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

ListSessionsRequest

ListSessions 메서드 요청입니다.

필드
`parent`	`string` 필수 항목입니다. 데이터 스토어 리소스 이름입니다. 형식: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` 반환할 결과의 최대 수입니다. 지정하지 않으면 기본값은 50입니다. 허용되는 최댓값은 1000입니다.
`page_token`	`string` 이전 `ListSessions` 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.
`filter`	`string` EBNF 문법에서 필터링할 필드의 쉼표로 구분된 목록입니다. 지원되는 필드는 다음과 같습니다. `user_pseudo_id` `state` `display_name` `starred` `is_pinned` `labels` `create_time` `update_time` 예: `user_pseudo_id = some_id` `display_name = "some_name"` `starred = true` `is_pinned=true AND (NOT labels:hidden)` `create_time > "1970-01-01T12:00:00Z"`
`order_by`	`string` 정렬할 필드의 쉼표로 구분된 목록입니다. 오름차순으로 정렬됩니다. 필드 이름 뒤에 'desc'를 사용하여 내림차순으로 정렬합니다. 지원되는 필드: `update_time` `create_time` `session_name` `is_pinned` 예: `update_time desc` `create_time` `is_pinned desc,update_time desc`: is_pinned를 기준으로 먼저 세션을 나열한 다음 update_time을 기준으로 나열합니다.

ListSessionsResponse

ListSessions 메서드의 응답입니다.

필드

sessions[]

지정된 데이터 스토어의 모든 세션입니다.

next_page_token

string

페이지로 나누기 토큰입니다. 반환되지 않으면 마지막 페이지를 나타냅니다.

ListTargetSitesRequest

SiteSearchEngineService.ListTargetSites 메서드의 요청 메시지입니다.

필드

parent

string

필수 항목입니다. 상위 사이트 검색엔진 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine).

호출자에게 이 사이트 검색 엔진에서 TargetSite를 나열할 권한이 없는 경우 이 브랜치의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

page_size

int32

이 필드가 음수이면 INVALID_ARGUMENT 오류가 반환됩니다.

page_token

string

이전 ListTargetSites 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

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

ListTargetSitesResponse

SiteSearchEngineService.ListTargetSites 메서드의 응답 메시지입니다.

필드

target_sites[]

TargetSite 목록입니다.

next_page_token

string

다음 페이지를 검색하기 위해 page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

total_size

int32

요청과 일치하는 항목의 총수입니다. 이 필드는 항상 응답에 채워집니다.

ListUserLicensesRequest

UserLicenseService.ListUserLicenses에 대한 요청 메시지입니다.

필드
`parent`	`string` 필수 항목입니다. 상위 [UserStore][] 리소스 이름입니다. 형식은 `projects/{project}/locations/{location}/userStores/{user_store_id}`입니다.
`page_size`	`int32` (선택사항) 요청한 페이지 크기입니다. 서버에서 요청한 것보다 적은 항목을 반환할 수 있습니다. 지정하지 않으면 기본값은 10입니다. 최댓값은 50이며, 50을 초과하는 값은 50으로 변환됩니다. 이 필드가 음수이면 INVALID_ARGUMENT 오류가 반환됩니다.
`page_token`	`string` (선택사항) 이전 `ListUserLicenses` 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다. 페이지를 매길 때 `ListUserLicenses`에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.
`filter`	`string` (선택사항) 목록 요청의 필터입니다. 지원되는 필드: `license_assignment_state` 예: `license_assignment_state = ASSIGNED`를 사용하여 할당된 사용자 라이선스를 나열합니다. `license_assignment_state = NO_LICENSE`를 사용하여 라이선스가 없는 사용자를 나열합니다. `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN`를 사용하여 로그인하려고 했지만 라이선스가 할당되지 않은 사용자를 나열합니다. `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN`를 사용하여 로그인 시도했지만 라이선스가 할당되지 않은 사용자를 필터링합니다.

ListUserLicensesResponse

UserLicenseService.ListUserLicenses의 응답 메시지입니다.

필드

user_licenses[]

UserLicense

모든 고객의 UserLicense입니다.

next_page_token

string

다음 페이지를 검색하기 위해 page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

MediaInfo

미디어 관련 사용자 이벤트 정보입니다.

필드

media_progress_duration

Duration

해당하는 경우 미디어 진행 시간(초)입니다. 예를 들어 최종 사용자가 90초 길이의 재생 동영상을 시청했다면 MediaInfo.media_progress_duration.seconds는 90으로 설정해야 합니다.

media_progress_percentage

float

미디어 진행률은 미디어 전체 길이에 대한 media_progress_duration만 사용하여 계산해야 합니다.

이 값은 [0, 1.0] 이상이어야 합니다.

재생이 아니거나 진행률을 계산할 수 없는 경우 (예: 진행 중인 라이브 스트림) 이 필드는 설정되지 않아야 합니다.

PageInfo

자세한 페이지 정보입니다.

필드
`pageview_id`	`string` 웹페이지 조회의 고유 ID입니다. 동일한 페이지 조회에서 트리거된 모든 사용자 이벤트에 대해 동일하게 유지해야 합니다. 예를 들어 사용자가 페이지를 탐색할 때 항목 세부정보 페이지 조회가 여러 이벤트를 트리거할 수 있습니다. 이러한 이벤트를 올바르게 그룹화할 수 있도록 `pageview_id` 속성은 모든 이벤트에 대해 동일하게 유지되어야 합니다. JavaScript 픽셀 및 Google 태그 관리자를 사용하여 클라이언트 측 이벤트 보고를 사용하는 경우 이 값이 자동으로 채워집니다.
`page_category`	`string` 카테고리 페이지와 연결된 가장 구체적인 카테고리입니다. 카테고리의 전체 경로를 나타내려면 '>' 기호를 사용하여 다양한 계층 구조를 구분합니다. '>'가 카테고리 이름에 포함된 경우 다른 문자로 바꿉니다. 카테고리 페이지에는 할인이나 프로모션과 같은 특별 페이지가 포함됩니다. 예를 들어 특별 할인 페이지의 카테고리 계층 구조는 다음과 같습니다. `"pageCategory" : "Sales > 2017 Black Friday Deals"` `view-category-page` 이벤트에 필요합니다. 다른 이벤트 유형에는 이 필드를 설정하면 안 됩니다. 그렇지 않으면 `INVALID_ARGUMENT` 오류가 반환됩니다.
`uri`	`string` 사용자의 현재 페이지의 전체 URL (window.location.href)입니다. JavaScript 픽셀 및 Google 태그 관리자를 사용하여 클라이언트 측 이벤트 보고를 사용하는 경우 이 값이 자동으로 채워집니다. 최대 길이는 5,000자입니다.
`referrer_uri`	`string` 현재 페이지의 리퍼러 URL입니다. JavaScript 픽셀 및 Google 태그 관리자를 사용하여 클라이언트 측 이벤트 보고를 사용하는 경우 이 값이 자동으로 채워집니다. 하지만 일부 브라우저 개인 정보 보호 제한으로 인해 이 필드가 비어 있을 수 있습니다.

PanelInfo

사용자 이벤트와 연결된 세부 패널 정보입니다.

필드
`panel_id`	`string` 필수 항목입니다. 패널 ID입니다.
`display_name`	`string` 패널의 표시 이름입니다.
`documents[]`	`DocumentInfo` (선택사항) 이 패널과 연결된 문서 ID입니다.
`panel_position`	`int32` 사용자에게 다른 패널과 함께 표시되는 경우 패널의 순서가 지정된 위치입니다. 설정된 경우 `total_panels`도 설정해야 합니다.
`total_panels`	`int32` 사용자에게 표시되는 패널의 총수입니다(이 패널 포함). `panel_position`가 설정된 경우 설정해야 합니다.

주 구성원

사용자 또는 그룹의 주 구성원 식별자입니다.

필드
통합 필드 `principal`. 통합 필드 주 구성원입니다. 주 구성원은 사용자 또는 그룹일 수 있습니다. `principal`은 다음 중 하나여야 합니다.
`user_id`	`string` 사용자 식별자입니다. Google Workspace 사용자 계정의 경우 user_id는 Google Workspace 사용자 이메일이어야 합니다. Google 이외의 ID 공급업체 사용자 계정의 경우 user_id는 workforcepool 구성 중에 구성된 매핑된 사용자 식별자입니다.
`group_id`	`string` 그룹 식별자입니다. Google Workspace 사용자 계정의 경우 group_id는 Google Workspace 그룹 이메일이어야 합니다. Google 이외의 ID 공급업체 사용자 계정의 경우 group_id는 workforcepool 구성 중에 구성된 매핑된 그룹 식별자입니다.
`external_entity_id`	`string` 고객 ID 공급자에 없는 서드 파티 애플리케이션 ID의 경우

프로젝트

서비스의 Google Cloud 프로젝트 메타데이터 및 구성입니다.

필드
`name`	`string` 출력 전용입니다. 프로젝트의 전체 리소스 이름입니다(예: `projects/{project}`). 요청 시 프로젝트 번호와 프로젝트 ID를 모두 사용할 수 있지만 서버는 항상 프로젝트 번호로 응답합니다.
`create_time`	`Timestamp` 출력 전용입니다. 이 프로젝트가 생성된 타임스탬프입니다.
`provision_completion_time`	`Timestamp` 출력 전용입니다. 이 프로젝트가 성공적으로 프로비저닝된 타임스탬프입니다. 값이 비어 있으면 이 프로젝트가 아직 프로비저닝 중이며 사용할 준비가 되지 않았음을 의미합니다.
`service_terms_map`	`map<string, ServiceTerms>` 출력 전용입니다. 서비스 약관 지도입니다. 키는 `ServiceTerms`의 `id`입니다.
`customer_provided_config`	`CustomerProvidedConfig` (선택사항) 고객이 제공한 구성입니다.

CustomerProvidedConfig

고객이 제공한 구성입니다.

필드

notebooklm_config

NotebooklmConfig

(선택사항) NotebookLM 설정 구성

NotebooklmConfig

NotebookLM 구성

필드

model_armor_config

ModelArmorConfig

사용자 프롬프트와 LLM 응답을 정리하는 데 사용되는 Model Armor 구성입니다.

ModelArmorConfig

사용자 프롬프트와 LLM 응답을 정리하는 데 사용되는 고객 정의 Model Armor 템플릿의 구성입니다.

필드

user_prompt_template

string

(선택사항) 사용자 프롬프트를 정리하기 위한 Model Armor 템플릿의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/templates/{template_id} 지정하지 않으면 사용자 프롬프트에 삭제가 적용되지 않습니다.

response_template

string

(선택사항) LLM 응답을 정리하기 위한 Model Armor 템플릿의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/templates/{template_id} 지정하지 않으면 LLM 응답에 정리 기능이 적용되지 않습니다.

ServiceTerms

서비스 약관에 관한 메타데이터입니다.

필드
`id`	`string` 이 서비스 약관의 고유 식별자입니다. 사용 가능한 기간: `GA_DATA_USE_TERMS`: 데이터 사용 약관 이를 `id`로 사용하는 경우 제공할 수 있는 `version`는 `2022-11-23`입니다.
`version`	`string` 서비스 약관의 버전 문자열입니다. 허용되는 값은 위의 `id` 설명을 참고하세요.
`state`	`State` 프로젝트에서 서비스 약관을 수락/거부했는지 또는 아직 대기 중인지 여부입니다.
`accept_time`	`Timestamp` 프로젝트가 서비스 약관에 동의한 마지막 시간입니다.
`decline_time`	`Timestamp` 프로젝트에서 서비스 약관에 대한 동의를 거부하거나 취소한 마지막 시간입니다.

주

계약에 이 서비스 약관이 명시되어 있습니다.

열거형
`STATE_UNSPECIFIED`	열거형의 기본값입니다. 이 값은 실제로 사용되지 않습니다.
`TERMS_ACCEPTED`	프로젝트에서 서비스 약관에 동의했습니다.
`TERMS_PENDING`	프로젝트에서 서비스 약관을 검토하고 동의해야 합니다.
`TERMS_DECLINED`	프로젝트에서 서비스 약관에 대한 동의를 거부하거나 취소했습니다.

ProvisionProjectMetadata

이 유형에는 필드가 없습니다.

프로젝트 프로비저닝 작업과 연결된 메타데이터입니다.

ProvisionProjectRequest

ProjectService.ProvisionProject 메서드 요청입니다.

필드
`name`	`string` 필수 항목입니다. `Project`의 전체 리소스 이름입니다(예: `projects/{project_id_or_number}`).
`accept_data_use_terms`	`bool` 필수 항목입니다. 호출자가 데이터 사용 약관을 읽었으며 이에 동의하고 싶다고 지정하려면 `true`로 설정합니다.
`data_use_terms_version`	`string` 필수 항목입니다. 호출자가 읽고 동의하려는 데이터 사용 약관의 버전입니다. 허용되는 버전은 `2022-11-23`이며, 이는 시간이 지남에 따라 변경될 수 있습니다.
`saas_params`	`SaasParams` (선택사항) Agentspace의 매개변수입니다.

SaasParams

Agentspace의 매개변수입니다.

필드

accept_biz_qos

bool

(선택사항) 호출자가 [Agent Space 서비스 품질 약관]을 읽었으며 이에 동의하고 싶다고 지정하려면 true로 설정합니다.

is_biz

bool

(선택사항) 현재 요청이 비즈니스 버전용인지 (= true) 아닌지 (= false)를 나타냅니다.

PurgeCompletionSuggestionsMetadata

PurgeCompletionSuggestions 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

PurgeCompletionSuggestionsRequest

CompletionService.PurgeCompletionSuggestions 메서드의 요청 메시지입니다.

필드

parent

string

필수 항목입니다. 완성 제안을 삭제할 상위 데이터 스토어 리소스 이름입니다. projects/*/locations/*/collections/*/dataStores/* 패턴을 따릅니다.

PurgeCompletionSuggestionsResponse

CompletionService.PurgeCompletionSuggestions 메서드의 응답 메시지입니다.

필드

purge_succeeded

bool

완성 제안이 성공적으로 삭제되었는지 여부입니다.

error_samples[]

요청을 처리하는 중에 발생한 오류 샘플입니다.

PurgeDocumentsMetadata

PurgeDocuments 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드
`create_time`	`Timestamp` 작업 생성 시간입니다.
`update_time`	`Timestamp` 작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.
`success_count`	`int64` 성공적으로 삭제된 항목의 수입니다.
`failure_count`	`int64` 처리 중에 오류가 발생한 항목의 수입니다.
`ignored_count`	`int64` 항목을 찾을 수 없어 무시된 항목의 수입니다.

PurgeDocumentsRequest

DocumentService.PurgeDocuments 메서드의 요청 메시지입니다.

필드
`parent`	`string` 필수 항목입니다. 상위 리소스 이름입니다(예: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`).
`filter`	`string` 필수 항목입니다. 일치하는 문서를 필터링하여 삭제합니다. 현재 지원되는 값은 `*` (모든 항목)뿐입니다.
`error_config`	`PurgeErrorConfig` 삭제 중에 발생하는 오류의 원하는 위치입니다.
`force`	`bool` 실제로 삭제를 실행합니다. `force`가 false로 설정되면 문서를 삭제하지 않고 예상되는 삭제 횟수를 반환합니다.
통합 필드 `source`. 문서 ID를 기반으로 문서를 삭제하는 데 필요한 입력 소스입니다. `source`은 다음 중 하나여야 합니다.
`gcs_source`	`GcsSource` 입력 콘텐츠의 Cloud Storage 위치입니다. 지원되는 `data_schema`: * `document_id`: 줄당 하나의 유효한 `Document.id`
`inline_source`	`InlineSource` 삭제를 위한 입력 콘텐츠의 인라인 소스입니다.

InlineSource

DocumentService.PurgeDocuments 메서드의 입력 구성에 관한 인라인 소스입니다.

필드

documents[]

string

필수 항목입니다. 삭제할 문서의 전체 리소스 이름 목록입니다. 형식은 projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*입니다. 권장되는 최대 항목 개수는 100개입니다.

PurgeDocumentsResponse

DocumentService.PurgeDocuments 메서드의 응답 메시지입니다. 장기 실행 작업이 완료되면 google.longrunning.Operations.response 필드에서 이 메시지를 반환합니다.

필드

purge_count

int64

작업의 결과로 삭제된 총 문서 수입니다.

purge_sample[]

string

삭제될 문서 이름의 샘플입니다. force가 false로 설정된 경우에만 채워집니다. 최대 100개의 이름이 반환되며 이름은 무작위로 선택됩니다.

PurgeErrorConfig

삭제 관련 오류의 대상 구성입니다.

필드

통합 필드 destination. 필수 항목입니다. 오류 대상입니다. destination은 다음 중 하나여야 합니다.

gcs_prefix

string

삭제 오류의 Cloud Storage 접두사입니다. 기존의 빈 Cloud Storage 디렉터리여야 합니다. 삭제 오류는 이 디렉터리의 샤딩된 파일에 JSON으로 인코딩된 google.rpc.Status 메시지로 한 줄에 하나씩 작성됩니다.

PurgeIdentityMappingsRequest

IdentityMappingStoreService.PurgeIdentityMappings의 요청 메시지

필드
`identity_mapping_store`	`string` 필수 항목입니다. ID 매핑 항목을 삭제할 ID 매핑 저장소의 이름입니다. 형식: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
`filter`	`string` 삭제할 일치하는 ID 매핑을 필터링합니다. 필터링할 수 있는 필드는 다음과 같습니다. * `update_time`: ISO 8601 'zulu' 형식 * `external_id` 예: 특정 기간에 업데이트된 모든 ID 매핑 삭제: `update_time > "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"` 지정된 external_id의 모든 ID 매핑 삭제: `external_id = "id1"` ID 매핑 저장소 내의 모든 ID 매핑 삭제: `*` 필터링 필드에는 암시적 AND가 있다고 가정됩니다. 소스와 함께 사용해서는 안 됩니다. 두 매개변수가 모두 제공되면 오류가 발생합니다.
통합 필드 `source`. 입력 소스입니다. `source`은 다음 중 하나여야 합니다.
`inline_source`	`InlineSource` ID 매핑 항목을 삭제할 인라인 소스입니다.
`force`	`bool` 실제로 삭제를 실행합니다. `force`가 false로 설정되면 ID 매핑을 삭제하지 않고 예상되는 삭제 횟수를 반환합니다. 이 필드는 필터로 삭제하는 경우에만 지원됩니다. 입력 소스의 경우 이 필드는 무시되며 이 필드의 값과 관계없이 데이터가 삭제됩니다.

InlineSource

ID 매핑 항목을 삭제할 인라인 소스입니다.

필드

identity_mapping_entries[]

IdentityMappingEntry

한 번에 최대 10,000개의 항목을 삭제할 수 있습니다.

PurgeSuggestionDenyListEntriesMetadata

PurgeSuggestionDenyListEntries 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

PurgeSuggestionDenyListEntriesRequest

CompletionService.PurgeSuggestionDenyListEntries 메서드의 요청 메시지입니다.

필드

parent

string

필수 항목입니다. 차단 목록 항목을 가져올 상위 데이터 스토어 리소스 이름입니다. projects/*/locations/*/collections/*/dataStores/* 패턴을 따릅니다.

PurgeSuggestionDenyListEntriesResponse

CompletionService.PurgeSuggestionDenyListEntries 메서드의 응답 메시지입니다.

필드

purge_count

int64

삭제된 추천 차단 목록 항목 수입니다.

error_samples[]

MatchHighlightingCondition

요청을 처리하는 중에 발생한 오류 샘플입니다.

PurgeUserEventsMetadata

PurgeUserEvents 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드
`create_time`	`Timestamp` 작업 생성 시간입니다.
`update_time`	`Timestamp` 작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.
`success_count`	`int64` 성공적으로 삭제된 항목의 수입니다.
`failure_count`	`int64` 처리 중에 오류가 발생한 항목의 수입니다.

PurgeUserEventsRequest

PurgeUserEvents 메서드의 요청 메시지입니다.

필드

parent

string

필수 항목입니다. 이벤트가 생성되는 카탈로그의 리소스 이름입니다. 형식은 projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}입니다.

filter

string

필수 항목입니다. 삭제할 이벤트를 지정하는 필터 문자열입니다. 길이는 5,000자로 제한됩니다. 필터링할 수 있는 필드는 다음과 같습니다.

eventType: 큰따옴표로 묶인 UserEvent.event_type 문자열입니다.
eventTime: ISO 8601 'zulu' 형식
userPseudoId: 큰따옴표로 묶인 문자열입니다. 이 값을 지정하면 방문자와 연결된 모든 이벤트가 삭제됩니다.
userId: 큰따옴표로 묶인 문자열입니다. 이 값을 지정하면 사용자와 연결된 모든 이벤트가 삭제됩니다.

참고: 이 API는 최대 30일 범위의 삭제만 지원합니다.

예:

특정 기간의 모든 이벤트 삭제: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
특정 기간의 특정 eventType 삭제: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
특정 기간의 특정 방문자의 모든 이벤트 삭제: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
DataStore 내에서 지난 30일의 이벤트 삭제: *

필터링 필드에는 암시적 AND가 있다고 가정됩니다.

force

bool

force 필드는 현재 지원되지 않습니다. 사용자 이벤트 삭제 요청은 삭제 가능한 모든 이벤트를 영구적으로 삭제합니다. 개발이 완료되면 force이 false로 설정된 경우 메서드가 사용자 이벤트를 삭제하지 않고 예상되는 삭제 횟수를 반환합니다. 이 필드는 요청에 포함되지 않은 경우 기본적으로 false로 설정됩니다.

PurgeUserEventsResponse

PurgeUserEventsRequest의 응답입니다. 장기 실행 작업이 완료되면 google.longrunning.Operations.response 필드에서 이 메시지를 반환합니다.

필드

purge_count

int64

작업의 결과로 삭제된 총 이벤트 수입니다.

쿼리

사용자가 입력한 쿼리를 정의합니다.

필드

query_id

string

출력 전용입니다. 질문의 고유 ID입니다.

통합 필드 content. 콘텐츠를 쿼리합니다. content은 다음 중 하나여야 합니다.

text

string

일반 텍스트

RankRequest

RankService.Rank 메서드의 요청 메시지입니다.

필드
`ranking_config`	`string` 필수 항목입니다. 순위 서비스 구성의 리소스 이름입니다(예: `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`).
`model`	`string` 사용할 모델의 식별자입니다. 다음 중 하나입니다. `semantic-ranker-512@latest`: 최대 입력 토큰 크기가 512인 시맨틱 순위 지정 모델입니다. 지정되지 않은 경우 기본적으로 `semantic-ranker-512@latest`로 설정됩니다.
`top_n`	`int32` 반환할 결과 수입니다. 설정되지 않았거나 0보다 크지 않으면 모든 결과를 반환합니다.
`query`	`string` 사용할 쿼리입니다.
`records[]`	`RankingRecord` 필수 항목입니다. 순위를 지정할 레코드 목록입니다.
`ignore_record_details_in_response`	`bool` true인 경우 응답에는 레코드 ID와 점수만 포함됩니다. 기본값은 false이며, 응답에 레코드 세부정보가 포함됩니다.
`user_labels`	`map<string, string>` 리소스에 적용된 사용자 라벨은 다음 요구사항을 충족해야 합니다. 각 리소스는 여러 개의 라벨(최대 64개)을 가질 수 있습니다. 각 라벨은 키-값 쌍이어야 합니다. 키는 비워 둘 수 없으며 최소 길이는 1자이고 최대 길이는 63자입니다. 값은 비워 둘 수 있으며 최대 길이는 63자(영문 기준)입니다. 키와 값에는 소문자, 숫자, 밑줄, 대시만 사용할 수 있습니다. 모든 문자는 UTF-8 인코딩을 사용해야 하며 국제 문자가 허용됩니다. 라벨의 키 부분은 고유해야 합니다. 그러나 여러 리소스에 동일한 키를 사용할 수 있습니다. 키는 소문자나 국제 문자로 시작해야 합니다. 자세한 내용은 Google Cloud 문서를 참고하세요.

RankResponse

RankService.Rank 메서드의 응답 메시지입니다.

필드

records[]

RankingRecord

점수를 기준으로 내림차순으로 정렬된 레코드 목록입니다.

RankingRecord

RankService.Rank 메서드의 메시지를 녹음합니다.

필드
`id`	`string` 레코드를 나타내는 고유 ID입니다.
`title`	`string` 레코드의 제목입니다. 기본적으로 비어 있습니다. `title` 또는 `content` 중 하나 이상을 설정해야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 발생합니다.
`content`	`string` 레코드의 콘텐츠입니다. 기본적으로 비어 있습니다. `title` 또는 `content` 중 하나 이상을 설정해야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 발생합니다.
`score`	`float` 지정된 쿼리 및 선택된 모델을 기반으로 한 이 레코드의 점수입니다. 점수는 소수점 이하 2자리로 반올림됩니다. 점수가 0에 가까우면 설정되지 않은 값이 반환되지 않도록 0.0001로 반올림됩니다.

RecommendRequest

Recommend 메서드의 요청 메시지입니다.

필드
`serving_config`	`string` 필수 항목입니다. `ServingConfig`의 전체 리소스 이름: `projects//locations/global/collections//engines//servingConfigs/` 또는 `projects//locations/global/collections//dataStores//servingConfigs/` 추천 엔진을 만들면 기본 서빙 구성이 하나 생성됩니다. 엔진 ID는 기본 서빙 구성의 ID로 사용됩니다. 예를 들어 엔진 `projects//locations/global/collections//engines/my-engine`의 경우 `RecommendationService.Recommend` 요청에 `projects//locations/global/collections//engines/my-engine/servingConfigs/my-engine`를 사용할 수 있습니다.
`user_event`	`UserEvent` 필수 항목입니다. 사용자, 사용자가 보고 있는 항목, 추천 요청을 트리거하기 위해 사용자가 취한 조치에 관한 컨텍스트입니다. 이 사용자 이벤트 세부정보는 userEvent 로그에 수집되지 않습니다. 따라서 이벤트 로깅에는 별도의 userEvent 쓰기 요청이 필요합니다. 여러 사용자에 대해 `UserEvent.user_pseudo_id` 또는 `UserEvent.user_info.user_id`을 동일한 고정 ID로 설정하지 마세요. 맞춤설정되지 않은 추천을 받으려면 (권장하지 않음, 모델 성능에 부정적인 영향을 줄 수 있음) 대신 `UserEvent.user_pseudo_id`을 임의의 고유 ID로 설정하고 `UserEvent.user_info.user_id`을 설정하지 않은 상태로 두세요.
`page_size`	`int32` 반환할 결과의 최대 수입니다. 이 속성을 필요한 추천 결과 수로 설정합니다. 0이면 서비스에서 적절한 기본값을 선택합니다. 허용되는 최댓값은 100입니다. 100을 초과하는 값은 100으로 설정됩니다.
`filter`	`string` 길이 제한이 5,000자인 추천 결과를 제한하는 필터입니다. 현재 `filter_tags` 속성에 대한 필터 표현식만 지원됩니다. 예: `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` `params` 필드에서 `attributeFilteringSyntax`이 true로 설정된 경우 위에서 설명한 태그 기반 구문 대신 속성 기반 표현식이 필요합니다. 예: (language: ANY("en", "es")) AND NOT (categories: ANY("Movie")) (available: true) AND (language: ANY("en", "es")) OR (categories: ANY("Movie")) 필터가 모든 결과를 차단하면 API는 일반적인 (필터링되지 않은) 인기 문서를 반환합니다. 필터와 정확히 일치하는 결과만 원하는 경우 `RecommendRequest.params`에서 `strictFiltering`을 `true`로 설정하여 대신 빈 결과를 수신하세요. 필터 선택과 관계없이 API는 `storageStatus`이 `EXPIRED` 또는 `DELETED`인 `Document`를 반환하지 않습니다.
`validate_only`	`bool` 이 추천 쿼리에 대해 유효성 검사 전용 모드를 사용합니다. `true`로 설정하면 임의의 문서 ID를 반환하는 가짜 모델이 사용됩니다. 유효성 검사 전용 모드는 API를 테스트하거나 모델이 준비되지 않은 경우에만 사용해야 합니다.
`params`	`map<string, Value>` 추천에 대한 추가 도메인별 매개변수입니다. 허용되는 값: `returnDocument`: 불리언. `true`로 설정하면 연결된 문서 객체가 `RecommendResponse.RecommendationResult.document`에 반환됩니다. `returnScore`: 불리언. true로 설정되면 반환된 각 문서에 해당하는 추천 점수가 `RecommendResponse.RecommendationResult.metadata`에 설정됩니다. 제공된 점수는 사용자의 컨텍스트와 기록을 고려할 때 문서가 전환될 가능성을 나타냅니다. `strictFiltering`: 불리언. 기본적으로 true입니다. `false`로 설정된 경우 필터가 모든 추천 결과를 차단하면 서비스는 비어 있는 대신 일반적인 (필터링되지 않은) 인기 문서를 반환합니다. `diversityLevel`: 문자열입니다. 기본값은 비어 있습니다. 비어 있지 않도록 설정된 경우 다음 중 하나여야 합니다. `no-diversity` `low-diversity` `medium-diversity` `high-diversity` `auto-diversity` 이렇게 하면 요청 수준에서 제어할 수 있으며 문서 카테고리를 기반으로 추천 결과가 조정됩니다. `attributeFilteringSyntax`: 불리언. 기본값은 false입니다. true로 설정되면 `filter` 필드가 새로운 속성 기반 구문에 따라 해석됩니다.
`user_labels`	`map<string, string>` 리소스에 적용된 사용자 라벨은 다음 요구사항을 충족해야 합니다. 각 리소스는 여러 개의 라벨(최대 64개)을 가질 수 있습니다. 각 라벨은 키-값 쌍이어야 합니다. 키는 비워 둘 수 없으며 최소 길이는 1자이고 최대 길이는 63자입니다. 값은 비워 둘 수 있으며 최대 길이는 63자(영문 기준)입니다. 키와 값에는 소문자, 숫자, 밑줄, 대시만 사용할 수 있습니다. 모든 문자는 UTF-8 인코딩을 사용해야 하며 국제 문자가 허용됩니다. 라벨의 키 부분은 고유해야 합니다. 그러나 여러 리소스에 동일한 키를 사용할 수 있습니다. 키는 소문자나 국제 문자로 시작해야 합니다. 자세한 내용은 라벨 요구사항을 참고하세요.

RecommendResponse

Recommend 메서드의 응답 메시지입니다.

필드
`results[]`	`RecommendationResult` 추천 문서 목록입니다. 순서는 순위를 나타냅니다 (가장 관련성이 높은 문서부터 가장 관련성이 낮은 문서까지).
`attribution_token`	`string` 고유한 기여 분석 토큰입니다. 이 토큰은 추천으로 인해 발생한 `UserEvent` 로그에 포함되어야 하며, 이를 통해 추천 모델 성능을 정확하게 기여 분석할 수 있습니다.
`missing_ids[]`	`string` 요청된 ServingConfig와 연결된 기본 브랜치에서 누락된 요청의 문서 ID입니다.
`validate_only`	`bool` `RecommendRequest.validate_only`가 설정된 경우 true입니다.

RecommendationResult

RecommendationResult는 연결된 메타데이터가 있는 일반 추천 결과를 나타냅니다.

필드

id

string

RecrawlUrisMetadata

SiteSearchEngineService.RecrawlUris 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드
`create_time`	`Timestamp` 작업 생성 시간입니다.
`update_time`	`Timestamp` 작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.
`invalid_uris[]`	`string` 요청에 포함된 고유 URI 중 형식이 잘못된 URI입니다. 샘플이 1,000개로 제한됩니다.
`invalid_uris_count`	`int32` 형식이 잘못된 요청의 고유 URI의 총수입니다.
`noindex_uris[]`	`string` 색인 메타 태그가 없는 URI입니다. 샘플이 1,000개로 제한됩니다.
`noindex_uris_count`	`int32` 색인 메타 태그가 없는 URI의 총수입니다.
`uris_not_matching_target_sites[]`	`string` 요청의 고유 URI가 DataStore의 TargetSite와 일치하지 않거나, 완전히 색인이 생성되지 않은 TargetSite와 일치하거나, 유형이 EXCLUDE인 TargetSite와 일치합니다. 샘플이 1,000개로 제한됩니다.
`uris_not_matching_target_sites_count`	`int32` TargetSites와 일치하지 않는 URI의 총수입니다.
`valid_uris_count`	`int32` invalid_uris에 없는 요청의 순 URI 수입니다.
`success_count`	`int32` 지금까지 크롤링된 URI의 총수입니다.
`pending_count`	`int32` 아직 크롤링되지 않은 URI의 총수입니다.
`quota_exceeded_count`	`int32` 색인 생성 리소스가 부족하여 거부된 URI의 총수입니다.

RecrawlUrisRequest

SiteSearchEngineService.RecrawlUris 메서드의 요청 메시지입니다.

필드

site_search_engine

string

필수 항목입니다. SiteSearchEngine의 전체 리소스 이름입니다(예: projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine).

uris[]

string

필수 항목입니다. 크롤링할 URI 목록입니다. 최대 10, 000개의 URI가 지원됩니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 발생합니다. 각 URI는 site_search_engine의 TargetSite 하나 이상과 일치해야 합니다.

site_credential

string

(선택사항) 크롤링에 사용할 사용자 인증 정보 ID입니다.

RecrawlUrisResponse

SiteSearchEngineService.RecrawlUris 메서드의 응답 메시지입니다.

필드

failure_samples[]

FailureInfo

최대 10개의 failed_uris 샘플에 대한 세부정보입니다.

failed_uris[]

string

LRO가 종료되기 전에 크롤링되지 않은 URI입니다.

FailureInfo

특정 URI가 크롤링되지 못한 이유에 관한 세부정보입니다. 각 FailureInfo에는 CorpusType당 FailureReason이 하나씩 포함됩니다.

필드

uri

string

크롤링에 실패한 URI입니다.

failure_reasons[]

FailureReason

코퍼스 유형 (예: 데스크톱, 모바일)별 실패 이유 목록입니다.

FailureReason

특정 CorpusType의 크롤링이 실패한 이유에 관한 세부정보입니다.예를 들면 다음과 같습니다. 데스크톱 및 모바일 크롤링은 서로 다른 이유로 실패할 수 있습니다.

필드

corpus_type

CorpusType

DESKTOP, MOBILE 또는 CORPUS_TYPE_UNSPECIFIED입니다.

error_message

string

URI가 크롤링되지 않은 이유입니다.

CorpusType

실패한 크롤링 작업의 CorpusType입니다.

열거형
`CORPUS_TYPE_UNSPECIFIED`	기본값
`DESKTOP`	페이지의 데스크톱 버전에 대한 크롤링 시도를 나타냅니다.
`MOBILE`	페이지의 모바일 버전에 대한 크롤링 시도를 나타냅니다.

답장

사용자에 대한 답장 메시지를 정의합니다.

필드

summary

Summary

검색 결과를 기반으로 한 요약

SafetyRating

생성된 콘텐츠에 해당하는 안전 등급입니다.

필드
`category`	`HarmCategory` 출력 전용입니다. 유해 카테고리입니다.
`probability`	`HarmProbability` 출력 전용입니다. 콘텐츠의 유해 콘텐츠일 확률 수준입니다.
`probability_score`	`float` 출력 전용입니다. 유해 콘텐츠일 확률 점수입니다.
`severity`	`HarmSeverity` 출력 전용입니다. 콘텐츠의 유해성 심각도 수준입니다.
`severity_score`	`float` 출력 전용입니다. 유해성 심각도 점수입니다.
`blocked`	`bool` 출력 전용입니다. 이 등급으로 인해 콘텐츠가 필터링되었는지 여부를 나타냅니다.

HarmProbability

콘텐츠의 유해 콘텐츠일 확률 수준입니다.

열거형
`HARM_PROBABILITY_UNSPECIFIED`	위해 확률이 지정되지 않았습니다.
`NEGLIGIBLE`	무시할 수 있는 수준의 피해입니다.
`LOW`	피해 수준이 낮습니다.
`MEDIUM`	중간 수준의 피해
`HIGH`	높은 수준의 유해성

HarmSeverity

유해성 심각도 수준입니다.

열거형
`HARM_SEVERITY_UNSPECIFIED`	피해 심각도가 지정되지 않았습니다.
`HARM_SEVERITY_NEGLIGIBLE`	피해 심각도가 무시할 수 있는 수준입니다.
`HARM_SEVERITY_LOW`	낮은 수준의 피해 심각도
`HARM_SEVERITY_MEDIUM`	중간 수준의 유해성 심각도입니다.
`HARM_SEVERITY_HIGH`	높은 수준의 피해 심각도

스키마

문서 데이터 유형의 구조와 레이아웃을 정의합니다.

필드
`name`	`string` 변경할 수 없습니다. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}` 형식의 스키마 전체 리소스 이름입니다. 이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 1,024자(영문 기준)입니다.
통합 필드 `schema`. 스키마 표현입니다. `struct_schema` 또는 `json_schema` 중 하나를 제공해야 합니다. 그렇지 않으면 `INVALID_ARGUMENT` 오류가 발생합니다. `schema`은 다음 중 하나여야 합니다.
`struct_schema`	`Struct` 스키마의 구조화된 표현입니다.
`json_schema`	`string` 스키마의 JSON 표현입니다.

SearchAddOn

검색에 추가 기능을 제공하는 부가기능입니다.

열거형
`SEARCH_ADD_ON_UNSPECIFIED`	열거형이 지정되지 않은 경우의 기본값입니다. 사용할 수 없습니다.
`SEARCH_ADD_ON_LLM`	대규모 언어 모델 부가기능

SearchInfo

자세한 검색 정보입니다.

필드

search_query

string

사용자의 검색어입니다.

정의는 SearchRequest.query를 참고하세요.

값은 5,000자 길이 제한이 있는 UTF-8 인코딩 문자열이어야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.

search 이벤트에는 search_query 또는 PageInfo.page_category 중 하나 이상이 필요합니다. 다른 이벤트 유형에는 이 필드를 설정하면 안 됩니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.

order_by

string

해당하는 경우 제품이 반환되는 순서입니다.

정의 및 구문은 SearchRequest.order_by를 참고하세요.

값은 1,000자 길이 제한이 있는 UTF-8 인코딩 문자열이어야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.

search 이벤트에만 설정할 수 있습니다. 다른 이벤트 유형에는 이 필드를 설정하면 안 됩니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.

offset

int32

페이지로 나누기 위한 현재 오프셋을 지정하는 정수입니다(API에서 관련성 있는 것으로 간주되는 제품 중에서 0부터 시작하는 색인의 시작 위치).

정의는 SearchRequest.offset를 참고하세요.

이 필드가 음수이면 INVALID_ARGUMENT이 반환됩니다.

search 이벤트에만 설정할 수 있습니다. 다른 이벤트 유형에는 이 필드를 설정하면 안 됩니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.

SearchLinkPromotion

프로모션 프로토에는 프로모션을 표시하는 데 도움이 되는 URI 및 기타 정보가 포함됩니다.

필드
`title`	`string` 필수 항목입니다. 프로모션의 제목입니다. 최대 길이: 160자(영문 기준)
`uri`	`string` (선택사항) 사용자가 홍보하려는 페이지의 URL입니다. 사이트 검색에 설정해야 합니다. 다른 업종의 경우 선택사항입니다.
`document`	`string` (선택사항) 사용자가 홍보하기를 원하는 `Document`입니다. 사이트 검색의 경우 설정되지 않은 상태로 두고 URI만 채웁니다. URI와 함께 설정할 수 있습니다.
`image_uri`	`string` (선택사항) 프로모션 썸네일 이미지 URL입니다.
`description`	`string` (선택사항) 프로모션 설명입니다. 최대 길이: 200자(영문 기준)
`enabled`	`bool` (선택사항) 사용 설정된 프로모션은 이 프로모션이 연결된 컨트롤의 상위 요소와 연결된 모든 서빙 구성에 대해 반환됩니다. 이 플래그는 기본 사이트 검색에만 사용됩니다.

SearchRequest

SearchService.Search 메서드의 요청 메시지입니다.

필드
`serving_config`	`string` 필수 항목입니다. 검색 서빙 구성의 리소스 이름입니다(예: `projects//locations/global/collections/default_collection/engines//servingConfigs/default_serving_config` 또는 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`). 이 필드는 검색하는 데 사용되는 모델 집합인 서빙 구성 이름을 식별하는 데 사용됩니다.
`branch`	`string` 브랜치 리소스 이름입니다(예: `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`). `default_branch`를 브랜치 ID로 사용하거나 이 필드를 비워 기본 브랜치에서 문서를 검색합니다.
`query`	`string` 원시 검색어입니다.
`image_query`	`ImageQuery` 원시 이미지 쿼리입니다.
`page_size`	`int32` 반환할 최대 `Document` 수입니다. 허용되는 최대값은 데이터 유형에 따라 다릅니다. 최댓값을 초과하는 값은 최댓값으로 변환됩니다. 기본 색인 생성이 있는 웹사이트: 기본값 `10`, 최댓값 `25` 고급 색인 생성이 있는 웹사이트: 기본값 `25`, 최댓값 `50` 기타: 기본값 `50`, 최댓값 `100` 이 필드가 음수이면 `INVALID_ARGUMENT`이 반환됩니다.
`page_token`	`string` 이전 `SearchService.Search` 호출에서 수신한 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다. 페이지를 매길 때 `SearchService.Search`에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다. 그렇지 않으면 `INVALID_ARGUMENT` 오류가 반환됩니다.
`offset`	`int32` 검색 결과에서 현재 오프셋 (API에서 관련 있는 것으로 간주되는 `Document` 중 시작 결과 위치)을 지정하는 0부터 시작하는 정수입니다. 이 필드는 `page_token`이 설정되지 않은 경우에만 고려됩니다. 이 필드가 음수이면 `INVALID_ARGUMENT`이 반환됩니다. 큰 오프셋은 적절한 기준점으로 제한될 수 있습니다.
`one_box_page_size`	`int32` OneBox에 반환할 최대 결과 수입니다. 이는 각 OneBox 유형에 개별적으로 적용됩니다. 기본값은 10입니다.
`data_store_specs[]`	`DataStoreSpec` 검색할 특정 `DataStore`와 해당 데이터 스토어의 구성을 정의하는 사양입니다. 데이터 스토어가 여러 개인 `Engine`에만 적용됩니다. 단일 데이터 스토어가 있는 엔진의 경우 `SearchRequest` 바로 아래의 사양을 사용해야 합니다.
`filter`	`string` 필터 구문은 필터링되는 문서의 하나 이상의 필드에서 조건자를 구성하기 위한 표현식 언어로 구성됩니다. 필터 표현식은 대소문자를 구분합니다. 이 필드를 인식할 수 없으면 `INVALID_ARGUMENT`가 반환됩니다. Vertex AI Search의 필터링은 LHS 필터 키를 Vertex AI Search 백엔드에 정의된 키 속성에 매핑하여 실행됩니다. 이 매핑은 고객이 스키마에 정의합니다. 예를 들어 미디어 고객의 스키마에 'name' 필드가 있을 수 있습니다. 이 경우 필터는 다음과 같습니다. filter --> name:'ANY("king kong")' 구문 및 필터 연산자를 비롯한 필터링에 대한 자세한 내용은 필터를 참고하세요.
`canonical_filter`	`string` 사용자가 검색 페이지에서 필터를 선택하지 않고 검색을 실행할 때 적용되는 기본 필터입니다. 질문 확장과 같은 품질 개선이 필요한 경우 모든 검색 요청에 적용되는 필터입니다. 쿼리에 결과가 충분하지 않은 경우 이 필터를 사용하여 쿼리 확장 흐름을 사용 설정할지 여부를 결정합니다. 확장된 검색어 검색에는 원래 필터가 계속 사용됩니다. 높은 검색 품질을 달성하려면 이 필드를 사용하는 것이 좋습니다. 필터 구문에 대한 자세한 내용은 `SearchRequest.filter`를 참고하세요.
`order_by`	`string` 문서가 반환되는 순서입니다. 문서는 `Document` 객체의 필드별로 정렬할 수 있습니다. 관련성별로 정렬하는 경우 설정하지 않은 상태로 둡니다. `order_by` 표현식은 대소문자를 구분합니다. 웹사이트 검색 결과 정렬에 대한 자세한 내용은 웹 검색 결과 정렬을 참고하세요. 의료 검색 결과 정렬에 대한 자세한 내용은 의료 검색 결과 정렬을 참고하세요. 이 필드를 인식할 수 없으면 `INVALID_ARGUMENT`가 반환됩니다.
`user_info`	`UserInfo` 최종 사용자에 관한 정보입니다. 분석 및 맞춤설정에 적극 권장됩니다. `UserInfo.user_agent`은 분석을 위해 `device_type`을 추론하는 데 사용됩니다.
`language_code`	`string` BCP-47 언어 코드(예: 'en-US' 또는 'sr-Latn') 자세한 내용은 표준 필드를 참고하세요. 이 필드는 쿼리를 더 잘 해석하는 데 도움이 됩니다. 값을 지정하지 않으면 쿼리 언어 코드가 자동으로 감지되지만 정확하지 않을 수 있습니다.
`facet_specs[]`	`FacetSpec` 패싯 검색을 위한 패싯 사양입니다. 비어 있으면 패싯이 반환되지 않습니다. 최대 100개의 값이 허용됩니다. 그렇지 않으면 `INVALID_ARGUMENT` 오류가 반환됩니다.
`boost_spec`	`BoostSpec` 특정 문서를 상단으로 올리는 부스트 사양입니다. 부스팅에 대한 자세한 내용은 부스팅을 참고하세요.
`params`	`map<string, Value>` 추가 검색 매개변수입니다. 공개 웹사이트 검색의 경우 지원되는 값은 다음과 같습니다. `user_country_code`: 문자열입니다. 기본값은 비어 있습니다. 비어 있지 않은 값으로 설정하면 제공된 위치에 따라 결과가 제한되거나 부스팅됩니다. 예를 들면 `user_country_code: "au"`입니다. 사용 가능한 코드는 국가 코드를 참고하세요. `search_type`: double 기본값은 비어 있습니다. 값에 따라 웹페이지가 아닌 검색을 사용 설정합니다. 유일하게 유효한 비기본값은 1이며, 이 값은 이미지 검색을 사용 설정합니다. 예를 들면 `search_type: 1`입니다.
`query_expansion_spec`	`QueryExpansionSpec` 검색어 확장이 발생하는 조건을 지정하는 검색어 확장 사양입니다.
`spell_correction_spec`	`SpellCorrectionSpec` 맞춤법 수정이 적용되는 모드를 지정하는 맞춤법 수정 사양입니다.
`user_pseudo_id`	`string` 방문자 추적을 위한 고유 식별자입니다. 예를 들어 단일 기기에서 방문자를 고유하게 식별할 수 있는 HTTP 쿠키를 사용하여 이를 구현할 수 있습니다. 이 고유 식별자는 방문자가 웹사이트에 로그인 또는 로그아웃해도 변경되지 않아야 합니다. 이 필드에는 `unknown_visitor`과 같은 고정 값이 있어서는 안 됩니다(NOT). `UserEvent.user_pseudo_id` 및 `CompleteQueryRequest.user_pseudo_id`과 동일한 식별자여야 합니다. 필드는 길이 제한이 128자(영문 기준)인 UTF-8로 인코딩된 문자열이어야 합니다. 그렇지 않으면 `INVALID_ARGUMENT` 오류가 반환됩니다.
`content_search_spec`	`ContentSearchSpec` 콘텐츠 검색의 동작을 구성하기 위한 사양입니다.
`ranking_expression`	`string` (선택사항) 순위 표현식은 검색 문서의 맞춤 순위를 제어합니다. 이렇게 하면 `ServingConfig.ranking_expression`이 재정의됩니다. 구문과 지원되는 기능은 `ranking_expression_backend` 값에 따라 달라집니다. `ranking_expression_backend`이 제공되지 않으면 기본값은 `RANK_BY_EMBEDDING`입니다. `ranking_expression_backend`가 제공되지 않거나 `RANK_BY_EMBEDDING`로 설정된 경우 '+'로 조인된 단일 함수 또는 여러 함수여야 합니다. ranking_expression = function, { " + ", function }; 지원되는 함수: double * relevance_score double * dotProduct(embedding_field_path) 함수 변수: `relevance_score`: 쿼리와 문서 간의 관련성을 측정하는 데 사용되는 사전 정의된 키워드입니다. `embedding_field_path`: 쿼리 임베딩 벡터와 함께 사용되는 문서 임베딩 필드입니다. `dotProduct`: `embedding_field_path`과 질문 임베딩 벡터 간의 임베딩 함수입니다. 순위 표현식의 예: 문서에 doc_embedding이라는 삽입 필드가 있는 경우 순위 표현식은 `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`일 수 있습니다. `ranking_expression_backend`이 `RANK_BY_FORMULA`로 설정된 경우 다음 표현식 유형 (및 + 또는 * 연산자를 사용하여 연결된 조합)이 지원됩니다. `double` `signal` `log(signal)` `exp(signal)` `rr(signal, double > 0)` -- 두 번째 인수가 분모 상수인 역수 순위 변환입니다. `is_nan(signal)` - 신호가 NaN이면 0을 반환하고, 그렇지 않으면 1을 반환합니다. `fill_nan(signal1, signal2 \| double)` -- signal1이 NaN이면 signal2 \| double을 반환하고, 그렇지 않으면 signal1을 반환합니다. 다음은 지원되는 순위 표현식 유형을 사용하는 순위 공식의 몇 가지 예입니다. `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- 주로 `keyword_similarity_score`의 로그로 순위를 지정하며 `semantic_smilarity_score` 조정이 약간 있습니다. `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)`: `semantic_similarity_score`의 지수로 순위를 지정합니다. 값이 NaN인 경우 0으로 채우고 `semantic_similarity_score`이 NaN인 경우 최종 점수에 상수 0.3 조정을 추가합니다. `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` - `semantic_smilarity_score`의 역수 순위를 약간 조정한 `keyword_similarity_score`의 역수 순위로 대부분 순위를 지정합니다. 다음 신호가 지원됩니다. `semantic_similarity_score`: Google 소유 모델에서 생성된 임베딩을 사용하여 계산된 의미 유사성 조정입니다. 이 점수는 검색 쿼리가 문서와 얼마나 의미상 유사한지를 나타냅니다. `keyword_similarity_score`: 키워드 일치 조정은 Best Match 25 (BM25) 순위 지정 함수를 사용합니다. 이 점수는 확률 모델을 사용하여 문서가 특정 질문과 관련이 있을 확률을 추정하여 계산됩니다. `relevance_score`: 독점적인 Google 모델을 사용하여 문서의 콘텐츠와 관련된 맥락에서 사용자 쿼리의 의미와 의도를 파악하는 의미론적 관련성 조정입니다. `pctr_rank`: 순위로 사용되는 예상 전환율 조정은 예상 클릭률 (pCTR)을 사용하여 사용자 관점에서 검색 결과의 관련성과 매력을 측정합니다. pCTR이 높을수록 결과가 사용자의 쿼리 및 의도를 충족할 가능성이 높으므로 순위 지정에 유용한 신호가 됩니다. `freshness_rank`: 순위로 표시된 최신성 조정 `document_age`: 문서가 마지막으로 업데이트된 후 경과된 시간(단위: 시간)입니다. 부동 소수점 숫자입니다(예: 0.25는 15분을 의미합니다. `topicality_rank`: 순위로 표시된 주제 조정입니다. 독점 Google 모델을 사용하여 질문과 문서 간의 키워드 기반 중복을 확인합니다. `base_rank`: 결과의 기본 순위
`ranking_expression_backend`	`RankingExpressionBackend` (선택사항) 순위 표현식 평가에 사용할 백엔드입니다.
`safe_search`	`bool` 세이프 서치를 사용 설정할지 여부입니다. 웹사이트 검색에만 지원됩니다.
`user_labels`	`map<string, string>` 리소스에 적용된 사용자 라벨은 다음 요구사항을 충족해야 합니다. 각 리소스는 여러 개의 라벨(최대 64개)을 가질 수 있습니다. 각 라벨은 키-값 쌍이어야 합니다. 키는 비워 둘 수 없으며 최소 길이는 1자이고 최대 길이는 63자입니다. 값은 비워 둘 수 있으며 최대 길이는 63자(영문 기준)입니다. 키와 값에는 소문자, 숫자, 밑줄, 대시만 사용할 수 있습니다. 모든 문자는 UTF-8 인코딩을 사용해야 하며 국제 문자가 허용됩니다. 라벨의 키 부분은 고유해야 합니다. 그러나 여러 리소스에 동일한 키를 사용할 수 있습니다. 키는 소문자나 국제 문자로 시작해야 합니다. 자세한 내용은 Google Cloud 문서를 참고하세요.
`natural_language_query_understanding_spec`	`NaturalLanguageQueryUnderstandingSpec` (선택사항) 쿼리에서 구조화된 필드 필터를 추출하는 등 자연어 쿼리 이해 기능의 구성입니다. 자세한 내용은 이 문서를 참고하세요. `naturalLanguageQueryUnderstandingSpec`가 지정되지 않으면 추가 자연어 쿼리 이해가 실행되지 않습니다.
`search_as_you_type_spec`	`SearchAsYouTypeSpec` 실시간 검색 구성입니다. `IndustryVertical.MEDIA` 카테고리에서만 지원됩니다.
`display_spec`	`DisplaySpec` (선택사항) 검색 결과의 일치 항목 강조 표시와 같은 디스플레이 기능 구성입니다.
`session`	`string` 세션 리소스 이름입니다. (선택사항) 세션을 사용하면 사용자가 다중 턴 /검색 API 호출을 수행하거나 /검색 API 호출과 /답변 API 호출 간에 조정을 할 수 있습니다. 예 1 (다중 턴 /search API 호출): 첫 번째 호출에서 생성된 세션 ID로 /search API를 호출합니다. 여기서는 이전 검색어가 쿼리 순위에 고려됩니다. 즉, 첫 번째 질문이 '2022년 Alphabet의 실적은 어땠어?'인 경우 현재 질문이 '2023년은 어때?'인 경우 현재 질문은 '2023년 Alphabet의 실적은 어때?'로 해석됩니다. 예 2(/search API 호출과 /answer API 호출 간의 조정): 첫 번째 호출에서 생성된 세션 ID로 /answer API를 호출합니다. 여기서는 첫 번째 검색 호출의 검색 결과 컨텍스트에서 답변이 생성됩니다. 다중 턴 검색 기능은 현재 비공개 GA 단계에 있습니다. 이 기능이 공개 GA로 출시되기 전에 v1alpha 또는 v1beta 버전을 사용하거나 Google 지원팀을 통해 허용 목록에 추가해 달라고 요청하세요.
`session_spec`	`SessionSpec` 세션 사양입니다. `session`가 설정된 경우에만 사용할 수 있습니다.
`relevance_threshold`	`RelevanceThreshold` 검색 결과의 관련성 기준점입니다. 정확도와 재현율의 균형을 활용하여 매우 정확한 결과와 관련 정보의 포괄적인 범위를 제공하는 Google 정의 기준을 기본값으로 설정합니다. 의료 검색에는 이 기능이 지원되지 않습니다.
`relevance_score_spec`	`RelevanceScoreSpec` (선택사항) 관련성 점수를 반환하기 위한 사양입니다.

BoostSpec

특정 문서를 상단으로 올리는 부스트 사양입니다.

필드

condition_boost_specs[]

ConditionBoostSpec

조건부 부스트 사양입니다. 문서가 사양의 여러 조건과 일치하는 경우 이러한 사양의 부스트 점수가 모두 비선형 방식으로 적용되고 결합됩니다. 최대 사양 수는 20개입니다.

ConditionBoostSpec

부스트는 조건에 일치하는 문서에 적용됩니다.

필드

condition

string

부스트 조건을 지정하는 표현식입니다. 구문 및 지원되는 필드는 필터 표현식과 동일합니다. 자세한 구문 및 제한사항은 SearchRequest.filter를 참조하세요.

예:

문서 ID가 'doc_1' 또는 'doc_2'이고 색상이 'Red' 또는 'Blue'인 문서를 부스트하기: (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))

boost

float

조건 부스팅의 강도이며, 범위는 [-1, 1]입니다. 음수 부스팅은 순위를 내리는 것을 의미합니다. 기본값은 0.0입니다.

1.0으로 설정하면 문서의 순위가 크게 높아집니다. 하지만 부스팅된 문서가 항상 상위 검색 결과에 표시되거나 다른 문서가 제외되는 것은 아닙니다. 조건과 일치하는 항목이 없더라도 결과가 계속 표시될 수 있습니다. 그리고 검색어와 관련성이 높은 검색 결과는 여전히 선호도는 높지만 관련성 없는 문서보다 우선합니다.

-1.0으로 설정하면 문서의 순위가 크게 낮아집니다. 하지만 관련성이 매우 높은 결과라면 계속 표시될 수 있습니다. 이 문서는 상당히 높은 순위를 얻기 위해 업스트림에서 경쟁해야 하지만 완전히 차단되지는 않습니다.

0.0으로 설정하면 부스트가 적용되지 않습니다. 부스팅 조건은 무시됩니다. (조건, 부스트) 조합 또는 아래의 boost_control_spec 중 하나만 설정됩니다. 둘 다 설정된 경우 전역 부스트는 무시되고 더 세분화된 boost_control_spec이 적용됩니다.

boost_control_spec

BoostControlSpec

고객 정의 속성 값을 기반으로 하는 맞춤 순위 지정의 복잡한 사양입니다.

BoostControlSpec

필드
`field_name`	`string` 값이 부스트 금액을 결정하는 데 사용되는 필드의 이름입니다.
`attribute_type`	`AttributeType` 부스트 금액을 결정하는 데 사용할 속성 유형입니다. 속성 값은 지정된 field_name의 필드 값에서 파생될 수 있습니다. 숫자의 경우 attribute_value = numerical_field_value와 같이 간단합니다. 하지만 신선도의 경우 attribute_value = (time.now() - datetime_field_value)입니다.
`interpolation_type`	`InterpolationType` 아래에 나열된 제어점을 연결하는 데 적용할 보간 유형입니다.
`control_points[]`	`ControlPoint` 곡선을 정의하는 데 사용되는 제어점입니다. 단조 함수 (위의 interpolation_type을 통해 정의됨)는 여기에 나열된 제어점을 통과합니다.

AttributeType

맞춤 순위가 적용될 속성(또는 함수)입니다.

열거형
`ATTRIBUTE_TYPE_UNSPECIFIED`	지정되지 않은 AttributeType입니다.
`NUMERICAL`	숫자 필드의 값은 부스트 금액을 동적으로 업데이트하는 데 사용됩니다. 이 경우 관리 포인트의 attribute_value (x 값)는 boost_amount가 지정된 숫자 필드의 실제 값이 됩니다.
`FRESHNESS`	최신성 사용 사례의 경우 속성 값은 현재 시간과 지정된 datetime 필드의 날짜 사이의 기간입니다. 값은 XSD `dayTimeDuration` 값 (ISO 8601 기간 값의 제한된 하위 집합)으로 형식이 지정되어야 합니다. 이 패턴은 `[nD][T[nH][nM][nS]]`입니다. 예를 들면 `5D`, `3DT12H30M`, `T24H`입니다.

ControlPoint

곡선을 정의하는 데 사용되는 제어점입니다. 이러한 제어점을 통해 정의된 곡선은 단조 증가 또는 단조 감소만 가능합니다(상수 값은 허용됨).

필드

attribute_value

string

다음 중 하나일 수 있습니다. 1. 숫자 필드 값입니다. 2. 새로고침 기간 사양입니다. 값은 XSD dayTimeDuration 값 (ISO 8601 기간 값의 제한된 하위 집합)으로 형식이 지정되어야 합니다. 이 패턴은 [nD][T[nH][nM][nS]]입니다.

boost_amount

float

attribute_value가 위에 지정된 값으로 평가되는 경우 점수를 높이는 데 사용할 -1~1 사이의 값입니다.

InterpolationType

적용할 보간 유형입니다. 기본값은 선형 (구간별 선형)입니다.

열거형
`INTERPOLATION_TYPE_UNSPECIFIED`	보간 유형이 지정되지 않았습니다. 이 경우 기본값은 선형입니다.
`LINEAR`	구간별 선형 보간이 적용됩니다.

ContentSearchSpec

콘텐츠 검색의 동작을 구성하기 위한 사양입니다.

필드
`snippet_spec`	`SnippetSpec` `snippetSpec`이 지정되지 않으면 스니펫이 검색 응답에 포함되지 않습니다.
`summary_spec`	`SummarySpec` `summarySpec`가 지정되지 않으면 요약이 검색 응답에 포함되지 않습니다.
`extractive_content_spec`	`ExtractiveContentSpec` extractive_content_spec이 제공되지 않으면 검색 결과에 추출 답변이 없습니다.
`search_result_mode`	`SearchResultMode` 검색 결과 모드를 지정합니다. 지정하지 않으면 검색 결과 모드는 기본적으로 `DOCUMENTS`입니다.
`chunk_spec`	`ChunkSpec` 검색 응답에서 반환할 청크 사양을 지정합니다. `SearchRequest.ContentSearchSpec.search_result_mode`가 `CHUNKS`로 설정된 경우에만 사용할 수 있습니다.

ChunkSpec

검색 응답에서 반환할 청크 사양을 지정합니다. SearchRequest.ContentSearchSpec.search_result_mode가 CHUNKS로 설정된 경우에만 사용할 수 있습니다.

필드

num_previous_chunks

int32

현재 청크에서 반환할 이전 청크의 수입니다. 허용되는 최댓값은 3입니다. 지정하지 않으면 이전 청크가 반환되지 않습니다.

num_next_chunks

int32

현재 청크에서 반환할 다음 청크의 수입니다. 허용되는 최댓값은 3입니다. 지정하지 않으면 다음 청크가 반환되지 않습니다.

ExtractiveContentSpec

검색 응답에서 추출 콘텐츠를 구성하기 위한 사양입니다.

필드
`max_extractive_answer_count`	`int32` 각 검색 결과에 반환되는 추출 답변의 최대 수입니다. 추출 답변은 원본 문서에서 추출된 그대로의 답변으로, 검색어에 대한 정확하고 맥락에 맞는 답변을 제공합니다. 일치하는 답변 수가 `max_extractive_answer_count`보다 적으면 모든 답변을 반환합니다. 그렇지 않으면 `max_extractive_answer_count`을 반환합니다. 각 `SearchResult`에 대해 최대 5개의 답변이 반환됩니다.
`max_extractive_segment_count`	`int32` 각 검색 결과에 반환되는 추출 세그먼트의 최대 개수입니다. `DataStore`이 `DataStore.ContentConfig.CONTENT_REQUIRED`으로 설정되거나 `DataStore.solution_types`이 `SOLUTION_TYPE_CHAT`인 경우에만 적용됩니다. 추출 세그먼트는 원본 문서에서 추출된 텍스트 세그먼트로, 검색어와 관련이 있으며 일반적으로 추출 답변보다 더 자세합니다. 그런 다음 이 세그먼트를 LLM의 입력으로 사용하여 요약과 답변을 생성할 수 있습니다. 일치하는 세그먼트 수가 `max_extractive_segment_count`보다 적으면 모든 세그먼트를 반환합니다. 그렇지 않으면 `max_extractive_segment_count`을 반환합니다.
`return_extractive_segment_score`	`bool` 각 검색 결과의 추출 세그먼트에서 신뢰도 점수를 반환할지 여부를 지정합니다. 이 기능은 신규 데이터 스토어 또는 허용 목록에 추가된 데이터 스토어에서만 사용할 수 있습니다. 데이터 스토어를 허용 목록에 추가하려면 고객 엔지니어에게 문의하세요. 기본값은 `false`입니다.
`num_previous_segments`	`int32` 선택한 각 세그먼트의 인접 세그먼트도 포함할지 여부를 지정합니다. 선택된 각 세그먼트 앞에 최대 `num_previous_segments`개의 세그먼트를 반환합니다.
`num_next_segments`	`int32` 선택한 각 세그먼트 뒤에 최대 `num_next_segments`개의 세그먼트를 반환합니다.

SearchResultMode

검색 결과 모드를 지정합니다. 지정하지 않으면 검색 결과 모드는 기본적으로 DOCUMENTS입니다.

열거형
`SEARCH_RESULT_MODE_UNSPECIFIED`	기본값
`DOCUMENTS`	검색 결과의 문서를 반환합니다.
`CHUNKS`	검색 결과에서 청크를 반환합니다. `DocumentProcessingConfig.chunking_config`이 지정된 경우에만 사용할 수 있습니다.

SnippetSpec

검색 응답에서 스니펫을 구성하기 위한 사양입니다.

필드

max_snippet_count
(deprecated)

int32

[지원 중단됨] 이 필드는 지원 중단되었습니다. 스니펫 반환을 제어하려면 return_snippet 필드를 사용하세요. 이전 버전과의 호환성을 위해 max_snippet_count > 0인 경우 스니펫이 반환됩니다.

reference_only
(deprecated)

bool

[지원 중단됨] 이 필드는 지원 중단되었으며 스니펫에 영향을 미치지 않습니다.

return_snippet

bool

true이면 스니펫을 반환합니다. 스니펫을 생성할 수 없는 경우 '이 페이지에 사용할 수 있는 스니펫이 없습니다'가 반환됩니다. SUCCESS 또는 NO_SNIPPET_AVAILABLE이 포함된 snippet_status도 반환됩니다.

SummarySpec

검색 응답에 반환되는 요약을 구성하기 위한 사양입니다.

필드
`summary_result_count`	`int32` 요약을 생성할 상위 결과의 수입니다. 반환된 결과 수가 `summaryResultCount`보다 적으면 모든 결과로부터 요약이 생성됩니다. 문서 모드의 경우 최대 10개, 청크 모드의 경우 최대 50개의 결과를 사용하여 요약을 생성할 수 있습니다. 청크 모드는 `SearchRequest.ContentSearchSpec.search_result_mode`이 `CHUNKS`로 설정된 경우에 사용됩니다.
`include_citations`	`bool` 요약에 인용을 포함할지 여부를 지정합니다. 기본값은 `false`입니다. 이 필드가 `true`로 설정되면 요약에 인라인 인용 번호가 포함됩니다. 인용을 포함한 요약의 예: BigQuery는 Google Cloud의 완전 관리형 서버리스 엔터프라이즈 데이터 웨어하우스입니다[1]. BigQuery는 모든 데이터 유형을 지원하고 클라우드 전반에서 작동하며 머신러닝 및 비즈니스 인텔리전스를 기본 제공하는 통합 플랫폼입니다[2, 3]. 인용 번호는 반환된 검색 결과를 나타내며 1부터 색인이 생성됩니다. 예를 들어 [1] 은 해당 문장이 첫 번째 검색 결과에 속함을 나타냅니다. [2, 3] 은 해당 문장이 두 번째 및 세 번째 검색 결과에 모두 속함을 의미합니다.
`ignore_adversarial_query`	`bool` 악의적인 쿼리를 필터링할지 여부를 지정합니다. 기본값은 `false`입니다. Google에서는 검색어 분류를 사용하여 적대적인 질문을 감지합니다. 검색어가 악의적인 쿼리로 분류되면 요약이 반환되지 않습니다. 예를 들어 사용자가 회사에 대한 부정적인 댓글에 관해 질문하거나 안전하지 않은 정책 위반 출력을 생성하도록 설계된 질문을 제출할 수 있습니다. 이 필드가 `true`로 설정되면 적대적 질문에 대한 요약 생성을 건너뛰고 대신 대체 메시지를 반환합니다.
`ignore_non_summary_seeking_query`	`bool` 요약을 원하지 않는 쿼리를 필터링할지 여부를 지정합니다. 기본값은 `false`입니다. Google은 검색어 분류를 사용하여 요약을 찾는 검색어를 감지합니다. 검색어가 요약을 원하지 않는 쿼리로 분류되면 요약이 반환되지 않습니다. 예를 들어 `why is the sky blue`와 `Who is the best soccer player in the world?`은 요약을 찾는 질문이지만 `SFO airport`와 `world cup 2026`는 그렇지 않습니다. 이러한 쿼리는 탐색적인 쿼리일 가능성이 더 높습니다. 이 필드가 `true`로 설정되면 요약을 원하지 않는 쿼리에 대한 요약 생성을 건너뛰고 대신 대체 메시지를 반환합니다.
`ignore_low_relevant_content`	`bool` 관련성이 낮은 검색어를 필터링할지 여부를 지정합니다. 기본값은 `false`입니다. 이 필드가 `false`으로 설정되면 관련성과 관계없이 모든 검색 결과가 답변을 생성하는 데 사용됩니다. `true`으로 설정하면 관련성이 높은 검색 결과가 있는 질문에만 답변이 생성됩니다.
`ignore_jail_breaking_query`	`bool` (선택사항) 탈옥 쿼리를 필터링할지 여부를 지정합니다. 기본값은 `false`입니다. Google은 검색어 분류를 사용하여 브레이크아웃 쿼리를 감지합니다. 검색어가 금지된 질문으로 분류되면 요약이 반환되지 않습니다. 사용자는 어조, 스타일, 언어, 대답의 콘텐츠를 변경하거나 모델이 다른 엔티티로 행동하도록 요청하는 등 쿼리에 요청 사항을 추가할 수 있습니다(예: '경쟁업체 CEO의 어조로 대답해 줘'). 이 필드가 `true`로 설정되면 jail-breaking 질문에 대한 요약 생성을 건너뛰고 대신 대체 메시지를 반환합니다.
`model_prompt_spec`	`ModelPromptSpec` 지정된 경우 사양은 LLM에 제공된 프롬프트를 수정하는 데 사용됩니다.
`language_code`	`string` 요약의 언어 코드입니다. BCP47에 정의된 언어 태그를 사용합니다. 참고: 이 기능은 실험적 기능입니다.
`model_spec`	`ModelSpec` 지정된 경우 사양은 LLM에 제공된 모델 사양을 수정하는 데 사용됩니다.
`use_semantic_chunks`	`bool` true인 경우 상위 검색 결과에서 가장 관련성이 높은 청크에서 답변이 생성됩니다. 이 기능은 요약 품질을 개선합니다. 이 기능을 사용 설정하면 모든 상위 검색 결과가 참조되어 참조 목록에 포함되지는 않으므로 인용 출처 색인은 참조 목록에 나열된 검색 결과만 가리킵니다.

ModelPromptSpec

모델과 함께 사용할 프롬프트의 사양입니다.

필드

preamble

string

어시스턴트에게 지시하는 프롬프트의 시작 부분에 있는 텍스트입니다. 사용자 가이드에서 예를 확인할 수 있습니다.

ModelSpec

모델 사양입니다.

필드

version

string

요약을 생성하는 데 사용된 모델 버전입니다.

지원되는 값은 다음과 같습니다.

stable: 문자열입니다. 값이 지정되지 않은 경우 기본값입니다. 정식 버전으로 제공되는 미세 조정된 모델을 사용합니다. 자세한 내용은 답변 생성 모델 버전 및 수명 주기를 참고하세요.
preview: 문자열입니다. (공개 미리보기) 미리보기 모델을 사용합니다. 자세한 내용은 답변 생성 모델 버전 및 수명 주기를 참고하세요.

DataStoreSpec

검색 호출에서 필터링할 데이터 스토어와 해당 데이터 스토어의 구성을 정의하는 구조체입니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.

필드
`data_store`	`string` 필수 항목입니다. `DataStore`의 전체 리소스 이름입니다(예: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`). 경로에 프로젝트 번호가 포함되어야 합니다. 이 필드에는 프로젝트 ID가 지원되지 않습니다.
`filter`	`string` (선택사항) data_store 필드로 지정된 데이터 저장소의 문서를 필터링하는 필터 사양입니다. 필터링에 관한 자세한 내용은 필터링을 참고하세요.
`boost_spec`	`BoostSpec` (선택사항) 특정 문서를 상단으로 올리는 부스트 사양입니다. 부스팅에 대한 자세한 내용은 부스팅을 참고하세요.
`custom_search_operators`	`string` (선택사항) 지정된 경우 작업공간 데이터 스토어의 결과를 필터링하는 데 사용되는 맞춤 검색 연산자입니다. 맞춤 검색 연산자에 대한 자세한 내용은 SearchOperators를 참고하세요.

DisplaySpec

일치 강조 표시와 같은 표시할 기능을 지정합니다.

필드

match_highlighting_condition

일치 항목 강조 표시가 수행되는 조건입니다.

MatchHighlightingCondition

일치 항목 강조 표시가 수행되는 조건을 설명하는 열거형입니다.

열거형
`MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED`	서버 동작은 `MATCH_HIGHLIGHTING_DISABLED`와 동일합니다.
`MATCH_HIGHLIGHTING_DISABLED`	모든 문서에서 일치 항목 강조 표시를 사용 중지합니다.
`MATCH_HIGHLIGHTING_ENABLED`	모든 문서에서 일치 항목 강조 표시를 사용 설정합니다.

FacetSpec

패싯 검색을 수행할 패싯 사양입니다.

필드
`facet_key`	`FacetKey` 필수 항목입니다. 패싯 키 사양입니다.
`limit`	`int32` 이 패싯에 대해 반환되는 최대 패싯 값입니다. 지정하지 않으면 기본값은 20입니다. 허용되는 최댓값은 300입니다. 300을 초과하는 값은 300으로 변환됩니다. 의료 검색의 집계에서 [FacetKey.key] 가 'healthcare_aggregation_key'인 경우 여기에 설정된 값과 관계없이 한도가 내부적으로 10,000으로 재정의됩니다. 이 필드가 음수이면 `INVALID_ARGUMENT`이 반환됩니다.
`excluded_filter_keys[]`	`string` 패싯 생성 시 제외할 키 목록입니다. 기본적으로 `FacetKey.key`는 이 필드에 나열되지 않는 한 필터에서 제외되지 않습니다. 이 필드에 속성 키를 나열하면 검색 결과에서 필터링되더라도 값이 속성 결과로 표시될 수 있습니다. 이 필드를 사용해도 반환되는 검색 결과에는 영향을 미치지 않습니다. 예를 들어 색상 패싯이 'Red'인 문서가 100개 있고 색상 패싯이 'Blue'인 문서가 200개 있다고 가정해 보겠습니다. 'color:ANY("Red")' 필터가 포함되어 있고 'color'가 `FacetKey.key`인 쿼리는 기본적으로 검색 결과에서 'Red' 문서만 반환하고 'Red'를 개수 100의 유일한 색상 패싯으로 반환합니다. 파란색 문서도 있지만 '파란색'은 사용 가능한 패싯 값으로 표시되지 않습니다. 'color'가 'excludedFilterKeys'에 나열된 경우 이제 'color' 키가 필터에서 제외되므로 쿼리는 개수가 100인 'Red'와 개수가 200인 'Blue'를 모두 반환합니다. 이 필드는 검색 결과에 영향을 미치지 않으므로 검색 결과는 여전히 'Red' 문서만 반환하도록 올바르게 필터링됩니다. 최대 100개의 값이 허용됩니다. 그렇지 않으면 `INVALID_ARGUMENT` 오류가 반환됩니다.
`enable_dynamic_position`	`bool` 이 패싯의 동적 위치를 사용 설정합니다. true로 설정하면 응답의 모든 패싯 중에서 이 패싯의 위치가 자동으로 결정됩니다. 동적 패싯이 사용 설정된 경우 함께 정렬됩니다. false로 설정하면 응답에서 이 패싯의 위치가 요청과 동일하며 동적 위치가 사용 설정된 패싯 및 모든 동적 패싯보다 순위가 높습니다. 예를 들어 항상 대답에 평가 패싯이 반환되기를 원하지만 평가 패싯을 항상 상단에 표시할 필요는 없습니다. 이 경우 응답에서 평가 패싯의 위치가 자동으로 결정되도록 enable_dynamic_position을 true로 설정할 수 있습니다. 또 다른 예로 요청에 다음 패싯이 있다고 가정해 보겠습니다. 'rating', enable_dynamic_position = true 'price', enable_dynamic_position = false 'brands', enable_dynamic_position = false 또한 동적 패싯이 사용 설정되어 있어 패싯 `gender`가 생성됩니다. 그런 다음 응답의 최종 상품 속성 순서는 API가 '성별' 및 '평점' 상품 속성을 정렬하는 방식에 따라 ("가격", "브랜드", "평점", "성별") 또는 ("가격", "브랜드", "성별", "평점")이 될 수 있습니다. 하지만 '가격'과 '브랜드'는 enable_dynamic_position이 false이므로 항상 1위와 2위로 표시됩니다.

FacetKey

패싯을 계산하는 방법을 지정합니다.

필드
`key`	`string` 필수 항목입니다. `Document` 객체에서 지원되는 텍스트 및 숫자 패싯 키로, 이 키를 기준으로 패싯 값이 계산됩니다. 패싯 키는 대소문자를 구분합니다.
`intervals[]`	`Interval` 값을 간격으로 버킷팅해야 하는 경우에만 설정합니다. 숫자 값이 있는 패싯에 설정해야 합니다. 텍스트 값이 있는 패싯에 설정하면 안 됩니다. 최대 간격 수는 30입니다.
`restricted_values[]`	`string` 지정된 제한된 값에 대한 패싯만 가져옵니다. 텍스트 필드에서만 지원됩니다. 예를 들어 'category'에 'Action > 2022', 'Action > 2021', 'Sci-Fi > 2022'라는 세 가지 값이 있다고 가정해 보겠습니다. 'restricted_values'를 'Action > 2022'로 설정하면 'category' 패싯에는 'Action > 2022'만 포함됩니다. 텍스트 필드에서만 지원됩니다. 최댓값은 10입니다.
`prefixes[]`	`string` 지정된 문자열 프리픽스로 시작하는 패싯 값만 가져옵니다. 예를 들어 'category'에 'Action > 2022', 'Action > 2021', 'Sci-Fi > 2022'라는 세 가지 값이 있다고 가정해 보겠습니다. 'prefixes'를 'Action'으로 설정하면 'category' 패싯에는 'Action > 2022' 및 'Action > 2021'만 포함됩니다. 텍스트 필드에서만 지원됩니다. 최댓값은 10입니다.
`contains[]`	`string` 지정된 문자열이 포함된 패싯 값만 가져옵니다. 예를 들어 'category'에 'Action > 2022', 'Action > 2021', 'Sci-Fi > 2022'라는 세 가지 값이 있다고 가정해 보겠습니다. 'contains'를 '2022'로 설정하면 'category' 패싯에는 'Action > 2022' 및 'Sci-Fi > 2022'만 포함됩니다. 텍스트 필드에서만 지원됩니다. 최댓값은 10입니다.
`case_insensitive`	`bool` 접두사 또는 포함으로 패싯 값을 가져올 때 패싯 키를 대소문자를 구분하지 않도록 하려면 true이고, 그렇지 않으면 false입니다.
`order_by`	`string` 문서가 반환되는 순서입니다. 허용되는 값은 다음과 같습니다. 'count desc': `SearchResponse.Facet.values.count` 내림차순으로 정렬합니다. 'value desc': `SearchResponse.Facet.values.value` 내림차순으로 정렬합니다. 텍스트 패싯에만 적용됩니다. 설정하지 않으면 텍스트 값은 일반적인 순서로 정렬되고, 숫자 간격은 `FacetSpec.FacetKey.intervals`에 의해 지정된 순서로 정렬됩니다.

ImageQuery

이미지 쿼리 입력을 지정합니다.

필드

통합 필드 image.

image는 다음 중 하나여야 합니다.

image_bytes

string

Base64로 인코딩된 이미지 바이트입니다. 지원되는 이미지 형식: JPEG, PNG, BMP

NaturalLanguageQueryUnderstandingSpec

검색 요청에 자연어 이해 기능을 사용 설정하기 위한 사양입니다.

필드
`filter_extraction_condition`	`FilterExtractionCondition` 필터 추출이 수행되는 조건입니다. 서버 동작은 기본적으로 `DISABLED`입니다.
`geo_search_query_detection_field_names[]`	`string` 자연어 검색 쿼리에서 위치정보 필터가 감지되는 경우 위치 기반 필터링에 사용되는 필드 이름입니다. FilterExtractionCondition이 `ENABLED`로 설정된 경우에만 유효합니다. 이 필드가 설정되면 `ServingConfig.geo_search_query_detection_field_names`에 설정된 필드 이름을 재정의합니다.
`extracted_filter_behavior`	`ExtractedFilterBehavior` (선택사항) 추출된 필터가 검색에 적용되는 방식을 제어합니다. 기본 동작은 요청에 따라 달라집니다. 단일 데이터 스토어 구조화된 검색의 경우 기본값은 `HARD_FILTER`입니다. 다중 데이터 스토어 검색의 경우 기본 동작은 `SOFT_BOOST`입니다. 위치 기반 필터는 항상 하드 필터로 적용되며 `SOFT_BOOST` 설정이 영향을 미치지 않습니다. 이 필드는 [SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition][] 이 `FilterExtractionCondition.ENABLED`로 설정된 경우에만 사용됩니다.
`allowed_field_names[]`	`string` (선택사항) 자연어 필터 추출에 사용할 수 있는 필드의 허용 목록입니다. 기본적으로 지정되지 않은 경우 색인 생성 가능한 모든 필드가 자연어 필터 추출에 적합합니다 (하지만 사용이 보장되지는 않음). allowed_field_names에 필드가 지정된 경우 스키마에서 색인 생성 가능으로 표시되고 허용 목록에 지정된 필드만 자연어 필터 추출에 적합합니다. 참고: 멀티 데이터 스토어 검색의 경우 아직 지원되지 않으며 무시됩니다.

ExtractedFilterBehavior

추출된 필터가 검색에 적용되는 방식을 설명하는 열거형입니다.

열거형
`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED`	`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED`는 추출된 필터에 기본 동작을 사용합니다. 단일 데이터 스토어 검색의 경우 기본적으로 하드 필터로 적용됩니다. 다중 데이터 스토어 검색의 경우 기본적으로 소프트 부스트로 적용됩니다.
`HARD_FILTER`	추출된 모든 필터를 결과에 하드 필터로 적용합니다. 추출된 필터를 통과하지 못한 결과는 결과 집합에 반환되지 않습니다.
`SOFT_BOOST`	추출된 모든 필터를 소프트 부스트로 적용합니다. 필터를 통과한 결과는 결과 세트에서 더 높은 순위로 올라갑니다.

FilterExtractionCondition

필터 추출이 수행되는 조건을 설명하는 열거형입니다.

열거형
`CONDITION_UNSPECIFIED`	서버 동작은 기본적으로 `DISABLED`입니다.
`DISABLED`	NL 필터 추출을 사용 중지합니다.
`ENABLED`	NL 필터 추출을 사용 설정합니다.

QueryExpansionSpec

쿼리 확장이 수행되는 조건을 결정하는 사양입니다.

필드

condition

Condition

쿼리 확장이 수행되는 조건입니다. 기본값은 Condition.DISABLED입니다.

pin_unexpanded_results

bool

확장되지 않은 결과를 고정할지 여부입니다. 이 필드를 true로 설정하면 비확장 제품이 항상 검색 결과 상단에 표시되고 그 아래에 확장된 결과가 표시됩니다.

조건

쿼리 확장이 수행되는 조건을 설명하는 열거형입니다.

열거형
`CONDITION_UNSPECIFIED`	지정되지 않은 검색어 확장 조건입니다. 이 경우 서버 동작은 기본적으로 `Condition.DISABLED`입니다.
`DISABLED`	검색어 확장이 사용 중지되었습니다. `SearchResponse.total_size`가 0이더라도 정확한 검색어만 사용됩니다.
`AUTO`	Search API에서 빌드한 자동 검색어 확장입니다.

RankingExpressionBackend

순위 표현식 평가에 사용할 백엔드입니다.

열거형
`RANKING_EXPRESSION_BACKEND_UNSPECIFIED`	지정되지 않은/알 수 없는 값의 기본 옵션입니다.
`BYOE`	지원 중단됨: 대신 `RANK_BY_EMBEDDING`을 사용하세요. 맞춤 임베딩 모델을 사용한 순위 지정(순위 표현식을 평가하는 기본 방법) 레거시 enum 옵션입니다. 대신 `RANK_BY_EMBEDDING`를 사용해야 합니다. 이 항목은 지원 중단되었습니다.
`CLEARBOX`	지원 중단됨: 대신 `RANK_BY_FORMULA`을 사용하세요. 맞춤 수식으로 순위 지정 레거시 enum 옵션입니다. 대신 `RANK_BY_FORMULA`를 사용해야 합니다. 이 항목은 지원 중단되었습니다.
`RANK_BY_EMBEDDING`	맞춤 임베딩 모델을 사용한 순위 지정(순위 표현식을 평가하는 기본 방법)
`RANK_BY_FORMULA`	맞춤 수식으로 순위 지정

RelevanceScoreSpec

문서 관련성 점수를 반환하기 위한 사양입니다.

필드

return_relevance_score

bool

(선택사항) 검색 결과의 관련성 점수를 반환할지 여부입니다. 점수가 높을수록 문서가 질문과 관련성이 높습니다.

RelevanceThreshold

검색 결과의 관련성 기준점입니다. 관련성 기준이 높을수록 더 관련성 있는 결과가 표시되고 반환되는 결과 수는 줄어듭니다.

열거형
`RELEVANCE_THRESHOLD_UNSPECIFIED`	기본값 이 경우 서버 동작은 Google 정의 기준점으로 기본 설정됩니다.
`LOWEST`	관련성 기준이 가장 낮습니다.
`LOW`	관련성 기준이 낮습니다.
`MEDIUM`	관련성 기준이 보통입니다.
`HIGH`	관련성 기준이 높습니다.

SearchAsYouTypeSpec

검색 요청에서 입력 시 검색을 위한 사양입니다.

필드

condition

Condition

실시간 검색이 수행되는 조건입니다. 기본값은 Condition.DISABLED입니다.

조건

입력 시 검색이 수행되는 조건을 설명하는 열거형입니다.

열거형
`CONDITION_UNSPECIFIED`	서버 동작은 기본적으로 `Condition.DISABLED`입니다.
`DISABLED`	실시간 검색을 사용 중지합니다.
`ENABLED`	입력과 동시에 검색을 사용 설정합니다.
`AUTO`	입력과 동시에 검색 모드와 표준 검색 모드 간 자동 전환으로, 단일 API 구현 (예: 디바운싱)에 적합합니다.

SessionSpec

세션 사양입니다.

다중 턴 검색 기능은 현재 비공개 GA 단계에 있습니다. 이 기능이 공개 GA로 출시되기 전에 v1alpha 또는 v1beta 버전을 사용하거나 Google 지원팀을 통해 허용 목록에 추가해 달라고 요청하세요.

필드

query_id

string

설정된 경우 검색 결과는 이 쿼리 ID로 지정된 '턴'에 저장됩니다.

예를 들어 세션이 다음과 같다고 가정해 보겠습니다. session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } }

사용자는 다음과 같은 요청으로 /search API를 호출할 수 있습니다.

session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" }

그런 다음 API는 마지막 턴과 연결된 검색 결과를 저장합니다. 저장된 검색 결과는 세션 ID와 질문 ID가 지정된 후속 /answer API 호출에서 사용할 수 있습니다. 또한 동일한 세션 ID 및 질문 ID로 /search와 /answer를 동시에 호출할 수 있습니다.

search_result_persistence_count

int32

유지할 상위 검색 결과의 수입니다. 지속된 검색 결과는 후속 /answer API 호출에 사용할 수 있습니다.

이 필드는 SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count의 summary_result_count 필드와 유사합니다.

문서 모드의 경우 최대 10개, 청크 모드의 경우 최대 50개의 결과가 표시됩니다.

SpellCorrectionSpec

질문 맞춤법 수정 사양입니다.

필드

mode

Mode

맞춤법 수정이 원래 검색어를 대체하는 모드입니다. 기본값은 Mode.AUTO입니다.

모드

맞춤법 수정이 수행되는 모드를 설명하는 열거형입니다.

열거형
`MODE_UNSPECIFIED`	지정되지 않은 맞춤법 수정 모드입니다. 이 경우 서버 동작은 기본적으로 `Mode.AUTO`입니다.
`SUGGESTION_ONLY`	Search API는 맞춤법 제안을 찾으려고 시도합니다. 추천이 발견되면 `SearchResponse.corrected_query`에 배치됩니다. 맞춤법 추천은 검색어로 사용되지 않습니다.
`AUTO`	Search API에서 빌드한 자동 맞춤법 검사입니다. 수정된 질문이 있으면 이를 기반으로 검색이 진행됩니다.

SearchResponse

SearchService.Search 메서드의 응답 메시지입니다.

필드
`results[]`	`SearchResult` 일치하는 문서 목록입니다. 순서는 순위를 나타냅니다.
`facets[]`	`Facet` 사용자가 요청한 패싯의 결과입니다.
`total_size`	`int32` 페이지로 나누기와 관계없이 일치하는 항목의 예상 총 개수입니다. 페이지로 나누기를 통해 반환된 `results` 수가 일치하는 `total_size`보다 적을 수 있습니다.
`attribution_token`	`string` 고유한 검색 토큰입니다. 이 토큰은 검색으로 인해 발생한 `UserEvent` 로그에 포함되어야 하며, 이를 통해 검색 모델 성능을 정확하게 기여 분석할 수 있습니다. 또한 고객 지원 시나리오에서 요청을 식별하는 데도 도움이 됩니다.
`redirect_uri`	`string` 고객 정의 리디렉션 페이지의 URI입니다. 리디렉션 작업이 트리거되면 검색이 실행되지 않으며 응답에 `redirect_uri` 및 `attribution_token`만 설정됩니다.
`next_page_token`	`string` 다음 페이지를 검색하기 위해 `SearchRequest.page_token`으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.
`corrected_query`	`string` 맞춤법이 수정된 질문을 포함합니다(있는 경우). 맞춤법 수정 유형이 AUTOMATIC인 경우 검색 결과는 corrected_query를 기반으로 합니다. 그렇지 않으면 검색에 원래 쿼리가 사용됩니다.
`summary`	`Summary` 검색 결과의 일부로 표시되는 요약 이 필드는 `SearchRequest.ContentSearchSpec.summary_spec`이 설정된 경우에만 반환됩니다.
`query_expansion_info`	`QueryExpansionInfo` 반환된 결과의 검색어 확장 정보입니다.
`session_info`	`SessionInfo` 세션 정보입니다. `SearchRequest.session`이 제공된 경우에만 설정됩니다. 자세한 내용은 설명을 참고하세요.
`search_link_promotions[]`	`SearchLinkPromotion` 사이트 검색 프로모션입니다.

패싯 결과입니다.

필드

key

string

이 패싯의 키입니다. 예를 들면 "colors" 또는 "price"입니다. SearchRequest.FacetSpec.FacetKey.key와 일치합니다.

values[]

FacetValue

이 필드의 패싯 값입니다.

dynamic_facet

bool

패싯이 동적으로 생성되는지 여부입니다.

FacetValue

값 이름과 개수가 포함된 패싯 값입니다.

필드
`count`	`int64` 이 패싯 값이 있는 항목의 수입니다.
통합 필드 `facet_value`. 값이 포함된 패싯 값입니다. `facet_value`은 다음 중 하나여야 합니다.
`value`	`string` 패싯의 텍스트 값입니다(예: 'colors' 패싯의 'Black').
`interval`	`Interval` 패싯의 간격 값입니다(예: '가격' 패싯의 경우 [10, 20)). `SearchRequest.FacetSpec.FacetKey.intervals`와 일치합니다.

QueryExpansionInfo

확장이 발생했는지 여부를 비롯한 검색어 확장을 설명하는 정보입니다.

필드

expanded_query

bool

쿼리 확장이 발생했는지 여부를 나타내는 부울입니다.

pinned_result_count

int64

고정된 결과 수입니다. 이 필드는 확장되고 SearchRequest.QueryExpansionSpec.pin_unexpanded_results이 true로 설정된 경우에만 설정됩니다.

SearchResult

검색 결과를 나타냅니다.

필드
`id`	`string` `Document`의 `Document.id`입니다.
`document`	`Document` 검색 응답의 문서 데이터 스니펫입니다. `retrievable`로 표시된 필드만 채워집니다.
`chunk`	`Chunk` `SearchRequest.ContentSearchSpec.search_result_mode`이 `CHUNKS`으로 설정된 경우 검색 응답의 청크 데이터입니다.
`model_scores`	`map<string, DoubleList>` 출력 전용입니다. Google에서 사용 가능한 점수를 제공했습니다.
`rank_signals`	`RankSignals` (선택사항) 결과와 연결된 순위 신호 집합입니다.

RankSignals

순위 지정 신호 집합입니다.

필드
`default_rank`	`float` (선택사항) 결과의 기본 순위입니다.
`custom_signals[]`	`CustomSignal` (선택사항) 맞춤 clearbox 신호 목록입니다.
`keyword_similarity_score`	`float` (선택사항) 키워드 검색 유형 조정입니다.
`relevance_score`	`float` (선택사항) 의미론적 관련성 조정입니다.
`semantic_similarity_score`	`float` (선택사항) 의미론적 유사도 조정
`pctr_rank`	`float` (선택사항) 예상 전환율 조정을 순위로 나타낸 값입니다.
`topicality_rank`	`float` (선택사항) 순위로 표시되는 주제성 조정입니다.
`document_age`	`float` (선택사항) 문서의 기간(시간)입니다.
`boosting_factor`	`float` (선택사항) 문서의 맞춤 부스트를 결합했습니다.

CustomSignal

이름과 값 쌍으로 표현되는 맞춤 clearbox 신호입니다.

필드

name

string

(선택사항) 신호의 이름입니다.

value

float

(선택사항) 순위 신호를 나타내는 부동 소수점 값입니다 (예: BM25의 경우 1.25).

SessionInfo

세션에 관한 정보입니다.

필드

name

string

세션 이름입니다. 자동 세션 모드를 사용하는 경우 (SearchRequest.session가 '-'로 끝나는 경우) 이 필드에는 새로 생성된 세션 이름이 저장됩니다.

query_id

string

이 검색 API 호출에 해당하는 쿼리 ID입니다. 하나의 세션에 여러 턴이 있을 수 있으며 각 턴에는 고유한 쿼리 ID가 있습니다.

Answer API 호출에서 세션 이름과 이 쿼리 ID를 지정하면 이 검색 호출의 검색 결과 컨텍스트에서 답변이 생성됩니다.

요약

요약 사양에 지정된 상위 N개 검색 결과의 요약입니다.

필드
`summary_text`	`string` 요약 콘텐츠입니다.
`summary_skipped_reasons[]`	`SummarySkippedReason` 추가 요약 건너뛰기 이유입니다. 무시된 케이스의 이유를 제공합니다. 건너뛴 항목이 없으면 이 필드가 설정되지 않습니다.
`safety_attributes`	`SafetyAttributes` 안전 속성 카테고리 및 연결된 신뢰도 점수의 컬렉션입니다.
`summary_with_metadata`	`SummaryWithMetadata` 메타데이터 정보가 포함된 요약입니다.

인용

세그먼트의 인용 정보입니다.

필드

start_index

int64

인덱스는 바이트/유니코드로 측정된 세그먼트의 시작을 나타냅니다.

end_index

int64

기여 분석된 세그먼트의 끝(해당 값 제외)입니다.

sources[]

CitationSource

기여도가 부여된 세그먼트의 인용 출처입니다.

CitationMetadata

인용 메타데이터입니다.

필드

citations[]

Citation

세그먼트의 인용입니다.

CitationSource

인용 출처입니다.

필드

reference_index

int64

SummaryWithMetadata.references의 문서 참조 색인입니다. 0부터 시작하는 색인이며 reference_index가 명시적으로 설정되지 않은 경우 값은 0입니다.

참조

문서 참조입니다.

필드
`title`	`string` 문서 제목입니다.
`document`	`string` 필수 항목입니다. `Document.name`을 반환합니다. 참조된 문서의 전체 리소스 이름입니다(`projects//locations//collections//dataStores//branches//documents/` 형식).
`uri`	`string` 문서의 Cloud Storage 또는 HTTP URI입니다.
`chunk_contents[]`	`ChunkContent` 문서 콘텐츠에서 파생된 인용된 청크 콘텐츠 목록입니다.

ChunkContent

청크 콘텐츠

필드

content

string

텍스트 콘텐츠를 청크로 나눕니다.

page_identifier

string

페이지 식별자입니다.

SafetyAttributes

안전 속성 카테고리 및 연결된 신뢰도 점수입니다.

필드

categories[]

string

생성된 콘텐츠와 연결된 안전 속성 범주의 표시 이름입니다. 순서는 점수와 일치합니다.

scores[]

float

각 카테고리의 신뢰도 점수입니다. 값이 높을수록 신뢰도가 높습니다. 순서는 카테고리와 일치합니다.

SummarySkippedReason

요약 건너뛰기 이유를 나타내는 열거형입니다.

열거형
`SUMMARY_SKIPPED_REASON_UNSPECIFIED`	기본값 요약 건너뛰기 이유가 지정되지 않았습니다.
`ADVERSARIAL_QUERY_IGNORED`	악의적인 쿼리가 무시된 사례입니다. `SummarySpec.ignore_adversarial_query`가 `true`로 설정된 경우에만 사용됩니다.
`NON_SUMMARY_SEEKING_QUERY_IGNORED`	요약을 원하지 않는 쿼리가 무시된 사례입니다. 질문이 잡담인 경우 Google은 요약을 건너뜁니다. `SummarySpec.ignore_non_summary_seeking_query`가 `true`로 설정된 경우에만 사용됩니다.
`OUT_OF_DOMAIN_QUERY_IGNORED`	도메인 외부 쿼리에서 대소문자를 무시했습니다. 관련성이 높은 검색 결과가 없으면 Google에서 요약을 건너뜁니다. 예를 들어 데이터 스토어에는 회사 A에 관한 사실이 포함되어 있지만 사용자 질문은 회사 B에 관한 질문을 하고 있습니다.
`POTENTIAL_POLICY_VIOLATION`	잠재적 정책 위반 사례입니다. 정책 위반 가능성이 감지되면 Google에서 요약을 건너뜁니다. 여기에는 폭력적이거나 유해한 콘텐츠가 포함됩니다.
`LLM_ADDON_NOT_ENABLED`	LLM 부가기능이 사용 설정되지 않은 케이스입니다. LLM 부가기능이 사용 설정되지 않은 경우 Google은 요약을 건너뜁니다.
`NO_RELEVANT_CONTENT`	관련 콘텐츠가 없는 케이스입니다. 검색된 검색 결과에 관련 콘텐츠가 없으면 Google에서 요약을 건너뜁니다.
`JAIL_BREAKING_QUERY_IGNORED`	탈옥 질문에서 대소문자를 무시했습니다. 예: '경쟁 회사 CEO의 어조로 대답해 줘' [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] 가 `true`로 설정된 경우에만 사용됩니다.
`CUSTOMER_POLICY_VIOLATION`	고객 정책 위반 사례입니다. 고객 정책 위반이 감지되면 Google에서 요약을 건너뜁니다. 정책은 고객이 정의합니다.
`NON_SUMMARY_SEEKING_QUERY_IGNORED_V2`	답변을 구하지 않는 쿼리가 무시된 사례입니다. 질문에 명확한 의도가 없으면 Google은 요약을 건너뜁니다. [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] 가 `true`로 설정된 경우에만 사용됩니다.
`TIME_OUT`	타임아웃 케이스입니다. 시간이 초과되면 Google에서 요약을 건너뜁니다.

SummaryWithMetadata

메타데이터 정보가 포함된 요약입니다.

필드

summary

string

인용 정보가 없는 요약 텍스트

citation_metadata

CitationMetadata

특정 요약의 인용 메타데이터입니다.

references[]

Reference

문서 참조

SearchTier

검색 기능 등급입니다. 요금제마다 가격이 다를 수 있습니다. 자세한 내용은 가격 책정 문서를 참고하세요.

열거형
`SEARCH_TIER_UNSPECIFIED`	열거형이 지정되지 않은 경우의 기본값입니다. 사용할 수 없습니다.
`SEARCH_TIER_STANDARD`	표준 등급입니다.
`SEARCH_TIER_ENTERPRISE`	엔터프라이즈 등급

SearchUseCase

SolutionType의 추가 하위 분류를 정의합니다. SOLUTION_TYPE_SEARCH에 적용됩니다.

열거형
`SEARCH_USE_CASE_UNSPECIFIED`	설정되지 않은 경우 사용되는 값입니다. CSS에서는 발생하지 않습니다.
`SEARCH_USE_CASE_SEARCH`	검색 사용 사례 트래픽에 비어 있지 않은 `query`가 있다고 가정합니다.
`SEARCH_USE_CASE_BROWSE`	사용 사례를 둘러봅니다. 트래픽에 빈 `query`가 있다고 가정합니다.

ServingConfig

서빙 시간 결과 (예: 검색 결과 또는 추천 예측)를 생성하는 데 사용되는 메타데이터를 구성합니다. ServingConfig는 검색 및 예측 요청에 전달되어 결과를 생성합니다.

필드
`name`	`string` 변경할 수 없습니다. 정규화된 이름 `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
`display_name`	`string` 필수 항목입니다. 사람이 읽을 수 있는 서빙 구성 표시 이름입니다. Discovery UI에서 사용됩니다. 이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 128자(영문 기준)입니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.
`solution_type`	`SolutionType` 필수 항목입니다. 변경할 수 없습니다. 서빙 구성이 연결될 수 있는 솔루션 유형을 지정합니다.
`model_id`	`string` 서빙 시 사용할 모델의 ID입니다. 현재는 RecommendationModel만 지원됩니다. 호환되는 모델 (예: 내가 좋아할 만한 기타 항목 CTR에서 내가 좋아할 만한 기타 항목 CVR)로만 변경할 수 있습니다. `SolutionType`이 `SOLUTION_TYPE_RECOMMENDATION`인 경우 필요합니다.
`diversity_level`	`string` 추천 모델 결과(예: `medium-diversity` 또는 `high-diversity`)에 사용할 다양성 정도입니다. 현재 지원되는 값: `no-diversity` `low-diversity` `medium-diversity` `high-diversity` `auto-diversity` 지정하지 않으면 추천 모델 유형에 따라 기본값이 선택됩니다. 기본값은 `no-diversity`입니다. `SolutionType`가 `SOLUTION_TYPE_RECOMMENDATION`인 경우에만 설정할 수 있습니다.
`ranking_expression`	`string` 순위 표현식은 검색 문서의 맞춤 순위를 제어합니다. 이를 활용하려면 문서 삽입이 필요합니다. ServingConfig의 순위 지정 표현식 설정은 서빙 구성에서 처리하는 모든 검색 요청에 적용됩니다. 하지만 `SearchRequest.ranking_expression`가 지정되면 ServingConfig 순위 표현식이 재정의됩니다. 순위 표현식은 '+'로 조인된 함수 하나 또는 여러 개입니다. ranking_expression = function, { " + ", function }; 지원되는 함수: double * relevance_score double * dotProduct(embedding_field_path) 함수 변수: `relevance_score`: 쿼리와 문서 간의 관련성을 측정하는 데 사용되는 사전 정의된 키워드입니다. `embedding_field_path`: 쿼리 임베딩 벡터와 함께 사용되는 문서 임베딩 필드입니다. `dotProduct`: embedding_field_path와 쿼리 임베딩 벡터 간의 임베딩 함수입니다. 순위 표현식의 예: 문서에 doc_embedding이라는 삽입 필드가 있는 경우 순위 표현식은 `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`일 수 있습니다.
`create_time`	`Timestamp` 출력 전용입니다. ServingConfig 생성 타임스탬프입니다.
`update_time`	`Timestamp` 출력 전용입니다. ServingConfig 업데이트 타임스탬프입니다.
`filter_control_ids[]`	`string` 서빙 경로에서 사용할 필터 컨트롤입니다. 트리거된 모든 필터 컨트롤이 적용됩니다. 필터 컨트롤은 서빙 구성과 동일한 데이터 저장소에 있어야 합니다. 필터 컨트롤은 최대 20개까지 사용할 수 있습니다.
`boost_control_ids[]`	`string` 서빙 경로에서 사용할 부스트 컨트롤입니다. 트리거된 모든 부스트 컨트롤이 적용됩니다. 부스트 컨트롤은 서빙 구성과 동일한 데이터 저장소에 있어야 합니다. 최대 20개의 부스트 제어
`redirect_control_ids[]`	`string` 리디렉션 컨트롤의 ID입니다. 여러 리디렉션이 적용되더라도 트리거된 첫 번째 리디렉션 작업만 적용됩니다. 최대 사양 수는 100개입니다. `SolutionType`가 `SOLUTION_TYPE_SEARCH`인 경우에만 설정할 수 있습니다.
`synonyms_control_ids[]`	`string` 조건 동의어 사양입니다. 여러 동의어 조건이 일치하는 경우 목록에 있는 일치하는 모든 동의어 컨트롤이 실행됩니다. 최대 사양 수는 100개입니다. `SolutionType`가 `SOLUTION_TYPE_SEARCH`인 경우에만 설정할 수 있습니다.
`oneway_synonyms_control_ids[]`	`string` 조건 단방향 동의어 사양입니다. 여러 단방향 동의어 조건이 일치하면 목록에 있는 일치하는 모든 단방향 동의어 컨트롤이 실행됩니다. 최대 사양 수는 100개입니다. `SolutionType`가 `SOLUTION_TYPE_SEARCH`인 경우에만 설정할 수 있습니다.
`dissociate_control_ids[]`	`string` 조건이 사양과 연결되지 않습니다. 일치하는 연결 해제 조건이 여러 개이면 목록에 있는 일치하는 모든 연결 해제 컨트롤이 실행됩니다. 순서는 중요하지 않습니다. 최대 사양 수는 100개입니다. `SolutionType`가 `SOLUTION_TYPE_SEARCH`인 경우에만 설정할 수 있습니다.
`replacement_control_ids[]`	`string` 조건 대체 사양입니다. 목록의 순서에 따라 적용됩니다. 이전에 대체된 용어는 다시 대체할 수 없습니다. 최대 사양 수는 100개입니다. `SolutionType`가 `SOLUTION_TYPE_SEARCH`인 경우에만 설정할 수 있습니다.
`ignore_control_ids[]`	`string` 조건 무시 사양입니다. 여러 무시 조건이 일치하면 목록에 있는 일치하는 모든 무시 컨트롤이 실행됩니다. 순서는 중요하지 않습니다. 최대 사양 수는 100개입니다.
`promote_control_ids[]`	`string` 조건부 프로모션 사양입니다. 최대 사양 수는 100개입니다.
`answer_generation_spec`	`AnswerGenerationSpec` (선택사항) 답변 생성 사양입니다.
통합 필드 `vertical_config`. 업종별 구성입니다. `vertical_config`은 다음 중 하나여야 합니다.
`media_config`	`MediaConfig` 제공 구성의 MediaConfig입니다.
`generic_config`	`GenericConfig` 제공 구성의 GenericConfig입니다.

GenericConfig

일반 검색에 필요한 구성을 지정합니다. 현재 다음을 지원합니다.

content_search_spec: 일반 콘텐츠 검색 구성입니다.

필드

content_search_spec

ContentSearchSpec

콘텐츠 검색의 예상 동작을 지정합니다. 콘텐츠 검색이 사용 설정된 데이터 스토어에만 유효합니다.

MediaConfig

미디어 디스커버리에 필요한 구성을 지정합니다. 현재 지원되는 제품 유형은 다음과 같습니다.

demote_content_watched: 시청한 콘텐츠의 강등 기준입니다. 고객은 시청한 콘텐츠 순위 내리기를 사용할지 또는 조회한 세부정보 페이지를 사용할지 지정할 수 있습니다. 시청한 콘텐츠 강등을 사용하면 고객이 시청한 시간 또는 비율이 기준점을 초과하는지 지정해야 합니다. 기준점을 초과하면 콘텐츠가 추천 결과에서 강등됩니다.
promote_fresh_content: 최신 콘텐츠 프로모션의 차단일입니다. 콘텐츠 업데이트 프로모션을 사용하는 경우 고객이 지정할 수 있습니다. 콘텐츠가 기준일 이내에 게시된 경우 콘텐츠가 추천 결과에 표시됩니다. SolutionType가 SOLUTION_TYPE_RECOMMENDATION인 경우에만 설정할 수 있습니다.

필드
`demotion_event_type`	`string` 추천 결과의 강등에 사용되는 이벤트 유형을 지정합니다. 현재 지원되는 값: `view-item`: 상품을 조회했습니다. `media-play`: 동영상 시청, 노래 재생 등을 시작하거나 다시 시작합니다. `media-complete`: 동영상, 노래 등을 끝까지 시청하거나 중간에 중단했습니다. 설정하지 않으면 시청 기록 강등이 적용되지 않습니다. 콘텐츠 최신성 강등은 계속 적용됩니다.
`demote_content_watched_past_days`	`int32` (선택사항) 시청한 콘텐츠의 순위를 내리기 위해 확인할 과거 기간(일)을 지정합니다. 0으로 설정하거나 설정하지 않으면 기본적으로 최대 365일로 설정됩니다.
`content_freshness_cutoff_days`	`int32` 추천 결과에 사용되는 콘텐츠 신선도를 지정합니다. 콘텐츠가 콘텐츠 최신성 기준일보다 오래 게시된 경우 콘텐츠의 순위가 내려갑니다.
통합 필드 `demote_content_watched`. 시청한 콘텐츠의 강등 기준점을 지정합니다. 기준점은 백분율 또는 분 값일 수 있습니다. `media-complete` 이벤트 유형의 경우 이 값을 설정해야 합니다. `demote_content_watched`은 다음 중 하나일 수 있습니다.
`content_watched_percentage_threshold`	`float` 순위 내리기를 위한 시청한 콘텐츠 비율 기준을 지정합니다. 임계값은 [0, 1.0] 사이여야 합니다(0과 1.0 포함).
`content_watched_seconds_threshold`	`float` 순위 내리기를 위한 시청한 콘텐츠 시간 기준을 지정합니다.

세션

외부 세션 프로토 정의입니다.

필드
`name`	`string` 변경할 수 없습니다. 정규화된 이름 `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
`display_name`	`string` (선택사항) 세션의 표시 이름입니다. 이 필드는 UI에서 세션을 식별하는 데 사용됩니다. 기본적으로 표시 이름은 세션의 첫 번째 턴 질문 텍스트입니다.
`state`	`State` 세션의 상태입니다.
`user_pseudo_id`	`string` 사용자 추적을 위한 고유 식별자입니다.
`turns[]`	`Turn` 턴
`labels[]`	`string` (선택사항) 세션의 라벨입니다. ListSessionsRequest에서 필터로 설정할 수 있습니다.
`start_time`	`Timestamp` 출력 전용입니다. 세션이 시작된 시간입니다.
`end_time`	`Timestamp` 출력 전용입니다. 세션이 종료된 시간입니다.
`is_pinned`	`bool` (선택사항) 세션이 고정되었는지 여부입니다. 고정된 세션은 세션 목록 상단에 표시됩니다.

주

세션 상태의 열거형입니다.

열거형
`STATE_UNSPECIFIED`	상태가 지정되지 않았습니다.
`IN_PROGRESS`	현재 세션이 열려 있습니다.

Turn

사용자의 질문과 서비스의 답변을 포함한 대화를 나타냅니다.

필드
`query`	`Query` (선택사항) 사용자 쿼리입니다. 이 턴이 다른 턴에 대한 대답을 재생성하는 경우 설정되지 않을 수 있습니다.
`answer`	`string` (선택사항) 사용자 질문에 대한 답변의 리소스 이름입니다. 이 턴에서 답변 생성 (/answer API 호출)이 발생한 경우에만 설정합니다.
`assist_answer`	`string` 출력 전용입니다. 사용자 질문에 대한 어시스턴트 대답의 리소스 이름입니다. 이 턴에서 지원 호출 (/assist API 호출)이 발생한 경우에만 설정됩니다. 형식은 `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}`입니다. 세션의 모든 AssistAnswers를 가져오려면 GetSessionRequest.include_answer_details를 true로 설정하세요. 또는 개별 AssistAnswer 리소스를 가져오려면 AssistAnswerService.GetAssistAnswer API를 사용하세요.
`detailed_answer`	`Answer` 출력 전용입니다. `ConversationalSearchService.GetSession` API에서 `GetSessionRequest.include_answer_details`이 true로 설정된 경우 이 필드는 답변 쿼리 세션을 가져올 때 채워집니다.
`detailed_assist_answer`	`AssistAnswer` 출력 전용입니다. `ConversationalSearchService.GetSession` API에서 `GetSessionRequest.include_answer_details`이 true로 설정된 경우 이 필드는 어시스턴트 세션을 가져올 때 채워집니다.
`query_config`	`map<string, string>` (선택사항) 사용된 LLM 모델 및 버전, 모델 파라미터 (온도, 그라운딩 파라미터 등)와 같은 쿼리 구성과 관련된 메타데이터를 나타냅니다. 'google.' 프리픽스는 Google에서 개발한 기능을 위해 예약되어 있습니다.

SetUpDataConnectorMetadata

이 유형에는 필드가 없습니다.

DataConnectorService.SetUpDataConnector 메서드의 메타데이터입니다.

SetUpDataConnectorRequest

DataConnectorService.SetUpDataConnector 메서드 요청입니다.

필드
`parent`	`string` 필수 항목입니다. `Collection`의 상위 요소(`projects/{project}/locations/{location}` 형식)입니다.
`collection_id`	`string` 필수 항목입니다. `Collection`에 사용할 ID이며, `Collection`의 리소스 이름에서 마지막 구성요소가 됩니다. 새 `Collection`가 `DataConnector` 설정의 일부로 생성됩니다. `DataConnector`은 `Collection` 아래의 싱글톤 리소스로, `Collection`의 모든 `DataStore`를 관리합니다. 이 필드는 RFC-1034 표준을 준수해야 하며 길이 제한은 63자(영문 기준)입니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.
`collection_display_name`	`string` 필수 항목입니다. `Collection`의 표시 이름입니다. 사람이 읽을 수 있어야 하며, 콘솔 대시보드에서 컬렉션을 표시하는 데 사용됩니다. 길이 제한이 1,024자인 UTF-8로 인코딩된 문자열입니다.
`data_connector`	`DataConnector` 필수 항목입니다. 새로 만든 `Collection`에서 초기화할 `DataConnector`입니다.

SingleRegionKey

단일 리전 CMEK의 메타데이터입니다.

필드

kms_key

string

필수 항목입니다. projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId} 리소스를 암호화하는 데 사용되는 단일 지역 kms 키 리소스 이름입니다.

SiteSearchEngine

SiteSearchEngine은 데이터 스토어 수준 사이트 검색 지속 구성을 캡처합니다. 데이터 스토어당 싱글톤 값입니다.

필드

name

string

사이트 검색엔진의 정규화된 리소스 이름입니다. 형식: projects/*/locations/*/dataStores/*/siteSearchEngine

SiteVerificationInfo

고급 사이트 검색의 타겟 사이트에 대한 인증 정보입니다.

필드

site_verification_state

SiteVerificationState

소유권과 유효성을 나타내는 사이트 인증 상태입니다.

verify_time

최신 사이트 확인 시간입니다.

SiteVerificationState

사이트 인증 상태입니다.

열거형
`SITE_VERIFICATION_STATE_UNSPECIFIED`	기본값은 VERIFIED입니다.
`VERIFIED`	사이트 소유권이 확인되었습니다.
`UNVERIFIED`	사이트 소유권이 인증 대기 중이거나 인증에 실패했습니다.
`EXEMPTED`	인증이 면제된 사이트(예: 모든 사용자에게 공개된 웹사이트)

필드
`name`	`string` 출력 전용입니다. 사이트맵의 정규화된 리소스 이름입니다. `projects//locations//collections//dataStores//siteSearchEngine/sitemaps/*` `sitemap_id` 접미사는 시스템에서 생성됩니다.
`create_time`	`Timestamp` 출력 전용입니다. 사이트맵 생성 시간입니다.
통합 필드 `feed`. 지원되는 피드 소스입니다. `feed`은 다음 중 하나여야 합니다.
`uri`	`string` 사이트맵의 공개 URI입니다(예: `www.example.com/sitemap.xml`).

솔루션 유형

솔루션 유형입니다.

열거형
`SOLUTION_TYPE_UNSPECIFIED`	기본값
`SOLUTION_TYPE_RECOMMENDATION`	Recommendations AI에 사용됩니다.
`SOLUTION_TYPE_SEARCH`	디스커버리 검색에 사용됩니다.
`SOLUTION_TYPE_CHAT`	생성형 AI 에이전트와 관련된 사용 사례에 사용됩니다.
`SOLUTION_TYPE_GENERATIVE_CHAT`	생성형 채팅 에이전트와 관련된 사용 사례에 사용됩니다. 생성형 채팅 엔진에만 사용되며 연결된 데이터 스토어가 `SOLUTION_TYPE_CHAT` 솔루션에 등록되어 있어야 합니다.

SpannerSource

데이터 가져오기를 위한 Spanner 소스

필드
`project_id`	`string` Spanner 소스가 포함된 프로젝트 ID입니다. 길이 제한은 128자(영문 기준)입니다. 지정하지 않으면 상위 요청에서 프로젝트 ID를 상속합니다.
`instance_id`	`string` 필수 항목입니다. 소스 Spanner 테이블의 인스턴스 ID입니다.
`database_id`	`string` 필수 항목입니다. 소스 Spanner 테이블의 데이터베이스 ID입니다.
`table_id`	`string` 필수 항목입니다. 가져와야 하는 Spanner 데이터베이스의 테이블 이름입니다.
`enable_data_boost`	`bool` Spanner 내보내기에 데이터 부스트를 적용할지 여부입니다. 이 옵션을 사용 설정하면 추가 비용이 발생합니다. 자세한 내용은 여기에서 확인하실 수 있습니다.

StreamAssistRequest

AssistantService.StreamAssist 메서드 요청입니다.

필드
`name`	`string` 필수 항목입니다. `Assistant`의 리소스 이름입니다. 형식: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` (선택사항) 현재 사용자 쿼리입니다. 빈 쿼리는 `file_ids`가 제공된 경우에만 지원됩니다. 이 경우 해당 컨텍스트 파일을 기반으로 답변이 생성됩니다.
`session`	`string` (선택사항) 요청에 사용할 세션입니다. 지정된 경우 어시스턴트는 세션 기록에 액세스할 수 있으며 질문과 답변이 여기에 저장됩니다. `-`이 세션 ID로 지정되거나 비워 두면 자동으로 생성된 ID로 새 세션이 생성됩니다. 형식: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
`user_metadata`	`AssistUserMetadata` (선택사항) 쿼리를 시작하는 사용자에 대한 정보입니다.
`agents_spec`	`AgentsSpec` (선택사항) 요청을 처리하는 데 사용되는 에이전트의 사양입니다.
`tools_spec`	`ToolsSpec` (선택사항) 요청을 처리하는 데 사용되는 도구의 사양입니다.
`generation_spec`	`GenerationSpec` (선택사항) 요청의 생성 구성 사양입니다.

AgentsSpec

요청을 처리하는 데 사용되는 에이전트의 사양입니다.

필드

agent_specs[]

AgentSpec

(선택사항) 요청을 처리하는 데 사용되는 에이전트의 사양입니다.

AgentSpec

에이전트 사양입니다.

필드

agent_id

string

필수 항목입니다. 요청을 처리하는 에이전트 리소스를 식별하는 ID입니다.

이 필드는 RFC-1034를 준수해야 하며 길이 제한은 63자(영문 기준)입니다.

GenerationSpec

요청의 어시스턴트 생성 사양입니다. 이렇게 하면 엔진 수준에서 기본 생성 구성을 재정의할 수 있습니다.

필드

model_id

string

(선택사항) 생성형 모델에 사용되는 Vertex AI model_id입니다. 설정하지 않으면 기본 어시스턴트 모델이 사용됩니다.

ToolsSpec

요청을 처리하는 데 사용되는 도구의 사양입니다.

필드
`vertex_ai_search_spec`	`VertexAiSearchSpec` (선택사항) Vertex AI Search 도구의 사양입니다.
`web_grounding_spec`	`WebGroundingSpec` (선택사항) 웹 그라운딩 도구의 사양입니다. 필드가 있으면 웹 검색을 사용한 그라운딩을 사용 설정합니다. `Assistant.web_grounding_type`이 [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] 또는 [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][]인 경우에만 작동합니다.
`image_generation_spec`	`ImageGenerationSpec` (선택사항) 이미지 생성 도구의 사양입니다.
`video_generation_spec`	`VideoGenerationSpec` (선택사항) 동영상 생성 도구의 사양입니다.

ImageGenerationSpec

이 유형에는 필드가 없습니다.

이미지 생성 도구의 사양입니다.

VertexAiSearchSpec

Vertex AI Search 도구의 사양입니다.

필드

data_store_specs[]

DataStoreSpec

(선택사항) 검색 호출에서 필터링할 DataStore와 해당 데이터 저장소의 구성을 정의하는 사양입니다. 데이터 스토어가 여러 개인 Engine에만 적용됩니다.

filter

string

(선택사항) 필터 구문은 필터링되는 문서의 하나 이상의 필드에서 조건자를 구성하기 위한 표현식 언어로 구성됩니다. 필터 표현식은 대소문자를 구분합니다.

이 필드를 인식할 수 없으면 INVALID_ARGUMENT가 반환됩니다.

Vertex AI Search의 필터링은 LHS 필터 키를 Vertex AI Search 백엔드에 정의된 키 속성에 매핑하여 실행됩니다. 이 매핑은 고객이 스키마에 정의합니다. 예를 들어 미디어 고객의 스키마에 'name' 필드가 있을 수 있습니다. 이 경우 필터는 다음과 같습니다. filter --> name:'ANY("king kong")'

구문 및 필터 연산자를 비롯한 필터링에 대한 자세한 내용은 필터를 참고하세요.

VideoGenerationSpec

이 유형에는 필드가 없습니다.

동영상 생성 도구의 사양입니다.

WebGroundingSpec

이 유형에는 필드가 없습니다.

웹 그라운딩 도구의 사양입니다.

StreamAssistResponse

AssistantService.StreamAssist 메서드에 대한 응답입니다.

필드

answer

AssistAnswer

사용자의 질문에 대한 어시스턴트의 최종 답변 일부를 포함하는 지원 답변 리소스 객체입니다.

현재 응답이 이전에 전송된 AssistAnswer.replies에 아무것도 추가하지 않으면 표시되지 않습니다.

AssistAnswer.state를 관찰하여 더 많은 부분이 예상되는지 확인합니다. 상태가 IN_PROGRESS인 동안 각 응답의 AssistAnswer.replies 필드에는 이전 응답에서 수신된 응답에 추가할 대답 (대답 프래그먼트)이 포함됩니다. AssistAnswer.name이 채워지지 않습니다.

상태가 SUCCEEDED, FAILED 또는 SKIPPED이면 응답은 마지막 응답이고 AssistAnswer.name에 값이 있습니다.

session_info

SessionInfo

세션 정보입니다. 응답 스트림의 최종 StreamAssistResponse에만 포함됩니다.

assist_token

string

현재 요청과 응답 스트림을 식별하는 전역 고유 ID입니다. 의견 및 지원에 사용됩니다.

SessionInfo

세션에 관한 정보입니다.

필드

session

string

새로 생성되거나 계속된 세션의 이름입니다.

형식은 projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}입니다.

SubscriptionTerm

구독 기간입니다. LINT.IfChange

열거형
`SUBSCRIPTION_TERM_UNSPECIFIED`	기본값이며 사용하면 안 됩니다.
`SUBSCRIPTION_TERM_ONE_MONTH`	1개월
`SUBSCRIPTION_TERM_ONE_YEAR`	1년
`SUBSCRIPTION_TERM_THREE_YEARS`	3년

SubscriptionTier

구독 등급 정보입니다.

열거형
`SUBSCRIPTION_TIER_UNSPECIFIED`	기본값
`SUBSCRIPTION_TIER_SEARCH`	검색 등급입니다. 검색 등급은 VAIS 검색 기능과 NotebookLM 기능을 이용할 수 있습니다.
`SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT`	검색 + 어시스턴트 등급 검색 + 어시스턴트 등급은 VAIS 검색 기능, NotebookLM 기능, 어시스턴트 기능에 액세스할 수 있습니다.
`SUBSCRIPTION_TIER_NOTEBOOK_LM`	NotebookLM 등급 NotebookLM은 NotebookLM 기능에만 액세스할 수 있는 구독 등급입니다.
`SUBSCRIPTION_TIER_FRONTLINE_WORKER`	일선 인력 등급입니다.
`SUBSCRIPTION_TIER_AGENTSPACE_STARTER`	Agentspace Starter 등급
`SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS`	Agentspace Business 등급입니다.
`SUBSCRIPTION_TIER_ENTERPRISE`	엔터프라이즈 등급
`SUBSCRIPTION_TIER_EDU`	EDU 등급
`SUBSCRIPTION_TIER_EDU_PRO`	EDU Pro 등급
`SUBSCRIPTION_TIER_EDU_EMERGING`	EDU 신흥 시장 등급입니다.
`SUBSCRIPTION_TIER_EDU_PRO_EMERGING`	EDU Pro 신흥 시장 등급입니다.

SuggestionDenyListEntry

추천에서 차단할 문구와 문구에 적용된 작업을 식별하는 제안 거부 목록 항목입니다.

필드

block_phrase

string

필수 항목입니다. 추천에 표시되지 않도록 차단할 문구입니다. 최대 125자(영문 기준)까지 가능합니다.

match_operator

MatchOperator

필수 항목입니다. 이 문구에 적용할 일치 연산자입니다. 정확한 문구를 차단할지 아니면 이 문구를 포함하는 추천을 차단할지 여부입니다.

MatchOperator

생성된 제안과 일치하는 연산자입니다.

열거형
`MATCH_OPERATOR_UNSPECIFIED`	기본값 사용하면 안 됨
`EXACT_MATCH`	추천이 block_phrase와 정확히 일치하면 차단합니다.
`CONTAINS`	추천에 block_phrase가 포함되어 있으면 차단합니다.

TargetSite

SiteSearchEngine의 타겟 사이트입니다.

필드
`name`	`string` 출력 전용입니다. 타겟 사이트의 정규화된 리소스 이름입니다. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` `target_site_id`는 시스템에서 생성됩니다.
`provided_uri_pattern`	`string` 필수 항목입니다. 입력 전용입니다. `generated_uri_pattern`이 생성된 사용자 제공 URI 패턴입니다.
`type`	`Type` 타겟 사이트의 유형입니다(예: 사이트가 포함되는지 또는 제외되는지).
`exact_match`	`bool` 변경할 수 없습니다. false로 설정하면 주소에 provided_uri_pattern이 포함된 모든 페이지를 포함하는 uri_pattern이 생성됩니다. true로 설정하면 제공된 uri_pattern과 정확히 일치하거나 제공된 uri_pattern이 특정 패턴인 경우 특정 페이지와 일치하도록 uri_pattern이 생성됩니다. 제공된 uri_pattern은 항상 검색엔진에서 사용할 URI 패턴을 생성하도록 정규화됩니다.
`generated_uri_pattern`	`string` 출력 전용입니다. 이는 provided_uri_pattern을 기반으로 시스템에서 생성됩니다.
`root_domain_uri`	`string` 출력 전용입니다. provided_uri_pattern의 루트 도메인입니다.
`site_verification_info`	`SiteVerificationInfo` 출력 전용입니다. 사이트 소유권 및 유효성 확인 상태입니다.
`indexing_status`	`IndexingStatus` 출력 전용입니다. 색인 생성 상태입니다.
`update_time`	`Timestamp` 출력 전용입니다. 타겟 사이트의 마지막 업데이트 시간입니다.
`failure_reason`	`FailureReason` 출력 전용입니다. 실패 이유입니다.

FailureReason

사이트 검색 색인 생성 실패 이유입니다.

필드

통합 필드 failure. 실패 이유입니다. failure은 다음 중 하나여야 합니다.

quota_failure

QuotaFailure

할당량이 부족하여 실패했습니다.

QuotaFailure

할당량이 부족하여 실패했습니다.

필드

total_required_quota

int64

이 숫자는 프로젝트에서 색인 생성을 성공적으로 완료하는 데 필요한 총 할당량을 추정한 것입니다.

IndexingStatus

타겟 사이트 색인 생성 상태 열거형입니다.

열거형
`INDEXING_STATUS_UNSPECIFIED`	기본값은 SUCCEEDED입니다.
`PENDING`	타겟 사이트가 업데이트 대기열에 있으며 색인 생성 파이프라인에서 선택됩니다.
`FAILED`	타겟 사이트의 색인이 생성되지 않습니다.
`SUCCEEDED`	대상 사이트의 색인이 생성되었습니다.
`DELETING`	이전에 색인이 생성된 타겟 사이트가 삭제되도록 표시되었습니다. 이는 전환 상태이며, 색인 해제가 성공하면 대상 사이트가 삭제되고 색인 해제가 실패하면 상태가 SUCCEEDED로 되돌아갑니다.
`CANCELLABLE`	타겟 사이트 변경이 대기 중이지만 취소할 수 있습니다.
`CANCELLED`	타겟 사이트 변경이 취소됩니다.

유형

가능한 타겟 사이트 유형입니다.

열거형
`TYPE_UNSPECIFIED`	이 값은 사용되지 않습니다. 이 경우 서버 동작은 기본적으로 `Type.INCLUDE`입니다.
`INCLUDE`	타겟 사이트를 포함합니다.
`EXCLUDE`	타겟 사이트를 제외합니다.

테넌트

커넥터 소스의 테넌트 정보입니다. 여기에는 Credential 메시지에 저장된 일부 정보가 포함되지만 사용자에게 액세스 가능한 테넌트 목록을 제공하는 데 필요한 정보로만 제한됩니다.

필드

id

string

테넌트의 인스턴스 ID입니다. 예: Jira ('8594f221-9797-5f78-1fa4-485e198d7cd0'), Slack ('T123456')

uri

string

테넌트의 URI입니다(해당하는 경우). 예를 들어 Jira 인스턴스의 URI는 https://my-jira-instance.atlassian.net이고 Slack 테넌트에는 URI가 없습니다.

display_name

string

테넌트의 선택적 표시 이름입니다(예: '내 Slack팀').

TextInput

텍스트 입력을 정의합니다.

필드

input

string

텍스트 입력

context

ConversationContext

입력의 대화 컨텍스트입니다.

TrainCustomModelMetadata

TrainCustomModel 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

TrainCustomModelRequest

SearchTuningService.TrainCustomModel 메서드의 요청 메시지입니다.

필드
`data_store`	`string` 필수 항목입니다. 데이터 스토어의 리소스 이름입니다(예: `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`). 이 필드는 모델을 학습시킬 데이터 스토어를 식별하는 데 사용됩니다.
`model_type`	`string` 학습할 모델입니다. 지원되는 값은 다음과 같습니다. search-tuning: 제공된 데이터를 기반으로 검색 시스템을 미세 조정합니다.
`error_config`	`ImportErrorConfig` 데이터 수집 및 학습 중에 발생하는 오류의 원하는 위치입니다.
`model_id`	`string` 제공하지 않으면 UUID가 생성됩니다.
통합 필드 `training_input`. 모델 학습 입력입니다. `training_input`은 다음 중 하나여야 합니다.
`gcs_training_input`	`GcsTrainingInput` Cloud Storage 학습 입력입니다.

GcsTrainingInput

Cloud Storage 학습 데이터 입력입니다.

필드
`corpus_data_path`	`string` 학습 데이터와 연결될 수 있는 Cloud Storage 말뭉치 데이터입니다. 데이터 경로 형식은 `gs://<bucket_to_data>/<jsonl_file_name>`입니다. 줄바꿈으로 구분된 jsonl/ndjson 파일입니다. 검색 조정 모델의 경우 각 줄에 _id, 제목, 텍스트가 있어야 합니다. 예: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
`query_data_path`	`string` 학습 데이터와 연결될 수 있는 gcs 쿼리 데이터입니다. 데이터 경로 형식은 `gs://<bucket_to_data>/<jsonl_file_name>`입니다. 줄바꿈으로 구분된 jsonl/ndjson 파일입니다. 검색 조정 모델의 경우 각 줄에 _id와 텍스트가 있어야 합니다. 예: {'_id': 'query1', 'text': 'example query'}
`train_data_path`	`string` 형식이 `gs://<bucket_to_data>/<tsv_file_name>`인 Cloud Storage 학습 데이터 경로입니다. 파일은 tsv 형식이어야 합니다. 각 줄에는 doc_id, query_id, score (숫자)가 있어야 합니다. 검색 조정 모델의 경우 질문-ID 코퍼스-ID 점수가 TSV 파일 헤더로 있어야 합니다. 점수는 `[0, inf+)`의 숫자여야 합니다. 숫자가 클수록 쌍의 관련성이 높습니다. 예: `query-id\tcorpus-id\tscore` `query1\tdoc1\t1`
`test_data_path`	`string` Cloud Storage 테스트 데이터입니다. train_data_path와 동일한 형식입니다. 제공되지 않은 경우 train_data_path에서 무작위 80/20 학습/테스트 분할이 실행됩니다.

TrainCustomModelResponse

TrainCustomModelRequest의 응답입니다. 이 메시지는 google.longrunning.Operations.response 필드에서 반환됩니다.

필드
`error_samples[]`	`Status` 데이터를 처리하는 중에 발생한 오류 샘플입니다.
`error_config`	`ImportErrorConfig` 설정된 경우 요청의 전체 오류에 대한 대상을 반환합니다.
`model_status`	`string` 학습된 모델 상태입니다. 가능한 값은 다음과 같습니다. bad-data: 학습 데이터 품질이 좋지 않습니다. no-improvement: 튜닝으로 성능이 개선되지 않았습니다. 배포되지 않습니다. in-progress: 모델 학습 작업 생성 진행 중입니다. training: 모델이 활발하게 학습 중입니다. 평가: 모델이 학습된 측정항목을 평가하고 있습니다. 색인 생성: 모델 학습 측정항목이 색인 생성됩니다. ready: 모델이 서빙 준비가 되었습니다.
`metrics`	`map<string, double>` 학습된 모델의 측정항목입니다.
`model_name`	`string` CustomTuningModel의 정규화된 이름입니다.

TransactionInfo

거래는 전체 구매 거래를 나타냅니다.

필드
`currency`	`string` 필수 항목입니다. 통화 코드입니다. 3자리 ISO-4217 코드를 사용하세요.
`transaction_id`	`string` 길이 제한이 128자(영문 기준)인 거래 ID입니다.
`value`	`float` 필수 항목입니다. 거래와 관련된 0이 아닌 총 값입니다. 이 값에는 배송비, 세금 또는 포함하려는 총 가치에 대한 기타 조정 금액이 포함될 수 있습니다.
`tax`	`float` 거래와 관련된 모든 세금입니다.
`cost`	`float` 제품과 관련된 모든 비용입니다. 제조 비용, 최종 사용자가 부담하지 않는 배송비 또는 기타 비용이 여기에 해당할 수 있습니다. 수익 = `value` - `tax` - `cost`
`discount_value`	`float` 이 거래에 적용된 총 할인 값입니다. 이 수치는 `TransactionInfo.value`에서 제외해야 합니다. 예를 들어 사용자가 `TransactionInfo.value` 금액을 지불한 경우 거래의 명목상 (할인 전) 값은 `TransactionInfo.value`와 `TransactionInfo.discount_value`의 합계입니다. 즉, 할인 값과 관계없이 이익이 동일한 방식으로 계산되며 `TransactionInfo.discount_value`이 `TransactionInfo.value`보다 클 수 있습니다. 수익 = `value` - `tax` - `cost`

UpdateAclConfigRequest

UpdateAclConfig 메서드의 요청 메시지입니다.

필드
`acl_config`	`AclConfig`

UpdateAssistantRequest

AssistantService.UpdateAssistant 메서드에 대한 요청 메시지입니다.

필드

assistant

Assistant

필수 항목입니다. 업데이트할 Assistant입니다.

Assistant의 name 필드는 업데이트할 Assistant를 식별하는 데 사용됩니다. 형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

호출자에게 Assistant를 업데이트할 권한이 없으면 Assistant의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

업데이트할 Assistant이 없으면 NOT_FOUND 오류가 반환됩니다.

update_mask

업데이트할 필드 목록입니다.

UpdateCmekConfigMetadata

CmekConfigService.UpdateCmekConfig 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

UpdateCmekConfigRequest

UpdateCmekConfig 메서드의 요청 메시지입니다. rpc.

필드

config

CmekConfig

필수 항목입니다. CmekConfig 리소스입니다.

set_default

bool

하위 리소스에 사용할 기본값으로 다음 CmekConfig를 설정합니다(지정되지 않은 경우).

UpdateControlRequest

UpdateControl 메서드 요청입니다.

필드

control

Control

필수 항목입니다. 업데이트할 컨트롤입니다.

update_mask

(선택사항) 제공된 Control에서 업데이트할 필드를 나타냅니다. 다음은 지원되지 않습니다.

Control.name
Control.solution_type

설정하지 않거나 비워두면 지원되는 모든 필드가 업데이트됩니다.

UpdateConversationRequest

UpdateConversation 메서드 요청입니다.

필드

conversation

필수 항목입니다. 업데이트할 대화입니다.

update_mask

제공된 Conversation에서 업데이트할 필드를 나타냅니다. 다음은 지원되지 않습니다.

Conversation.name

설정하지 않거나 비워두면 지원되는 모든 필드가 업데이트됩니다.

UpdateDataConnectorRequest

DataConnectorService.UpdateDataConnector 메서드의 요청 메시지입니다.

필드

data_connector

DataConnector

필수 항목입니다. 업데이트할 DataConnector입니다.

호출자에게 DataConnector를 업데이트할 권한이 없으면 DataConnector의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

DataConnector이 존재하지 않으면 NOT_FOUND 오류가 반환됩니다.

update_mask

제공된 DataConnector에서 업데이트할 필드를 나타냅니다.

지원되는 필드 경로는 다음과 같습니다.

refresh_interval
params
auto_run_disabled
action_config
action_config.action_params
action_config.service_name
destination_configs
blocking_reasons
sync_mode
incremental_sync_disabled
incremental_refresh_interval

참고: 이러한 필드에 대한 지원은 커넥터 유형에 따라 다를 수 있습니다. 예를 들어 일부 커넥터는 destination_configs를 지원하지 않습니다.

지원되지 않거나 알 수 없는 필드 경로가 제공되면 요청에서 INVALID_ARGUMENT 오류가 반환됩니다.

UpdateDataStoreRequest

DataStoreService.UpdateDataStore 메서드의 요청 메시지입니다.

필드

data_store

DataStore

필수 항목입니다. 업데이트할 DataStore입니다.

호출자에게 DataStore를 업데이트할 권한이 없으면 DataStore의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

업데이트할 DataStore이 없으면 NOT_FOUND 오류가 반환됩니다.

update_mask

제공된 DataStore에서 업데이트할 필드를 나타냅니다.

지원되지 않거나 알 수 없는 필드가 제공되면 INVALID_ARGUMENT 오류가 반환됩니다.

UpdateDocumentRequest

DocumentService.UpdateDocument 메서드의 요청 메시지입니다.

필드

document

필수 항목입니다. 업데이트하거나 생성할 문서입니다.

호출자에게 Document를 업데이트할 권한이 없으면 PERMISSION_DENIED 오류가 반환됩니다(Document의 존재 여부와 관계없음).

업데이트할 Document가 없고 allow_missing가 설정되지 않은 경우 NOT_FOUND 오류가 반환됩니다.

allow_missing

bool

true로 설정되어 있고 Document을 찾을 수 없는 경우 새 Document이 생성됩니다.

update_mask

제공된 가져온 '문서'에서 업데이트할 필드를 나타냅니다. 설정하지 않으면 기본적으로 모든 필드가 업데이트됩니다.

UpdateEngineRequest

EngineService.UpdateEngine 메서드의 요청 메시지입니다.

필드

engine

Engine

필수 항목입니다. 업데이트할 Engine입니다.

호출자에게 Engine를 업데이트할 권한이 없으면 Engine의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

업데이트할 Engine이 없으면 NOT_FOUND 오류가 반환됩니다.

update_mask

제공된 Engine에서 업데이트할 필드를 나타냅니다.

지원되지 않거나 알 수 없는 필드가 제공되면 INVALID_ARGUMENT 오류가 반환됩니다.

UpdateLicenseConfigRequest

LicenseConfigService.UpdateLicenseConfig 메서드의 요청 메시지입니다.

필드

license_config

LicenseConfig

필수 항목입니다. 업데이트할 LicenseConfig입니다.

update_mask

(선택사항) 제공된 LicenseConfig에서 업데이트할 필드를 나타냅니다.

지원되지 않거나 알 수 없는 필드가 제공되면 INVALID_ARGUMENT 오류가 반환됩니다.

UpdateSchemaMetadata

UpdateSchema LRO의 메타데이터입니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

UpdateSchemaRequest

SchemaService.UpdateSchema 메서드의 요청 메시지입니다.

필드

schema

Schema

필수 항목입니다. 업데이트할 Schema입니다.

allow_missing

bool

true로 설정되어 있고 Schema을 찾을 수 없는 경우 새 Schema이 생성됩니다. 이 경우 update_mask는 무시됩니다.

UpdateServingConfigRequest

UpdateServingConfig 메서드 요청입니다.

필드

serving_config

ServingConfig

필수 항목입니다. 업데이트할 ServingConfig입니다.

update_mask

제공된 ServingConfig에서 업데이트할 필드를 나타냅니다. 다음은 지원되지 않습니다.

ServingConfig.name

설정하지 않으면 지원되는 모든 필드가 업데이트됩니다.

UpdateSessionRequest

UpdateSession 메서드 요청입니다.

필드

session

필수 항목입니다. 업데이트할 세션입니다.

update_mask

제공된 Session에서 업데이트할 필드를 나타냅니다. 다음은 지원되지 않습니다.

Session.name

설정하지 않거나 비워두면 지원되는 모든 필드가 업데이트됩니다.

UpdateTargetSiteMetadata

SiteSearchEngineService.UpdateTargetSite 작업 진행 상황과 관련된 메타데이터입니다. 이는 google.longrunning.Operation.metadata 필드에서 반환됩니다.

필드

create_time

작업 생성 시간입니다.

update_time

작업의 마지막 업데이트 시간입니다. 작업이 완료되면 이 값은 종료 시간이기도 합니다.

UpdateTargetSiteRequest

SiteSearchEngineService.UpdateTargetSite 메서드의 요청 메시지입니다.

필드

target_site