Package google.cloud.discoveryengine.v1

QueryClassificationInfo

Der Zeitpunkt, zu dem diese letzte Suche stattgefunden hat.

score

double

Der Wert jedes Vorschlags. Der Wert liegt im Bereich [0, 1].

AdvancedSiteSearchConfig

Konfigurationsdaten für die erweiterte Websitesuche.

Felder

disable_initial_index

bool

Bei Einstellung auf „true“ wird die Erstindexierung für den DataStore deaktiviert.

disable_automatic_refresh

bool

Bei Einstellung auf „true“ wird die automatische Aktualisierung für den DataStore deaktiviert.

AlertPolicyConfig

Die Benachrichtigungskonfiguration auf Connectorebene.

Felder

alert_policy_name

string

Nicht veränderbar. Der vollständig qualifizierte Ressourcenname der AlertPolicy.

alert_enrollments[]

AlertEnrollment

Optional. Die Registrierungsstatus der einzelnen Benachrichtigungen.

AlertEnrollment

Der Status der Benachrichtigungsregistrierung.

Felder

alert_id

string

Nicht veränderbar. Die ID einer Benachrichtigung.

enroll_state

EnrollStates

Erforderlich. Der Registrierungsstatus eines Kunden.

EnrollStates

Die Enum für den Registrierungsstatus für die Benachrichtigung.

Enums
`ENROLL_STATES_UNSPECIFIED`	Standardwert. Wird für Kunden verwendet, die nicht auf die Benachrichtigungsrichtlinie reagiert haben.
`ENROLLED`	Der Kunde ist für diese Richtlinie registriert.
`DECLINED`	Der Kunde hat diese Richtlinie abgelehnt.

AlertPolicyResourceConfig

Die Benachrichtigungskonfiguration auf Ressourcenebene. Wird verwendet in: * UserLicense * EngineUserData Die AlertPolicyConfig im Daten-Connector wird auf dieselbe Weise verwendet. Es gibt keine einfache Möglichkeit zur Migration.

Felder
`alert_policy`	`string` Nicht veränderbar. Der vollständig qualifizierte Ressourcenname der AlertPolicy.
`alert_enrollments[]`	`AlertEnrollment` Optional. Der Registrierungsstatus der einzelnen Benachrichtigungen.
`contact_details[]`	`ContactDetails` Optional. Die Kontaktdaten für jede Benachrichtigungsrichtlinie.
`language_code`	`string` Optional. Der für Benachrichtigungen verwendete Sprachcode

AlertEnrollment

Der Status der Benachrichtigungsregistrierung.

Felder

alert_id

string

Nicht veränderbar. Die ID einer Benachrichtigung.

enroll_state

EnrollState

Erforderlich. Der Registrierungsstatus eines Kunden.

notification_params

map<string, string>

Optional. Parameter, die zum Instanziieren einer Benachrichtigung verwendet werden. Wird für Benachrichtigungen verwendet, die bei der Registrierung ausgelöst werden. Nicht gespeichert. * Willkommens-E‑Mails für Gemini Business * E‑Mail-Einladungen für Gemini Business-Nutzer.

EnrollState

Die Enum für den Registrierungsstatus für die Benachrichtigung.

Enums
`ENROLL_STATE_UNSPECIFIED`	Standardwert. Wird für Kunden verwendet, die nicht auf die Benachrichtigungsrichtlinie reagiert haben.
`ENROLLED`	Der Kunde ist für diese Richtlinie registriert.
`DECLINED`	Der Kunde hat diese Richtlinie abgelehnt.

AlloyDbSource

AlloyDB-Quelle, aus der Daten importiert werden.

Felder
`project_id`	`string` Die Projekt-ID des Projekts, das die AlloyDB-Quelle enthält. Die Länge ist auf 128 Zeichen begrenzt. Wenn keine Angabe erfolgt, wird die Projekt-ID von der übergeordneten Anfrage übernommen.
`location_id`	`string` Erforderlich. Der AlloyDB-Standort, von dem die Daten kopiert werden sollen. Die maximale Länge beträgt 256 Zeichen.
`cluster_id`	`string` Erforderlich. Der AlloyDB-Cluster, aus dem die Daten kopiert werden sollen. Die maximale Länge beträgt 256 Zeichen.
`database_id`	`string` Erforderlich. Die AlloyDB-Datenbank, aus der die Daten kopiert werden sollen. Die maximale Länge beträgt 256 Zeichen.
`table_id`	`string` Erforderlich. Die AlloyDB-Tabelle, aus der die Daten kopiert werden sollen. Die maximale Länge beträgt 256 Zeichen.
`gcs_staging_dir`	`string` Für den Import verwendetes Cloud Storage-Zwischenverzeichnis mit einer Längenbeschränkung von 2.000 Zeichen. Kann angegeben werden, wenn der AlloyDB-Export in ein bestimmtes Cloud Storage-Verzeichnis erfolgen soll. Achten Sie darauf, dass das AlloyDB-Dienstkonto die erforderlichen Cloud Storage-Administratorberechtigungen für den Zugriff auf das angegebene Cloud Storage-Verzeichnis hat.

Antwort

Definiert eine Antwort.

Felder
`name`	`string` Nicht veränderbar. Vollständig qualifizierter Name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions//answers/`
`state`	`State` Der Status der Antworterstellung.
`answer_text`	`string` Die Textantwort.
`citations[]`	`Citation` Zitate.
`grounding_supports[]`	`GroundingSupport` Optional. Unterstützung für Grounding
`references[]`	`Reference` Referenzen.
`related_questions[]`	`string` Vorgeschlagene ähnliche Fragen
`steps[]`	`Step` Schritte zum Generieren von Antworten.
`query_understanding_info`	`QueryUnderstandingInfo` Informationen zur Interpretation von Anfragen.
`answer_skipped_reasons[]`	`AnswerSkippedReason` Zusätzliche Gründe, warum Antworten übersprungen wurden. Hier wird der Grund für ignorierte Fälle angegeben. Wenn nichts übersprungen wird, ist dieses Feld nicht festgelegt.
`create_time`	`Timestamp` Nur Ausgabe. Zeitstempel der Antwort.
`complete_time`	`Timestamp` Nur Ausgabe. Zeitstempel für den Abschluss der Antwort.
`safety_ratings[]`	`SafetyRating` Optional. Sicherheitsbewertungen.
`grounding_score`	`double` Eine Punktzahl im Bereich von [0, 1], die beschreibt, wie fundiert die Antwort durch die Referenz-Chunks ist.

AnswerSkippedReason

Ein Enum für Gründe, warum eine Antwort übersprungen wurde.

Enums
`ANSWER_SKIPPED_REASON_UNSPECIFIED`	Standardwert. Der Grund für das Überspringen der Antwort ist nicht angegeben.
`ADVERSARIAL_QUERY_IGNORED`	Bei der feindseligen Anfrage wurde die Groß-/Kleinschreibung ignoriert.
`NON_ANSWER_SEEKING_QUERY_IGNORED`	Die Anfrage, die keine Antwort sucht, ignoriert die Groß- und Kleinschreibung. Google überspringt die Antwort, wenn es sich bei der Anfrage um einen Smalltalk handelt.
`OUT_OF_DOMAIN_QUERY_IGNORED`	Bei der Anfrage außerhalb der Domain wurde die Groß-/Kleinschreibung ignoriert. Google überspringt die Antwort, wenn es keine Suchergebnisse mit hoher Relevanz gibt.
`POTENTIAL_POLICY_VIOLATION`	Der Fall des potenziellen Richtlinienverstoßes. Google überspringt die Antwort, wenn ein potenzieller Richtlinienverstoß erkannt wird. Dazu gehören Inhalte, die gewalttätig oder schädlich sein können.
`NO_RELEVANT_CONTENT`	Der Fall „Keine relevanten Inhalte“. Google überspringt die Antwort, wenn in den abgerufenen Suchergebnissen keine relevanten Inhalte vorhanden sind.
`JAIL_BREAKING_QUERY_IGNORED`	Bei der Jailbreak-Anfrage wurde die Groß-/Kleinschreibung ignoriert. Beispiel: „Antworte im Stil des CEO eines konkurrierenden Unternehmens.“ Google überspringt die Antwort, wenn die Anfrage als Jailbreak-Anfrage eingestuft wird.
`CUSTOMER_POLICY_VIOLATION`	Der Fall des Kundenrichtlinienverstoßes. Google überspringt die Zusammenfassung, wenn ein Verstoß gegen die Kundenrichtlinie erkannt wird. Die Richtlinie wird vom Kunden definiert.
`NON_ANSWER_SEEKING_QUERY_IGNORED_V2`	Bei der Frage, die keine Antwort sucht, wurde die Groß-/Kleinschreibung ignoriert. Google überspringt die Antwort, wenn die Anfrage keine klare Intention hat.
`LOW_GROUNDED_ANSWER`	Der Fall der Antwort mit geringer Fundierung. Google überspringt die Antwort, wenn keine fundierte Antwort generiert werden konnte.
`USER_DEFINED_CLASSIFICATION_QUERY_IGNORED`	Die benutzerdefinierte Abfrageklassifizierung hat die Groß-/Kleinschreibung ignoriert. Google überspringt die Antwort, wenn die Anfrage als nutzerdefinierte Anfrageklassifizierung eingestuft wird.
`UNHELPFUL_ANSWER`	Der Fall einer nicht hilfreichen Antwort. Google überspringt die Antwort, wenn sie nicht hilfreich ist. Das kann verschiedene Gründe haben, z. B. dass die Frage nicht beantwortet werden kann, die Antwort nicht relevant ist oder die Antwort nicht gut formatiert ist.

Quellenangabe

Zitierinformationen für ein Segment.

Felder

start_index

int64

Der Index gibt den Beginn des Segments in Byte (UTF-8-Unicode) an. Wenn es Multibyte-Zeichen wie Nicht-ASCII-Zeichen gibt, ist die Indexmessung länger als die Stringlänge.

end_index

int64

Ende des zugeordneten Segments (ausschließlich). Gemessen in Byte (UTF-8-Unicode). Wenn es Multibyte-Zeichen wie Nicht-ASCII-Zeichen gibt, ist die Indexmessung länger als die Stringlänge.

sources[]

CitationSource

Zitationsquellen für das zugeordnete Segment.

CitationSource

Zitationsquelle.

Felder

reference_id

string

Die ID der Zitationsquelle.

GroundingSupport

Fundierung für eine Behauptung in answer_text.

Felder
`start_index`	`int64` Erforderlich. Der Index gibt den Beginn des Anspruchs in Byte (UTF-8-Unicode) an.
`end_index`	`int64` Erforderlich. Ende des Anspruchs, exklusiv.
`sources[]`	`CitationSource` Optional. Zitationsquellen für die Behauptung.
`grounding_score`	`double` Ein Wert im Bereich [0, 1], der beschreibt, wie gut eine bestimmte Behauptung durch die Referenzen belegt wird. Ein höherer Wert bedeutet, dass die Behauptung besser durch die Referenz-Chunks belegt wird.
`grounding_check_required`	`bool` Gibt an, dass für diesen Anspruch eine Fundierungsprüfung erforderlich war. Wenn das System entschieden hat, dass für diese Behauptung keine Attributions-/Fundierungsprüfung erforderlich ist, wird dieses Feld auf „false“ gesetzt. In diesem Fall wurde keine Fundierungsprüfung für die Behauptung durchgeführt und daher wird `grounding_score`, `sources` nicht zurückgegeben.

QueryUnderstandingInfo

Informationen zur Interpretation von Anfragen.

Felder

query_classification_info[]

Informationen zur Abfrageklassifizierung.

QueryClassificationInfo

Informationen zur Abfrageklassifizierung.

Felder

type

Type

Typ der Abfrageklassifizierung.

positive

bool

Klassifizierungsausgabe.

Typ

Klassifizierungstypen für Anfragen.

Enums
`TYPE_UNSPECIFIED`	Nicht angegebener Typ der Anfragenklassifizierung.
`ADVERSARIAL_QUERY`	Typ der Klassifizierung von feindseligen Anfragen.
`NON_ANSWER_SEEKING_QUERY`	Klassifizierungstyp für Anfragen, die keine Antwort erfordern, für Smalltalk.
`JAIL_BREAKING_QUERY`	Klassifizierungstyp für Jailbreak-Abfragen.
`NON_ANSWER_SEEKING_QUERY_V2`	Anfrageklassifizierungstyp für Anfragen, die nicht auf eine Antwort abzielen, ohne klare Intention.
`USER_DEFINED_CLASSIFICATION_QUERY`	Benutzerdefinierter Typ der Suchanfrageklassifizierung.

Referenz

Reference hinzufügen.

Felder
Union-Feld `content`. Inhalte der Suchergebnisse. Für `content` ist nur einer der folgenden Werte zulässig:
`unstructured_document_info`	`UnstructuredDocumentInfo` Informationen aus unstrukturierten Dokumenten.
`chunk_info`	`ChunkInfo` Informationen zu Chunks.
`structured_document_info`	`StructuredDocumentInfo` Strukturierte Dokumentinformationen.

ChunkInfo

Informationen zu Chunks.

Felder
`chunk`	`string` Name der Chunk-Ressource.
`content`	`string` Textinhalte in Abschnitte unterteilen
`document_metadata`	`DocumentMetadata` Dokumentmetadaten
`relevance_score`	`float` Die Relevanz des Chunks für eine bestimmte Anfrage. Die Werte reichen von 0,0 (völlig irrelevant) bis 1,0 (völlig relevant). Dieser Wert dient nur zu Informationszwecken. Er kann sich für dieselbe Anfrage und denselben Chunk jederzeit aufgrund eines erneuten Modelltrainings oder einer Änderung der Implementierung ändern.

DocumentMetadata

Dokumentmetadaten

Felder
`document`	`string` Name der Dokumentressource.
`uri`	`string` URI für das Dokument.
`title`	`string` Titel:
`page_identifier`	`string` Seiten-ID.
`struct_data`	`Struct` Die strukturierten JSON-Metadaten für das Dokument. Sie wird aus den strukturierten Daten des Chunks im Suchergebnis generiert.

StructuredDocumentInfo

Strukturierte Suchinformationen.

Felder
`document`	`string` Name der Dokumentressource.
`struct_data`	`Struct` Strukturierte Suchdaten.
`title`	`string` Nur Ausgabe. Der Titel des Dokuments.
`uri`	`string` Nur Ausgabe. Der URI des Dokuments.

UnstructuredDocumentInfo

Informationen aus unstrukturierten Dokumenten.

Felder
`document`	`string` Name der Dokumentressource.
`uri`	`string` URI für das Dokument.
`title`	`string` Titel:
`chunk_contents[]`	`ChunkContent` Liste der zitierten Chunks, die aus Dokumentinhalten abgeleitet wurden.
`struct_data`	`Struct` Die strukturierten JSON-Metadaten für das Dokument. Sie wird aus den strukturierten Daten des Chunks im Suchergebnis generiert.

ChunkContent

Inhalte in Chunks aufteilen

Felder

content

string

Textinhalte in Abschnitte unterteilen

page_identifier

string

Seiten-ID.

relevance_score

float

Die Relevanz des Chunks für eine bestimmte Anfrage. Die Werte reichen von 0,0 (völlig irrelevant) bis 1,0 (völlig relevant). Dieser Wert dient nur zu Informationszwecken. Er kann sich für dieselbe Anfrage und denselben Chunk jederzeit aufgrund eines erneuten Modelltrainings oder einer Änderung der Implementierung ändern.

Bundesland

Aufzählung des Status der Antwortgenerierung.

Enums
`STATE_UNSPECIFIED`	Unbekannt.
`IN_PROGRESS`	Die Antwort wird gerade generiert.
`FAILED`	Die Antwort konnte derzeit nicht generiert werden.
`SUCCEEDED`	Die Antwort wurde erfolgreich generiert.
`STREAMING`	Die Antwort wird gerade generiert.

Schritt

Schrittinformationen.

Felder
`state`	`State` Der Status des Schritts.
`description`	`string` Die Beschreibung des Schritts.
`thought`	`string` Die Idee hinter dem Schritt.
`actions[]`	`Action` Aktionen

Aktion

Aktion.

Felder

observation

Observation

Beobachtung.

Union-Feld action. Die Aktion. Für action ist nur einer der folgenden Werte zulässig:

search_action

SearchAction

Suchaktion.

Beobachtung

Beobachtung.

Felder

search_results[]

SearchResult

Suchergebnisse, die von der Suchaktion beobachtet werden. Das können Snippet-Informationen oder Chunk-Informationen sein, je nach dem vom Nutzer festgelegten Zitationstyp.

SearchResult

Felder
`document`	`string` Name der Dokumentressource.
`uri`	`string` URI für das Dokument.
`title`	`string` Titel:
`snippet_info[]`	`SnippetInfo` Wenn „citation_type“ „DOCUMENT_LEVEL_CITATION“ ist, füllen Sie Snippets auf Dokumentebene aus.
`chunk_info[]`	`ChunkInfo` Wenn „citation_type“ CHUNK_LEVEL_CITATION ist und der Chunk-Modus aktiviert ist, füllen Sie die Chunk-Informationen ein.
`struct_data`	`Struct` Datendarstellung Die strukturierten JSON-Daten für das Dokument. Sie wird aus den strukturierten Daten des Dokuments oder des Chunks im Suchergebnis gefüllt.

ChunkInfo

Informationen zu Chunks.

Felder

chunk

string

Name der Chunk-Ressource.

content

string

Textinhalte in Abschnitte unterteilen

relevance_score

float

SnippetInfo

Snippet-Informationen

Felder

snippet

string

Snippet-Inhalte.

snippet_status

string

Status des Snippets, der vom Suchteam definiert wird.

SearchAction

Suchaktion.

Felder

query

string

Die Suchanfrage.

Bundesland

Aufzählung des Status des Schritts.

Enums
`STATE_UNSPECIFIED`	Unbekannt.
`IN_PROGRESS`	Der Schritt wird gerade ausgeführt.
`FAILED`	Der Schritt ist derzeit fehlgeschlagen.
`SUCCEEDED`	Der Schritt wurde erfolgreich ausgeführt.

AnswerGenerationSpec

Die Spezifikation für die Antwortgenerierung.

Felder

user_defined_classifier_spec

UserDefinedClassifierSpec

Optional. Die Spezifikation für die vom Nutzer angegebene Klassifikatorspezifikation.

UserDefinedClassifierSpec

Die Spezifikation für den benutzerdefinierten Classifier.

Felder
`enable_user_defined_classifier`	`bool` Optional. Gibt an, ob der benutzerdefinierte Classifier aktiviert und einbezogen werden soll.
`preamble`	`string` Optional. Die Präambel, die für den benutzerdefinierten Klassifikator verwendet werden soll.
`model_id`	`string` Optional. Die Modell-ID, die für den benutzerdefinierten Classifier verwendet werden soll.
`task_marker`	`string` Optional. Die Aufgabenmarkierung, die für den benutzerdefinierten Classifier verwendet werden soll.
`top_p`	`double` Optional. Der für den benutzerdefinierten Classifier zu verwendende Top-P-Wert.
`top_k`	`int64` Optional. Der Top-k-Wert, der für den benutzerdefinierten Classifier verwendet werden soll.
`temperature`	`double` Optional. Der Temperaturwert, der für den benutzerdefinierten Classifier verwendet werden soll.
`seed`	`int32` Optional. Der Seed-Wert, der für die benutzerdefinierte Klassifizierung verwendet werden soll.

AnswerQueryRequest

Anfragenachricht für die Methode ConversationalSearchService.AnswerQuery.

Felder
`serving_config`	`string` Erforderlich. Der Ressourcenname der Bereitstellungskonfiguration für die Suche, z. B. `projects//locations/global/collections/default_collection/engines//servingConfigs/default_serving_config` oder `projects//locations/global/collections/default_collection/dataStores//servingConfigs/default_serving_config`. Dieses Feld wird verwendet, um den Namen der Bereitstellungskonfiguration zu identifizieren, also die Gruppe von Modellen, die für die Suche verwendet werden.
`query`	`Query` Erforderlich. Aktuelle Nutzeranfrage.
`session`	`string` Der Name der Sitzungsressource. Nicht erforderlich. Wenn das Sitzungsfeld nicht festgelegt ist, befindet sich die API im sitzungslosen Modus. Wir unterstützen den automatischen Sitzungsmodus: Nutzer können das Platzhaltersymbol `-` als Sitzungs-ID verwenden. Eine neue ID wird automatisch generiert und zugewiesen.
`safety_spec`	`SafetySpec` Modellspezifikation.
`related_questions_spec`	`RelatedQuestionsSpec` Spezifikation ähnlicher Fragen
`grounding_spec`	`GroundingSpec` Optional. Spezifikation für die Fundierung.
`answer_generation_spec`	`AnswerGenerationSpec` Spezifikation für die Antwortgenerierung.
`search_spec`	`SearchSpec` Spezifikation der Suche.
`query_understanding_spec`	`QueryUnderstandingSpec` Spezifikation der Interpretation von Anfragen.
`asynchronous_mode (deprecated)`	`bool` Dieses Element ist veraltet. Eingestellt: Dieses Feld wurde eingestellt. Die Streaming Answer API wird unterstützt. Steuerung des asynchronen Modus. Wenn diese Option aktiviert ist, wird die Antwort mit dem Antwort-/Sitzungsressourcennamen ohne endgültige Antwort zurückgegeben. API-Nutzer müssen den neuesten Status der Antwort/Sitzung durch Aufrufen der Methode `ConversationalSearchService.GetAnswer` oder `ConversationalSearchService.GetSession` abrufen.
`user_pseudo_id`	`string` Eine eindeutige Kennung für das Tracking von Besuchern. Dies kann beispielsweise mit einem HTTP-Cookie implementiert werden, mit dem ein Besucher auf einem einzelnen Gerät eindeutig identifiziert werden kann. Diese eindeutige Kennung sollte sich nicht ändern, wenn sich der Besucher auf der Website an- oder abmeldet. Dieses Feld sollte KEINEN festen Wert wie `unknown_visitor` haben. Das Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 128 Zeichen sein. Andernfalls wird der Fehler `INVALID_ARGUMENT` zurückgegeben.
`user_labels`	`map<string, string>` Die Nutzerlabels, die auf eine Ressource angewendet werden, müssen die folgenden Anforderungen erfüllen: Jede Ressource kann bis zu 64 Labels haben. Jedes Label muss ein Schlüssel/Wert-Paar sein. Schlüssel haben eine Mindestlänge von einem Zeichen und eine maximale Länge von 63 Zeichen und dürfen nicht leer sein. Werte dürfen leer sein und haben eine maximale Länge von 63 Zeichen. Schlüssel und Werte dürfen nur Kleinbuchstaben, Ziffern, Unterstriche und Bindestriche enthalten. Alle Zeichen müssen UTF-8-codiert sein. Internationale Zeichen sind zulässig. Der Schlüsselabschnitt eines Labels darf nur einmal vorkommen. Sie können jedoch denselben Schlüssel für mehrere Ressourcen verwenden. Schlüssel müssen mit einem Kleinbuchstaben oder einem internationalen Zeichen beginnen. Weitere Informationen finden Sie im Google Cloud-Dokument.
`end_user_spec`	`EndUserSpec` Optional. Spezifikation für Endnutzer.

AnswerGenerationSpec

Spezifikation für die Antwortgenerierung.

Felder
`model_spec`	`ModelSpec` Spezifikation des Modells zur Antwortgenerierung.
`prompt_spec`	`PromptSpec` Spezifikation für Prompts zur Antwortgenerierung.
`include_citations`	`bool` Gibt an, ob Zitationsmetadaten in die Antwort aufgenommen werden sollen. Der Standardwert ist `false`.
`answer_language_code`	`string` Sprachcode für die Antwort. Verwenden Sie Sprachentags, die von BCP47 definiert werden. Hinweis: Dies ist eine experimentelle Funktion.
`ignore_adversarial_query`	`bool` Gibt an, ob feindselige Anfragen herausgefiltert werden sollen. Der Standardwert ist `false`. Google verwendet die Klassifizierung von Suchanfragen, um schädliche Anfragen zu erkennen. Wenn die Suchanfrage als feindselige Anfrage eingestuft wird, wird keine Antwort zurückgegeben. Ein Nutzer könnte beispielsweise eine Frage zu negativen Kommentaren über das Unternehmen stellen oder eine Anfrage senden, die darauf abzielt, unsichere, richtlinienwidrige Ausgaben zu generieren. Wenn dieses Feld auf `true` gesetzt ist, überspringen wir das Generieren von Antworten auf feindselige Anfragen und geben stattdessen Fallback-Nachrichten zurück.
`ignore_non_answer_seeking_query`	`bool` Gibt an, ob Anfragen herausgefiltert werden sollen, die nicht auf eine Antwort abzielen. Der Standardwert ist `false`. Google verwendet die Klassifizierung von Suchanfragen, um Anfragen zu erkennen, die auf eine Antwort abzielen. Wenn die Suchanfrage als nicht antwortorientiert eingestuft wird, wird keine Antwort zurückgegeben. Wenn dieses Feld auf `true` festgelegt ist, überspringen wir das Generieren von Antworten für Anfragen, die nicht auf Antworten ausgerichtet sind, und geben stattdessen Fallback-Nachrichten zurück.
`ignore_jail_breaking_query`	`bool` Optional. Gibt an, ob Anfragen zum Jailbreaking herausgefiltert werden sollen. Der Standardwert ist `false`. Google verwendet die Klassifizierung von Suchanfragen, um Anfragen zu erkennen, die darauf abzielen, die Sicherheitsvorkehrungen zu umgehen. Es wird keine Zusammenfassung zurückgegeben, wenn die Suchanfrage als Jailbreak-Anfrage eingestuft wird. Ein Nutzer kann der Anfrage Anweisungen hinzufügen, um den Ton, Stil, die Sprache oder den Inhalt der Antwort zu ändern oder das Modell zu bitten, als eine andere Einheit zu agieren, z.B. „Antworte im Stil des CEO eines konkurrierenden Unternehmens“. Wenn dieses Feld auf `true` gesetzt ist, werden keine Zusammenfassungen für Anfragen zum Jailbreaking generiert. Stattdessen werden Fallback-Nachrichten zurückgegeben.
`ignore_low_relevant_content`	`bool` Gibt an, ob Suchanfragen mit geringer Relevanz herausgefiltert werden sollen. Wenn dieses Feld auf `false` festgelegt ist, werden alle Suchergebnisse unabhängig von ihrer Relevanz verwendet, um Antworten zu generieren. Wenn die Richtlinie auf `true` festgelegt oder nicht konfiguriert ist, wird das Verhalten automatisch vom Dienst bestimmt.

ModelSpec

Spezifikation des Modells zur Antworterstellung.

Felder

model_version

string

Modellversion Wenn nicht festgelegt, wird das standardmäßige stabile Modell verwendet. Zulässige Werte sind „stable“ und „preview“.

PromptSpec

Spezifikation für Prompts zur Antwortgenerierung.

Felder

preamble

string

Benutzerdefinierte Präambel

EndUserSpec

Spezifikation für Endnutzer.

Felder

end_user_metadata[]

EndUserMetaData

Optional. Endnutzermetadaten.

EndUserMetaData

Endnutzermetadaten.

Felder

Union-Feld content. Inhalte der Suchergebnisse. Für content ist nur einer der folgenden Werte zulässig:

chunk_info

ChunkInfo

Informationen zu Chunks.

ChunkInfo

Informationen zu Chunks.

Felder

content

string

Textinhalte in Abschnitte unterteilen Sie ist auf 8.000 Zeichen begrenzt.

document_metadata

QueryClassificationSpec

Metadaten des Dokuments aus dem aktuellen Chunk.

DocumentMetadata

Dokumentmetadaten enthalten die Informationen des Dokuments des aktuellen Chunks.

Felder

title

string

Titel des Dokuments.

GroundingSpec

Spezifikation für die Fundierung.

Felder

include_grounding_supports

bool

Optional. Gibt an, ob in der Antwort „grounding_supports“ enthalten sein sollen. Der Standardwert ist false.

Wenn dieses Feld auf true gesetzt ist, enthält die zurückgegebene Antwort grounding_score und GroundingSupports für jede Behauptung.

filtering_level

FilteringLevel

Optional. Gibt an, ob die Filterung basierend auf dem Fundierungsergebnis aktiviert werden soll und auf welcher Ebene.

FilteringLevel

Ebene, nach der basierend auf der Antwortgrundlage gefiltert werden soll.

Enums
`FILTERING_LEVEL_UNSPECIFIED`	Standardmäßig ist kein Filter festgelegt.
`FILTERING_LEVEL_LOW`	Antworten anhand eines niedrigen Schwellenwerts filtern.
`FILTERING_LEVEL_HIGH`	Antworten anhand eines hohen Schwellenwerts filtern.

QueryUnderstandingSpec

Spezifikation der Interpretation von Anfragen.

Felder

query_classification_spec

Spezifikation der Abfrageklassifizierung.

query_rephraser_spec

QueryRephraserSpec

Spezifikation für die Umformulierung von Anfragen.

disable_spell_correction

bool

Optional. Gibt an, ob die Rechtschreibkorrektur deaktiviert werden soll. Der Standardwert ist false.

QueryClassificationSpec

Spezifikation der Abfrageklassifizierung.

Felder

types[]

Type

Abfrageklassifizierungstypen aktiviert.

Typ

Klassifizierungstypen für Anfragen.

Enums
`TYPE_UNSPECIFIED`	Nicht angegebener Typ der Anfragenklassifizierung.
`ADVERSARIAL_QUERY`	Typ der Klassifizierung von feindseligen Anfragen.
`NON_ANSWER_SEEKING_QUERY`	Klassifizierungstyp für Anfragen, die keine Antwort erfordern, für Smalltalk.
`JAIL_BREAKING_QUERY`	Klassifizierungstyp für Jailbreak-Abfragen.
`NON_ANSWER_SEEKING_QUERY_V2`	Anfrageklassifizierungstyp für Anfragen, die nicht auf eine Antwort abzielen, ohne klare Intention.
`USER_DEFINED_CLASSIFICATION_QUERY`	Benutzerdefinierter Typ der Suchanfrageklassifizierung.

QueryRephraserSpec

Spezifikation für die Umformulierung von Anfragen.

Felder

disable

bool

Abfrage-Rephraser deaktivieren

max_rephrase_steps

int32

Maximale Anzahl der Schritte zum Umformulieren. Es sind maximal 5 Schritte möglich. Wenn der Wert nicht festgelegt oder auf < 1 gesetzt ist, wird er standardmäßig auf 1 gesetzt.

model_spec

ModelSpec

Optional. Modellspezifikation für die Umformulierung von Suchanfragen.

ModelSpec

Modellspezifikation für die Umformulierung von Suchanfragen.

Felder

model_type

ModelType

Optional. Der Modelltyp „Suchanfrage umformulieren“ ist aktiviert. Wenn nicht festgelegt, wird standardmäßig LARGE verwendet.

ModelType

Typen von Tools zum Umformulieren von Anfragen. Derzeit werden nur Modellselektionen mit einem Hop (max_rephrase_steps = 1) unterstützt. Für Multi-Hop (max_rephrase_steps > 1) gibt es nur ein Standardmodell.

Enums
`MODEL_TYPE_UNSPECIFIED`	Nicht angegebener Modelltyp.
`SMALL`	Kleines Modell zum Umformulieren von Anfragen. Gemini 1.0 XS-Modell
`LARGE`	Großes Modell für die Umformulierung von Anfragen Gemini 1.0 Pro-Modell.

RelatedQuestionsSpec

Spezifikation ähnlicher Fragen

Felder

enable

bool

Aktiviert die Funktion „Ähnliche Fragen“, wenn „true“ festgelegt ist.

SafetySpec

Sicherheitsanforderungen. Es gibt zwei Anwendungsfälle: 1. Wenn nur „safety_spec.enable“ festgelegt ist, wird der Schwellenwert „BLOCK_LOW_AND_ABOVE“ für alle Kategorien angewendet. 2. Wenn „safety_spec.enable“ festgelegt ist und einige „safety_settings“ festgelegt sind, werden nur die angegebenen „safety_settings“ angewendet.

Felder

enable

bool

Aktivieren Sie die Sicherheitsfilterung für die Antwort. Der Standardwert ist „false“.

safety_settings[]

SafetySetting

Optional. Sicherheitseinstellungen. Diese Einstellungen sind nur wirksam, wenn „safety_spec.enable“ auf „true“ gesetzt ist.

SafetySetting

Sicherheitseinstellungen.

Felder

category

HarmCategory

Erforderlich. Schadenskategorie.

threshold

HarmBlockThreshold

Erforderlich. Der Schwellenwert für die die Schadenssperre

HarmBlockThreshold

Auf Wahrscheinlichkeit basierende Schwellenwertebenen für die Blockierung.

Enums
`HARM_BLOCK_THRESHOLD_UNSPECIFIED`	Unbekannter Schwellenwert für Schadenssperre.
`BLOCK_LOW_AND_ABOVE`	Niedrigeren Schwellenwert und höher blockieren (d. h. mehr blockieren).
`BLOCK_MEDIUM_AND_ABOVE`	Mittleren Schwellenwert und höher blockieren
`BLOCK_ONLY_HIGH`	Nur einen hohen Schwellenwert blockieren (d. h. weniger blockieren).
`BLOCK_NONE`	Keine blockieren.
`OFF`	Deaktivieren Sie den Sicherheitsfilter.

SearchSpec

Spezifikation der Suche.

Felder

Union-Feld input. Suchparameter zum Steuern des Suchverhaltens. Oder geben Sie eine Liste mit Suchergebnissen an, um eine Antwort zu generieren. Für input ist nur einer der folgenden Werte zulässig:

search_params

SearchParams

Suchparameter

search_result_list

SearchResultList

Suchergebnisliste.

SearchParams

Suchparameter

Felder
`max_return_results`	`int32` Anzahl der zurückzugebenden Suchergebnisse. Der Standardwert ist 10.
`filter`	`string` Die Filtersyntax besteht aus einer Ausdruckssprache zum Erstellen eines Prädikats aus einem oder mehreren Feldern der gefilterten Dokumente. Bei Filterausdrücken wird zwischen Groß- und Kleinschreibung unterschieden. Diese werden verwendet, um Suchergebnisse zu filtern, was sich auf die Antwort auswirken kann. Wenn dieses Feld nicht erkannt wird, wird `INVALID_ARGUMENT` zurückgegeben. Das Filtern in Vertex AI Search erfolgt durch Zuordnen des LHS-Filterschlüssels zu einer Schlüsselattribut, das im Vertex AI Search-Backend definiert ist. Diese Zuordnung wird vom Kunden in seinem Schema definiert. Ein Media-Kunde hat in seinem Schema beispielsweise das Feld „name“. In diesem Fall würde der Filter so aussehen: filter --> name:'ANY("king kong")' Weitere Informationen zum Filtern, einschließlich Syntax und Filteroperatoren, finden Sie unter Filter.
`boost_spec`	`BoostSpec` Mit der Boost-Spezifikation können Sie bestimmte Dokumente in den Suchergebnissen hervorheben, was sich auf die Antwort auf die Anfrage auswirken kann. Weitere Informationen zum Boosten finden Sie unter Boost.
`order_by`	`string` Die Reihenfolge, in der Dokumente zurückgegeben werden. Dokumente können nach einem Feld in einem `Document`-Objekt sortiert werden. Lassen Sie das Feld leer, wenn die Ergebnisse nach Relevanz sortiert werden sollen. Bei `order_by` wird zwischen Groß- und Kleinschreibung unterschieden. Weitere Informationen zur Bestellung finden Sie unter Bestellen. Wenn dieses Feld nicht erkannt wird, wird `INVALID_ARGUMENT` zurückgegeben.
`search_result_mode`	`SearchResultMode` Gibt den Modus für Suchergebnisse an. Wenn nichts angegeben ist, wird standardmäßig der Suchergebnismodus `DOCUMENTS` verwendet. Dokumente parsen und in Chunks aufteilen
`data_store_specs[]`	`DataStoreSpec` Spezifikationen, die Datenspeicher zum Filtern in einem Suchaufruf und Konfigurationen für diese Datenspeicher definieren. Dies wird nur für den Anwendungsfall von Engines mit mehreren DataStores berücksichtigt. Für einen einzelnen Datenspeicher innerhalb einer Engine sollten die Spezifikationen auf der obersten Ebene verwendet werden.

SearchResultList

Suchergebnisliste.

Felder

search_results[]

SearchResult

Suchergebnisse.

SearchResult

Suchergebnis.

Felder

Union-Feld content. Inhalte der Suchergebnisse. Für content ist nur einer der folgenden Werte zulässig:

unstructured_document_info

UnstructuredDocumentInfo

Informationen aus unstrukturierten Dokumenten.

chunk_info

ChunkInfo

Informationen zu Chunks.

ChunkInfo

Informationen zu Chunks.

Felder

chunk

string

Name der Chunk-Ressource.

content

string

Textinhalte in Abschnitte unterteilen

document_metadata

Metadaten des Dokuments aus dem aktuellen Chunk.

DocumentMetadata

Dokumentmetadaten enthalten die Informationen des Dokuments des aktuellen Chunks.

Felder

uri

string

URI des Dokuments.

title

string

Titel des Dokuments.

UnstructuredDocumentInfo

Informationen aus unstrukturierten Dokumenten.

Felder
`document`	`string` Name der Dokumentressource.
`uri`	`string` URI für das Dokument.
`title`	`string` Titel:
`document_contexts[]`	`DocumentContext` Liste der Dokumentkontexte. Die Inhalte werden für die Antwortgenerierung verwendet. Dies soll der Hauptinhalt des Dokuments sein, der lang und umfassend sein kann.
`extractive_segments[]`	`ExtractiveSegment` Liste der extraktiven Segmente.
`extractive_answers[] (deprecated)`	`ExtractiveAnswer` Dieses Element ist veraltet. Verworfen: Dieses Feld ist veraltet und hat keine Auswirkungen auf die Antwortgenerierung. Verwenden Sie stattdessen die Felder „document_contexts“ und „extractive_segments“. Liste der extraktiven Antworten.

DocumentContext

Dokumentkontext.

Felder

page_identifier

string

Seiten-ID.

content

string

Dokumentinhalt, der für die Antwortgenerierung verwendet werden soll.

ExtractiveAnswer

Extraktive Antwort. Leitfaden

Felder

page_identifier

string

Seiten-ID.

content

string

Inhalte extraktiver Antworten.

ExtractiveSegment

Extrahierendes Segment. Guide: Die Antwortgenerierung wird nur verwendet, wenn „document_contexts“ leer ist. Es sollen kürzere Ausschnitte sein.

Felder

page_identifier

string

Seiten-ID.

content

string

Extrahierte Segmentinhalte.

AnswerQueryResponse

Antwortnachricht für die Methode ConversationalSearchService.AnswerQuery.

Felder

answer

Answer

Antwortressourcenobjekt. Wenn AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps größer als 1 ist, verwenden Sie Answer.name, um Antwortinformationen mit der ConversationalSearchService.GetAnswer API abzurufen.

session

PolicyEnforcementResult

Sitzungsressourcenobjekt. Es ist nur verfügbar, wenn das Sitzungsfeld in der AnswerQueryRequest-Anfrage festgelegt und gültig ist.

answer_query_token

string

Eine global eindeutige ID, die für die Protokollierung verwendet wird.

AssistAnswer

AssistAnswer-Ressource, Hauptteil von AssistResponse.

Felder
`name`	`string` Nicht veränderbar. ID. Ressourcenname von `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.
`state`	`State` Status der Antwortgenerierung.
`replies[]`	`Reply` Antworten des Assistenten
`assist_skipped_reasons[]`	`AssistSkippedReason` Gründe, warum der Supportanruf nicht angenommen wurde.
`customer_policy_enforcement_result`	`CustomerPolicyEnforcementResult` Optional. Das Feld enthält Informationen zu den Ergebnissen der verschiedenen Richtlinienprüfungen, z. B. zu verbotenen Begriffen oder Model Armor-Prüfungen. Dieses Feld wird nur ausgefüllt, wenn der Assist-Anruf aufgrund eines Richtlinienverstoßes übersprungen wurde.

AssistSkippedReason

Mögliche Gründe für das Nichtbeantworten eines Supportanrufs.

Enums
`ASSIST_SKIPPED_REASON_UNSPECIFIED`	Standardwert. Der Grund für das Überspringen wird nicht angegeben.
`NON_ASSIST_SEEKING_QUERY_IGNORED`	Der Assistent hat die Anfrage ignoriert, da sie nicht auf eine Antwort ausgerichtet war.
`CUSTOMER_POLICY_VIOLATION`	Der Assistent hat die Anfrage ignoriert oder die Antwort verweigert, weil gegen eine Kundenrichtlinie verstoßen wurde (z.B. weil die Anfrage oder die Antwort eine verbotene Wortgruppe enthielt).

CustomerPolicyEnforcementResult

Ergebnisse der Durchsetzung von Kundenrichtlinien. Enthält die Ergebnisse der verschiedenen Richtlinienprüfungen, z. B. der Prüfungen auf verbotene Begriffe oder der Model Armor-Prüfungen.

Felder

verdict

Verdict

Endgültiges Urteil zur Durchsetzung der Kundenrichtlinie. Wenn die Verarbeitung nur durch eine Richtlinie blockiert wurde, lautet das Ergebnis BLOCK.

policy_results[]

Ergebnisse der Durchsetzung von Kundenrichtlinien. Wird nur ausgefüllt, wenn der Assist-Anruf aufgrund eines Richtlinienverstoßes übersprungen wurde. Sie enthält Ergebnisse von Filtern, die die Verarbeitung der Abfrage blockiert haben.

BannedPhraseEnforcementResult

Ergebnis der Richtliniendurchsetzung für die Richtlinie zu verbotenen Begriffen.

Felder

banned_phrases[]

string

Die verbotenen Begriffe, die in der Anfrage oder der Antwort gefunden wurden.

ModelArmorEnforcementResult

Ergebnis der Richtliniendurchsetzung für Kunden für die Model Armor-Richtlinie.

Felder

Union-Feld result. Das Ergebnis der Model Armor-Richtlinie. Für result ist nur einer der folgenden Werte zulässig:

model_armor_violation

string

Der gefundene Model Armor-Verstoß.

error

BannedPhraseEnforcementResult

Der von Model Armor zurückgegebene Fehler, wenn die Richtlinienerzwingung aus irgendeinem Grund fehlgeschlagen ist.

PolicyEnforcementResult

Ergebnis der Durchsetzung der Kundenrichtlinie für einen einzelnen Richtlinientyp.

Felder

Union-Feld enforcement_result. Das spezifische Ergebnis des Richtlinientyps. Es kann sich entweder um einen Fehler oder um detaillierte Informationen zum Ergebnis der Richtliniendurchsetzung handeln. Für enforcement_result ist nur einer der folgenden Werte zulässig:

banned_phrase_enforcement_result

Das Ergebnis der Richtlinienerzwingung für die Richtlinie für verbotene Begriffe.

model_armor_enforcement_result

ModelArmorEnforcementResult

Das Ergebnis der Richtlinienerzwingung für die Model Armor-Richtlinie.

Urteil

Das Ergebnis der Durchsetzung der Kundenrichtlinie.

Enums
`UNSPECIFIED`	Unbekannter Wert.
`ALLOW`	Es lag kein Richtlinienverstoß vor.
`BLOCK`	Die Verarbeitung wurde durch die Kundenrichtlinie blockiert.

Antworten

Ein Teil der mehrteiligen Antwort des Assist-Aufrufs.

Felder

Union-Feld reply. Alternativen für die Antwort des Assistenten. Für reply ist nur einer der folgenden Werte zulässig:

grounded_content

AssistantGroundedContent

Möglicherweise auf Fakten basierender Antworttext oder Medien vom Assistenten.

Bundesland

Status der Antwortgenerierung.

Enums
`STATE_UNSPECIFIED`	Unbekannt.
`IN_PROGRESS`	Der Assist-Vorgang wird gerade ausgeführt.
`FAILED`	Der Assist-Vorgang ist fehlgeschlagen.
`SUCCEEDED`	Der Assist-Vorgang war erfolgreich.
`SKIPPED`	Der Assist-Vorgang wurde übersprungen.

AssistRequest

Anfrage für die Methode AssistantService.Assist.

Felder
`name`	`string` Erforderlich. Der Ressourcenname der `Assistant`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` Optional. Aktuelle Nutzeranfrage. Leere Abfragen werden nur unterstützt, wenn `file_ids` angegeben werden. In diesem Fall wird die Antwort auf Grundlage dieser Kontextdateien generiert.
`session`	`string` Optional. Die für die Anfrage zu verwendende Sitzung. Falls angegeben, hat der Assistent Zugriff auf den Sitzungsverlauf und die Anfrage und die Antwort werden dort gespeichert. Wenn `-` als Session-ID angegeben oder das Feld leer gelassen wird, wird eine neue Session mit einer automatisch generierten ID erstellt. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
`assist_skipping_mode`	`AssistSkippingMode` Optional. Legt fest, in welchen Fällen der Assistent die Anfrage nicht beantwortet. Wenn die Antwort übersprungen wird, werden die Gründe in `AssistAnswer.assist_skipped_reasons` innerhalb von `AssistResponse.answer` aufgeführt.
`file_ids[]`	`string` Optional. Die IDs der Dateien, die zum Beantworten der Anfrage verwendet werden sollen. Beim Hochladen einer Datei wird ihre ID in `AddContextFileResponse.file_id` zurückgegeben.
`user_metadata`	`AssistUserMetadata` Optional. Informationen zum Nutzer, der die Anfrage initiiert.

AssistSkippingMode

Verfügbare Überspringensweisen für Assist-Anfragen.

Enums
`ASSIST_SKIPPING_MODE_UNSPECIFIED`	Standardwert. Die Antwort kann übersprungen werden, wenn in der Anfrage keine Unterstützung gesucht wird.
`REQUEST_ASSIST`	Assistant um Antwort bitten Die Antwort kann weiterhin übersprungen werden, wenn die Anfrage gegen Richtlinien verstößt.

AssistResponse

Antwort für die Methode AssistantService.Assist.

Felder

answer

AssistAnswer

Die Ressource AssistAnswer, die als Antwort auf die Anfrage generiert wurde.

session_info

SessionInfo

Informationen zur Sitzung.

assist_token

string

Eine global eindeutige ID, die das aktuelle Anfrage-Antwort-Paar identifiziert. Wird für Feedback und Support verwendet.

SessionInfo

Informationen zur Sitzung.

Felder

session

string

Name der neu generierten oder fortgesetzten Sitzung.

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

query_id

string

Die Abfrage-ID, die diesem Assist API-Aufruf entspricht. Eine Sitzung kann mehrere Turns mit jeweils einer eindeutigen Abfrage-ID haben.

Wenn Sie den Sitzungsnamen und diese Anfrage-ID im Assist API-Aufruf angeben, erfolgt die Assist-Anfrage im Kontext der Suchergebnisse aus diesem Suchaufruf.

AssistUserMetadata

Nutzermetadaten der Anfrage.

Felder

time_zone

string

Optional. IANA-Zeitzone, z.B. Europe/Budapest.

preferred_language_code

string

Optional. Bevorzugte Sprache, die für die Beantwortung verwendet werden soll, wenn die Spracherkennung fehlschlägt. Wird auch als Sprache für Fehlermeldungen verwendet, die von Aktionen erstellt werden, unabhängig von den Ergebnissen der Spracherkennung.

Assistant

Discovery Engine Assistant-Ressource.

Felder
`name`	`string` Nicht veränderbar. Ressourcenname des Assistenten. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` Es muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.
`display_name`	`string` Erforderlich. Der Anzeigename des Assistenten. Es muss ein UTF-8-codierter String mit einer Längenbegrenzung von 128 Zeichen sein.
`description`	`string` Optional. Beschreibung für zusätzliche Informationen. Sollte in der Konfigurations-UI angezeigt werden, nicht den Nutzern des Assistenten.
`generation_config`	`GenerationConfig` Optional. Konfiguration für die Generierung der Assistant-Antwort.
`google_search_grounding_enabled (deprecated)`	`bool` Dieses Element ist veraltet. Optional. Verworfen. Verwenden Sie stattdessen `web_grounding_type`.
`web_grounding_type`	`WebGroundingType` Optional. Der Typ der Webfundierung, die verwendet werden soll.
`enabled_actions (deprecated)`	`map<string, ActionList>` Dieses Element ist veraltet. Optional. Verworfen: Wird stattdessen durch `enabled_tools` ersetzt. Die aktivierten Aktionen für diesen Assistenten. Die Schlüssel sind Connectornamen, z. B. „projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector“. Die Werte bestehen aus vom Administrator aktivierten Aktionen für die Connector-Instanz. Administratoren können mehrere Aktionen für jede der Connector-Instanzen, die sie im Projekt erstellt haben, selektiv aktivieren. Beispiel: {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
`enabled_tools`	`map<string, ToolList>` Optional. Hinweis: Noch nicht implementiert. Verwenden Sie stattdessen `enabled_actions`. Die aktivierten Tools für diesen Assistenten. Die Schlüssel sind Connectornamen, z. B. „projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector“. Die Werte bestehen aus vom Administrator aktivierten Tools für die Connector-Instanz. Administratoren können mehrere Tools für jede der Connector-Instanzen, die sie im Projekt erstellt haben, selektiv aktivieren. Beispiel: {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
`customer_policy`	`CustomerPolicy` Optional. Kundenrichtlinie für den Assistenten.

ActionInfo

Verworfen: Wird stattdessen durch ToolInfo ersetzt. Informationen zur Identifizierung einer Aktion.

Felder

action_name

string

Der Name der Aktion, wie er von DataConnectorService.QueryAvailableActions definiert wird.

action_display_name

string

Der Anzeigename der Aktion.

ActionList

Verworfen: Wird stattdessen durch ToolList ersetzt. Die aktivierten Aktionen für einen Connector

Felder

action_info[]

ActionInfo

Die Liste der Aktionen mit den entsprechenden Aktionsinformationen.

CustomerPolicy

Vom Kunden definierte Richtlinie für den Assistenten.

Felder

banned_phrases[]

BannedPhrase

Optional. Liste der verbotenen Wortgruppen.

model_armor_config

ModelArmorConfig

Optional. Model Armor-Konfiguration, die zum Bereinigen von Nutzer-Prompts und Assistentenantworten verwendet werden soll.

BannedPhrase

Definition eines vom Kunden definierten verbotenen Ausdrucks. Ein verbotener Begriff darf nicht in der Nutzeranfrage oder der LLM-Antwort enthalten sein, da die Antwort sonst abgelehnt wird.

Felder

phrase

string

Erforderlich. Der zu sperrende Rohstring-Inhalt.

match_type

BannedPhraseMatchType

Optional. Keyword-Option für die verbotene Wortgruppe.

ignore_diacritics

bool

Optional. Bei „true“ werden diakritische Zeichen (z.B. Akzente, Umlaute) beim Abgleich mit verbotenen Begriffen ignoriert. So wird beispielsweise „cafe“ genau wie „café“ behandelt.

BannedPhraseMatchType

Die Abgleichsmethode für die verbotene Wortgruppe.

Enums
`BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED`	Die Standardeinstellung ist SIMPLE_STRING_MATCH.
`SIMPLE_STRING_MATCH`	Die verbotene Wortgruppe wird als Übereinstimmung erkannt, wenn sie als exakte Teilzeichenfolge an einer beliebigen Stelle im Text vorkommt.
`WORD_BOUNDARY_STRING_MATCH`	Eine verbotene Wortgruppe wird nur dann erkannt, wenn das im Text gefundene Muster von Worttrennzeichen umgeben ist. Die Wortgruppe selbst kann weiterhin Worttrennzeichen enthalten.

ModelArmorConfig

Konfiguration für kundendefinierte Model Armor-Vorlagen, die zum Bereinigen von Nutzer-Prompts und Assistentenantworten verwendet werden.

Felder

user_prompt_template

string

Optional. Der Ressourcenname der Model Armor-Vorlage zum Bereinigen von Nutzer-Prompts. Format: projects/{project}/locations/{location}/templates/{template_id}

Wenn nicht angegeben, wird der Nutzer-Prompt nicht bereinigt.

response_template

string

Optional. Der Ressourcenname der Model Armor-Vorlage zum Bereinigen von Assistentenantworten. Format: projects/{project}/locations/{location}/templates/{template_id}

Wenn keine Angabe erfolgt, wird die Antwort des Assistenten nicht bereinigt.

failure_mode

FailureMode

Optional. Definiert den Fehlermodus für die Bereinigung von Model Armor.

FailureMode

Bestimmt das Verhalten, wenn Model Armor eine Anfrage nicht verarbeiten kann.

Enums
`FAILURE_MODE_UNSPECIFIED`	Nicht angegebener Fehlermodus, Standardverhalten ist `FAIL_CLOSED`.
`FAIL_OPEN`	Bei einem Fehler während der Model Armor-Verarbeitung darf die Anfrage ohne Änderungen fortgesetzt werden.
`FAIL_CLOSED`	Bei einem Fehler während der Model Armor-Verarbeitung wird die Anfrage abgelehnt.

GenerationConfig

Konfiguration für die Generierung der Assistant-Antwort.

Felder

system_instruction

SystemInstruction

Systemanweisung, auch als Prompt-Präambel für LLM-Aufrufe bezeichnet. Siehe auch https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions

default_language

string

Die Standardsprache, die für die Generierung der Assistant-Antwort verwendet werden soll. Verwenden Sie einen ISO 639-1-Sprachcode wie en. Falls nicht angegeben, wird die Sprache automatisch erkannt.

SystemInstruction

Systemanweisung, auch als Prompt-Präambel für LLM-Aufrufe bezeichnet.

Felder

additional_system_instruction

string

Optional. Zusätzliche Systemanweisung, die der Standard-Systemanweisung hinzugefügt wird.

ToolInfo

Informationen zur Identifizierung eines Tools.

Felder

tool_name

string

Der Name des Tools, wie er von DataConnectorService.QueryAvailableActions definiert wird. Hinweis: In den DataConnectorService-APIs wird action verwendet, aber die Werte sind dieselben wie hier für tool.

tool_display_name

string

Der Anzeigename des Tools.

ToolList

Die aktivierten Tools für einen Connector

Felder

tool_info[]

ToolInfo

Die Liste der Tools mit den entsprechenden Toolinformationen.

WebGroundingType

Der Typ der Webfundierung, die verwendet werden soll.

Enums
`WEB_GROUNDING_TYPE_UNSPECIFIED`	Nicht spezifizierte Standardeinstellung. Dies entspricht „Deaktiviert“.
`WEB_GROUNDING_TYPE_DISABLED`	Web-Grounding ist deaktiviert.
`WEB_GROUNDING_TYPE_GOOGLE_SEARCH`	Die Fundierung mit der Google Suche ist aktiviert.
`WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`	Die Fundierung mit Enterprise Web Search ist aktiviert.

AssistantContent

Multimodale Inhalte.

Felder
`role`	`string` Der Produzent des Inhalts. Kann „model“ oder „user“ sein.
`thought`	`bool` Optional. Gibt an, ob der Teil vom Modell generiert wurde.
Union-Feld `data`. Enthaltene Daten. Für `data` ist nur einer der folgenden Werte zulässig:
`text`	`string` Inline-Text
`inline_data`	`Blob` Inline-Binärdaten.
`file`	`File` Eine Datei, z.B. eine Audiozusammenfassung.
`executable_code`	`ExecutableCode` Vom Modell generierter Code, der ausgeführt werden soll.
`code_execution_result`	`CodeExecutionResult` Ergebnis der Ausführung von ExecutableCode.

Blob

Inline-Blob

Felder

mime_type

string

Erforderlich. Der Medientyp (MIME-Typ) der generierten Daten.

data

bytes

Erforderlich. Rohbyte.

CodeExecutionResult

Ergebnis der Ausführung von ExecutableCode.

Felder

outcome

Outcome

Erforderlich. Ergebnis der Codeausführung.

output

string

Optional. Enthält stdout, wenn die Codeausführung erfolgreich ist, andernfalls stderr oder eine andere Beschreibung.

Ergebnis

Auflistung der möglichen Ergebnisse der Codeausführung.

Enums
`OUTCOME_UNSPECIFIED`	Nicht angegebener Status. Dieser Wert sollte nicht verwendet werden.
`OUTCOME_OK`	Die Codeausführung wurde erfolgreich abgeschlossen.
`OUTCOME_FAILED`	Die Codeausführung wurde abgeschlossen, aber mit einem Fehler. `stderr` sollte den Grund enthalten.
`OUTCOME_DEADLINE_EXCEEDED`	Die Codeausführung dauerte zu lange und wurde abgebrochen. Möglicherweise ist eine Teilausgabe vorhanden.

ExecutableCode

Vom Modell generierter Code, der vom Modell ausgeführt werden soll.

Felder

code

string

Erforderlich. Der Code-Inhalt. Derzeit wird nur Python unterstützt.

Datei

Eine Datei, z.B. eine Audiozusammenfassung.

Felder

mime_type

string

Erforderlich. Der Medientyp (MIME-Typ) der Datei.

file_id

string

Erforderlich. Die Datei-ID.

AssistantGroundedContent

Ein Inhalt und möglicherweise die zugehörigen Fundierungsinformationen.

Nicht für alle Inhalte ist eine Fundierung erforderlich. Formulierungen wie „Natürlich suche ich gerne für Sie danach“ müssen nicht belegt werden.

Felder
`content`	`AssistantContent` Der Inhalt.
`citation_metadata`	`CitationMetadata` Quellenangabe für die generierten Inhalte. Siehe auch https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check.
`content_metadata`	`ContentMetadata` Optional. Metadaten für die Inhalte. Wird derzeit nur für Antworten von Forschungsassistenten verwendet.
Union-Feld `metadata`. Fundierungsmetadaten für verschiedene Modale. Derzeit wird nur Text unterstützt. Für `metadata` ist nur einer der folgenden Werte zulässig:
`text_grounding_metadata`	`TextGroundingMetadata` Metadaten für die Fundierung auf Grundlage von Textquellen.

ContentMetadata

Metadaten für die Inhalte.

Felder

content_kind

ContentKind

Typ des Inhalts. Hier sehen Sie, zu welchem Teil der Antwort des Rechercheassistenten dieser Inhalt gehört.

content_id

string

ID des Inhalts. Sie wird verwendet, um Forschungsfragen mit Antworten darauf zu verknüpfen. Die Teile der Antwort auf eine Forschungsfrage haben beispielsweise dieselbe content_id wie die Frage.

ContentKind

Mögliche Arten von Inhalten. Wird derzeit nur verwendet, um Abschnitte in der vollständigen Antwort eines Research-Assistenten zu unterscheiden.

Enums
`CONTENT_KIND_UNSPECIFIED`	Unbekannt.
`RESEARCH_PLAN`	Forschungsplan.
`RESEARCH_QUESTION`	Forschungsfrage.
`RESEARCH_ANSWER`	Antwort auf die Frage.
`RESEARCH_REPORT`	Forschungsbericht.
`RESEARCH_AUDIO_SUMMARY`	Audiozusammenfassung durchsuchen

TextGroundingMetadata

Details zur Fundierung für Textquellen.

Felder

segments[]

Segment

Grundlageninformationen für Teile des Texts.

references[]

Reference

Referenzen für den fundierten Text.

Referenz

Referenzierte Inhalte und zugehörige Dokumentmetadaten.

Felder

content

string

Referenzierter Textinhalt.

document_metadata

Dokumentmetadaten

DocumentMetadata

Dokumentmetadaten

Felder
`document`	`string` Name der Dokumentressource.
`uri`	`string` URI für das Dokument. Sie kann eine URL enthalten, die zur eigentlichen Website weiterleitet.
`title`	`string` Titel:
`page_identifier`	`string` Seiten-ID.
`domain`	`string` Domainname aus dem Dokument-URI. Das Feld `uri` kann eine URL enthalten, die zur eigentlichen Website weiterleitet. In diesem Fall enthält es den Domainnamen der Zielwebsite.
`mime_type`	`string` Der MIME-Typ des Dokuments. https://www.iana.org/assignments/media-types/media-types.xhtml.

Segment

Grundlageninformationen für ein Textsegment.

Felder
`start_index`	`int64` Nullbasierter Index, der den Beginn des Segments angibt, gemessen in Byte eines UTF-8-Strings (d.h. Zeichen, die in mehreren Byte codiert sind, haben eine Länge von mehr als eins).
`end_index`	`int64` Ende des Segments, exklusiv.
`reference_indices[]`	`int32` Referenzen für das Segment.
`grounding_score`	`float` Punktzahl für das Segment.
`text`	`string` Das Textsegment selbst.

BAPConfig

Die Konfiguration für den BAP-Connector.

Felder

supported_connector_modes[]

ConnectorMode

Erforderlich. Die unterstützten Connectormodi für die zugehörige BAP-Verbindung.

enabled_actions[]

string

Optional. Die Aktionen, die für die zugehörige BAP-Verbindung aktiviert sind.

ConnectorMode

Von diesem BAP-Connector unterstützte Anwendungsfälle.

Enums
`CONNECTOR_MODE_UNSPECIFIED`	Der Connector-Modus ist nicht angegeben.
`DATA_INGESTION`	Connector, der für die Datenaufnahme verwendet wird.
`ACTIONS`	Für Aktionen verwendeter Connector
`END_USER_AUTHENTICATION`	Für die Endnutzerauthentifizierung verwendeter Connector.

BatchCreateTargetSiteMetadata

Metadaten zum Fortschritt des Vorgangs SiteSearchEngineService.BatchCreateTargetSites. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

CreateTargetSiteRequest

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

BatchCreateTargetSitesRequest

Anfragenachricht für die Methode SiteSearchEngineService.BatchCreateTargetSites.

Felder

parent

string

Erforderlich. Die übergeordnete Ressource, die von allen erstellten TargetSites gemeinsam genutzt wird. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine. Das übergeordnete Feld in den CreateBookRequest-Nachrichten muss entweder leer sein oder mit diesem Feld übereinstimmen.

requests[]

Erforderlich. Die Anfragenachricht, in der die zu erstellenden Ressourcen angegeben werden. In einem Batch können maximal 20 TargetSites erstellt werden.

BatchCreateTargetSitesResponse

Antwortnachricht für die Methode SiteSearchEngineService.BatchCreateTargetSites.

Felder

target_sites[]

TargetSites erstellt.

BatchGetDocumentsMetadataRequest

Anfragenachricht für die Methode DocumentService.BatchGetDocumentsMetadata.

Felder

parent

string

Erforderlich. Der Ressourcenname des übergeordneten Zweigs, z. B. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

matcher

Matcher

Erforderlich. Matcher für die Document.

FhirMatcher

Matcher für die Documents nach FHIR-Ressourcennamen.

Felder

fhir_resources[]

string

Erforderlich. Die FHIR-Ressourcen, die abgeglichen werden sollen. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}

Matcher

Matcher für die Document. Derzeit wird nur der Abgleich anhand exakter URIs unterstützt.

Felder

Union-Feld matcher. Matcher für die Document. Für matcher ist nur einer der folgenden Werte zulässig:

uris_matcher

UrisMatcher

Abgleich mit genauen URIs.

fhir_matcher

FhirMatcher

Abgleich nach FHIR-Ressourcennamen.

UrisMatcher

Matcher für die Documents nach genauen URIs.

Felder

uris[]

string

Die genauen URIs, die abgeglichen werden sollen.

BatchGetDocumentsMetadataResponse

Antwortnachricht für die Methode DocumentService.BatchGetDocumentsMetadata.

Felder

documents_metadata[]

Die Metadaten der Document.

DocumentMetadata

Die Metadaten eines Document.

Felder
`matcher_value`	`MatcherValue` Der Wert des Matchers, der zum Abgleichen des `Document` verwendet wurde.
`state`	`State` Der Status des Dokuments.
`last_refreshed_time`	`Timestamp` Der Zeitstempel der letzten Indexierung von `Document`.
`data_ingestion_source`	`string` Die Quelle für die Datenaufnahme von `Document`. Zulässige Werte sind: `batch`: Daten, die über die Batch API aufgenommen wurden, z.B. ImportDocuments. `streaming` Über die Streaming API aufgenommene Daten, z.B.: FHIR-Streaming

MatcherValue

Der Wert des Matchers, der zum Abgleichen des Document verwendet wurde.

Felder

Union-Feld matcher_value. Der Wert des Matchers, der zum Abgleichen des Document verwendet wurde. Für matcher_value ist nur einer der folgenden Werte zulässig:

uri

string

Wenn die Übereinstimmung nach URI erfolgt, der URI des Document.

fhir_resource

string

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

Bundesland

Der Status von Document.

Enums
`STATE_UNSPECIFIED`	Sollte nie festgelegt werden.
`INDEXED`	Das `Document` ist indexiert.
`NOT_IN_TARGET_SITE`	`Document` wird nicht indexiert, da der URI nicht in `TargetSite` enthalten ist.
`NOT_IN_INDEX`	Das `Document` ist nicht indexiert.

BatchUpdateUserLicensesMetadata

Metadaten zum Fortschritt des Vorgangs UserLicenseService.BatchUpdateUserLicenses. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder
`create_time`	`Timestamp` Erstellungszeit des Vorgangs.
`update_time`	`Timestamp` Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.
`success_count`	`int64` Anzahl der Nutzerlizenzen, die erfolgreich aktualisiert wurden.
`failure_count`	`int64` Anzahl der Nutzerlizenzen, die nicht aktualisiert werden konnten.

BatchUpdateUserLicensesRequest

Anfragenachricht für die Methode UserLicenseService.BatchUpdateUserLicenses.

Felder
`parent`	`string` Erforderlich. Der Ressourcenname des übergeordneten [UserStore][] im Format `projects/{project}/locations/{location}/userStores/{user_store_id}`.
`delete_unassigned_user_licenses`	`bool` Optional. Wenn „true“, wird die Nutzerlizenz gelöscht, wenn Nutzerlizenzen die zugehörige Lizenzkonfiguration entfernen. Standardmäßig (false) wird die Nutzerlizenz auf den Status „Nicht zugewiesen“ aktualisiert.
Union-Feld `source`. Erforderlich. Die Quelle der Eingabe. Für `source` ist nur einer der folgenden Werte zulässig:
`inline_source`	`InlineSource` Die Inline-Quelle für die Eingabeinhalte für Dokument-Embeddings.

InlineSource

Die Inline-Quelle für die Eingabekonfiguration für die Methode „BatchUpdateUserLicenses“.

Felder

user_licenses[]

UserLicense

Erforderlich. Eine Liste der zu aktualisierenden Nutzerlizenzen. Jede Nutzerlizenz muss eine gültige UserLicense.user_principal haben.

update_mask

Optional. Die Liste der zu aktualisierenden Felder.

BatchUpdateUserLicensesResponse

Antwortnachricht für die Methode UserLicenseService.BatchUpdateUserLicenses.

Felder

user_licenses[]

UserLicense

UserLicenses wurde aktualisiert.

error_samples[]

Ein Beispiel für Fehler, die bei der Verarbeitung der Anfrage aufgetreten sind.

BatchVerifyTargetSitesMetadata

Metadaten zum Fortschritt des Vorgangs SiteSearchEngineService.BatchVerifyTargetSites. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

BatchVerifyTargetSitesRequest

Anfragenachricht für die Methode SiteSearchEngineService.BatchVerifyTargetSites.

Felder

parent

string

Erforderlich. Die übergeordnete Ressource, die von allen zu überprüfenden TargetSites gemeinsam verwendet wird. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

BatchVerifyTargetSitesResponse

Dieser Typ hat keine Felder.

Antwortnachricht für die Methode SiteSearchEngineService.BatchVerifyTargetSites.

BigQuerySource

BigQuery-Quelle, aus der Daten importiert werden.

Felder
`project_id`	`string` Die Projekt-ID oder die Projektnummer, die die BigQuery-Quelle enthält. Die Länge ist auf 128 Zeichen begrenzt. Wenn keine Angabe erfolgt, wird die Projekt-ID von der übergeordneten Anfrage übernommen.
`dataset_id`	`string` Erforderlich. Das BigQuery-Dataset,aus dem die Daten kopiert werden sollen. Die maximale Länge beträgt 1.024 Zeichen.
`table_id`	`string` Erforderlich. Die BigQuery-Tabelle,aus der die Daten kopiert werden sollen. Die maximale Länge beträgt 1.024 Zeichen.
`gcs_staging_dir`	`string` Für den Import verwendetes Cloud Storage-Zwischenverzeichnis mit einer Längenbeschränkung von 2.000 Zeichen. Kann angegeben werden, wenn der BigQuery-Export in ein bestimmtes Cloud Storage-Verzeichnis erfolgen soll.
`data_schema`	`string` Das Schema, das beim Parsen der Daten aus der Quelle verwendet werden soll. Unterstützte Werte für den Import von Nutzerereignissen: `user_event` (Standard): Ein `UserEvent` pro Zeile. Unterstützte Werte für den Dokumentimport: `document` (Standard): Ein `Document`-Format pro Zeile. Jedes Dokument muss eine gültige `Document.id` und entweder `Document.json_data` oder `Document.struct_data` haben. `custom`: Eine benutzerdefinierte Dateneinheit pro Zeile in einem beliebigen Format, das der definierten `Schema` des Datenspeichers entspricht. Diese Funktion kann nur für die vertikale Branche „GENERIC Data Store“ verwendet werden.
Union-Feld `partition`. Informationen zur Partitionierung der BigQuery-Tabelle. Lassen Sie dieses Feld leer, wenn die BigQuery-Tabelle nicht partitioniert ist. Für `partition` ist nur einer der folgenden Werte zulässig:
`partition_date`	`Date` _PARTITIONDATE der zeitpartitionierten BigQuery-Tabelle im Format JJJJ-MM-TT.

BigtableOptions

Das Bigtable-Options-Objekt, das Informationen zur Unterstützung des Imports enthält.

Felder

key_field_name

string

Der Feldname, der zum Speichern des Zeilenschlüsselwerts im Dokument verwendet wird. Der Name muss dem Muster [a-zA-Z0-9][a-zA-Z0-9-_]* entsprechen.

families

map<string, BigtableColumnFamily>

Die Zuordnung von Familiennamen zu einem Objekt, das Informationen auf Spaltenfamilienebene für die angegebene Spaltenfamilie enthält. Wenn eine Familie in dieser Zuordnung nicht vorhanden ist, wird sie ignoriert.

BigtableColumn

Die Spalte der Bigtable-Tabelle.

Felder
`qualifier`	`bytes` Erforderlich. Qualifizierer der Spalte. Wenn es nicht mit UTF‑8 decodiert werden kann, verwenden Sie stattdessen einen Base64-codierten String.
`field_name`	`string` Der Feldname, der für diese Spalte im Dokument verwendet werden soll. Der Name muss dem Muster `[a-zA-Z0-9][a-zA-Z0-9-_]*` entsprechen. Wenn nicht festgelegt, wird sie nach bestem Wissen und Gewissen aus den Qualifier-Bytes geparst. Aufgrund unterschiedlicher Namensmuster kann es jedoch zu Kollisionen von Feldnamen kommen, bei denen das Parsing-Verhalten nicht definiert ist.
`encoding`	`Encoding` Der Codierungsmodus der Werte, wenn der Typ nicht `STRING` ist. Zulässige Codierungswerte: `TEXT`: Gibt an, dass die Werte alphanumerische Textstrings sind. `BINARY`: Gibt an, dass Werte mit der `HBase Bytes.toBytes`-Funktionsfamilie codiert werden. Dies kann für eine bestimmte Spalte überschrieben werden, indem Sie diese Spalte in `columns` auflisten und eine Codierung dafür angeben.
`type`	`Type` Der Typ der Werte in dieser Spaltenfamilie. Die Werte müssen mit der Funktion `HBase Bytes.toBytes` codiert werden, wenn der Codierungswert auf `BINARY` festgelegt ist.

BigtableColumnFamily

Die Spaltenfamilie der Bigtable-Tabelle.

Felder
`field_name`	`string` Der Feldname, der für diese Spaltenfamilie im Dokument verwendet werden soll. Der Name muss dem Muster `[a-zA-Z0-9][a-zA-Z0-9-_]*` entsprechen. Wenn sie nicht festgelegt ist, wird sie nach bestem Wissen und Gewissen aus dem Familiennamen geparst. Aufgrund unterschiedlicher Namensmuster kann es jedoch zu Kollisionen von Feldnamen kommen, bei denen das Parsing-Verhalten nicht definiert ist.
`encoding`	`Encoding` Der Codierungsmodus der Werte, wenn der Typ nicht STRING ist. Zulässige Codierungswerte: `TEXT`: Gibt an, dass die Werte alphanumerische Textstrings sind. `BINARY`: Gibt an, dass Werte mit der `HBase Bytes.toBytes`-Funktionsfamilie codiert werden. Dies kann für eine bestimmte Spalte überschrieben werden, indem Sie diese Spalte in `columns` auflisten und eine Codierung dafür angeben.
`type`	`Type` Der Typ der Werte in dieser Spaltenfamilie. Die Werte müssen mit der Funktion `HBase Bytes.toBytes` codiert werden, wenn der Codierungswert auf `BINARY` festgelegt ist.
`columns[]`	`BigtableColumn` Die Liste der Objekte, die Informationen auf Spaltenebene für jede Spalte enthält. Wenn eine Spalte nicht in dieser Liste enthalten ist, wird sie ignoriert.

Codierung

Der Codierungsmodus einer Bigtable-Spalte oder ‑Spaltenfamilie.

Enums
`ENCODING_UNSPECIFIED`	Die Codierung ist nicht angegeben.
`TEXT`	Textcodierung.
`BINARY`	Binärcodierung.

Typ

Der Typ der Werte in einer Bigtable-Spalte oder ‑Spaltenfamilie. Die Werte müssen mit der Funktion HBase Bytes.toBytes codiert werden, wenn der Codierungswert auf BINARY gesetzt ist.

Enums
`TYPE_UNSPECIFIED`	Der Typ ist nicht angegeben.
`STRING`	String-Typ.
`NUMBER`	Numerischer Typ
`INTEGER`	Ganzzahltyp.
`VAR_INTEGER`	Ganzzahltyp mit variabler Länge.
`BIG_NUMERIC`	BigDecimal-Typ.
`BOOLEAN`	Boolescher Typ.
`JSON`	JSON-Typ.

BigtableSource

Die Cloud Bigtable-Quelle zum Importieren von Daten.

Felder
`project_id`	`string` Die Projekt-ID, die die Bigtable-Quelle enthält. Die Länge ist auf 128 Zeichen begrenzt. Wenn keine Angabe erfolgt, wird die Projekt-ID von der übergeordneten Anfrage übernommen.
`instance_id`	`string` Erforderlich. Die Instanz-ID der Cloud Bigtable-Instanz, die importiert werden muss.
`table_id`	`string` Erforderlich. Die Tabellen-ID der Cloud Bigtable-Tabelle, die importiert werden muss.
`bigtable_options`	`BigtableOptions` Erforderlich. Bigtable-Optionen, die Informationen enthalten, die zum Parsen von Daten in typisierte Strukturen erforderlich sind. Das können beispielsweise Annotationen für Spaltentypen sein.

CheckGroundingRequest

Anfragenachricht für die Methode GroundedGenerationService.CheckGrounding.

Felder
`grounding_config`	`string` Erforderlich. Der Ressourcenname der Grounding-Konfiguration, z. B. `projects/*/locations/global/groundingConfigs/default_grounding_config`.
`answer_candidate`	`string` Antwortkandidat zur Überprüfung. Sie darf maximal 4.096 Tokens lang sein.
`facts[]`	`GroundingFact` Liste der Fakten für die Fundierungsprüfung. Wir unterstützen bis zu 200 Fakten.
`grounding_spec`	`CheckGroundingSpec` Konfiguration der Fundierungsprüfung.
`user_labels`	`map<string, string>` Die Nutzerlabels, die auf eine Ressource angewendet werden, müssen die folgenden Anforderungen erfüllen: Jede Ressource kann bis zu 64 Labels haben. Jedes Label muss ein Schlüssel/Wert-Paar sein. Schlüssel haben eine Mindestlänge von einem Zeichen und eine maximale Länge von 63 Zeichen und dürfen nicht leer sein. Werte dürfen leer sein und haben eine maximale Länge von 63 Zeichen. Schlüssel und Werte dürfen nur Kleinbuchstaben, Ziffern, Unterstriche und Bindestriche enthalten. Alle Zeichen müssen UTF-8-codiert sein. Internationale Zeichen sind zulässig. Der Schlüsselabschnitt eines Labels darf nur einmal vorkommen. Sie können jedoch denselben Schlüssel für mehrere Ressourcen verwenden. Schlüssel müssen mit einem Kleinbuchstaben oder einem internationalen Zeichen beginnen. Weitere Informationen finden Sie im Google Cloud-Dokument.

CheckGroundingResponse

Antwortnachricht für die Methode GroundedGenerationService.CheckGrounding.

Felder
`cited_chunks[]`	`FactChunk` Liste der Fakten, die in allen Behauptungen im Antwortkandidaten zitiert werden. Diese werden aus den in der Anfrage angegebenen Fakten abgeleitet.
`cited_facts[]`	`CheckGroundingFactChunk` Liste der Fakten, die in allen Behauptungen im Antwortkandidaten zitiert werden. Diese werden aus den in der Anfrage angegebenen Fakten abgeleitet.
`claims[]`	`Claim` Anspruchstexte und Zitationsinformationen für alle Ansprüche im Antwortkandidaten.
`support_score`	`float` Die Support-Bewertung für den Kandidaten für die Eingabeantwort. Je höher der Wert, desto höher ist der Anteil der Behauptungen, die durch die bereitgestellten Fakten gestützt werden. Diese wird immer festgelegt, wenn eine Antwort zurückgegeben wird.

CheckGroundingFactChunk

Faktenblock für die Fundierungsprüfung.

Felder

chunk_text

string

Textinhalt des Faktenblocks. Darf höchstens 10.000 Zeichen lang sein.

Anforderung

Text und Zitationsinformationen für eine Behauptung im Antwortvorschlag.

Felder
`claim_text`	`string` Text für die Behauptung im Antwortvorschlag. Wird immer bereitgestellt, unabhängig davon, ob Zitationen oder Anti-Zitationen gefunden werden.
`citation_indices[]`	`int32` Eine Liste von Indexen (in „cited_chunks“), die die mit der Behauptung verknüpften Quellenangaben angeben. Beispiel: [1,3,4] bedeutet, dass cited_chunks[1], cited_chunks[3] und cited_chunks[4] die Fakten sind, die die Behauptung stützen. Eine Quellenangabe zu einer Tatsache weist darauf hin, dass die Behauptung durch die Tatsache gestützt wird.
`start_pos`	`int32` Position, die den Beginn der Behauptung im Antwortkandidaten angibt, gemessen in Byte. Die Länge wird nicht in Zeichen gemessen. Daher muss bei der Darstellung auf der Benutzeroberfläche berücksichtigt werden, dass einige Zeichen mehr als ein Byte belegen können. Wenn der Anspruchstext beispielsweise Nicht-ASCII-Zeichen enthält, variieren die Start- und Endpositionen, wenn sie in Zeichen (programmiersprachenabhängig) und in Byte (programmiersprachenunabhängig) gemessen werden.
`end_pos`	`int32` Position, die das Ende der Behauptung im Antwortkandidaten angibt (exklusiv), in Byte. Die Länge wird nicht in Zeichen gemessen und muss daher entsprechend gerendert werden. Wenn der Anspruchstext beispielsweise Nicht-ASCII-Zeichen enthält, variieren die Start- und Endpositionen, wenn sie in Zeichen (programmiersprachenabhängig) und in Byte (programmiersprachenunabhängig) gemessen werden.
`grounding_check_required`	`bool` Gibt an, dass für diesen Anspruch eine Fundierungsprüfung erforderlich war. Wenn das System entschieden hat, dass für diese Behauptung keine Attributions-/Fundierungsprüfung erforderlich ist, wird dieses Feld auf „false“ gesetzt. In diesem Fall wurde keine Fundierungsprüfung für die Behauptung durchgeführt. Daher sollte `citation_indices` nicht zurückgegeben werden.
`score`	`double` Konfidenzwert für die Behauptung im Antwortkandidaten im Bereich [0, 1]. Wird nur festgelegt, wenn `CheckGroundingRequest.grounding_spec.enable_claim_level_score` „true“ ist.

CheckGroundingSpec

Spezifikation für die Fundierungsprüfung.

Felder

citation_threshold

double

Der Schwellenwert (im Bereich [0,1]), der verwendet wird, um zu bestimmen, ob für eine Behauptung im Antwortvorschlag eine Quelle angegeben werden muss. Wenn Sie einen höheren Schwellenwert wählen, erhalten Sie weniger, aber sehr starke Zitationen. Wenn Sie einen niedrigeren Schwellenwert wählen, erhalten Sie möglicherweise mehr, aber etwas schwächere Zitationen. Wenn nicht festgelegt, wird der Schwellenwert standardmäßig auf 0,6 gesetzt.

enable_claim_level_score

bool

Das Kontrollflag, das den Fundierungs-Score auf Behauptungsebene in der Antwort aktiviert.

Chunk

Im Chunk werden alle Rohmetadateninformationen von Elementen erfasst, die im Chunk-Modus empfohlen oder gesucht werden sollen.

Felder
`name`	`string` Der vollständige Ressourcenname des Chunks. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.
`id`	`string` Eindeutige Chunk-ID des aktuellen Chunks.
`content`	`string` „Inhalt“ ist ein String aus einem Dokument (geparster Inhalt).
`document_metadata`	`DocumentMetadata` Metadaten des Dokuments aus dem aktuellen Chunk.
`derived_struct_data`	`Struct` Nur Ausgabe. Dieses Feld dient nur der Ausgabe. Es enthält abgeleitete Daten, die nicht im ursprünglichen Eingabedokument enthalten sind.
`page_span`	`PageSpan` Seitenbereich des Blocks.
`chunk_metadata`	`ChunkMetadata` Nur Ausgabe. Metadaten des aktuellen Chunks.
`data_urls[]`	`string` Nur Ausgabe. Bilddaten-URLs, wenn der aktuelle Chunk Bilder enthält. Data-URLs bestehen aus vier Teilen: einem Präfix (data:), einem MIME-Typ, der den Datentyp angibt, einem optionalen base64-Token, wenn die Daten nicht textbasiert sind, und den Daten selbst: data:[][;base64],
`annotation_contents[]`	`string` Nur Ausgabe. Inhalt der Anmerkungen, wenn der aktuelle Chunk Anmerkungen enthält.
`annotation_metadata[]`	`AnnotationMetadata` Nur Ausgabe. Die Metadaten der Anmerkung enthalten strukturierte Inhalte im aktuellen Chunk.
`relevance_score`	`double` Nur Ausgabe. Stellt die Relevanzbewertung basierend auf der Ähnlichkeit dar. Ein höherer Wert weist auf eine höhere Relevanz des Chunks hin. Der Wert liegt im Bereich [-1,0, 1,0]. Wird nur für `SearchResponse` ausgefüllt.

AnnotationMetadata

Die Metadaten der Anmerkung enthalten strukturierte Inhalte im aktuellen Chunk.

Felder

structured_content

StructuredContent

Nur Ausgabe. Informationen zu strukturierten Inhalten.

image_id

string

Nur Ausgabe. Die Bild-ID wird angegeben, wenn die strukturierten Inhalte auf einem Bild basieren.

ChunkMetadata

Metadaten des aktuellen Chunks. Dieses Feld wird nur in der SearchService.Search API ausgefüllt.

Felder

previous_chunks[]

Chunk

Die vorherigen Chunks des aktuellen Chunks. Die Nummer wird von SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks verwaltet. Dieses Feld wird nur in der SearchService.Search API ausgefüllt.

next_chunks[]

Chunk

Die nächsten Chunks des aktuellen Chunks. Die Nummer wird von SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks verwaltet. Dieses Feld wird nur in der SearchService.Search API ausgefüllt.

DocumentMetadata

Dokumentmetadaten enthalten die Informationen des Dokuments des aktuellen Chunks.

Felder
`uri`	`string` URI des Dokuments.
`title`	`string` Titel des Dokuments.
`mime_type`	`string` Der MIME-Typ des Dokuments. https://www.iana.org/assignments/media-types/media-types.xhtml.
`struct_data`	`Struct` Datendarstellung Die strukturierten JSON-Daten für das Dokument. Sie muss der registrierten `Schema` entsprechen, andernfalls wird ein `INVALID_ARGUMENT`-Fehler ausgegeben.

PageSpan

Seitenbereich des Blocks.

Felder

page_start

int32

Die Startseite des Chunks.

page_end

int32

Die Endseite des Chunks.

StructureType

Definiert die Typen der strukturierten Inhalte, die extrahiert werden können.

Enums
`STRUCTURE_TYPE_UNSPECIFIED`	Standardwert.
`SHAREHOLDER_STRUCTURE`	Aktionärsstruktur.
`SIGNATURE_STRUCTURE`	Signaturstruktur
`CHECKBOX_STRUCTURE`	Kästchenstruktur.

StructuredContent

Informationen zu strukturierten Inhalten.

Felder

structure_type

StructureType

Nur Ausgabe. Der Strukturtyp des strukturierten Inhalts.

content

string

Nur Ausgabe. Der Inhalt der strukturierten Inhalte.

Quellenangabe

Quellenangaben für Inhalte.

Felder
`start_index`	`int32` Nur Ausgabe. Startindex im Inhalt.
`end_index`	`int32` Nur Ausgabe. Endindex für den Inhalt.
`uri`	`string` Nur Ausgabe. URL-Referenz der Attribution.
`title`	`string` Nur Ausgabe. Titel der Quellenangabe.
`license`	`string` Nur Ausgabe. Lizenz der Namensnennung.
`publication_date`	`Date` Nur Ausgabe. Das Veröffentlichungsdatum der Quellenangabe.

Zitat-MetadatenS

Eine Sammlung von Quellenangaben für einen Inhalt.

Felder

citations[]

Citation

Nur Ausgabe. Liste der Zitationen.

CloudSqlSource

Cloud SQL-Quelle, aus der Daten importiert werden.

Felder
`project_id`	`string` Die Projekt-ID des Projekts, das die Cloud SQL-Quelle enthält. Die Länge ist auf 128 Zeichen begrenzt. Wenn keine Angabe erfolgt, wird die Projekt-ID von der übergeordneten Anfrage übernommen.
`instance_id`	`string` Erforderlich. Die Cloud SQL-Instanz, aus der die Daten kopiert werden sollen. Die maximale Länge beträgt 256 Zeichen.
`database_id`	`string` Erforderlich. Die Cloud SQL-Datenbank, aus der die Daten kopiert werden sollen. Die maximale Länge beträgt 256 Zeichen.
`table_id`	`string` Erforderlich. Die Cloud SQL-Tabelle, aus der die Daten kopiert werden sollen. Die maximale Länge beträgt 256 Zeichen.
`gcs_staging_dir`	`string` Für den Import verwendetes Cloud Storage-Zwischenverzeichnis mit einer Längenbeschränkung von 2.000 Zeichen. Kann angegeben werden, wenn der Cloud SQL-Export in ein bestimmtes Cloud Storage-Verzeichnis erfolgen soll. Achten Sie darauf, dass das Cloud SQL-Dienstkonto die erforderlichen Cloud Storage-Administratorberechtigungen für den Zugriff auf das angegebene Cloud Storage-Verzeichnis hat.
`offload`	`bool` Option für den serverlosen Export. Durch Aktivieren dieser Option fallen zusätzliche Kosten an. Weitere Informationen

CmekConfig

Konfigurationen, die zum Aktivieren der CMEK-Datenverschlüsselung mit Cloud KMS-Schlüsseln verwendet werden.

Felder
`name`	`string` Erforderlich. Der Name der CmekConfig im Format `projects/{project}/locations/{location}/cmekConfig` oder `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
`kms_key`	`string` Erforderlich. Der Ressourcenname des KMS-Schlüssels, der zum Verschlüsseln von Ressourcen `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}` verwendet wird.
`kms_key_version`	`string` Nur Ausgabe. Ressourcenname der KMS-Schlüsselversion, die zum Verschlüsseln von Ressourcen `<kms_key>/cryptoKeyVersions/{keyVersion}` verwendet wird.
`state`	`State` Nur Ausgabe. Die Status der CmekConfig.
`is_default`	`bool` Nur Ausgabe. Die Standard-CmekConfig für den Kunden.
`last_rotation_timestamp_micros`	`int64` Nur Ausgabe. Der Zeitstempel der letzten Schlüsselrotation.
`single_region_keys[]`	`SingleRegionKey` Optional. Einzelregionale CMEKs, die für einige VAIS-Funktionen erforderlich sind.
`notebooklm_state`	`NotebookLMState` Nur Ausgabe. Gibt an, ob das NotebookLM-Corpus verwendet werden kann.

NotebookLMState

Status von NotebookLM

Enums
`NOTEBOOK_LM_STATE_UNSPECIFIED`	Der Status von NotebookLM ist unbekannt.
`NOTEBOOK_LM_NOT_READY`	NotebookLM ist nicht bereit.
`NOTEBOOK_LM_READY`	NotebookLM kann jetzt verwendet werden.
`NOTEBOOK_LM_NOT_ENABLED`	NotebookLM ist nicht aktiviert.

Bundesland

Status der CmekConfig.

Enums
`STATE_UNSPECIFIED`	Der Status von CmekConfig ist unbekannt.
`CREATING`	Die CmekConfig wird erstellt.
`ACTIVE`	CmekConfig kann mit DataStores verwendet werden.
`KEY_ISSUE`	Die CmekConfig ist nicht verfügbar, höchstwahrscheinlich, weil der KMS-Schlüssel widerrufen wurde.
`DELETING`	Die CmekConfig wird gelöscht.
`DELETE_FAILED`	Das Löschen der CmekConfig ist fehlgeschlagen.
`UNUSABLE`	Die CmekConfig ist wahrscheinlich aufgrund eines internen Problems nicht nutzbar.
`ACTIVE_ROTATING`	Die KMS-Schlüsselversion wird rotiert.
`DELETED`	Der KMS-Schlüssel wurde vorläufig gelöscht. Es wird eine Bereinigungsrichtlinie angewendet.
`EXPIRED`	Der KMS-Schlüssel ist abgelaufen. Das bedeutet, dass der Schlüssel seit mehr als 30 Tagen deaktiviert ist. Der Kunde kann DeleteCmekConfig aufrufen, um den Status in DELETED zu ändern.

CollectUserEventRequest

Anfragenachricht für die Methode „CollectUserEvent“.

Felder
`parent`	`string` Erforderlich. Der Name der übergeordneten Ressource. Wenn die Aktion „Nutzerereignis erfassen“ auf `DataStore`-Ebene angewendet wird, lautet das Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. Wenn die Aktion „Nutzerereignis erfassen“ beispielsweise auf `Location`-Ebene angewendet wird, ist das Format für das Ereignis mit `Document` über mehrere `DataStore` hinweg: `projects/{project}/locations/{location}`.
`user_event`	`string` Erforderlich. URL-codiertes UserEvent-Proto mit einer Längenbeschränkung von 2.000.000 Zeichen.
`uri`	`string` Die URL einschließlich CGI-Parameter,aber ohne das Hash-Fragment. Die Länge ist auf 5.000 Zeichen begrenzt. Das ist oft nützlicher als die Referrer-URL, da viele Browser nur die Domain für Anfragen von Drittanbietern senden.
`ets`	`int64` Der Zeitstempel des Ereignisses in Millisekunden. Dadurch wird verhindert, dass Browser ansonsten identische GET-Anfragen im Cache speichern. Der Name wird abgekürzt, um die Nutzlastbyte zu reduzieren.

Sammlung

Eine Sammlung ist ein Container zum Konfigurieren von Ressourcen und des Zugriffs auf eine Reihe von DataStores.

Felder

name

string

Nicht veränderbar. Der vollständige Ressourcenname der Sammlung. Format: projects/{project}/locations/{location}/collections/{collection_id}.

Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.

display_name

string

Erforderlich. Der Anzeigename der Sammlung.

Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 128 Zeichen sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

create_time

Nur Ausgabe. Zeitstempel für die Erstellung von Collection.

CompleteQueryRequest

Anfragenachricht für die Methode CompletionService.CompleteQuery.

Felder
`data_store`	`string` Erforderlich. Der Name der übergeordneten Datenbankspeicherressource, für die die Vervollständigung ausgeführt wird, z. B. `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
`query`	`string` Erforderlich. Die Typeahead-Eingabe, mit der Vorschläge abgerufen werden. Die maximale Länge beträgt 128 Zeichen.
`query_model`	`string` Gibt das Datenmodell für die automatische Vervollständigung an. Dadurch wird jedes Modell überschrieben, das in der Cloud Console unter „Konfiguration“ > „Autovervollständigung“ angegeben ist. Derzeit unterstützte Werte: `document` – Vorschläge aus von Nutzern importierten Dokumenten verwenden `search-history` – Vorschläge verwenden, die anhand des bisherigen Verlaufs von `SearchService.Search`-API-Aufrufen generiert wurden. Verwenden Sie sie nicht, wenn kein Traffic für die Search API vorhanden ist. `user-event` – Es werden Vorschläge verwendet, die aus von Nutzern importierten Suchvorgängen generiert wurden. `document-completable`: Vorschläge werden direkt aus den vom Nutzer importierten Dokumentfeldern übernommen, die als „Vervollständigbar“ gekennzeichnet sind. Standardwerte: `document` ist das Standardmodell für reguläre DataStores. `search-history` ist das Standardmodell für DataStores für die Websitesuche.
`user_pseudo_id`	`string` Eine eindeutige Kennung für das Tracking von Besuchern. Dies kann beispielsweise mit einem HTTP-Cookie implementiert werden, mit dem ein Besucher auf einem einzelnen Gerät eindeutig identifiziert werden kann. Diese eindeutige Kennung sollte sich nicht ändern, wenn sich der Besucher auf der Website an- oder abmeldet. Dieses Feld sollte KEINEN festen Wert wie `unknown_visitor` haben. Dies sollte dieselbe Kennung wie `UserEvent.user_pseudo_id` und `SearchRequest.user_pseudo_id` sein. Das Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 128 Zeichen sein. Andernfalls wird der Fehler `INVALID_ARGUMENT` zurückgegeben.
`include_tail_suggestions`	`bool` Gibt an, ob Vorschläge für den Schlussteil zurückgegeben werden sollen, wenn es keine Vorschläge gibt, die der vollständigen Anfrage entsprechen. Auch wenn der Wert auf „true“ gesetzt ist, werden Vorschläge, die der vollständigen Anfrage entsprechen, zurückgegeben und keine Vorschläge für den Tail.

CompleteQueryResponse

Antwortnachricht für die Methode CompletionService.CompleteQuery.

Felder

query_suggestions[]

QuerySuggestion

Ergebnisse der übereinstimmenden Suchvorschläge. Die Ergebnisliste ist sortiert und das erste Ergebnis ist ein Top-Vorschlag.

tail_match_triggered

bool

„True“, wenn alle zurückgegebenen Vorschläge Tail-Vorschläge sind.

Damit die Endenübereinstimmung ausgelöst wird, muss „include_tail_suggestions“ in der Anfrage auf „true“ gesetzt sein und es darf keine Vorschläge geben, die der vollständigen Anfrage entsprechen.

QuerySuggestion

Vorschläge als Suchanfragen.

Felder

suggestion

string

Der Vorschlag für die Abfrage.

completable_field_paths[]

string

Die eindeutigen Dokumentfeldpfade, die als Quelle für diesen Vorschlag dienen, wenn er aus vervollständigbaren Feldern generiert wurde.

Dieses Feld wird nur für das Modell ausgefüllt, das Dokumente vervollständigen kann.

CompletionInfo

Detaillierte Informationen zum Abschluss, einschließlich des Attributions-Tokens für den Abschluss und der Informationen zum angeklickten Abschluss.

Felder

selected_suggestion

string

Endnutzer CompleteQueryResponse.QuerySuggestion.suggestion ausgewählt.

selected_position

int32

Die vom Endnutzer ausgewählte Position CompleteQueryResponse.QuerySuggestion.suggestion, beginnend mit 0.

CompletionSuggestion

Vorschläge zur automatischen Vervollständigung, die vom Kunden importiert werden.

Felder
`suggestion`	`string` Erforderlich. Der Text des Vorschlags.
`language_code`	`string` BCP-47-Sprachcode dieses Vorschlags.
`group_id`	`string` Wenn zwei Vorschläge dieselbe „groupId“ haben, werden sie nicht zusammen zurückgegeben. Stattdessen wird das höher eingestufte zurückgegeben. Damit lassen sich semantisch identische Vorschläge deduplizieren.
`group_score`	`double` Die Punktzahl dieses Vorschlags innerhalb seiner Gruppe.
`alternative_phrases[]`	`string` Alternative passende Formulierungen für diesen Vorschlag.
Union-Feld `ranking_info`. Ranking-Messwerte dieses Vorschlags. Für `ranking_info` ist nur einer der folgenden Werte zulässig:
`global_score`	`double` Globaler Wert dieses Vorschlags. Festlegen, wie dieser Vorschlag bewertet / eingeordnet werden soll.
`frequency`	`int64` Häufigkeit dieses Vorschlags. Wird verwendet, um Vorschläge zu sortieren, wenn kein Score verfügbar ist.

Bedingung

Definiert Umstände, die geprüft werden müssen, bevor ein Verhalten zugelassen wird

Felder

query_terms[]

QueryTerm

Nur suchen Eine Liste mit Begriffen, die mit der Anfrage übereinstimmen sollen. Kann nicht festgelegt werden, wenn Condition.query_regex festgelegt ist.

Maximal 10 Suchbegriffe.

active_time_range[]

TimeRange

Zeitbereich(e), der angibt, wann die Bedingung aktiv ist.

Maximal 10 Zeiträume.

query_regex

string

Optional. Regulärer Ausdruck für die Abfrage, der mit der gesamten Suchanfrage übereinstimmen muss. Kann nicht festgelegt werden, wenn Condition.query_terms festgelegt ist. Nur für die Steuerelemente für die Bereitstellung von Werbeaktionen für die einfache Websitesuche unterstützt.

QueryTerm

Matcher für die Abfrage der Suchanfrage

Felder

value

string

Der spezifische Abfragewert, mit dem abgeglichen werden soll

Muss in Kleinbuchstaben und UTF-8-codiert sein. Kann höchstens drei durch Leerzeichen getrennte Begriffe enthalten, wenn „full_match“ auf „true“ gesetzt ist. Darf kein leerer String sein. Maximale Länge: 5.000 Zeichen.

full_match

bool

Gibt an, ob die Suchanfrage genau mit dem Abfragebegriff übereinstimmen muss.

TimeRange

Wird für zeitabhängige Bedingungen verwendet.

Felder

start_time

Beginn des Zeitraums.

Der Bereich ist inklusiv.

end_time

Ende des Zeitraums.

Der Bereich ist inklusiv. Muss in der Zukunft liegen.

ConnectorType

Der Typ des Connectors.

Enums
`CONNECTOR_TYPE_UNSPECIFIED`	Standardwert.
`THIRD_PARTY`	Drittanbieter-Connector zum Herstellen einer Verbindung zu einer Drittanbieteranwendung.
`GCP_FHIR`	Der Datenconnector stellt eine Verbindung zwischen dem FHIR-Speicher und dem VAIS-Datenspeicher her.
`BIG_QUERY`	BigQuery-Connector
`GCS`	Google Cloud Storage-Connector
`GOOGLE_MAIL`	Gmail-Connector
`GOOGLE_CALENDAR`	Google Kalender Connector
`GOOGLE_DRIVE`	Google Drive-Connector.
`NATIVE_CLOUD_IDENTITY`	Nativer Cloud Identity-Connector für die Personensuche auf Grundlage der People API.
`THIRD_PARTY_FEDERATED`	Föderierter Connector: Ein Drittanbieter-Connector, mit dem keine Daten aufgenommen werden. Die Suche wird über die API der Drittanbieteranwendung ausgeführt.
`THIRD_PARTY_EUA`	Connector, der für die Funktionen zur Endnutzerauthentifizierung verwendet wird.
`GCNV`	Google Cloud NetApp Volumes Connector

ContactDetails

Die auf Ressourcenebene gespeicherten Kontaktdaten. Wenn sowohl die Projekt- als auch die Ressourcenebene ausgefüllt ist, werden die Kontaktinformationen auf Ressourcenebene durch die Kontaktinformationen auf Projektebene überschrieben.

Felder

email_address

string

Optional. Die E-Mail-Adresse des Kontakts.

Steuerung

Definiert ein bedingtes Verhalten, das bei der Bereitstellung verwendet werden soll. Muss an ein ServingConfig angehängt sein, damit es bei der Auslieferung berücksichtigt wird. Zulässige Aktionen in Abhängigkeit von SolutionType.

Felder
`name`	`string` Nicht veränderbar. Vollständig qualifizierter Name `projects//locations/global/dataStore//controls/*`
`display_name`	`string` Erforderlich. Für Menschen lesbarer Name. Die in UI-Ansichten verwendete Kennung. Muss ein UTF-8-codierter String sein. Die maximale Länge beträgt 128 Zeichen. Andernfalls wird ein INVALID_ARGUMENT-Fehler ausgegeben.
`associated_serving_config_ids[]`	`string` Nur Ausgabe. Liste aller `ServingConfig`-IDs, an die dieses Steuerelement angehängt ist. Nach Änderungen kann es bis zu 10 Minuten dauern, bis die Aktualisierung erfolgt.
`solution_type`	`SolutionType` Erforderlich. Nicht veränderbar. Zu welcher Lösung das Steuerelement gehört. Muss mit der Branche der Ressource kompatibel sein. Andernfalls wird ein INVALID_ARGUMENT-Fehler ausgegeben.
`use_cases[]`	`SearchUseCase` Gibt den Anwendungsfall für die Kontrollvariablen an. Wirkt sich darauf aus, welche Bedingungsfelder festgelegt werden können. Gilt nur für `SOLUTION_TYPE_SEARCH`. Derzeit ist nur ein Anwendungsfall pro Steuerelement zulässig. Muss festgelegt werden, wenn „solution_type“ `SolutionType.SOLUTION_TYPE_SEARCH` ist.
`conditions[]`	`Condition` Bestimmt, wann die zugehörige Aktion ausgelöst wird. Lassen Sie das Feld leer, um die Aktion immer anzuwenden. Derzeit kann nur eine Bedingung angegeben werden. Andernfalls wird ein INVALID_ARGUMENT-Fehler ausgegeben.
Union-Feld `action`. Aktionen sind nach Branche und Lösung eingeschränkt Erforderlich. Für `action` ist nur einer der folgenden Werte zulässig:
`boost_action`	`BoostAction` Definiert eine Kontrollgruppe vom Typ „Steigerung“
`filter_action`	`FilterAction` Definiert eine Filtersteuerung. Wird derzeit nicht von Recommendation unterstützt.
`redirect_action`	`RedirectAction` Definiert ein Steuerelement vom Typ „Weiterleitung“.
`synonyms_action`	`SynonymsAction` Behandelt eine Gruppe von Begriffen als Synonyme.
`promote_action`	`PromoteAction` Bestimmte Links auf Grundlage vordefinierter Triggeranfragen bewerben.

BoostAction

Passt die Reihenfolge der Produkte in der zurückgegebenen Liste an.

Felder
`boost (deprecated)`	`float` Dieses Element ist veraltet. Stärke des Boostings, die im Bereich [-1, 1] liegen sollte. Negatives Boosting bedeutet Abwertung. Der Standardwert ist 0,0 (keine Operation).
`filter`	`string` Erforderlich. Gibt an, auf welche Produkte der Boost angewendet werden soll. Wenn kein Filter angegeben ist, werden alle Produkte beworben (No-op). Dokumentation zur Syntax: https://cloud.google.com/retail/docs/filter-and-order. Die maximale Länge beträgt 5.000 Zeichen. Andernfalls wird ein INVALID_ARGUMENT-Fehler ausgegeben.
`data_store`	`string` Erforderlich. Gibt an, welche Dokumente des Datenspeichers durch diese Einstellung hochgestuft werden können. Vollständiger Name des Datenspeichers, z.B. „projects/123/locations/global/collections/default_collection/dataStores/default_data_store“
Union-Feld `boost_spec`. Spezifikationen für die Steigerung durch einen konstanten Wert oder für benutzerdefiniertes Ranking. Für `boost_spec` ist nur einer der folgenden Werte zulässig:
`fixed_boost`	`float` Optional. Stärke des Boostings, die im Bereich [-1, 1] liegen sollte. Negatives Boosting bedeutet Abwertung. Der Standardwert ist 0,0 (keine Operation).
`interpolation_boost_spec`	`InterpolationBoostSpec` Optional. Komplexe Spezifikation für benutzerdefiniertes Ranking basierend auf einem vom Kunden definierten Attributwert.

InterpolationBoostSpec

Spezifikation für benutzerdefiniertes Ranking basierend auf einem vom Kunden angegebenen Attributwert. Sie bietet mehr Steuerungsmöglichkeiten für das benutzerdefinierte Ranking als die einfache Kombination aus „Bedingung“ und „Steigerung“ oben.

Felder
`field_name`	`string` Optional. Der Name des Felds, dessen Wert zur Bestimmung des Steigerungsbetrags verwendet wird.
`attribute_type`	`AttributeType` Optional. Der Attributtyp, der zum Ermitteln des Steigerungsbetrags verwendet werden soll. Der Attributwert kann aus dem Feldwert des angegebenen „field_name“ abgeleitet werden. Bei numerischen Werten ist das ganz einfach: attribute_value = numerical_field_value. Im Fall von „Aktualität“ gilt jedoch: attribute_value = (time.now() – datetime_field_value).
`interpolation_type`	`InterpolationType` Optional. Der Interpolationstyp, der zum Verbinden der unten aufgeführten Kontrollpunkte angewendet werden soll.
`control_points[]`	`ControlPoint` Optional. Die Kontrollpunkte, mit denen die Kurve definiert wird. Die monotone Funktion (die oben über „interpolation_type“ definiert wurde) verläuft durch die hier aufgeführten Kontrollpunkte.

AttributeType

Das Attribut(oder die Funktion), auf das bzw. die das benutzerdefinierte Ranking angewendet werden soll.

Enums
`ATTRIBUTE_TYPE_UNSPECIFIED`	Nicht angegebener AttributeType.
`NUMERICAL`	Der Wert des numerischen Felds wird verwendet, um den Steigerungsbetrag dynamisch zu aktualisieren. In diesem Fall ist der „attribute_value“ (der x-Wert) des Kontrollpunkts der tatsächliche Wert des numerischen Felds, für das „boost_amount“ angegeben ist.
`FRESHNESS`	Im Anwendungsfall „Aktualität“ ist der Attributwert die Dauer zwischen der aktuellen Uhrzeit und dem Datum im angegebenen Datums-/Uhrzeitfeld. Der Wert muss als XSD-`dayTimeDuration`-Wert formatiert sein (eine eingeschränkte Teilmenge eines ISO 8601-Dauerwerts). Das Muster dafür ist: `[nD][T[nH][nM][nS]]`. Beispiele: `5D`, `3DT12H30M`, `T24H`.

ControlPoint

Die Kontrollpunkte, mit denen die Kurve definiert wird. Die durch diese Kontrollpunkte definierte Kurve kann nur monoton steigend oder fallend sein(konstante Werte sind zulässig).

Felder

attribute_value

string

Optional. Kann einer der folgenden Werte sein: 1. Der numerische Feldwert. 2. Die Dauerangabe für die Aktualität: Der Wert muss als XSD-dayTimeDuration-Wert formatiert sein (eine eingeschränkte Teilmenge eines ISO 8601-Dauerwerts). Das Muster dafür ist: [nD][T[nH][nM][nS]].

boost_amount

float

Optional. Der Wert zwischen -1 und 1, um den die Punktzahl erhöht werden soll, wenn der „attribute_value“ dem oben angegebenen Wert entspricht.

InterpolationType

Der anzuwendende Interpolationstyp. Der Standardwert ist „linear“ (Piecewise Linear).

Enums
`INTERPOLATION_TYPE_UNSPECIFIED`	Der Interpolationstyp ist nicht angegeben. In diesem Fall wird standardmäßig „Linear“ verwendet.
`LINEAR`	Es wird eine stückweise lineare Interpolation angewendet.

FilterAction

Gibt an, welche Produkte in die Ergebnisse aufgenommen werden dürfen. Verwendet denselben Filter wie die Steigerung.

Felder

filter

string

Erforderlich. Ein Filter, der auf die Ergebnisse der Abgleichsbedingung angewendet werden soll.

Erforderliche Dokumentation zur Syntax: https://cloud.google.com/retail/docs/filter-and-order. Die maximale Länge beträgt 5.000 Zeichen. Andernfalls wird ein INVALID_ARGUMENT-Fehler ausgegeben.

data_store

string

Erforderlich. Gibt an, welche Dokumente des Datenspeichers durch diese Einstellung gefiltert werden können. Vollständiger Name des Datenspeichers, z.B. „projects/123/locations/global/collections/default_collection/dataStores/default_data_store“

PromoteAction

Bestimmte Links basierend auf einigen Triggeranfragen bewerben.

Beispiel: Link zum Schuhgeschäft bewerben, wenn nach dem Keyword shoe gesucht wird. Der Link kann sich außerhalb des zugehörigen Datenspeichers befinden.

Felder

data_store

string

Erforderlich. Datenspeicher, dem dieses Angebot zugeordnet ist.

search_link_promotion

SearchLinkPromotion

Erforderlich. Mit dieser Aktion verknüpftes Angebot.

RedirectAction

Leitet einen Käufer an den angegebenen URI weiter.

Felder

redirect_uri

string

Erforderlich. Der URI, an den der Käufer weitergeleitet wird.

Erforderlich. Der URI darf maximal 2.000 Zeichen lang sein. Andernfalls wird ein INVALID_ARGUMENT-Fehler ausgegeben.

SynonymsAction

Erstellt eine Gruppe von Begriffen, die als Synonyme fungieren.

Beispiel: „happy“ wird auch als „glad“ betrachtet und „glad“ wird auch als „happy“ betrachtet.

Felder

synonyms[]

string

Definiert eine Gruppe von Synonymen. Sie können bis zu 100 Synonyme angeben. Es müssen mindestens zwei Synonyme angegeben werden. Andernfalls wird ein INVALID_ARGUMENT-Fehler ausgegeben.

Unterhaltung

Proto-Definition für externe Unterhaltungen.

Felder
`name`	`string` Nicht veränderbar. Vollständig qualifizierter Name `projects/{project}/locations/global/collections/{collection}/dataStore//conversations/` oder `projects/{project}/locations/global/collections/{collection}/engines//conversations/`.
`state`	`State` Der Status der Unterhaltung.
`user_pseudo_id`	`string` Eine eindeutige Kennung für das Tracking von Nutzern.
`messages[]`	`ConversationMessage` Unterhaltungsnachrichten.
`start_time`	`Timestamp` Nur Ausgabe. Der Zeitpunkt, zu dem die Unterhaltung begonnen hat.
`end_time`	`Timestamp` Nur Ausgabe. Die Uhrzeit, zu der die Unterhaltung beendet wurde.

Bundesland

Aufzählung des Status der Unterhaltung.

Enums
`STATE_UNSPECIFIED`	Unbekannt.
`IN_PROGRESS`	Die Unterhaltung ist derzeit geöffnet.
`COMPLETED`	Die Unterhaltung ist beendet.

ConversationContext

Definiert den Kontext der Unterhaltung

Felder

context_documents[]

string

Die aktuelle Liste der Dokumente, die der Nutzer sieht. Sie enthält die Dokumentressourcenreferenzen.

active_document

string

Das aktuelle aktive Dokument, das der Nutzer geöffnet hat. Sie enthält die Dokumentressourcenreferenz.

ConversationMessage

Definiert eine Unterhaltungsnachricht.

Felder
`create_time`	`Timestamp` Nur Ausgabe. Zeitstempel der Nachrichtenerstellung.
Union-Feld `message`. Für `message` ist nur einer der folgenden Werte zulässig:
`user_input`	`TextInput` Texteingabe durch Nutzer.
`reply`	`Reply` Suchantwort.

ConverseConversationRequest

Anfragenachricht für die Methode ConversationalSearchService.ConverseConversation.

Felder
`name`	`string` Erforderlich. Der Ressourcenname der abzurufenden Konversation. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Verwenden Sie `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`, um den automatischen Sitzungsmodus zu aktivieren. Dadurch wird automatisch eine neue Unterhaltung in einer ConverseConversation-Sitzung erstellt.
`query`	`TextInput` Erforderlich. Aktuelle Nutzereingabe.
`serving_config`	`string` Der Ressourcenname der zu verwendenden Bereitstellungskonfiguration. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` Wenn dies nicht festgelegt ist, wird die Standardkonfiguration für die Bereitstellung verwendet.
`conversation`	`Conversation` Die Unterhaltung, die nur für die automatische Sitzung verwendet werden soll. Das Namensfeld wird ignoriert, da wir der Unterhaltung in der automatischen Sitzung automatisch einen neuen Namen zuweisen.
`safe_search`	`bool` Gibt an, ob SafeSearch aktiviert werden soll.
`user_labels`	`map<string, string>` Die Nutzerlabels, die auf eine Ressource angewendet werden, müssen die folgenden Anforderungen erfüllen: Jede Ressource kann bis zu 64 Labels haben. Jedes Label muss ein Schlüssel/Wert-Paar sein. Schlüssel haben eine Mindestlänge von einem Zeichen und eine maximale Länge von 63 Zeichen und dürfen nicht leer sein. Werte dürfen leer sein und haben eine maximale Länge von 63 Zeichen. Schlüssel und Werte dürfen nur Kleinbuchstaben, Ziffern, Unterstriche und Bindestriche enthalten. Alle Zeichen müssen UTF-8-codiert sein. Internationale Zeichen sind zulässig. Der Schlüsselabschnitt eines Labels darf nur einmal vorkommen. Sie können jedoch denselben Schlüssel für mehrere Ressourcen verwenden. Schlüssel müssen mit einem Kleinbuchstaben oder einem internationalen Zeichen beginnen. Weitere Informationen finden Sie im Google Cloud-Dokument.
`summary_spec`	`SummarySpec` Eine Spezifikation zum Konfigurieren der Zusammenfassung, die in der Antwort zurückgegeben wird.
`filter`	`string` Die Filtersyntax besteht aus einer Ausdruckssprache zum Erstellen eines Prädikats aus einem oder mehreren Feldern der gefilterten Dokumente. Bei Filterausdrücken wird zwischen Groß- und Kleinschreibung unterschieden. Diese Informationen werden verwendet, um Suchergebnisse zu filtern, was sich auf die Zusammenfassung auswirken kann. Wenn dieses Feld nicht erkannt wird, wird `INVALID_ARGUMENT` zurückgegeben. Das Filtern in Vertex AI Search erfolgt durch Zuordnen des LHS-Filterschlüssels zu einer Schlüsselattribut, das im Vertex AI Search-Backend definiert ist. Diese Zuordnung wird vom Kunden in seinem Schema definiert. Ein Media-Kunde hat in seinem Schema beispielsweise möglicherweise das Feld „name“. In diesem Fall würde der Filter so aussehen: filter --> name:'ANY("king kong")' Weitere Informationen zum Filtern, einschließlich Syntax und Filteroperatoren, finden Sie unter Filter.
`boost_spec`	`BoostSpec` Mit der Boost-Spezifikation können Sie bestimmte Dokumente in den Suchergebnissen hervorheben, was sich auf die Antwort auswirken kann. Weitere Informationen zum Boosten finden Sie unter Boost.

ConverseConversationResponse

Antwortnachricht für die Methode ConversationalSearchService.ConverseConversation.

Felder

reply

Reply

Antwort auf die aktuelle Anfrage.

conversation

Aktualisierte Unterhaltung mit der Antwort.

search_results[]

SearchResult

Suchergebnisse.

CreateAssistantRequest

Anfrage für die Methode AssistantService.CreateAssistant.

Felder

parent

string

Erforderlich. Der Name der übergeordneten Ressource. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

assistant

Assistant

Erforderlich. Die zu erstellende Assistant.

assistant_id

string

Erforderlich. Die für Assistant zu verwendende ID, die als letzte Komponente des Ressourcennamens von Assistant verwendet wird.

Dieses Feld muss RFC-1034 entsprechen und darf maximal 63 Zeichen lang sein.

CreateControlRequest

Anfrage für die Methode „CreateControl“.

Felder

parent

string

Erforderlich. Vollständiger Ressourcenname des übergeordneten Datenspeichers. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} oder projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

control

Control

Erforderlich. Die zu erstellende Kontrollgruppe.

control_id

string

Erforderlich. Die für die Kontrollgruppe zu verwendende ID, die die letzte Komponente des Ressourcennamens der Kontrollgruppe darstellt.

Dieser Wert muss zwischen 1 und 63 Zeichen lang sein. Gültige Zeichen sind /[a–z][0–9]–_/.

CreateConversationRequest

Anfrage für die Methode „CreateConversation“.

Felder

parent

string

Erforderlich. Vollständiger Ressourcenname des übergeordneten Datenspeichers. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

conversation

Erforderlich. Die zu erstellende Unterhaltung.

CreateDataStoreMetadata

Metadaten zum Fortschritt des Vorgangs DataStoreService.CreateDataStore. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

CreateDataStoreRequest

Anfrage für die Methode DataStoreService.CreateDataStore.

Felder
`parent`	`string` Erforderlich. Der Name der übergeordneten Ressource, z. B. `projects/{project}/locations/{location}/collections/{collection}`.
`data_store`	`DataStore` Erforderlich. Die zu erstellende `DataStore`.
`data_store_id`	`string` Erforderlich. Die für `DataStore` zu verwendende ID, die als letzte Komponente des Ressourcennamens von `DataStore` verwendet wird. Dieses Feld muss dem RFC-1034-Standard entsprechen und darf maximal 63 Zeichen lang sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.
`create_advanced_site_search`	`bool` Ein boolescher Wert, der angibt, ob der Nutzer direkt einen erweiterten Datenspeicher für die Site Search erstellen möchte. Wenn der Datenspeicher nicht als Website-Suche konfiguriert ist (GENERIC-Branche und PUBLIC_WEBSITE-content_config), wird dieses Flag ignoriert.
`skip_default_schema_creation`	`bool` Ein boolescher Parameter, der angibt, ob die Standardschemaerstellung für den Datenspeicher übersprungen werden soll. Aktivieren Sie dieses Flag nur, wenn Sie sicher sind, dass das Standardschema mit Ihrem Anwendungsfall nicht kompatibel ist. Wenn diese Option auf „true“ gesetzt ist, müssen Sie manuell ein Schema für den Datenspeicher erstellen, bevor Dokumente aufgenommen werden können. Dieses Flag kann nicht angegeben werden, wenn `data_store.starting_schema` angegeben ist.
Union-Feld `cmek_options`. CMEK-Optionen für den DataStore. Wenn Sie dieses Feld festlegen, wird die Standard-CmekConfig überschrieben, sofern eine für das Projekt festgelegt ist. Für `cmek_options` ist nur einer der folgenden Werte zulässig:
`cmek_config_name`	`string` Der Ressourcenname der CmekConfig, die zum Schutz dieses Datenspeichers verwendet werden soll.
`disable_cmek`	`bool` DataStore ohne CMEK-Schutz. Wenn für das Projekt eine Standard-CmekConfig festgelegt ist, wird diese durch Festlegen dieses Felds ebenfalls überschrieben.

CreateDocumentRequest

Anfragenachricht für die Methode DocumentService.CreateDocument.

Felder

parent

string

Erforderlich. Der Name der übergeordneten Ressource, z. B. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

document

Erforderlich. Die zu erstellende Document.

document_id

string

Erforderlich. Die für Document zu verwendende ID, die die letzte Komponente von Document.name wird.

Wenn der Aufrufer nicht berechtigt ist, die Document zu erstellen, unabhängig davon, ob sie vorhanden ist oder nicht, wird ein PERMISSION_DENIED-Fehler zurückgegeben.

Dieses Feld muss für alle Document mit derselben parent eindeutig sein. Andernfalls wird der Fehler ALREADY_EXISTS zurückgegeben.

Dieses Feld muss dem RFC-1034-Standard entsprechen und darf maximal 128 Zeichen lang sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

CreateEngineMetadata

Metadaten zum Fortschritt des Vorgangs EngineService.CreateEngine. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

CreateEngineRequest

Anfrage für die Methode EngineService.CreateEngine.

Felder

parent

string

Erforderlich. Der Name der übergeordneten Ressource, z. B. projects/{project}/locations/{location}/collections/{collection}.

engine

Engine

Erforderlich. Die zu erstellende Engine.

engine_id

string

Erforderlich. Die für Engine zu verwendende ID, die als letzte Komponente des Ressourcennamens von Engine verwendet wird.

Dieses Feld muss dem RFC-1034-Standard entsprechen und darf maximal 63 Zeichen lang sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

CreateIdentityMappingStoreRequest

Anfragenachricht für IdentityMappingStoreService.CreateIdentityMappingStore

Felder
`parent`	`string` Erforderlich. Der Name der übergeordneten Sammlung, z. B. `projects/{project}/locations/{location}`.
`identity_mapping_store_id`	`string` Erforderlich. Die ID des zu erstellenden Identity Mapping Store. Die ID darf nur Buchstaben (a–z, A–Z), Ziffern (0–9), Unterstriche (_) und Bindestriche (-) enthalten. Die maximale Länge beträgt 63 Zeichen.
`identity_mapping_store`	`IdentityMappingStore` Erforderlich. Der zu erstellende Identity Mapping Store.
Union-Feld `cmek_options`. CMEK-Optionen für den Identity Mapping Store. Wenn Sie dieses Feld festlegen, wird die Standard-CmekConfig überschrieben, sofern eine für das Projekt festgelegt ist. Für `cmek_options` ist nur einer der folgenden Werte zulässig:
`cmek_config_name`	`string` Der Ressourcenname der CmekConfig, die zum Schutz dieses Identity Mapping Store verwendet werden soll.
`disable_cmek`	`bool` Identitätszuordnungsspeicher ohne CMEK-Schutz. Wenn für das Projekt eine Standard-CmekConfig festgelegt ist, wird diese durch Festlegen dieses Felds ebenfalls überschrieben.

CreateLicenseConfigRequest

Anfragenachricht für die Methode LicenseConfigService.CreateLicenseConfig.

Felder

parent

string

Erforderlich. Der Name der übergeordneten Ressource, z. B. projects/{project}/locations/{location}.

license_config

LicenseConfig

Erforderlich. Die zu erstellende LicenseConfig.

license_config_id

string

Optional. Die für LicenseConfig zu verwendende ID, die als letzte Komponente des Ressourcennamens von LicenseConfig verwendet wird. Wir verwenden den Namen der Stufe (Produktversion) als Lizenzkonfigurations-ID, z. B. search oder search_and_assistant.

CreateSchemaMetadata

Metadaten für den Vorgang mit langer Ausführungszeit zum Erstellen eines Schemas.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

CreateSchemaRequest

Anfragenachricht für die Methode SchemaService.CreateSchema.

Felder

parent

string

Erforderlich. Der Name der übergeordneten Datenspeicherressource im Format projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

schema

Schema

Erforderlich. Die zu erstellende Schema.

schema_id

string

Erforderlich. Die für Schema zu verwendende ID, die die letzte Komponente von Schema.name wird.

Dieses Feld sollte dem RFC-1034-Standard entsprechen und darf maximal 63 Zeichen lang sein.

CreateSessionRequest

Anfrage für die Methode „CreateSession“.

Felder

parent

string

Erforderlich. Vollständiger Ressourcenname des übergeordneten Datenspeichers. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

session

Erforderlich. Die zu erstellende Sitzung.

CreateSitemapMetadata

Metadaten zum Fortschritt des Vorgangs SiteSearchEngineService.CreateSitemap. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

CreateSitemapRequest

Anfragenachricht für die Methode SiteSearchEngineService.CreateSitemap.

Felder

parent

string

Erforderlich. Name der übergeordneten Ressource von SiteSearchEngine, z. B. projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

sitemap

Sitemap

Erforderlich. Die zu erstellende Sitemap.

CreateTargetSiteMetadata

Metadaten zum Fortschritt des Vorgangs SiteSearchEngineService.CreateTargetSite. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

CreateTargetSiteRequest

Anfragenachricht für die Methode SiteSearchEngineService.CreateTargetSite.

Felder

parent

string

Erforderlich. Name der übergeordneten Ressource von TargetSite, z. B. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

target_site

Erforderlich. Die zu erstellende TargetSite.

CustomAttribute

Ein benutzerdefiniertes Attribut, das nicht explizit in einer Ressource modelliert wird, z.B. UserEvent.

Felder

text[]

string

Die Textwerte dieses benutzerdefinierten Attributs. Beispiel: ["yellow", "green"], wenn der Schlüssel „color“ ist.

Ein leerer String ist nicht zulässig. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

Es sollte genau eines von CustomAttribute.text und CustomAttribute.numbers festgelegt sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

numbers[]

double

Die numerischen Werte dieses benutzerdefinierten Attributs. Beispiel: [2.3, 15.4], wenn der Schlüssel „lengths_cm“ ist.

Es sollte genau eines von CustomAttribute.text und CustomAttribute.numbers festgelegt sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

CustomTuningModel

Metadaten, die ein benutzerdefiniertes Modell beschreiben.

Felder
`name`	`string` Erforderlich. Der vollständig qualifizierte Ressourcenname des Modells. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Das Modell muss ein alphanumerischer String mit maximal 40 Zeichen sein.
`display_name`	`string` Der Anzeigename des Modells.
`model_version`	`int64` Die Version des Modells.
`model_state`	`ModelState` Der Status des Modells (z.B.`TRAINING` oder `TRAINING_FAILED`).
`create_time (deprecated)`	`Timestamp` Dieses Element ist veraltet. Veraltet: Zeitstempel für die Erstellung des Modells.
`training_start_time`	`Timestamp` Zeitstempel, zu dem das Modelltraining initiiert wurde.
`metrics`	`map<string, double>` Die Messwerte des trainierten Modells.
`error_message`	`string` Derzeit wird dieses Feld nur ausgefüllt, wenn der Modellstatus `INPUT_VALIDATION_FAILED` ist.

ModelState

Der Status des Modells.

Enums
`MODEL_STATE_UNSPECIFIED`	Standardwert.
`TRAINING_PAUSED`	Das Modell befindet sich im pausierten Trainingsstatus.
`TRAINING`	Das Modell wird derzeit trainiert.
`TRAINING_COMPLETE`	Das Modell wurde erfolgreich trainiert.
`READY_FOR_SERVING`	Das Modell ist bereit für die Bereitstellung.
`TRAINING_FAILED`	Das Modelltraining ist fehlgeschlagen.
`NO_IMPROVEMENT`	Das Modelltraining wurde erfolgreich abgeschlossen, aber die Messwerte haben sich nicht verbessert.
`INPUT_VALIDATION_FAILED`	Die Validierung der Eingabedaten ist fehlgeschlagen. Das Modelltraining wurde nicht gestartet.

DataConnector

Verwaltet die Verbindung zu externen Datenquellen für alle Datenspeicher, die unter einem Collection gruppiert sind. Es handelt sich um eine Singleton-Ressource von Collection. Die Initialisierung wird nur über die Methode DataConnectorService.SetUpDataConnector unterstützt. Dadurch wird ein neues Collection erstellt und sein DataConnector initialisiert.

Felder
`name`	`string` Nur Ausgabe. Der vollständige Ressourcenname des Data Connectors. Format: `projects//locations//collections/*/dataConnector`.
`state`	`State` Nur Ausgabe. Status des Connectors.
`data_source`	`string` Erforderlich. Der Name der Datenquelle. Unterstützte Werte: `salesforce`, `jira`, `confluence`, `bigquery`.
`remove_param_keys[]`	`string` Optional. Gibt die Schlüssel an, die aus dem Feld „params“ entfernt werden sollen. Dies ist nur aktiv, wenn „params“ in der „update_mask“ in einem UpdateDataConnectorRequest enthalten ist. Das Löschen hat Vorrang, wenn ein Schlüssel sowohl in „remove_param_keys“ als auch im Feld „params“ der Anfrage vorhanden ist.
`refresh_interval`	`Duration` Erforderlich. Das Aktualisierungsintervall für die Datensynchronisierung. Wenn „Dauer“ auf 0 gesetzt ist, werden die Daten in Echtzeit synchronisiert. Die Streamingfunktion wird noch nicht unterstützt. Die Mindestdauer beträgt 30 Minuten, die Höchstdauer 7 Tage. Wenn das Aktualisierungsintervall auf denselben Wert wie das inkrementelle Aktualisierungsintervall festgelegt ist, wird die inkrementelle Synchronisierung deaktiviert.
`next_sync_time`	`DateTime` Definiert die geplante Zeit für die nächste Datensynchronisierung. Für dieses Feld sind „hour“, „minute“ und „time_zone“ aus der IANA-Zeitzonendatenbank erforderlich. Diese Option wird verwendet, wenn der Daten-Connector ein Aktualisierungsintervall von mehr als einem Tag hat. Wenn die Stunden oder Minuten nicht angegeben sind, gehen wir von einer Synchronisierungszeit von 0:00 Uhr aus. Der Nutzer muss eine Zeitzone angeben, um Unklarheiten zu vermeiden.
`entities[]`	`SourceEntity` Liste der Entitäten aus der verbundenen Datenquelle, die aufgenommen werden sollen.
`create_time`	`Timestamp` Nur Ausgabe. Zeitstempel für die Erstellung von `DataConnector`.
`latest_pause_time`	`Timestamp` Nur Ausgabe. Der letzte Zeitstempel, als diese `DataConnector` pausiert wurde. Dies wirkt sich auf alle Funktionen wie die Datensynchronisierung aus. Wenn Sie einen Connector pausieren, hat das folgende Auswirkungen: – Alle Funktionen, einschließlich der Datensynchronisierung, werden angehalten. – Alle laufenden Datensynchronisierungsjobs werden abgebrochen. – Es werden keine zukünftigen Datensynchronisierungen geplant und es können auch keine ausgelöst werden.
`last_sync_time`	`Timestamp` Nur Ausgabe. Nur für periodische Connectors: Der Zeitpunkt, zu dem die letzte Datensynchronisierung abgeschlossen wurde.
`update_time`	`Timestamp` Nur Ausgabe. Zeitstempel der letzten Aktualisierung von `DataConnector`.
`errors[]`	`Status` Nur Ausgabe. Die Fehler aus der Initialisierung oder dem letzten Connector-Lauf.
`sync_mode`	`SyncMode` Der vom Daten-Connector unterstützte Datensynchronisierungsmodus.
`kms_key_name`	`string` Nur Eingabe. Der KMS-Schlüssel, der zum Schutz der von diesem Connector verwalteten Datenspeicher verwendet werden soll. Muss für Anfragen festgelegt werden, die den CMEK-Organisationsrichtlinien entsprechen müssen. Wenn dieses Feld festgelegt und erfolgreich verarbeitet wird, werden die von diesem Connector erstellten DataStores durch den KMS-Schlüssel geschützt.
`destination_configs[]`	`DestinationConfig` Optional. Alle Zielorte, die zum Herstellen einer Verbindung zu Drittanbieterdiensten verwendet werden.
`action_state`	`State` Nur Ausgabe. Status des Aktions-Connectors. Hier sehen Sie, ob der Aktions-Connector initialisiert wird, aktiv ist oder Fehler aufgetreten sind.
`action_config`	`ActionConfig` Optional. Aktionskonfigurationen, damit der Connector Aktionen unterstützt.
`end_user_config`	`EndUserConfig` Optional. Alle Parameter und Anmeldedaten, die speziell für EUA-Connectors verwendet werden.
`federated_config`	`FederatedConfig` Optional. Alle Parameter und Anmeldedaten, die speziell für Hybrid-Connectors verwendet werden, die den FEDERATED-Modus unterstützen. Dieses Feld sollte nur festgelegt werden, wenn der Connector ein Hybrid-Connector ist und wir den FEDERATED-Modus aktivieren möchten.
`connector_modes[]`	`ConnectorMode` Optional. Die für diesen Connector aktivierten Modi. Der Standardstatus ist CONNECTOR_MODE_UNSPECIFIED.
`static_ip_enabled`	`bool` Optional. Gibt an, ob der Kunde statische IP-Adressen für diesen Connector aktiviert hat.
`static_ip_addresses[]`	`string` Nur Ausgabe. Die von diesem Connector verwendeten statischen IP-Adressen.
`blocking_reasons[]`	`BlockingReason` Nur Ausgabe. Nutzeraktionen, die abgeschlossen werden müssen, bevor der Connector mit der Synchronisierung von Daten beginnen kann.
`identity_refresh_interval (deprecated)`	`Duration` Dieses Element ist veraltet. Das Aktualisierungsintervall für die Synchronisierung der Informationen zur Access Control List für die von diesem Connector aufgenommenen Dokumente. Wenn die Richtlinie nicht konfiguriert ist, wird die Zugriffssteuerungsliste im Standardintervall von 30 Minuten aktualisiert. Das Aktualisierungsintervall für die Identität kann mindestens 30 Minuten und höchstens 7 Tage betragen.
`identity_schedule_config`	`IdentityScheduleConfig` Die Konfiguration für die Synchronisierungsläufe von Identitätsdaten. Dieses Feld enthält das Aktualisierungsintervall für die Synchronisierung der Informationen zur Zugriffssteuerungsliste für die von diesem Connector aufgenommenen Dokumente.
`private_connectivity_project_id`	`string` Nur Ausgabe. Die Mandantenprojekt-ID, die mit Connectors für private Verbindungen verknüpft ist. Dieses Projekt muss auf der Zulassungsliste stehen, damit der Connector funktioniert.
`bap_config`	`BAPConfig` Optional. Die Konfiguration zum Herstellen einer BAP-Verbindung.
`connector_type`	`ConnectorType` Nur Ausgabe. Der Typ des Connectors. Jede Quelle kann nur einem Typ zugeordnet werden. Salesforce, Confluence und Jira haben beispielsweise den Connectortyp THIRD_PARTY. Sie kann nicht geändert werden, sobald sie vom System festgelegt wurde.
`realtime_state`	`State` Nur Ausgabe. Status der Echtzeitsynchronisierung
`alert_policy_configs[]`	`AlertPolicyConfig` Optional. Die Benachrichtigungskonfiguration auf Connectorebene.
`realtime_sync_config`	`RealtimeSyncConfig` Optional. Die Konfiguration für die Echtzeitsynchronisierung.
`acl_enabled`	`bool` Optional. Gibt an, ob der Connector mit einer ACL-Konfiguration erstellt wird. Derzeit wirkt sich dieses Feld nur auf Cloud Storage- und BigQuery-Connectors aus.
`create_eua_saas`	`bool` Optional. Gibt an, ob der END USER AUTHENTICATION-Connector in SaaS erstellt wird.
`auto_run_disabled`	`bool` Optional. Gibt an, ob der Connector für die automatische Ausführung deaktiviert ist. Damit kann die regelmäßige und die Echtzeitsynchronisierung pausiert werden. Aktualisierung: Mit der Einführung von „incremental_sync_disabled“ wird „auto_run_disabled“ nur zum Pausieren/Deaktivieren vollständiger Synchronisierungen verwendet.
`incremental_sync_disabled`	`bool` Optional. Gibt an, ob inkrementelle Synchronisierungen für diesen Connector pausiert sind. Dies ist unabhängig von „auto_run_disabled“. Gilt nur für Drittanbieter-Connectors. Wenn das Aktualisierungsintervall auf denselben Wert wie das inkrementelle Aktualisierungsintervall festgelegt ist, wird die inkrementelle Synchronisierung deaktiviert, d.h. auf „true“ gesetzt.
`incremental_refresh_interval`	`Duration` Optional. Das Aktualisierungsintervall speziell für inkrementelle Datensynchronisierungen. Wenn nicht festgelegt, wird für inkrementelle Synchronisierungen der Standardwert aus der Umgebung verwendet, der auf 3 Stunden festgelegt ist. Die Mindestdauer beträgt 30 Minuten, die Höchstdauer 7 Tage. Gilt nur für Drittanbieter-Connectors. Wenn das Aktualisierungsintervall auf denselben Wert wie das inkrementelle Aktualisierungsintervall festgelegt ist, wird die inkrementelle Synchronisierung deaktiviert.
`hybrid_ingestion_disabled`	`bool` Optional. Wenn der Connector ein Hybrid-Connector ist, wird damit festgelegt, ob die Aufnahme aktiviert ist und ob beim Erstellen des Connectors die entsprechenden Ressourcen bereitgestellt werden. Wenn der Connector kein Hybrid-Connector ist, wird dieses Feld ignoriert.
Union-Feld `data_connector_params`. Parameter, die für den Zugriff auf die Quelle erforderlich sind, im Format von (Schlüssel, Wert)-Paaren. String-Werte im Format `projects//[locations//]secrets//versions/` werden aus Secret Manager gelesen. Erforderliche Parameter für alle Datenquellen: Schlüssel: `instance_uri` Wert: Typ STRING. Der URI für den Zugriff auf die Datenquelle. Erforderliche Parameter für Quellen, die OAuth unterstützen, z.B. `salesforce`: Schlüssel: `client_id` Wert: Typ STRING. Die Client-ID für den Drittanbieter, um Ihre Anwendung zu identifizieren. Schlüssel: `client_secret` Wert:Typ STRING. Der vom Autorisierungsserver des Drittanbieters generierte Clientschlüssel. Schlüssel: `access_token` Wert: Typ STRING. OAuth-Token für UCS für den Zugriff auf die geschützte Ressource. Schlüssel: `refresh_token` Wert: Typ STRING. OAuth-Aktualisierungstoken für UCS, um ohne Nutzerinteraktion ein neues Zugriffstoken zu erhalten. Erforderliche Parameter für Quellen, die die grundlegende API-Token-Authentifizierung unterstützen, d.h. `jira`, `confluence`: Schlüssel: `user_account` Wert: Typ STRING. Der Nutzername oder die E‑Mail-Adresse der Quelle. Schlüssel: `api_token` Wert: Typ STRING. Das für das Quellkonto generierte API-Token, das zur Authentifizierung an allen Stellen verwendet wird, an denen Sie ein Passwort verwendet hätten. Beispiel: `{ "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" }` Optionaler Parameter, um den Autorisierungstyp anzugeben, der bei Unterstützung mehrerer Autorisierungstypen verwendet werden soll: Schlüssel: `auth_type` Wert: Typ STRING. Der Autorisierungstyp für die Datenquelle. Unterstützte Werte: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. Für `data_connector_params` ist nur einer der folgenden Werte zulässig:
`params`	`Struct` Erforderliche Parameter für Datenconnectors im strukturierten JSON-Format.
`json_params`	`string` Erforderliche Parameter für den Datenconnector im JSON-Stringformat.

BlockingReason

Nutzeraktionen, die abgeschlossen werden müssen, bevor der Connector mit der Synchronisierung von Daten beginnen kann.

Enums
`BLOCKING_REASON_UNSPECIFIED`	Standardwert.
`ALLOWLIST_STATIC_IP`	Für den Connector muss der Kunde statische IP-Adressen auf die Zulassungsliste setzen.
`ALLOWLIST_IN_SERVICE_ATTACHMENT`	Für den Connector muss der Kunde unser Projekt in seinem Dienstanhang auf die Zulassungsliste setzen.
`ALLOWLIST_SERVICE_ACCOUNT`	Für den Connector muss der Kunde das Dienstkonto in seinem Projekt auf die Zulassungsliste setzen.

ConnectorMode

Die für diesen Connector aktivierten Modi. INGESTION, ACTIONS, FEDERATED, OR EUA

Enums
`CONNECTOR_MODE_UNSPECIFIED`	Der Connector-Modus ist nicht angegeben.
`DATA_INGESTION`	Connector, der für die Datenaufnahme verwendet wird.
`ACTIONS`	Connector, der für Aktionen verwendet wird.
`FEDERATED`	Connector, der für die föderierte Suche verwendet wird.
`EUA`	Für die Endnutzerauthentifizierung verwendeter Connector.
`FEDERATED_AND_EUA`	Hybrid-Connector für die föderierte Suche und die Endnutzerauthentifizierung.

EndUserConfig

Alle Parameter und Anmeldedaten, die speziell für EUA-Connectors verwendet werden.

Felder
`additional_params`	`Struct` Optional. Alle zusätzlichen Parameter, die für die EUA erforderlich sind.
`tenant`	`Tenant` Optional. Das Mandantenprojekt, mit dem der Connector verbunden ist.
Union-Feld `auth_config`. Authentifizierungskonfiguration für EUA-Connectors. Für `auth_config` ist nur einer der folgenden Werte zulässig:
`auth_params`	`Struct` Optional. Alle Authentifizierungsparameter, die für EUA-Connectors spezifisch sind.
`json_auth_params`	`string` Optional. Alle Authentifizierungsparameter, die für EUA-Connectors spezifisch sind, im JSON-Stringformat.

FederatedConfig

Alle Parameter und Anmeldedaten, die speziell für Hybrid-Connectors verwendet werden, die den FEDERATED-Modus unterstützen.

Felder
`additional_params`	`Struct` Optional. Alle zusätzlichen Parameter, die für FEDERATED erforderlich sind.
Union-Feld `auth_config`. Authentifizierungskonfiguration für FEDERATED-Connectors. Für `auth_config` ist nur einer der folgenden Werte zulässig:
`auth_params`	`Struct` Optional. Alle Authentifizierungsparameter, die für FEDERATED-Connectors spezifisch sind.
`json_auth_params`	`string` Optional. Alle Authentifizierungsparameter, die für FEDERATED-Connectors spezifisch sind, im JSON-Stringformat.

RealtimeSyncConfig

Die Konfiguration für die Echtzeitsynchronisierung zum Speichern zusätzlicher Parameter für die Echtzeitsynchronisierung.

Felder

webhook_uri

string

Optional. Webhook-URL für den Connector, um zusätzliche Parameter für die Echtzeitsynchronisierung anzugeben.

realtime_sync_secret

string

Optional. Die ID des Secret Manager-Secrets, das für das Webhook-Secret verwendet wird.

streaming_error

StreamingError

Optional. Details zum Streamingfehler.

StreamingError

Details zum Streamingfehler.

Felder

streaming_error_reason

StreamingErrorReason

Optional. Streamingfehler.

error

Optional. Fehlerdetails.

StreamingErrorReason

Allgemeine Arten von Streamingfehlern.

Enums
`STREAMING_ERROR_REASON_UNSPECIFIED`	Grund für Streamingfehler nicht angegeben.
`STREAMING_SETUP_ERROR`	Beim Einrichten von Ressourcen für die Echtzeitsynchronisierung ist ein Fehler aufgetreten.
`STREAMING_SYNC_ERROR`	Beim Ausführen der Echtzeitsynchronisierung für den Connector ist ein Fehler aufgetreten.
`INGRESS_ENDPOINT_REQUIRED`	Ein Ingress-Endpunkt ist erforderlich, wenn Sie die Echtzeitsynchronisierung in einer privaten Verbindung einrichten.

SourceEntity

Stellt eine Entität in der Datenquelle dar. Beispiel: das Account-Objekt in Salesforce.

Felder
`entity_name`	`string` Der Name der Entität. Unterstützte Werte nach Datenquelle: Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` Jira: `Issue` Confluence: `Content`, `Space`
`key_property_mappings`	`map<string, string>` Attribute für die Indexierung. Schlüssel: Feldname. Wert: Das Schlüsselattribut, dem ein Feld zugeordnet werden soll, z. B. `title` und `description`. Unterstützte Haupteigenschaften: `title`: Der Titel für den Datensatz. Diese Informationen werden in den Suchergebnissen angezeigt. `description`: Die Beschreibung für den Datensatz. Diese Informationen werden in den Suchergebnissen angezeigt.
`data_store`	`string` Nur Ausgabe. Der vollständige Ressourcenname des zugehörigen Datenspeichers für die Quellentität. Format: `projects//locations//collections//dataStores/`. Wenn der Connector mit der Methode `DataConnectorService.SetUpDataConnector` initialisiert wird, wird automatisch ein `DataStore` für jede Quellentität erstellt.
`starting_schema`	`Schema` Optional. Das Startschema, das für die `DataStore` verwendet werden soll, die aus dieser SourceEntity erstellt wurde. Wenn kein Wert angegeben ist, wird ein standardspezifisches Schema verwendet. Dieses Feld wird nur von der [SetUpDataConnector][] API verwendet und wird ignoriert, wenn es in anderen APIs verwendet wird. Dieses Feld wird aus allen API-Antworten, einschließlich der [GetDataConnector]-API, entfernt. Verwenden Sie stattdessen die `SchemaService.GetSchema` API, um ein Schema für eine `DataStore` abzurufen. Das bereitgestellte Schema wird anhand bestimmter Schemaregeln validiert. Weitere Informationen
`healthcare_fhir_config`	`HealthcareFhirConfig` Optional. Konfiguration für die Branche `HEALTHCARE_FHIR`.
Union-Feld `entity_params`. Die Parameter für die Einheit, um die Datenaufnahme zu erleichtern. Beispiel für BigQuery-Connectors: Schlüssel: `document_id_column` Wert: Typ STRING. Der Wert der Spalten-ID. Für `entity_params` ist nur einer der folgenden Werte zulässig:
`params`	`Struct` Die Parameter für die Entität, um die Datenerfassung im strukturierten JSON-Format zu ermöglichen.
`json_params`	`string` Die Parameter für die Entität, um die Datenerfassung im JSON-Stringformat zu ermöglichen.

Bundesland

Der Status des Connectors.

Enums
`STATE_UNSPECIFIED`	Standardwert.
`CREATING`	Der Connector wird eingerichtet.
`ACTIVE`	Der Connector wurde eingerichtet und wartet auf die nächste Synchronisierung.
`FAILED`	Der Connector weist Fehler auf. Die Fehlerdetails finden Sie unter `DataConnector.errors`. Wenn der Fehler nicht behoben werden kann, kann die `DataConnector` mit der API [CollectionService.DeleteCollection] gelöscht werden.
`RUNNING`	Der Connector synchronisiert aktiv Datensätze aus der Datenquelle.
`WARNING`	Der Connector hat einen Synchronisierungslauf abgeschlossen, aber es sind nicht schwerwiegende Fehler aufgetreten.
`INITIALIZATION_FAILED`	Connector-Initialisierung fehlgeschlagen. Mögliche Ursachen sind Laufzeitfehler oder Probleme in der asynchronen Pipeline, die verhindern, dass die Anfrage nachgelagerte Dienste erreicht (mit Ausnahme einiger Connectortypen).
`UPDATING`	Der Connector wird gerade aktualisiert.

SyncMode

Definiert den vom Datenconnector unterstützten Datensynchronisationsmodus.

Enums
`PERIODIC`	Der Connector synchronisiert Daten regelmäßig basierend auf dem refresh_interval. Verwenden Sie es mit auto_run_disabled, um die regelmäßige Synchronisierung zu pausieren oder eine einmalige Synchronisierung anzugeben.
`STREAMING`	Die Daten werden in Echtzeit synchronisiert.
`UNSPECIFIED`	Connector, der keine Daten aufnimmt, hat diesen Wert.

Datastore

DataStore erfasst globale Einstellungen und Konfigurationen auf DataStore-Ebene.

Felder
`name`	`string` Nicht veränderbar. ID. Der vollständige Ressourcenname des Datenspeichers. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.
`display_name`	`string` Erforderlich. Der Anzeigename des Datenspeichers. Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 128 Zeichen sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.
`industry_vertical`	`IndustryVertical` Nicht veränderbar. Die Branche, in der der Datenspeicher registriert ist.
`solution_types[]`	`SolutionType` Die Lösungen, für die der Datenspeicher registriert ist. Verfügbare Lösungen für die einzelnen `industry_vertical`: `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` und `SOLUTION_TYPE_SEARCH`. `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` ist automatisch registriert. Andere Lösungen können nicht registriert werden.
`default_schema_id`	`string` Nur Ausgabe. Die ID des Standard-`Schema`, der diesem Datenspeicher zugeordnet ist.
`content_config`	`ContentConfig` Nicht veränderbar. Die Inhaltskonfiguration des Datenspeichers. Wenn dieses Feld nicht festgelegt ist, wird standardmäßig `ContentConfig.NO_CONTENT` verwendet.
`create_time`	`Timestamp` Nur Ausgabe. Zeitstempel für die Erstellung von `DataStore`.
`advanced_site_search_config`	`AdvancedSiteSearchConfig` Optional. Konfiguration für die erweiterte Websitesuche.
`kms_key_name`	`string` Nur Eingabe. Der KMS-Schlüssel, der zum Schutz dieses Datenspeichers bei der Erstellung verwendet werden soll. Muss für Anfragen festgelegt werden, die den CMEK-Organisationsrichtlinien entsprechen müssen. Wenn dieses Feld festgelegt und erfolgreich verarbeitet wird, ist der DataStore durch den KMS-Schlüssel geschützt, wie im Feld „cmek_config“ angegeben.
`cmek_config`	`CmekConfig` Nur Ausgabe. CMEK-bezogene Informationen für den DataStore.
`billing_estimation`	`BillingEstimation` Nur Ausgabe. Schätzung der Datengröße für die Abrechnung.
`acl_enabled`	`bool` Nicht veränderbar. Ob Daten in `DataStore` ACL-Informationen enthalten. Wenn diese Option auf `true` festgelegt ist, müssen die Quelldaten eine Zugriffssteuerungsliste haben. ACLs werden aufgenommen, wenn Daten mit `DocumentService.ImportDocuments`-Methoden aufgenommen werden. Wenn die ACL für `DataStore` aktiviert ist, kann auf `Document` nicht durch Aufrufen von `DocumentService.GetDocument` oder `DocumentService.ListDocuments` zugegriffen werden. Derzeit wird ACL nur in der Branche `GENERIC` mit einer Inhaltskonfiguration ohne `PUBLIC_WEBSITE` unterstützt.
`workspace_config`	`WorkspaceConfig` Konfiguration zum Speichern der Datenspeichertypkonfiguration für Arbeitsbereichsdaten. Dieser muss festgelegt werden, wenn `DataStore.content_config` auf `DataStore.ContentConfig.GOOGLE_WORKSPACE` gesetzt ist.
`document_processing_config`	`DocumentProcessingConfig` Konfiguration für Dokumentverständnis und ‑anreicherung.
`starting_schema`	`Schema` Das Startschema, das für diese `DataStore` bei der Bereitstellung verwendet werden soll. Wenn kein Wert angegeben ist, wird ein standardspezifisches Schema verwendet. Dieses Feld wird nur von der `CreateDataStore` API verwendet und wird ignoriert, wenn es in anderen APIs verwendet wird. Dieses Feld wird in allen API-Antworten, einschließlich der `CreateDataStore` API, ausgelassen. Verwenden Sie stattdessen die `SchemaService.GetSchema` API, um ein Schema für eine `DataStore` abzurufen. Das bereitgestellte Schema wird anhand bestimmter Schemaregeln validiert. Weitere Informationen
`healthcare_fhir_config`	`HealthcareFhirConfig` Optional. Konfiguration für die Branche `HEALTHCARE_FHIR`.
`serving_config_data_store`	`ServingConfigDataStore` Optional. Konfiguration auf DataStore-Ebene speichern.
`identity_mapping_store`	`string` Nicht veränderbar. Der vollständig qualifizierte Ressourcenname der zugehörigen `IdentityMappingStore`. Dieses Feld kann nur für DataStores mit `THIRD_PARTY`- oder `GSUITE`-IdP festgelegt werden, für die ACL aktiviert ist. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.
`is_infobot_faq_data_store`	`bool` Optional. Wenn festgelegt, ist dieser DataStore ein Infobot-FAQ-DataStore.
`configurable_billing_approach`	`ConfigurableBillingApproach` Optional. Konfiguration für den konfigurierbaren Abrechnungsansatz. Siehe

BillingEstimation

Schätzung der Datengröße pro Datenspeicher.

Felder
`structured_data_size`	`int64` Datengröße für strukturierte Daten in Byte.
`unstructured_data_size`	`int64` Datengröße für unstrukturierte Daten in Byte.
`website_data_size`	`int64` Datengröße für Websites in Byte.
`structured_data_update_time`	`Timestamp` Zeitstempel der letzten Aktualisierung der strukturierten Daten.
`unstructured_data_update_time`	`Timestamp` Zeitstempel der letzten Aktualisierung für unstrukturierte Daten.
`website_data_update_time`	`Timestamp` Zeitstempel der letzten Aktualisierung für Websites.

ConfigurableBillingApproach

Konfiguration für den konfigurierbaren Abrechnungsansatz.

Enums
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	Standardwert. Nicht konfigurierbarer Abrechnungsansatz für Spark und Nicht-Spark.
`CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE`	Verwenden Sie die Abrechnung für Abo-Basis und Überschreitung für den Indexierungskern für Speicher ohne Einbettung.
`CONFIGURABLE_CONSUMPTION_EMBEDDING`	Verwenden Sie die nutzungsbasierte Pay-as-you-go-Abrechnung für das Add-on für eingebetteten Speicher.

ContentConfig

Inhaltskonfiguration des Datenspeichers.

Enums
`CONTENT_CONFIG_UNSPECIFIED`	Standardwert.
`NO_CONTENT`	Enthält nur Dokumente ohne `Document.content`.
`CONTENT_REQUIRED`	Enthält nur Dokumente mit `Document.content`.
`PUBLIC_WEBSITE`	Der Datenspeicher wird für die Suche auf öffentlichen Websites verwendet.
`GOOGLE_WORKSPACE`	Der Datenspeicher wird für die Suche im Arbeitsbereich verwendet. Details zum Arbeitsbereich-Datenspeicher werden in der `WorkspaceConfig` angegeben.

ServingConfigDataStore

Speichert Informationen zu den Bereitstellungskonfigurationen auf DataStore-Ebene.

Felder

disabled_for_serving

bool

Optional. Wenn auf „true“ gesetzt, ist der DataStore nicht für die Bearbeitung von Suchanfragen verfügbar.

DeleteAssistantRequest

Anfragenachricht für die Methode AssistantService.DeleteAssistant.

Felder

name

string

Erforderlich. Ressourcenname von Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Wenn der Aufrufer nicht berechtigt ist, die Assistant zu löschen, unabhängig davon, ob sie vorhanden ist oder nicht, wird der Fehler PERMISSION_DENIED zurückgegeben.

Wenn das zu löschende Assistant nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

DeleteCmekConfigMetadata

Metadaten zum Fortschritt des Vorgangs CmekConfigService.DeleteCmekConfig. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

DeleteCmekConfigRequest

Anfragenachricht für die Methode CmekConfigService.DeleteCmekConfig.

Felder

name

string

Erforderlich. Der Ressourcenname des zu löschenden CmekConfig, z. B. projects/{project}/locations/{location}/cmekConfigs/{cmek_config}.

DeleteCollectionMetadata

Metadaten zum Fortschritt des Vorgangs [CollectionService.UpdateCollection][]. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

DeleteCollectionRequest

Anfragenachricht für die Methode CollectionService.DeleteCollection.

Felder

name

string

Erforderlich. Der vollständige Ressourcenname der Sammlung im Format projects/{project}/locations/{location}/collections/{collection}.

DeleteControlRequest

Anfrage für die Methode „DeleteControl“.

Felder

name

string

Erforderlich. Der Ressourcenname des zu löschenden Steuerelements. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

DeleteConversationRequest

Anfrage für die Methode „DeleteConversation“.

Felder

name

string

Erforderlich. Der Ressourcenname der zu löschenden Konversation. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

DeleteDataStoreMetadata

Metadaten zum Fortschritt des Vorgangs DataStoreService.DeleteDataStore. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

DeleteDataStoreRequest

Anfragenachricht für die Methode DataStoreService.DeleteDataStore.

Felder

name

string

Erforderlich. Vollständiger Ressourcenname von DataStore, z. B. projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

Wenn der Aufrufer nicht berechtigt ist, die DataStore zu löschen, unabhängig davon, ob sie vorhanden ist oder nicht, wird der Fehler PERMISSION_DENIED zurückgegeben.

Wenn das zu löschende DataStore nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

DeleteDocumentRequest

Anfragenachricht für die Methode DocumentService.DeleteDocument.

Felder

name

string

Erforderlich. Vollständiger Ressourcenname von Document, z. B. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

Wenn der Aufrufer keine Berechtigung zum Löschen der Document hat, unabhängig davon, ob sie vorhanden ist oder nicht, wird der Fehler PERMISSION_DENIED zurückgegeben.

Wenn die zu löschende Document nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

DeleteEngineMetadata

Metadaten zum Fortschritt des Vorgangs EngineService.DeleteEngine. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

DeleteEngineRequest

Anfragenachricht für die Methode EngineService.DeleteEngine.

Felder

name

string

Erforderlich. Vollständiger Ressourcenname von Engine, z. B. projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

Wenn der Aufrufer nicht berechtigt ist, die Engine zu löschen, unabhängig davon, ob sie vorhanden ist oder nicht, wird der Fehler PERMISSION_DENIED zurückgegeben.

Wenn das zu löschende Engine nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

DeleteIdentityMappingStoreMetadata

Metadaten zum Fortschritt des Vorgangs IdentityMappingStoreService.DeleteIdentityMappingStore. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

DeleteIdentityMappingStoreRequest

Anfragenachricht für IdentityMappingStoreService.DeleteIdentityMappingStore

Felder

name

string

Erforderlich. Der Name des zu löschenden Identity Mapping Store. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

DeleteSchemaMetadata

Metadaten für den LRO „DeleteSchema“.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

DeleteSchemaRequest

Anfragenachricht für die Methode SchemaService.DeleteSchema.

Felder

name

string

Erforderlich. Der vollständige Ressourcenname des Schemas im Format projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

DeleteSessionRequest

Anfrage für die Methode „DeleteSession“.

Felder

name

string

Erforderlich. Der Ressourcenname der zu löschenden Sitzung. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

DeleteSitemapMetadata

Metadaten zum Fortschritt des Vorgangs SiteSearchEngineService.DeleteSitemap. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

DeleteSitemapRequest

Anfragenachricht für die Methode SiteSearchEngineService.DeleteSitemap.

Felder

name

string

Erforderlich. Vollständiger Ressourcenname von Sitemap, z. B. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}.

Wenn der Aufrufer keine Berechtigung für den Zugriff auf die Sitemap hat, unabhängig davon, ob sie vorhanden ist oder nicht, wird ein PERMISSION_DENIED-Fehler zurückgegeben.

Wenn die angeforderte Sitemap nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

DeleteTargetSiteMetadata

Metadaten zum Fortschritt des Vorgangs SiteSearchEngineService.DeleteTargetSite. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

DeleteTargetSiteRequest

Anfragenachricht für die Methode SiteSearchEngineService.DeleteTargetSite.

Felder

name

string

Erforderlich. Vollständiger Ressourcenname von TargetSite, z. B. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}.

Wenn der Aufrufer keine Berechtigung für den Zugriff auf die TargetSite hat, unabhängig davon, ob sie vorhanden ist oder nicht, wird ein PERMISSION_DENIED-Fehler zurückgegeben.

Wenn die angeforderte TargetSite nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

DestinationConfig

Definiert Zielendpunkte, die für die Verbindung zu Drittanbieterquellen verwendet werden.

Felder
`key`	`string` Optional. Eindeutige Ziel-ID, die vom Connector unterstützt wird.
`destinations[]`	`Destination` Optional. Die Ziele für den entsprechenden Schlüssel.
Union-Feld `destination_config_params`. Zusätzliche Parameter für diese Zielkonfiguration. Für `destination_config_params` ist nur einer der folgenden Werte zulässig:
`params`	`Struct` Optional. Zusätzliche Parameter für diese Zielkonfiguration im strukturierten JSON-Format.
`json_params`	`string` Zusätzliche Parameter für diese Zielkonfiguration im JSON-Stringformat.

Ziel

Definiert einen Zielendpunkt.

Felder

port

int32

Optional. Vom Ziel akzeptierte Zielportnummer.

Union-Feld destination. Das Endpunktziel. Für destination ist nur einer der folgenden Werte zulässig:

host

string

Öffentlich routingfähiger Host.

DisableAdvancedSiteSearchMetadata

Metadaten zum Fortschritt des Vorgangs SiteSearchEngineService.DisableAdvancedSiteSearch. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

DisableAdvancedSiteSearchRequest

Anfragenachricht für die Methode SiteSearchEngineService.DisableAdvancedSiteSearch.

Felder

site_search_engine

string

Erforderlich. Vollständiger Ressourcenname des SiteSearchEngine, z. B. projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine.

DisableAdvancedSiteSearchResponse

Dieser Typ hat keine Felder.

Antwortnachricht für die Methode SiteSearchEngineService.DisableAdvancedSiteSearch.

Dokument

Im Dokument werden alle Rohmetadateninformationen von Elementen erfasst, die empfohlen oder gesucht werden sollen.

Felder
`name`	`string` Nicht veränderbar. Der vollständige Ressourcenname des Dokuments. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.
`id`	`string` Nicht veränderbar. Die Kennung des Dokuments. Die ID sollte dem RFC-1034-Standard entsprechen und darf maximal 128 Zeichen lang sein.
`schema_id`	`string` Die Kennung des Schemas, das sich im selben Datenspeicher befindet.
`content`	`Content` Die mit diesem Dokument verknüpften unstrukturierten Daten. Inhalte können nur festgelegt werden und müssen festgelegt werden, wenn sich dieses Dokument in einem `CONTENT_REQUIRED`-Datenspeicher befindet.
`parent_document_id`	`string` Die Kennung des übergeordneten Dokuments. Derzeit wird maximal eine Dokumenthierarchie mit zwei Ebenen unterstützt. Die ID sollte dem RFC-1034-Standard entsprechen und darf maximal 63 Zeichen lang sein.
`derived_struct_data`	`Struct` Nur Ausgabe. Dieses Feld dient nur der Ausgabe. Es enthält abgeleitete Daten, die nicht im ursprünglichen Eingabedokument enthalten sind.
`acl_info`	`AclInfo` Informationen zur Zugriffssteuerung für das Dokument.
`index_time`	`Timestamp` Nur Ausgabe. Der Zeitpunkt der letzten Indexierung des Dokuments. Wenn dieses Feld festgelegt ist, kann das Dokument in den Suchergebnissen zurückgegeben werden. Dieses Feld dient nur der Ausgabe. Wenn dieses Feld nicht ausgefüllt ist, bedeutet das, dass das Dokument noch nie indexiert wurde.
`index_status`	`IndexStatus` Nur Ausgabe. Der Indexstatus des Dokuments. Wenn das Dokument erfolgreich indexiert wurde, wird das Feld „index_time“ ausgefüllt. Andernfalls wird das Feld „error_samples“ ausgefüllt, wenn das Dokument aufgrund von Fehlern nicht indexiert wird. Andernfalls wird das Feld „pending_message“ ausgefüllt, wenn der Index des Dokuments gerade erstellt wird.
Union-Feld `data`. Datendarstellung Du musst entweder `struct_data` oder `json_data` angeben. Andernfalls wird der Fehler `INVALID_ARGUMENT` ausgegeben. Für `data` ist nur einer der folgenden Werte zulässig:
`struct_data`	`Struct` Die strukturierten JSON-Daten für das Dokument. Sie muss der registrierten `Schema` entsprechen, andernfalls wird ein `INVALID_ARGUMENT`-Fehler ausgegeben.
`json_data`	`string` Die JSON-String-Darstellung des Dokuments. Sie muss der registrierten `Schema` entsprechen, andernfalls wird ein `INVALID_ARGUMENT`-Fehler ausgegeben.

AclInfo

ACL-Informationen des Dokuments.

Felder

readers[]

AccessRestriction

Leser des Dokuments.

AccessRestriction

AclRestriction zum Modellieren komplexer Einschränkungen für die Vererbung.

Beispiel: Modellieren einer „Both Permit“-Vererbung, bei der ein Nutzer Zugriff auf das übergeordnete Dokument benötigt, um auf ein untergeordnetes Dokument zugreifen zu können.

Dokumenthierarchie: Space_S –> Page_P.

Leser: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2

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

Page_P-ACL-Einschränkung. { "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" } ], } ] } }

Felder

principals[]

Principal

Liste der Hauptkonten.

idp_wide

bool

Alle Nutzer innerhalb des Identitätsanbieters.

Inhalt

Unstrukturierte Daten, die mit diesem Dokument verknüpft sind.

Felder
`mime_type`	`string` Der MIME-Typ des Inhalts. Unterstützte Typen: `application/pdf` (PDF, derzeit werden nur native PDFs unterstützt) `text/html` (HTML) `text/plain` (TXT) `application/xml` oder `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) Die folgenden Typen werden nur unterstützt, wenn der Layoutparser im Datenspeicher aktiviert ist: `image/bmp` (BMP) `image/gif` (GIF) `image/jpeg` (JPEG) `image/png` (PNG) `image/tiff` (TIFF) Weitere Informationen finden Sie unter https://www.iana.org/assignments/media-types/media-types.xhtml.
Union-Feld `content`. Der Inhalt des unstrukturierten Dokuments. Für `content` ist nur einer der folgenden Werte zulässig:
`raw_bytes`	`bytes` Der Inhalt als Bytestream. Die maximale Länge beträgt 1.000.000 Bytes (1 MB / ~0,95 MiB). Hinweis: Wie bei allen `bytes`-Feldern wird dieses Feld in Protocol Buffers als reiner Binärwert und in JSON als base64-codierter String dargestellt. `abc123!?$*&()'-=@~` sollte in JSON beispielsweise als `YWJjMTIzIT8kKiYoKSctPUB+` dargestellt werden. Weitere Informationen finden Sie unter https://developers.google.com/protocol-buffers/docs/proto3#json.
`uri`	`string` Der URI des Inhalts. Es werden nur Cloud Storage-URIs unterstützt, z.B. `gs://bucket-name/path/to/file`. Die maximale Dateigröße beträgt 2, 5 MB für textbasierte Formate und 200 MB für andere Formate.

IndexStatus

Indexierungsstatus des Dokuments.

Felder

index_time

Der Zeitpunkt, zu dem das Dokument indexiert wurde. Wenn dieses Feld ausgefüllt ist, wurde das Dokument indexiert.

error_samples[]

LayoutBasedChunkingConfig

Ein Beispiel für Fehler, die beim Indexieren des Dokuments aufgetreten sind. Wenn dieses Feld ausgefüllt ist, wird das Dokument aufgrund von Fehlern nicht indexiert.

pending_message

string

Nicht veränderbar. Die Meldung gibt an, dass der Dokumentindex erstellt wird. Wenn dieses Feld ausgefüllt ist, wird der Dokumentindex noch erstellt.

DocumentInfo

Detaillierte Dokumentinformationen, die mit einem Nutzerereignis verknüpft sind.

Felder
`promotion_ids[]`	`string` Die mit diesem Dokument verknüpften Angebots-IDs. Derzeit ist dieses Feld auf maximal eine ID beschränkt.
`joined`	`bool` Nur Ausgabe. Gibt an, ob das referenzierte Dokument im Datenspeicher gefunden werden kann.
Union-Feld `document_descriptor`. Ein erforderlicher Deskriptor der zugehörigen `Document`. Wenn `id` angegeben ist, werden die Standardwerte für `{location}`, `{collection_id}`, `{data_store_id}` und `{branch_id}` verwendet, wenn Anmerkungen mit dem gespeicherten Dokument erstellt werden. Wenn `name` angegeben ist, werden die angegebenen Werte (Standardwerte sind zulässig) für `{location}`, `{collection_id}`, `{data_store_id}` und `{branch_id}` verwendet, wenn das gespeicherte Dokument annotiert wird. Für `document_descriptor` ist nur einer der folgenden Werte zulässig:
`id`	`string` Die Ressourcen-ID von `Document`.
`name`	`string` Der vollständige Name der `Document`-Ressource im Format `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`.
`uri`	`string` Der `Document`-URI ist nur für Website-Datenspeicher zulässig.
`quantity`	`int32` Menge des Dokuments, das mit dem Nutzerereignis verknüpft ist. Der Standardfaktor ist 1. Dieser Wert ist beispielsweise „2“, wenn bei einem `add-to-cart`-Ereignis zwei Mengen desselben Dokuments beteiligt sind. Erforderlich für Ereignisse der folgenden Ereignistypen: `add-to-cart` `purchase`
`conversion_value`	`float` Optional. Der mit diesem Dokument verknüpfte Conversion-Wert. Muss festgelegt werden, wenn `UserEvent.event_type` „conversion“ ist. Ein Wert von 1.000 bedeutet beispielsweise, dass ein Dokument für den Conversion-Typ `watch` 1.000 Sekunden lang angesehen wurde.

DocumentProcessingConfig

Eine Singleton-Ressource von DataStore. Wenn das Feld leer ist, wenn DataStore erstellt wird und DataStore auf DataStore.ContentConfig.CONTENT_REQUIRED gesetzt ist, wird standardmäßig der digitale Parser verwendet.

Felder
`name`	`string` Der vollständige Ressourcenname der Konfiguration für die Dokumentverarbeitung. Format: `projects//locations//collections//dataStores//documentProcessingConfig`.
`chunking_config`	`ChunkingConfig` Gibt an, ob der Chunking-Modus aktiviert ist.
`default_parsing_config`	`ParsingConfig` Konfigurationen für den Standardparser für Dokumente. Wenn dies nicht angegeben ist, wird die Standard-DigitalParsingConfig konfiguriert und die Standardkonfiguration für das Parsen wird auf alle Dateitypen für das Parsen von Dokumenten angewendet.
`parsing_config_overrides`	`map<string, ParsingConfig>` Zuordnung vom Dateityp zum Überschreiben der Standardkonfiguration für das Parsen basierend auf dem Dateityp. Unterstützte Schlüssel: `pdf`: Überschreiben der Parsing-Konfiguration für PDF-Dateien. Es werden entweder das digitale Parsen, das OCR-Parsen oder das Layout-Parsen unterstützt. `html`: Überschreibt die Parsing-Konfiguration für HTML-Dateien. Es werden nur das digitale Parsing und das Layout-Parsing unterstützt. `docx`: Überschreibt die Parsing-Konfiguration für DOCX-Dateien. Es werden nur das digitale Parsing und das Layout-Parsing unterstützt. `pptx`: Konfiguration zum Überschreiben der Analyse für PPTX-Dateien. Es werden nur die digitale Analyse und die Layoutanalyse unterstützt. `xlsm`: Überschreiben der Parsing-Konfiguration für XLSM-Dateien. Es werden nur das digitale und das Layout-Parsing unterstützt. `xlsx`: Überschreibt die Parsing-Konfiguration für XLSX-Dateien. Es werden nur digitales Parsing und Layout-Parsing unterstützt.

ChunkingConfig

Konfiguration für die Chunking-Konfiguration.

Felder

Union-Feld chunk_mode. Zusätzliche Konfigurationen, die das Verhalten der Chunking-Funktion definieren. Für chunk_mode ist nur einer der folgenden Werte zulässig:

layout_based_chunking_config

Konfiguration für die auf dem Layout basierende Aufteilung.

LayoutBasedChunkingConfig

Konfiguration für die auf dem Layout basierende Aufteilung.

Felder

chunk_size

int32

Das Token-Größenlimit für jeden Chunk.

Unterstützte Werte: 100–500 (einschließlich). Standardwert: 500

include_ancestor_headings

bool

Gibt an, ob verschiedene Überschriftenebenen an Blöcke aus der Mitte des Dokuments angehängt werden sollen, um Kontextverlust zu vermeiden.

Standardwert: „False“.

ParsingConfig

Zugehörige Konfigurationen, die auf einen bestimmten Dokumentparser angewendet werden.

Felder
Union-Feld `type_dedicated_config`. Konfigurationen für Dokumentverarbeitungstypen. Für `type_dedicated_config` ist nur einer der folgenden Werte zulässig:
`digital_parsing_config`	`DigitalParsingConfig` Konfigurationen, die auf den digitalen Parser angewendet wurden.
`ocr_parsing_config`	`OcrParsingConfig` Auf den OCR-Parser angewendete Konfigurationen. Derzeit gilt das nur für PDFs.
`layout_parsing_config`	`LayoutParsingConfig` Auf den Layoutparser angewendete Konfigurationen.

DigitalParsingConfig

Dieser Typ hat keine Felder.

Die Konfigurationen für das digitale Parsen von Dokumenten.

LayoutParsingConfig

Die Konfigurationen für das Parsen des Layouts von Dokumenten.

Felder
`enable_table_annotation`	`bool` Optional. Wenn „true“, wird der Tabelle während des Parsens eine LLM-basierte Annotation hinzugefügt.
`enable_image_annotation`	`bool` Optional. Wenn „true“, wird dem Bild während des Parsens die LLM-basierte Annotation hinzugefügt.
`structured_content_types[]`	`string` Optional. Enthält die erforderlichen Strukturtypen, die aus dem Dokument extrahiert werden sollen. Unterstützte Werte: `shareholder-structure`
`exclude_html_elements[]`	`string` Optional. Liste der HTML-Elemente, die aus den geparsten Inhalten ausgeschlossen werden sollen.
`exclude_html_classes[]`	`string` Optional. Liste der HTML-Klassen, die aus dem geparsten Inhalt ausgeschlossen werden sollen.
`exclude_html_ids[]`	`string` Optional. Liste der HTML-IDs, die aus den geparsten Inhalten ausgeschlossen werden sollen.
`enable_get_processed_document`	`bool` Optional. Bei „true“ wird das verarbeitete Dokument für die GetProcessedDocument API verfügbar gemacht.

OcrParsingConfig

Die OCR-Parsing-Konfigurationen für Dokumente.

Felder

enhanced_document_elements[]
(deprecated)

string

[VERWORFEN] Die Verwendung dieses Feldes wurde eingestellt. Wenn Sie die zusätzliche Verarbeitung erweiterter Dokumentelemente nutzen möchten, wechseln Sie zu layout_parsing_config.

use_native_text

bool

Wenn „true“ festgelegt ist, wird auf Seiten mit nativem Text nativer Text anstelle von OCR-Text verwendet.

DoubleList

Doppelte Liste.

Felder

values[]

double

Double-Werte.

EnableAdvancedSiteSearchMetadata

Metadaten zum Fortschritt des Vorgangs SiteSearchEngineService.EnableAdvancedSiteSearch. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

RecommendedForYouFeatureConfig

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

EnableAdvancedSiteSearchRequest

Anfragenachricht für die Methode SiteSearchEngineService.EnableAdvancedSiteSearch.

Felder

site_search_engine

string

Erforderlich. Vollständiger Ressourcenname des SiteSearchEngine, z. B. projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine.

EnableAdvancedSiteSearchResponse

Dieser Typ hat keine Felder.

Antwortnachricht für die Methode SiteSearchEngineService.EnableAdvancedSiteSearch.

Engine

Metadaten, die die Trainings- und Bereitstellungsparameter eines Engine beschreiben.

Felder
`name`	`string` Nicht veränderbar. ID. Der vollständig qualifizierte Ressourcenname der Engine. Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`-Engine sollte 1–63 Zeichen umfassen. Gültige Zeichen sind /[a-z0-9][a-z0-9-_]*/. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.
`display_name`	`string` Erforderlich. Der Anzeigename der Engine. Sollte für Menschen lesbar sein. UTF-8-codierter String mit einem Limit von 1.024 Zeichen.
`create_time`	`Timestamp` Nur Ausgabe. Zeitstempel für die Erstellung der Recommendation Engine.
`update_time`	`Timestamp` Nur Ausgabe. Zeitstempel der letzten Aktualisierung der Recommendation Engine.
`data_store_ids[]`	`string` Optional. Die mit dieser Engine verknüpften Datenspeicher. Für Engines vom Typ `SOLUTION_TYPE_SEARCH` und `SOLUTION_TYPE_RECOMMENDATION` kann maximal ein Datenspeicher zugeordnet werden. Wenn `solution_type` gleich `SOLUTION_TYPE_CHAT` ist, können hier mehrere `DataStore`s im selben `Collection` verknüpft werden. Wenn das Feld in `CreateEngineRequest` verwendet wird, muss eine DataStore-ID angegeben werden, da das System sie für erforderliche Initialisierungen verwendet.
`solution_type`	`SolutionType` Erforderlich. Die Lösungen der Engine.
`industry_vertical`	`IndustryVertical` Optional. Die Branche, die von der Engine registriert wird. Die Einschränkung der Branche „Engine“ basiert auf `DataStore`: Die Branche der Engine muss mit der Branche des mit der Engine verknüpften Datenspeichers übereinstimmen.
`common_config`	`CommonConfig` Allgemeine Konfigurationsspezifikation, die die Metadaten der Engine angibt.
`app_type`	`AppType` Optional. Nicht veränderbar. Dies ist der Anwendungstyp, den diese Engine-Ressource darstellt. HINWEIS: Dies ist ein neues Konzept, das unabhängig von der bestehenden Branche oder dem Lösungstyp ist.
`disable_analytics`	`bool` Optional. Gibt an, ob die Analyse für Suchanfragen, die mit dieser Engine durchgeführt werden, deaktiviert werden soll.
`features`	`map<string, FeatureState>` Optional. Funktionskonfiguration für die Engine, um Funktionen zu aktivieren oder zu deaktivieren. Unterstützte Schlüssel: `*`: Alle Funktionen. Wenn dieser Wert vorhanden ist, werden alle anderen Einstellungen für den Funktionsstatus ignoriert. `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` Optional. Konfiguration für den konfigurierbaren Abrechnungsansatz.
Union-Feld `engine_config`. Zusätzliche Konfigurationsspezifikationen, die das Verhalten der Engine definieren. Für `engine_config` ist nur einer der folgenden Werte zulässig:
`chat_engine_config`	`ChatEngineConfig` Konfigurationen für die Chat Engine. Gilt nur, wenn `solution_type` `SOLUTION_TYPE_CHAT` ist.
`search_engine_config`	`SearchEngineConfig` Konfigurationen für die Suchmaschine. Gilt nur, wenn `solution_type` `SOLUTION_TYPE_SEARCH` ist.
`media_recommendation_engine_config`	`MediaRecommendationEngineConfig` Konfigurationen für die Media Engine. Gilt nur für die Datenspeicher mit den Branchen `solution_type` `SOLUTION_TYPE_RECOMMENDATION` und `IndustryVertical.MEDIA`.
Union-Feld `engine_metadata`. Metadaten der Engine zum Überwachen des Status der Engine. Für `engine_metadata` ist nur einer der folgenden Werte zulässig:
`chat_engine_metadata`	`ChatEngineMetadata` Nur Ausgabe. Zusätzliche Informationen zur Chat Engine. Gilt nur, wenn `solution_type` `SOLUTION_TYPE_CHAT` ist.

AppType

Die App der Engine.

Enums
`APP_TYPE_UNSPECIFIED`	Alle nicht angegebenen Apps.
`APP_TYPE_INTRANET`	App-Typ für die Intranetsuche und Agentspace.

ChatEngineConfig

Konfigurationen für eine Chat Engine.

Felder

agent_creation_config

AgentCreationConfig

Die Konfiguration zum Generieren des Dialogflow-Agents, der dieser Engine zugeordnet ist.

Diese Konfigurationen werden einmalig vom Dialogflow-Dienst verwendet und an ihn übergeben. Das bedeutet, dass sie nach der Erstellung der Engine nicht mehr über die EngineService.GetEngine- oder EngineService.ListEngines-API abgerufen werden können.

dialogflow_agent_to_link

string

Der Ressourcenname eines vorhandenen Dialogflow-Agents, der mit dieser Chat Engine verknüpft werden soll. Kunden können entweder agent_creation_config angeben, um einen Agent zu erstellen, oder einen Agentnamen angeben, der den Agent mit der Chat-Engine verknüpft.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Die dialogflow_agent_to_link werden einmalig vom Dialogflow-Dienst verwendet und an ihn übergeben. Das bedeutet, dass sie nach der Erstellung der Engine nicht mehr über die EngineService.GetEngine- oder EngineService.ListEngines-API abgerufen werden können. Verwenden Sie ChatEngineMetadata.dialogflow_agent für die tatsächliche Agent-Zuordnung, nachdem die Engine erstellt wurde.

allow_cross_region

bool

Optional. Wenn das Flag auf „true“ gesetzt ist, können sich der Agent und die Engine an verschiedenen Standorten befinden. Andernfalls müssen sie sich am selben Standort befinden. Das Flag ist standardmäßig auf „false“ gesetzt.

Die allow_cross_region werden einmalig von EngineService.CreateEngine verwendet und an EngineService.CreateEngine übergeben. Das bedeutet, dass sie nach der Erstellung der Engine nicht mehr über die EngineService.GetEngine- oder EngineService.ListEngines-API abgerufen werden können.

AgentCreationConfig

Konfigurationen zum Generieren eines Dialogflow-Agents.

Felder
`business`	`string` Name des Unternehmens, der Organisation oder des Rechtssubjekts, das der Vertreter vertritt. Wird für den LLM-Prompt des Wissensconnectors und für die Wissenssuche verwendet.
`default_language_code`	`string` Erforderlich. Die Standardsprache des Agents als Sprachtag. Unter Sprachunterstützung finden Sie eine Liste der aktuell unterstützten Sprachcodes.
`time_zone`	`string` Erforderlich. Die Zeitzone des Agents aus der Zeitzonendatenbank, z. B. Amerika/New_York, Europa/Paris.
`location`	`string` Agent-Standort für die Agent-Erstellung. Unterstützte Werte: global/us/eu. Wenn nicht angegeben, wird der Agent von der US-Engine standardmäßig mit „us-central-1“ und von der EU-Engine standardmäßig mit „eu-west-1“ erstellt.

ChatEngineMetadata

Zusätzliche Informationen zu einer Chat Engine. Felder in dieser Nachricht dienen nur der Ausgabe.

Felder

dialogflow_agent

string

Der Ressourcenname eines Dialogflow-Agents, auf den sich diese Chat Engine bezieht.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

CommonConfig

Häufige Konfigurationen für eine Engine.

Felder

company_name

string

Der Name des Unternehmens, des Betriebs oder der Rechtspersönlichkeit, die mit der Engine verknüpft ist. Wenn Sie dies festlegen, können Sie die LLM-bezogenen Funktionen möglicherweise verbessern.

ConfigurableBillingApproach

Konfiguration für den konfigurierbaren Abrechnungsansatz.

Enums
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	Standardwert. Nicht konfigurierbarer Abrechnungsansatz für Spark und Nicht-Spark. Allgemeines Preismodell.
`CONFIGURABLE_BILLING_APPROACH_ENABLED`	Der Abrechnungsansatz richtet sich nach den vom Kunden angegebenen Konfigurationen.

FeatureState

Der Status des Features für die Engine.

Enums
`FEATURE_STATE_UNSPECIFIED`	Der Funktionsstatus ist nicht angegeben.
`FEATURE_STATE_ON`	Die Funktion ist aktiviert, um sie zugänglich zu machen.
`FEATURE_STATE_OFF`	Die Funktion ist deaktiviert und kann nicht aufgerufen werden.

MediaRecommendationEngineConfig

Zusätzliche Konfigurationsspezifikationen für eine Media Recommendation Engine.

Felder
`type`	`string` Erforderlich. Der Motortyp, z. B. `recommended-for-you`. Dieses Feld und `optimization_objective` beschreiben Metadaten für die Engine, mit denen das Training und die Bereitstellung der Engine gesteuert werden. Derzeit unterstützte Werte: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.
`optimization_objective`	`string` Das Optimierungsziel, z. B. `cvr`. Dieses Feld und `optimization_objective` beschreiben Metadaten für die Engine, mit denen das Training und die Bereitstellung der Engine gesteuert werden. Derzeit unterstützte Werte: `ctr`, `cvr`. Wenn nicht angegeben, wird je nach Engine-Typ ein Standardwert ausgewählt. Der Standardwert hängt vom Empfehlungstyp ab: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
`optimization_objective_config`	`OptimizationObjectiveConfig` Name und Wert des benutzerdefinierten Grenzwerts für „cvr“-Optimierungszielvorhaben. Für target_field `watch-time` muss target_field_value ein Ganzzahlwert sein, der die Media-Fortschrittszeit in Sekunden zwischen (0, 86400] angibt (0 wird ausgeschlossen, 86400 wird eingeschlossen). Beispiel: 90). Für target_field `watch-percentage` muss target_field_value ein gültiger Gleitkommawert zwischen (0, 1.0] sein (0 wird ausgeschlossen, 1.0 wird eingeschlossen) (z.B. 0,5).
`training_state`	`TrainingState` Der Trainingsstatus der Engine, z.B. `TRAINING` oder `PAUSED`. Da ein Teil der Kosten für den Betrieb des Dienstes von der Häufigkeit des Trainings abhängt, kann dies verwendet werden, um zu bestimmen, wann die Engine trainiert werden soll, um die Kosten zu kontrollieren. Wenn keine Angabe erfolgt, ist der Standardwert für die `CreateEngine`-Methode `TRAINING`. Der Standardwert für die `UpdateEngine`-Methode ist, den Status beizubehalten.
`engine_features_config`	`EngineFeaturesConfig` Optional. Konfiguration zusätzlicher Engine-Funktionen.

EngineFeaturesConfig

Weitere Featurekonfigurationen des ausgewählten Engine-Typs.

Felder

Union-Feld type_dedicated_config. Konfigurationen für Funktionen, die auf einen bestimmten Typ von Media-Empfehlungs-Engines angewendet werden. Für type_dedicated_config ist nur einer der folgenden Werte zulässig:

recommended_for_you_config

Für die Konfiguration der Engine-Funktion empfohlen.

most_popular_config

MostPopularFeatureConfig

Beliebteste Engine-Funktionskonfiguration.

MostPopularFeatureConfig

Funktionskonfigurationen, die zum Erstellen einer Engine vom Typ „Am beliebtesten“ erforderlich sind.

Felder

time_window_days

int64

Das Zeitfenster, für das die Engine während des Trainings und der Vorhersage abgefragt wird. Nur positive Ganzzahlen. Der Wert entspricht den Ereignissen der letzten X Tage. Derzeit für die most-popular-items-Engine erforderlich.

OptimizationObjectiveConfig

Benutzerdefinierte Untergrenze für das cvr-Optimierungsziel.

Felder

target_field

string

Erforderlich. Der Name des Zielfelds. Derzeit unterstützte Werte: watch-percentage, watch-time.

target_field_value_float

float

Erforderlich. Der Schwellenwert, der auf das Ziel angewendet werden soll (z.B. 0,5).

RecommendedForYouFeatureConfig

Zusätzliche Konfigurationen für die Erstellung einer recommended-for-you-Engine.

Felder

context_event_type

string

Der Ereignistyp, mit dem die Engine zum Zeitpunkt der Vorhersage abgefragt wird. Wenn diese Option auf generic gesetzt ist, werden nur view-item, media-play und media-complete als context-event beim Engine-Training verwendet. Wenn view-home-page festgelegt ist, wird view-home-page zusätzlich zu view-item, media-play und media-complete auch als context-events verwendet. Wird derzeit für die recommended-for-you-Engine unterstützt. Derzeit unterstützte Werte: view-home-page, generic.

TrainingState

Der Trainingsstatus der Engine.

Enums
`TRAINING_STATE_UNSPECIFIED`	Nicht angegebener Trainingsstatus.
`PAUSED`	Das Training der Engine wurde pausiert.
`TRAINING`	Die Engine wird trainiert.

SearchEngineConfig

Konfigurationen für eine Suchmaschine.

Felder

search_tier

SearchTier

Die Stufe der Suchfunktion dieser Engine.

Für die verschiedenen Stufen gelten möglicherweise unterschiedliche Preise. Weitere Informationen finden Sie in der Dokumentation zur Preisgestaltung.

Wenn keine Angabe gemacht wird, ist der Standardwert SearchTier.SEARCH_TIER_STANDARD.

search_add_ons[]

SearchAddOn

Das Add‑on, das durch diese Suchmaschine aktiviert wird.

FactChunk

Fakten-Chunk.

Felder
`chunk_text`	`string` Textinhalt des Faktenblocks. Darf höchstens 10.000 Zeichen lang sein.
`source`	`string` Quelle, aus der dieser Faktenblock stammt. Wenn der Chunk aus den in der Anfrage bereitgestellten GroundingFacts abgerufen wurde, enthält dieses Feld den Index des entsprechenden Fakts.
`index`	`int32` Der Index dieses Chunks. Wird derzeit nur für den Streamingmodus verwendet.
`source_metadata`	`map<string, string>` Detailliertere Informationen zur Quellreferenz.
`uri`	`string` Der URI der Quelle.
`title`	`string` Der Titel der Quelle.
`domain`	`string` Die Domain der Quelle.

FetchDomainVerificationStatusRequest

Anfragenachricht für die Methode SiteSearchEngineService.FetchDomainVerificationStatus.

Felder

site_search_engine

string

Erforderlich. Die Ressource der Website-Suchmaschine, unter der wir den gesamten Domainbestätigungsstatus abrufen. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

page_size

int32

Angeforderte Seitengröße. Der Server gibt möglicherweise weniger Elemente als angefordert zurück. Wenn kein Wert angegeben wurde, wählt der Server einen geeigneten Standardwert aus. Der Höchstwert beträgt 1.000. Werte über 1.000 werden implizit auf 1.000 umgewandelt.

Wenn dieses Feld negativ ist, wird der Fehler INVALID_ARGUMENT zurückgegeben.

page_token

string

Ein Seitentoken, das von einem vorherigen FetchDomainVerificationStatus-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für FetchDomainVerificationStatus bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

FetchDomainVerificationStatusResponse

Antwortnachricht für die Methode SiteSearchEngineService.FetchDomainVerificationStatus.

Felder

target_sites[]

Liste der TargetSites mit dem Status der Websiteüberprüfung.

next_page_token

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

total_size

int32

Die Gesamtzahl der Elemente, die der Anfrage entsprechen. Sie wird immer in der Antwort ausgegeben.

FetchSitemapsRequest

Anfragenachricht für die Methode SiteSearchEngineService.FetchSitemaps.

Felder

parent

string

Erforderlich. Name der übergeordneten Ressource von SiteSearchEngine, z. B. projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

matcher

Matcher

Optional. Ruft, falls angegeben, die entsprechenden Sitemap ab. Wenn nicht angegeben, werden alle Sitemaps in der DataStore abgerufen.

Matcher

Matcher für die Sitemap. Derzeit wird nur der URI-Abgleich unterstützt.

Felder

Union-Feld matcher. Matcher für die Sitemap. Für matcher ist nur einer der folgenden Werte zulässig:

uris_matcher

UrisMatcher

Matcher nach Sitemap-URIs.

UrisMatcher

Matcher für die Sitemaps anhand ihrer URIs.

Felder

uris[]

string

Die Sitemap-URIs.

FetchSitemapsResponse

Antwortnachricht für die Methode SiteSearchEngineService.FetchSitemaps.

Felder

sitemaps_metadata[]

SitemapMetadata

Liste der abgerufenen Sitemap.

SitemapMetadata

Enthält ein Sitemap und seine Metadaten.

Felder

sitemap

Sitemap

Das Feld Sitemap.

FhirStoreSource

Cloud FhirStore-Quelldaten importieren aus.

Felder
`fhir_store`	`string` Erforderlich. Der vollständige Ressourcenname des FHIR-Speichers, aus dem Daten importiert werden sollen, im Format `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.
`gcs_staging_dir`	`string` Für den Import verwendetes Cloud Storage-Zwischenverzeichnis mit einer Längenbeschränkung von 2.000 Zeichen. Kann angegeben werden, wenn der FhirStore-Export in ein bestimmtes Cloud Storage-Verzeichnis erfolgen soll.
`resource_types[]`	`string` Die zu importierenden FHIR-Ressourcentypen. Die Ressourcentypen sollten eine Teilmenge aller unterstützten FHIR-Ressourcentypen sein. Standardmäßig werden alle unterstützten FHIR-Ressourcentypen verwendet, wenn das Feld leer ist.
`update_from_latest_predefined_schema`	`bool` Optional. Gibt an, ob das DataStore-Schema auf das neueste vordefinierte Schema aktualisiert werden soll. Wenn „true“, wird das DataStore-Schema aktualisiert, um alle FHIR-Felder oder Ressourcentypen einzuschließen, die seit dem letzten Import hinzugefügt wurden. Die entsprechenden FHIR-Ressourcen werden aus dem FHIR-Speicher importiert. Hinweis: Dieses Feld kann nicht in Verbindung mit `resource_types` verwendet werden. Sie sollte nach dem ersten Import verwendet werden.

FirestoreSource

Firestore-Quelle, aus der Daten importiert werden sollen.

Felder
`project_id`	`string` Die Projekt-ID des Projekts, in dem sich die Cloud SQL-Quelle befindet. Die maximale Länge beträgt 128 Zeichen. Wenn keine Angabe erfolgt, wird die Projekt-ID von der übergeordneten Anfrage übernommen.
`database_id`	`string` Erforderlich. Die Firestore-Datenbank, aus der die Daten kopiert werden sollen. Die Länge darf 256 Zeichen nicht überschreiten.
`collection_id`	`string` Erforderlich. Die Firestore-Sammlung (oder ‑Entität), aus der die Daten kopiert werden sollen. Die Länge ist auf 1.500 Zeichen begrenzt.
`gcs_staging_dir`	`string` Für den Import verwendetes Cloud Storage-Zwischenverzeichnis mit einer Längenbeschränkung von 2.000 Zeichen. Kann angegeben werden, wenn der Firestore-Export in ein bestimmtes Cloud Storage-Verzeichnis erfolgen soll. Achten Sie darauf, dass das Firestore-Dienstkonto die erforderlichen Cloud Storage-Administratorberechtigungen für den Zugriff auf das angegebene Cloud Storage-Verzeichnis hat.

GcsSource

Cloud Storage-Speicherort für Eingabeinhalte.

Felder

input_uris[]

string

Erforderlich. Cloud Storage-URIs für Eingabedateien. Jeder URI kann bis zu 2.000 Zeichen lang sein. URIs können dem vollständigen Objektpfad entsprechen (z. B. gs://bucket/directory/object.json) oder einem Muster, das mit einer oder mehreren Dateien übereinstimmt, z. B. gs://bucket/directory/*.json.

Eine Anfrage kann maximal 100 Dateien enthalten (oder 100.000 Dateien, wenn data_schema gleich content ist). Jede Datei darf maximal 2 GB groß sein (oder 100 MB, wenn data_schema gleich content ist).

data_schema

string

Das Schema, das beim Parsen der Daten aus der Quelle verwendet werden soll.

Unterstützte Werte für den Dokumentimport:

document (Standard): Ein JSON-Document pro Zeile. Jedes Dokument muss eine gültige Document.id haben.
content: Unstrukturierte Daten (z.B. PDF, HTML). Jede Datei, die mit input_uris übereinstimmt, wird zu einem Dokument. Die ID wird auf die ersten 128 Bit von SHA256(URI) gesetzt, die als Hexadezimalstring codiert sind.
custom: Ein benutzerdefiniertes JSON-Objekt pro Zeile in einem beliebigen Format, das der definierten Schema des Datenspeichers entspricht. Diese Funktion kann nur für die vertikale Branche „GENERIC Data Store“ verwendet werden.
csv: Eine CSV-Datei mit einem Header, der der definierten Schema des Datenspeichers entspricht. Jeder Eintrag nach dem Header wird als Dokument importiert. Diese Funktion kann nur für die vertikale Branche GENERIC Data Store verwendet werden.

Unterstützte Werte für den Import von Nutzerereignissen:

user_event (Standard): Ein JSON-UserEvent pro Zeile.

GetAclConfigRequest

Anfragenachricht für die Methode GetAclConfigRequest.

Felder

name

string

Erforderlich. Ressourcenname von AclConfig, z. B. projects/*/locations/*/aclConfig.

Wenn der Aufrufer keine Berechtigung für den Zugriff auf die AclConfig hat, unabhängig davon, ob sie vorhanden ist oder nicht, wird ein PERMISSION_DENIED-Fehler zurückgegeben.

GetAnswerRequest

Anfrage für die Methode „GetAnswer“.

Felder

name

string

Erforderlich. Der Ressourcenname der abzurufenden Antwort. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}

GetAssistAnswerRequest

Anfragenachricht für die Methode AssistAnswerService.GetAssistAnswer.

Felder

name

string

Erforderlich. Ressourcenname von AssistAnswer. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}

GetAssistantRequest

Anfragenachricht für die Methode AssistantService.GetAssistant.

Felder

name

string

Erforderlich. Ressourcenname von Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

GetCmekConfigRequest

Anfragenachricht für die Methode GetCmekConfigRequest.

Felder

name

string

Erforderlich. Ressourcenname von CmekConfig, z. B. projects/*/locations/*/cmekConfig oder projects/*/locations/*/cmekConfigs/*.

Wenn der Aufrufer keine Berechtigung für den Zugriff auf die CmekConfig hat, unabhängig davon, ob sie vorhanden ist oder nicht, wird ein PERMISSION_DENIED-Fehler zurückgegeben.

GetControlRequest

Anfrage für die Methode „GetControl“.

Felder

name

string

Erforderlich. Der Ressourcenname des abzurufenden Steuerelements. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

GetConversationRequest

Anfrage für die Methode „GetConversation“.

Felder

name

string

Erforderlich. Der Ressourcenname der abzurufenden Konversation. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

GetDataConnectorRequest

Anfrage für die Methode DataConnectorService.GetDataConnector.

Felder

name

string

Erforderlich. Vollständiger Ressourcenname von DataConnector, z. B. projects/{project}/locations/{location}/collections/{collection_id}/dataConnector.

Wenn der Aufrufer keine Berechtigung für den Zugriff auf die DataConnector hat, unabhängig davon, ob sie vorhanden ist oder nicht, wird ein PERMISSION_DENIED-Fehler zurückgegeben.

Wenn die angeforderte DataConnector nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

GetDataStoreRequest

Anfragenachricht für die Methode DataStoreService.GetDataStore.

Felder

name

string

Erforderlich. Vollständiger Ressourcenname von DataStore, z. B. projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

Wenn der Aufrufer keine Berechtigung für den Zugriff auf die DataStore hat, unabhängig davon, ob sie vorhanden ist oder nicht, wird ein PERMISSION_DENIED-Fehler zurückgegeben.

Wenn die angeforderte DataStore nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

GetDocumentRequest

Anfragenachricht für die Methode DocumentService.GetDocument.

Felder

name

string

Erforderlich. Vollständiger Ressourcenname von Document, z. B. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

Wenn der Aufrufer keine Berechtigung für den Zugriff auf die Document hat, unabhängig davon, ob sie vorhanden ist oder nicht, wird ein PERMISSION_DENIED-Fehler zurückgegeben.

Wenn die angeforderte Document nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

GetEngineRequest

Anfragenachricht für die Methode EngineService.GetEngine.

Felder

name

string

Erforderlich. Vollständiger Ressourcenname von Engine, z. B. projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

GetIdentityMappingStoreRequest

Anfragenachricht für IdentityMappingStoreService.GetIdentityMappingStore

Felder

name

string

Erforderlich. Der Name des abzurufenden Identity Mapping Store. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

GetLicenseConfigRequest

Anfragenachricht für die Methode LicenseConfigService.GetLicenseConfig.

Felder

name

string

Erforderlich. Vollständiger Ressourcenname von LicenseConfig, z. B. projects/{project}/locations/{location}/licenseConfigs/*.

Wenn der Aufrufer keine Berechtigung für den Zugriff auf die LicenseConfig hat, unabhängig davon, ob sie vorhanden ist oder nicht, wird ein PERMISSION_DENIED-Fehler zurückgegeben.

Wenn die angeforderte LicenseConfig nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

GetSchemaRequest

Anfragenachricht für die Methode SchemaService.GetSchema.

Felder

name

string

Erforderlich. Der vollständige Ressourcenname des Schemas im Format projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

GetSessionRequest

Anfrage für die Methode „GetSession“.

Felder

name

string

Erforderlich. Der Ressourcenname der abzurufenden Sitzung. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

include_answer_details

bool

Optional. Wenn diese Option auf „true“ gesetzt ist, wird die vollständige Sitzung einschließlich aller Antwortdetails zurückgegeben.

GetSiteSearchEngineRequest

Anfragenachricht für die Methode SiteSearchEngineService.GetSiteSearchEngine.

Felder

name

string

Erforderlich. Ressourcenname von SiteSearchEngine, z. B. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

Wenn der Aufrufer keine Berechtigung für den Zugriff auf die [SiteSearchEngine] hat, wird ein PERMISSION_DENIED-Fehler zurückgegeben, unabhängig davon, ob sie vorhanden ist oder nicht.

GetTargetSiteRequest

Anfragenachricht für die Methode SiteSearchEngineService.GetTargetSite.

Felder

name

string

Wenn der Aufrufer keine Berechtigung für den Zugriff auf die TargetSite hat, unabhängig davon, ob sie vorhanden ist oder nicht, wird ein PERMISSION_DENIED-Fehler zurückgegeben.

Wenn die angeforderte TargetSite nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

GroundingFact

Fundierungsfakt.

Felder

fact_text

string

Textinhalt des Fakts. Darf höchstens 10.000 Zeichen lang sein.

attributes

map<string, string>

Attribute, die mit der Tatsache verknüpft sind. Zu den allgemeinen Attributen gehören source (gibt an, woher die Fakten stammen) und author (gibt den Autor der Fakten an).

HarmCategory

Schadenskategorien, die Inhalte blockieren

Enums
`HARM_CATEGORY_UNSPECIFIED`	Die Schadenskategorie ist nicht angegeben.
`HARM_CATEGORY_HATE_SPEECH`	Die Schadenskategorie ist Hassrede.
`HARM_CATEGORY_DANGEROUS_CONTENT`	Die Schadenskategorie ist gefährlicher Inhalt.
`HARM_CATEGORY_HARASSMENT`	Die Schadenskategorie ist Belästigung.
`HARM_CATEGORY_SEXUALLY_EXPLICIT`	Die Schadenskategorie umfasst sexuell explizite Inhalte.
`HARM_CATEGORY_CIVIC_INTEGRITY`	Die Schadenskategorie ist bürgerliche Integrität.

HealthcareFhirConfig

Konfiguration für den Datenspeicher für die Branche HEALTHCARE_FHIR.

Felder

enable_configurable_schema

bool

Gibt an, ob das konfigurierbare Schema für die HEALTHCARE_FHIR-Branche aktiviert werden soll.

Wenn diese Option auf true festgelegt ist, kann das vordefinierte FHIR-Schema für das Gesundheitswesen erweitert werden, um die Suche und Filterung anzupassen.

enable_static_indexing_for_batch_ingestion

bool

Gibt an, ob die statische Indexierung für die HEALTHCARE_FHIR-Batchaufnahme aktiviert werden soll.

Wenn der Wert auf true festgelegt ist, wird die Batch-Aufnahme im statischen Indexierungsmodus verarbeitet. Dieser Modus ist langsamer, kann aber größere Datenmengen verarbeiten.

IdentityMappingEntry

Identity Mapping Entry, der eine externe Identität einer internen Identität zuordnet.

Felder
`external_identity`	`string` Erforderlich. Identität außerhalb des Kundenidentitätsanbieters. Die Längenbeschränkung für die externe Identität beträgt 100 Zeichen.
Union-Feld `identity_provider_id`. Union-Feld „identity_provider_id“. Die ID des Identitätsanbieters kann ein Nutzer oder eine Gruppe sein. Für `identity_provider_id` ist nur einer der folgenden Werte zulässig:
`user_id`	`string` Nutzer-ID. Bei einem Google Workspace-Nutzerkonto sollte „user_id“ die E‑Mail-Adresse des Google Workspace-Nutzers sein. Bei einem Identitätsanbieter, der nicht von Google stammt, ist „user_id“ die zugeordnete Nutzer-ID, die während der Konfiguration des Personalpools konfiguriert wurde.
`group_id`	`string` Gruppen-ID. Bei einem Google Workspace-Nutzerkonto sollte „group_id“ die E-Mail-Adresse der Google Workspace-Gruppe sein. Bei einem Nicht-Google-Identitätsanbieter ist „group_id“ die zugeordnete Gruppen-ID, die während der Konfiguration des Mitarbeiterpools konfiguriert wurde.

IdentityMappingEntryOperationMetadata

IdentityMappingEntry-Metadaten für Vorgänge mit langer Ausführungszeit für IdentityMappingStoreService.ImportIdentityMappings und IdentityMappingStoreService.PurgeIdentityMappings

Felder

success_count

int64

Die Anzahl der IdentityMappingEntries, die erfolgreich verarbeitet wurden.

failure_count

int64

Die Anzahl der IdentityMappingEntries, die nicht verarbeitet werden konnten.

total_count

int64

Die Gesamtzahl der verarbeiteten IdentityMappingEntries.

IdentityMappingStore

Identity Mapping Store, der Identity Mapping Entries enthält.

Felder

name

string

Nicht veränderbar. Der vollständige Ressourcenname des Identitätszuordnungsspeichers. Format: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}. Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.

kms_key_name

string

Nur Eingabe. Der KMS-Schlüssel, der zum Schutz dieses Identity Mapping Store bei der Erstellung verwendet werden soll.

Muss für Anfragen festgelegt werden, die den CMEK-Organisationsrichtlinien entsprechen müssen.

Wenn dieses Feld festgelegt und erfolgreich verarbeitet wird, wird der Identity Mapping Store durch den KMS-Schlüssel geschützt, wie im Feld „cmek_config“ angegeben.

cmek_config

CmekConfig

Nur Ausgabe. CMEK-bezogene Informationen für den Identity Mapping Store.

IdentityScheduleConfig

Die Konfiguration für die Synchronisierungsläufe von Identitätsdaten.

Felder

refresh_interval

Duration

Optional. Das Aktualisierungsintervall für die Synchronisierung der Informationen zur Access Control List für die von diesem Connector aufgenommenen Dokumente. Wenn die Richtlinie nicht konfiguriert ist, wird die Zugriffssteuerungsliste im Standardintervall von 30 Minuten aktualisiert. Das Aktualisierungsintervall für die Identität kann mindestens 30 Minuten und höchstens 7 Tage betragen.

next_sync_time

DateTime

Optional. Die UTC-Zeit, zu der die nächste Datensynchronisierung für den Data Connector voraussichtlich beginnt. Kunden können nur die Stunde und Minute für die Planung der Datensynchronisierung angeben. Diese Option wird verwendet, wenn der Daten-Connector ein Aktualisierungsintervall von mehr als einem Tag hat.

IdpConfig

Konfiguration des Identitätsanbieters

Felder

idp_type

IdpType

Der Typ des Identitätsanbieters ist konfiguriert.

external_idp_config

ExternalIdpConfig

Konfiguration des externen Identitätsanbieters.

ExternalIdpConfig

Konfiguration von Drittanbieter-IdPs

Felder

workforce_pool_name

string

Name des Personalpools. Beispiel: „locations/global/workforcePools/pool_id“

IdpType

Typ des Identitätsanbieters

Enums
`IDP_TYPE_UNSPECIFIED`	Standardwert. Die ACL-Suche ist nicht aktiviert.
`GSUITE`	Google als Anbieter von selbst erhobenen Daten.
`THIRD_PARTY`	Drittanbieter.

ImportCompletionSuggestionsMetadata

Metadaten zum Fortschritt des Vorgangs „ImportCompletionSuggestions“. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder
`create_time`	`Timestamp` Erstellungszeit des Vorgangs.
`update_time`	`Timestamp` Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.
`success_count`	`int64` Anzahl der erfolgreich importierten `CompletionSuggestion`s.
`failure_count`	`int64` Anzahl der `CompletionSuggestion`, die nicht importiert werden konnten.

ImportCompletionSuggestionsRequest

Anfragenachricht für die Methode CompletionService.ImportCompletionSuggestions.

Felder
`parent`	`string` Erforderlich. Der Ressourcenname des übergeordneten Datenspeichers, für den Vorschläge zur automatischen Vervollständigung von Kunden importiert werden sollen. Entspricht dem Muster `projects//locations//collections//dataStores/`
`error_config`	`ImportErrorConfig` Der gewünschte Speicherort für Fehler, die während des Imports aufgetreten sind.
Union-Feld `source`. Die Quelle der Vorschläge für die automatische Vervollständigung. Für `source` ist nur einer der folgenden Werte zulässig:
`inline_source`	`InlineSource` Die Inline-Quelle für Vorschlagseinträge.
`gcs_source`	`GcsSource` Cloud Storage-Speicherort für die Eingabeinhalte.
`bigquery_source`	`BigQuerySource` BigQuery-Eingabequelle.

InlineSource

Die Inline-Quelle für CompletionSuggestions.

Felder

suggestions[]

CompletionSuggestion

Erforderlich. Eine Liste aller zu importierenden Einträge auf der Sperrliste. Maximal 1.000 Artikel.

ImportCompletionSuggestionsResponse

Antwort der Methode CompletionService.ImportCompletionSuggestions. Wenn der Vorgang mit langer Ausführungszeit abgeschlossen ist, wird diese Nachricht vom Feld „google.longrunning.Operations.response“ zurückgegeben, sofern der Vorgang erfolgreich war.

Felder

error_samples[]

Ein Beispiel für Fehler, die bei der Verarbeitung der Anfrage aufgetreten sind.

error_config

ImportErrorConfig

Der gewünschte Speicherort für Fehler, die während des Imports aufgetreten sind.

ImportDocumentsMetadata

Metadaten zum Fortschritt des Vorgangs „ImportDocuments“. Dieser Wert wird vom Feld „google.longrunning.Operation.metadata“ zurückgegeben.

Felder
`create_time`	`Timestamp` Erstellungszeit des Vorgangs.
`update_time`	`Timestamp` Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.
`success_count`	`int64` Anzahl der Einträge, die erfolgreich verarbeitet wurden.
`failure_count`	`int64` Anzahl der Einträge, bei deren Verarbeitung Fehler aufgetreten sind.
`total_count`	`int64` Gesamtzahl der verarbeiteten Einträge.

ImportDocumentsRequest

Anfragenachricht für Importmethoden.

Felder
`parent`	`string` Erforderlich. Der Ressourcenname des übergeordneten Zweigs, z. B. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Erfordert die Berechtigung zum Erstellen/Aktualisieren.
`error_config`	`ImportErrorConfig` Der gewünschte Speicherort für Fehler, die während des Imports aufgetreten sind.
`reconciliation_mode`	`ReconciliationMode` Der Abgleichsmodus zwischen vorhandenen Dokumenten und den zu importierenden Dokumenten. Die Standardeinstellung ist `ReconciliationMode.INCREMENTAL`.
`update_mask`	`FieldMask` Gibt an, welche Felder in den bereitgestellten importierten Dokumenten aktualisiert werden sollen. Wenn nicht festgelegt, werden standardmäßig alle Felder aktualisiert.
`auto_generate_ids`	`bool` Gibt an, ob IDs für die Dokumente automatisch generiert werden sollen, wenn sie nicht vorhanden sind. Wenn der Wert auf `true` festgelegt ist, werden `Document.id`s automatisch auf Grundlage des Hash der Nutzlast generiert. Die IDs sind bei mehreren Importen möglicherweise nicht konsistent. In diesem Fall wird `ReconciliationMode.FULL` dringend empfohlen, um doppelte Inhalte zu vermeiden. Wenn nicht festgelegt oder auf `false` gesetzt, müssen `Document.id`s mit `id_field` angegeben werden. Andernfalls können Dokumente ohne IDs nicht importiert werden. Unterstützte Datenquellen: `GcsSource`. `GcsSource.data_schema` muss `custom` oder `csv` sein. Andernfalls wird der Fehler INVALID_ARGUMENT ausgegeben. `BigQuerySource`. `BigQuerySource.data_schema` muss `custom` oder `csv` sein. Andernfalls wird der Fehler INVALID_ARGUMENT ausgegeben. `SpannerSource`. `CloudSqlSource`. `FirestoreSource`. `BigtableSource`.
`id_field`	`string` Das Feld gibt das ID-Feld oder die ID-Spalte an, die als eindeutige IDs der Dokumente verwendet werden soll. Für `GcsSource` ist es der Schlüssel des JSON-Felds. Beispiel: `my_id` für JSON `{"my_id": "some_uuid"}`. Für andere ist es möglicherweise der Spaltenname der Tabelle, in der die eindeutigen IDs gespeichert sind. Die Werte des JSON-Felds oder der Tabellenspalte werden als `Document.id` verwendet. Das JSON-Feld oder die Tabellenspalte muss vom Typ „String“ sein und die Werte müssen als gültige Strings gemäß RFC-1034 mit 1 bis 63 Zeichen festgelegt werden. Andernfalls können Dokumente ohne gültige IDs nicht importiert werden. Legen Sie dieses Feld nur fest, wenn `auto_generate_ids` nicht festgelegt oder auf `false` gesetzt ist. Andernfalls wird der Fehler INVALID_ARGUMENT ausgegeben. Wenn es nicht festgelegt ist, wird beim Importieren aus den zulässigen Datenquellen der Standardwert `_id` verwendet. Unterstützte Datenquellen: `GcsSource`. `GcsSource.data_schema` muss `custom` oder `csv` sein. Andernfalls wird der Fehler INVALID_ARGUMENT ausgegeben. `BigQuerySource`. `BigQuerySource.data_schema` muss `custom` oder `csv` sein. Andernfalls wird der Fehler INVALID_ARGUMENT ausgegeben. `SpannerSource`. `CloudSqlSource`. `BigtableSource`.
`force_refresh_content`	`bool` Optional. Gibt an, ob der unstrukturierte Inhalt der Dokumente aktualisiert werden soll. Wenn diese Option auf `true` gesetzt ist, wird der Inhaltsteil der Dokumente unabhängig vom Aktualisierungsstatus des referenzierten Inhalts aktualisiert.
Union-Feld `source`. Erforderlich. Die Quelle der Eingabe. Für `source` ist nur einer der folgenden Werte zulässig:
`inline_source`	`InlineSource` Die Inline-Quelle für die Eingabeinhalte für Dokumente.
`gcs_source`	`GcsSource` Cloud Storage-Speicherort für die Eingabeinhalte.
`bigquery_source`	`BigQuerySource` BigQuery-Eingabequelle.
`fhir_store_source`	`FhirStoreSource` FhirStore-Eingabequelle.
`spanner_source`	`SpannerSource` Spanner-Eingabequelle.
`cloud_sql_source`	`CloudSqlSource` Cloud SQL-Eingabequelle.
`firestore_source`	`FirestoreSource` Firestore-Eingabequelle.
`alloy_db_source`	`AlloyDbSource` AlloyDB-Eingabequelle.
`bigtable_source`	`BigtableSource` Cloud Bigtable-Eingabequelle.

InlineSource

Die Inline-Quelle für die Eingabekonfiguration für die Methode „ImportDocuments“.

Felder

documents[]

Erforderlich. Eine Liste der zu aktualisierenden/erstellenden Dokumente. Jedes Dokument muss eine gültige Document.id haben. Es werden maximal 100 Elemente empfohlen.

ReconciliationMode

Gibt an, wie importierte Dokumente mit den vorhandenen Dokumenten abgeglichen werden, die zuvor erstellt oder importiert wurden.

Enums
`RECONCILIATION_MODE_UNSPECIFIED`	Die Standardeinstellung ist `INCREMENTAL`.
`INCREMENTAL`	Fügt neue Dokumente ein oder aktualisiert vorhandene Dokumente.
`FULL`	Berechnet die Differenz und ersetzt das gesamte Dokument-Dataset. Vorhandene Dokumente werden möglicherweise gelöscht, wenn sie nicht am Quellspeicherort vorhanden sind. Bei Verwendung dieses Modus gibt es keine Ausfallzeiten für das Ziel-Dataset. Alle Dokumente, die unverändert bleiben oder aktualisiert werden sollen, werden während des Vorgangs weiterhin ausgeliefert.

ImportDocumentsResponse

Antwort von ImportDocumentsRequest. Wenn der Vorgang mit langer Ausführungszeit abgeschlossen ist, wird diese Nachricht vom Feld „google.longrunning.Operations.response“ zurückgegeben, wenn der Vorgang erfolgreich war.

Felder

error_samples[]

Ein Beispiel für Fehler, die bei der Verarbeitung der Anfrage aufgetreten sind.

error_config

ImportErrorConfig

Gibt das Ziel für die vollständigen Fehler in der Anfrage an, sofern festgelegt.

ImportErrorConfig

Konfiguration des Ziels für importbezogene Fehler.

Felder

Union-Feld destination Erforderlich. Ziel für Fehler. Für destination ist nur einer der folgenden Werte zulässig:

gcs_prefix

string

Cloud Storage-Präfix für Importfehler. Dies muss ein leeres, vorhandenes Cloud Storage-Verzeichnis sein. Importfehler werden in Shard-Dateien in diesem Verzeichnis geschrieben, eine pro Zeile, als JSON-codierte google.rpc.Status-Nachricht.

ImportIdentityMappingsRequest

Anfragenachricht für IdentityMappingStoreService.ImportIdentityMappings

Felder

identity_mapping_store

string

Erforderlich. Der Name des Identity Mapping Store, in den Identity Mapping-Einträge importiert werden sollen. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

Union-Feld source. Die Quelle der Eingabe. Für source ist nur einer der folgenden Werte zulässig:

inline_source

InlineSource

Die Inline-Quelle, aus der Einträge für die Identitätszuordnung importiert werden sollen.

InlineSource

Die Inline-Quelle, aus der Einträge für die Identitätszuordnung importiert werden sollen.

Felder

identity_mapping_entries[]

IdentityMappingEntry

Es können maximal 10.000 Einträge gleichzeitig importiert werden.

ImportIdentityMappingsResponse

Antwortnachricht für IdentityMappingStoreService.ImportIdentityMappings

Felder

error_samples[]

Ein Beispiel für Fehler, die bei der Verarbeitung der Anfrage aufgetreten sind.

ImportSuggestionDenyListEntriesMetadata

Metadaten zum Fortschritt des Vorgangs „ImportSuggestionDenyListEntries“. Dieser Wert wird vom Feld „google.longrunning.Operation.metadata“ zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

SuggestionDenyListEntry

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

ImportSuggestionDenyListEntriesRequest

Anfragenachricht für die Methode CompletionService.ImportSuggestionDenyListEntries.

Felder
`parent`	`string` Erforderlich. Der Ressourcenname des übergeordneten Datenspeichers, für den Einträge auf der Sperrliste importiert werden sollen. Entspricht dem Muster „projects//locations//collections//dataStores/“.
Union-Feld `source`. Die Quelle der aktualisierten SuggestionDenyList. Für `source` ist nur einer der folgenden Werte zulässig:
`inline_source`	`InlineSource` Die Inline-Quelle für den Eingabeinhalt für Einträge in der Sperrliste für Vorschläge.
`gcs_source`	`GcsSource` Cloud Storage-Speicherort für die Eingabeinhalte. Es kann nur eine Datei angegeben werden, die alle zu importierenden Einträge enthält. Unterstützte Werte `gcs_source.schema` für den Import von Einträgen in die Ablehnungsliste für Vorschläge zur automatischen Vervollständigung: `suggestion_deny_list` (Standard): Ein JSON-[SuggestionDenyListEntry] pro Zeile.

InlineSource

Die Inline-Quelle für SuggestionDenyListEntry.

Felder

entries[]

Erforderlich. Eine Liste aller zu importierenden Einträge auf der Sperrliste. Maximal 1.000 Artikel.

ImportSuggestionDenyListEntriesResponse

Antwortnachricht für die Methode CompletionService.ImportSuggestionDenyListEntries.

Felder

error_samples[]

Ein Beispiel für Fehler, die bei der Verarbeitung der Anfrage aufgetreten sind.

imported_entries_count

int64

Anzahl der erfolgreich importierten Einträge in der Sperrliste.

failed_entries_count

int64

Anzahl der Einträge in der Sperrliste, die nicht importiert werden konnten.

ImportUserEventsMetadata

Metadaten zum Fortschritt des Importvorgangs. Dieser Wert wird vom Feld „google.longrunning.Operation.metadata“ zurückgegeben.

Felder
`create_time`	`Timestamp` Erstellungszeit des Vorgangs.
`update_time`	`Timestamp` Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.
`success_count`	`int64` Anzahl der Einträge, die erfolgreich verarbeitet wurden.
`failure_count`	`int64` Anzahl der Einträge, bei deren Verarbeitung Fehler aufgetreten sind.

ImportUserEventsRequest

Anfragenachricht für die ImportUserEvents-Anfrage.

Felder
`parent`	`string` Erforderlich. Name der übergeordneten DataStore-Ressource im Format `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
`error_config`	`ImportErrorConfig` Der gewünschte Speicherort für Fehler, die während des Imports aufgetreten sind. Kann nicht für Inline-Importe von Nutzerereignissen festgelegt werden.
Union-Feld `source`. Erforderlich: Die gewünschte Quelle für die Nutzerereignisdaten. Für `source` ist nur einer der folgenden Werte zulässig:
`inline_source`	`InlineSource` Die Inline-Quelle für die Eingabeinhalte für UserEvents.
`gcs_source`	`GcsSource` Cloud Storage-Speicherort für die Eingabeinhalte.
`bigquery_source`	`BigQuerySource` BigQuery-Eingabequelle.

InlineSource

Die Inline-Quelle für die Eingabekonfiguration für die Methode „ImportUserEvents“.

Felder

user_events[]

UserEvent

Erforderlich. Eine Liste der zu importierenden Nutzerereignisse. Es werden maximal 10.000 Artikel empfohlen.

ImportUserEventsResponse

Antwort auf die ImportUserEventsRequest. Wenn der Vorgang mit langer Ausführungszeit erfolgreich war, wird diese Nachricht vom Feld „google.longrunning.Operations.response“ zurückgegeben.

Felder
`error_samples[]`	`Status` Ein Beispiel für Fehler, die bei der Verarbeitung der Anfrage aufgetreten sind.
`error_config`	`ImportErrorConfig` Gibt das Ziel für die vollständigen Fehler zurück, wenn dieses Feld in der Anfrage festgelegt wurde.
`joined_events_count`	`int64` Anzahl der Nutzerereignisse, die mit vollständigen vorhandenen Dokumenten importiert wurden.
`unjoined_events_count`	`int64` Anzahl der importierten Nutzerereignisse, für die keine Dokumentinformationen im vorhandenen Zweig gefunden wurden.

IndustryVertical

Die Branche, die mit DataStore verknüpft ist.

Enums
`INDUSTRY_VERTICAL_UNSPECIFIED`	Wert, der verwendet wird, wenn er nicht festgelegt ist.
`GENERIC`	Die allgemeine Branche für Dokumente, die nicht branchenspezifisch sind.
`MEDIA`	Die Medienbranche.
`HEALTHCARE_FHIR`	Healthcare FHIR

Intervall

Ein Gleitkomma-Intervall.

Felder

Union-Feld min. Die Untergrenze des Intervalls. Wenn keines der „min“-Felder festgelegt ist, ist die Untergrenze minus unendlich.

Dieses Feld darf nicht größer als „max“ sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben. Für min ist nur einer der folgenden Werte zulässig:

minimum

double

Inklusive Untergrenze.

exclusive_minimum

double

Ausgeschlossene Untergrenze.

Union-Feld max. Die Obergrenze des Intervalls. Wenn keines der Felder für das Maximum festgelegt ist, ist die Obergrenze positiv unendlich.

Der Wert in diesem Feld darf nicht kleiner als „min“ sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben. Für max ist nur einer der folgenden Werte zulässig:

maximum

double

Inklusive Obergrenze.

exclusive_maximum

double

Ausschließliche Obergrenze.

LicenseConfig

Informationen zu den Lizenzen von Nutzern.

Felder
`name`	`string` Nicht veränderbar. ID. Der vollständig qualifizierte Ressourcenname der Lizenzkonfiguration. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
`license_count`	`int64` Erforderlich. Anzahl der gekauften Lizenzen.
`subscription_tier`	`SubscriptionTier` Erforderlich. Informationen zur Abostufe für die Lizenzkonfiguration.
`state`	`State` Nur Ausgabe. Der Status der Lizenzkonfiguration.
`auto_renew`	`bool` Optional. Gibt an, ob die Lizenzkonfiguration automatisch verlängert werden soll, wenn das Enddatum erreicht ist.
`start_date`	`Date` Erforderlich. Das Startdatum.
`end_date`	`Date` Optional. Das geplante Enddatum.
`subscription_term`	`SubscriptionTerm` Erforderlich. Abolaufzeit
`free_trial`	`bool` Optional. Gibt an, ob die Lizenzkonfiguration für einen kostenlosen Testzeitraum gilt.
`alert_policy_resource_config`	`AlertPolicyResourceConfig` Optional. Die Konfiguration der Benachrichtigungsrichtlinie für diese Lizenzkonfiguration.
`gemini_bundle`	`bool` Nur Ausgabe. Gibt an, ob die Lizenzkonfiguration für das Gemini-Bundle gilt.

Bundesland

Aufzählung des Status der Lizenzkonfiguration.

Enums
`STATE_UNSPECIFIED`	Standardwert. Die Lizenzkonfiguration ist nicht vorhanden.
`ACTIVE`	Die Lizenzkonfiguration ist aktiv und wird verwendet.
`EXPIRED`	Die Lizenzkonfiguration ist abgelaufen.
`NOT_STARTED`	Die Lizenzkonfiguration hat noch nicht begonnen und ihr Startdatum liegt in der Zukunft.

ListAssistantsRequest

Anfragenachricht für die Methode AssistantService.ListAssistants.

Felder

parent

string

Erforderlich. Der Name der übergeordneten Ressource. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

page_size

int32

Maximale Anzahl der zurückzugebenden Assistant. Wenn nicht angegeben, lautet die Standardeinstellung 100. Der maximal zulässige Wert beträgt 1.000. Werte über 1.000 werden implizit auf 1.000 umgewandelt.

page_token

string

Ein Seitentoken ListAssistantsResponse.next_page_token, das von einem vorherigen AssistantService.ListAssistants-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für ListAssistants bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

ListAssistantsResponse

Antwortnachricht für die Methode AssistantService.ListAssistants.

Felder

assistants[]

Assistant

Alle Assistants des Kunden.

next_page_token

string

Ein Token, das als ListAssistantsRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

ListCmekConfigsRequest

Anfragenachricht für die Methode CmekConfigService.ListCmekConfigs.

Felder

parent

string

Erforderlich. Der Name der übergeordneten Standortressource, z. B. projects/{project}/locations/{location}.

Wenn der Aufrufer nicht berechtigt ist, CmekConfigs an diesem Standort aufzulisten, wird unabhängig davon, ob eine CmekConfig vorhanden ist, ein PERMISSION_DENIED-Fehler zurückgegeben.

ListCmekConfigsResponse

Antwortnachricht für die Methode CmekConfigService.ListCmekConfigs.

Felder

cmek_configs[]

CmekConfig

Alle CmekConfigs des Kunden.

ListControlsRequest

Anfrage für die Methode „ListControls“.

Felder
`parent`	`string` Erforderlich. Der Ressourcenname des Datenspeichers. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` oder `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
`page_size`	`int32` Optional. Maximale Anzahl der zurückzugebenden Ergebnisse. Wenn nicht angegeben, lautet die Standardeinstellung 50. Der maximal zulässige Wert beträgt 1.000.
`page_token`	`string` Optional. Ein Seitentoken, das von einem vorherigen `ListControls`-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.
`filter`	`string` Optional. Ein Filter, der auf die Listenergebnisse angewendet werden soll. Unterstützte Funktionen: Alle Produkte im übergeordneten Zweig auflisten, wenn `filter` nicht festgelegt ist. Dieses Feld wird derzeit nicht unterstützt.

ListControlsResponse

Antwort für die Methode „ListControls“.

Felder

controls[]

Control

Alle Kontrollen für einen bestimmten Datenspeicher.

next_page_token

string

Paginierungstoken. Wenn es nicht zurückgegeben wird, ist dies die letzte Seite.

ListConversationsRequest

Anfrage für die Methode „ListConversations“.

Felder
`parent`	`string` Erforderlich. Der Ressourcenname des Datenspeichers. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` Maximale Anzahl der zurückzugebenden Ergebnisse. Wenn nicht angegeben, lautet die Standardeinstellung 50. Der maximal zulässige Wert beträgt 1.000.
`page_token`	`string` Ein Seitentoken, das von einem vorherigen `ListConversations`-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.
`filter`	`string` Ein Filter, der auf die Listenergebnisse angewendet werden soll. Die unterstützten Funktionen sind: user_pseudo_id, state. Beispiel: „user_pseudo_id = some_id“
`order_by`	`string` Eine durch Kommas getrennte Liste von Feldern, nach denen in aufsteigender Reihenfolge sortiert werden soll. Verwenden Sie „desc“ nach einem Feldnamen für die absteigende Sortierung. Unterstützte Felder: * `update_time` * `create_time` * `conversation_name` Beispiel: „update_time desc“, „create_time“

ListConversationsResponse

Antwort für die Methode „ListConversations“.

Felder

conversations[]

Alle Unterhaltungen für einen bestimmten Datenspeicher.

next_page_token

string

Paginierungstoken. Wenn es nicht zurückgegeben wird, ist dies die letzte Seite.

ListCustomModelsRequest

Anfragenachricht für die Methode SearchTuningService.ListCustomModels.

Felder

data_store

string

Erforderlich. Der Ressourcenname des übergeordneten Datenspeichers, z. B. projects/*/locations/global/collections/default_collection/dataStores/default_data_store. Mit diesem Feld wird der Datenspeicher angegeben, aus dem die Modelle abgerufen werden sollen.

ListCustomModelsResponse

Antwortnachricht für die Methode SearchTuningService.ListCustomModels.

Felder

models[]

CustomTuningModel

Liste der benutzerdefinierten Abstimmungsmodelle.

ListDataStoresRequest

Anfragenachricht für die Methode DataStoreService.ListDataStores.

Felder
`parent`	`string` Erforderlich. Der Ressourcenname des übergeordneten Zweigs, z. B. `projects/{project}/locations/{location}/collections/{collection_id}`. Wenn der Aufrufer nicht berechtigt ist, `DataStore`s für diesen Standort aufzulisten, wird unabhängig davon, ob dieser Datenspeicher vorhanden ist oder nicht, ein PERMISSION_DENIED-Fehler zurückgegeben.
`page_size`	`int32` Maximale Anzahl der zurückzugebenden `DataStore`. Wenn nicht angegeben, wird standardmäßig 10 verwendet. Der maximal zulässige Wert beträgt 50. Werte über 50 werden implizit auf 50 umgewandelt. Wenn dieses Feld negativ ist, wird INVALID_ARGUMENT zurückgegeben.
`page_token`	`string` Ein Seitentoken `ListDataStoresResponse.next_page_token`, das von einem vorherigen `DataStoreService.ListDataStores`-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen für `DataStoreService.ListDataStores` bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.
`filter`	`string` Nach Lösungstyp filtern Beispiel: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`

ListDataStoresResponse

Antwortnachricht für die Methode DataStoreService.ListDataStores.

Felder

data_stores[]

DataStore

Alle DataStores des Kunden.

next_page_token

string

Ein Token, das als ListDataStoresRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

ListDocumentsRequest

Anfragenachricht für die Methode DocumentService.ListDocuments.

Felder

parent

string

Erforderlich. Der Ressourcenname des übergeordneten Zweigs, z. B. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Verwenden Sie default_branch als Zweig-ID, um Dokumente unter dem Standardzweig aufzulisten.

Wenn der Aufrufer keine Berechtigung hat, Documents unter dieser Niederlassung aufzulisten, wird unabhängig davon, ob diese Niederlassung vorhanden ist oder nicht, der Fehler PERMISSION_DENIED zurückgegeben.

page_size

int32

Maximale Anzahl der zurückzugebenden Document. Wenn nicht angegeben, lautet die Standardeinstellung 100. Der maximal zulässige Wert beträgt 1.000. Werte über 1.000 werden auf 1.000 festgelegt.

Wenn dieses Feld negativ ist, wird ein INVALID_ARGUMENT-Fehler zurückgegeben.

page_token

string

Ein Seitentoken ListDocumentsResponse.next_page_token, das von einem vorherigen DocumentService.ListDocuments-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für DocumentService.ListDocuments bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

ListDocumentsResponse

Antwortnachricht für die Methode DocumentService.ListDocuments.

Felder

documents[]

Die Document.

next_page_token

string

Ein Token, das als ListDocumentsRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

ListEnginesRequest

Anfragenachricht für die Methode EngineService.ListEngines.

Felder
`parent`	`string` Erforderlich. Der Name der übergeordneten Ressource, z. B. `projects/{project}/locations/{location}/collections/{collection_id}`.
`page_size`	`int32` Optional. Nicht unterstützt.
`page_token`	`string` Optional. Nicht unterstützt.
`filter`	`string` Optional. Nach Lösungstyp filtern Beispiel: solution_type=SOLUTION_TYPE_SEARCH

ListEnginesResponse

Antwortnachricht für die Methode EngineService.ListEngines.

Felder

engines[]

Engine

Alle Engines des Kunden.

next_page_token

string

Nicht unterstützt.

ListIdentityMappingStoresRequest

Anfragenachricht für IdentityMappingStoreService.ListIdentityMappingStores

Felder

parent

string

Erforderlich. Das übergeordnete Element der aufzulistenden Identity Mapping Stores. Format: projects/{project}/locations/{location}.

page_size

int32

Maximale Anzahl der zurückzugebenden IdentityMappingStores. Wenn nicht angegeben, lautet die Standardeinstellung 100. Der maximal zulässige Wert beträgt 1.000. Werte über 1.000 werden implizit auf 1.000 umgewandelt.

page_token

string

Ein Seitentoken, das von einem vorherigen ListIdentityMappingStores-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für ListIdentityMappingStores bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

ListIdentityMappingStoresResponse

Antwortnachricht für IdentityMappingStoreService.ListIdentityMappingStores

Felder

identity_mapping_stores[]

IdentityMappingStore

Die Speichereinheiten für die Identitätszuordnung.

next_page_token

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

ListIdentityMappingsRequest

Anfragenachricht für IdentityMappingStoreService.ListIdentityMappings

Felder

identity_mapping_store

string

Erforderlich. Der Name des Identity Mapping Store, in dem die Identity Mapping-Einträge aufgeführt werden sollen. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

page_size

int32

Maximale Anzahl der zurückzugebenden IdentityMappings. Wenn nicht angegeben, wird standardmäßig 2.000 verwendet. Der maximal zulässige Wert beträgt 10.000. Werte über 10.000 werden implizit auf 10.000 umgewandelt.

page_token

string

Ein Seitentoken, das von einem vorherigen ListIdentityMappings-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für ListIdentityMappings bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

ListIdentityMappingsResponse

Antwortnachricht für IdentityMappingStoreService.ListIdentityMappings

Felder

identity_mapping_entries[]

IdentityMappingEntry

Die Einträge für die Identitätszuweisung.

next_page_token

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

ListSchemasRequest

Anfragenachricht für die Methode SchemaService.ListSchemas.

Felder

parent

string

Erforderlich. Der Name der übergeordneten Datenspeicherressource im Format projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

page_size

int32

Die maximale Anzahl der zurückzugebenden Schema. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Falls nicht angegeben, werden maximal 100 Schema zurückgegeben.

Der Höchstwert beträgt 1.000. Werte über 1.000 werden auf 1.000 festgelegt.

page_token

string

Ein Seitentoken, das von einem vorherigen SchemaService.ListSchemas-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für SchemaService.ListSchemas bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

ListSchemasResponse

Antwortnachricht für die Methode SchemaService.ListSchemas.

Felder

schemas[]

Schema

Die Schema.

next_page_token

string

Ein Token, das als ListSchemasRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

ListSessionsRequest

Anfrage für die Methode „ListSessions“.

Felder
`parent`	`string` Erforderlich. Der Ressourcenname des Datenspeichers. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` Maximale Anzahl der zurückzugebenden Ergebnisse. Wenn nicht angegeben, lautet die Standardeinstellung 50. Der maximal zulässige Wert beträgt 1.000.
`page_token`	`string` Ein Seitentoken, das von einem vorherigen `ListSessions`-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.
`filter`	`string` Eine durch Kommas getrennte Liste der Felder, nach denen gefiltert werden soll, in EBNF-Grammatik. Folgende Felder werden unterstützt: `user_pseudo_id` `state` `display_name` `starred` `is_pinned` `labels` `create_time` `update_time` Beispiele: `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` Eine durch Kommas getrennte Liste von Feldern, nach denen in aufsteigender Reihenfolge sortiert werden soll. Verwenden Sie „desc“ nach einem Feldnamen für die absteigende Sortierung. Unterstützte Felder: `update_time` `create_time` `session_name` `is_pinned` Beispiel: `update_time desc` `create_time` `is_pinned desc,update_time desc`: listet Sitzungen zuerst nach „is_pinned“ und dann nach „update_time“ auf.

ListSessionsResponse

Antwort für die Methode „ListSessions“.

Felder

sessions[]

Alle Sitzungen für einen bestimmten Datenspeicher.

next_page_token

string

Paginierungstoken. Wenn es nicht zurückgegeben wird, ist dies die letzte Seite.

ListTargetSitesRequest

Anfragenachricht für die Methode SiteSearchEngineService.ListTargetSites.

Felder

parent

string

Erforderlich. Der Ressourcenname der übergeordneten Suchmaschine für Websites, z. B. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

Wenn der Aufrufer keine Berechtigung hat, TargetSites für diese Website-Suchmaschine aufzulisten, wird unabhängig davon, ob dieser Zweig vorhanden ist oder nicht, ein PERMISSION_DENIED-Fehler zurückgegeben.

page_size

int32

Wenn dieses Feld negativ ist, wird der Fehler INVALID_ARGUMENT zurückgegeben.

page_token

string

Ein Seitentoken, das von einem vorherigen ListTargetSites-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für ListTargetSites bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

ListTargetSitesResponse

Antwortnachricht für die Methode SiteSearchEngineService.ListTargetSites.

Felder

target_sites[]

Liste der TargetSites.

next_page_token

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

total_size

int32

Die Gesamtzahl der Elemente, die der Anfrage entsprechen. Sie wird immer in der Antwort ausgegeben.

ListUserLicensesRequest

Anfragenachricht für UserLicenseService.ListUserLicenses.

Felder
`parent`	`string` Erforderlich. Der Ressourcenname des übergeordneten [UserStore][] im Format `projects/{project}/locations/{location}/userStores/{user_store_id}`.
`page_size`	`int32` Optional. Angeforderte Seitengröße. Der Server gibt möglicherweise weniger Elemente als angefordert zurück. Wenn nicht angegeben, wird standardmäßig 10 verwendet. Der Höchstwert beträgt 50. Werte über 50 werden implizit auf 50 umgewandelt. Wenn dieses Feld negativ ist, wird der Fehler INVALID_ARGUMENT zurückgegeben.
`page_token`	`string` Optional. Ein Seitentoken, das von einem vorherigen `ListUserLicenses`-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen für `ListUserLicenses` bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.
`filter`	`string` Optional. Filter für die Listenanfrage. Unterstützte Felder: `license_assignment_state` Beispiele: `license_assignment_state = ASSIGNED`, um die zugewiesenen Nutzerlizenzen aufzulisten. `license_assignment_state = NO_LICENSE`, um nicht lizenzierte Nutzer aufzulisten. `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN`, um Nutzer aufzulisten, die versucht haben, sich anzumelden, denen aber keine Lizenz zugewiesen ist. `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN`, um Nutzer herauszufiltern, die versucht haben, sich anzumelden, denen aber keine Lizenz zugewiesen ist.

ListUserLicensesResponse

Antwortnachricht für UserLicenseService.ListUserLicenses.

Felder

user_licenses[]

UserLicense

Alle UserLicenses des Kunden.

next_page_token

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

MediaInfo

Medienspezifische Nutzerereignisinformationen

Felder

media_progress_duration

Duration

Die Zeit, die seit Beginn der Wiedergabe vergangen ist, in Sekunden (falls zutreffend). Wenn der Endnutzer beispielsweise 90 Sekunden eines Wiedergabevideos angesehen hat, sollte MediaInfo.media_progress_duration.seconds auf 90 gesetzt werden.

media_progress_percentage

float

Der Fortschritt von Media sollte nur anhand von media_progress_duration im Verhältnis zur Gesamtlänge der Media berechnet werden.

Dieser Wert muss zwischen [0, 1.0] liegen.

Wenn es sich nicht um eine Wiedergabe handelt oder der Fortschritt nicht berechnet werden kann (z.B. bei einem laufenden Livestream), sollte dieses Feld nicht festgelegt werden.

PageInfo

Detaillierte Seiteninformationen.

Felder
`pageview_id`	`string` Eine eindeutige ID einer Webseitenaufrufs. Dieser Wert sollte für alle Nutzerereignisse, die durch denselben Seitenaufruf ausgelöst werden, gleich bleiben. Ein Aufruf der Detailseite eines Artikels kann beispielsweise mehrere Ereignisse auslösen, während der Nutzer die Seite durchsucht. Die `pageview_id`-Property sollte für alle diese Ereignisse gleich bleiben, damit sie richtig gruppiert werden können. Wenn Sie die clientseitige Ereignisberichterstellung mit JavaScript-Pixel und Google Tag Manager verwenden, wird dieser Wert automatisch ausgefüllt.
`page_category`	`string` Die spezifischste Kategorie, die einer Kategorieseite zugeordnet ist. Verwenden Sie das Zeichen „>“, um verschiedene Hierarchien zu trennen und den vollständigen Pfad der Kategorie darzustellen. Wenn „>“ Teil des Kategorienamens ist, ersetzen Sie es durch andere Zeichen. Kategorieseiten umfassen spezielle Seiten wie Verkaufs- oder Werbeaktionsseiten. Eine spezielle Angebotsseite kann beispielsweise die Kategoriehierarchie `"pageCategory" : "Sales > 2017 Black Friday Deals"` haben. Erforderlich für `view-category-page`-Ereignisse. Bei anderen Ereignistypen sollte dieses Feld nicht festgelegt werden. Andernfalls wird der Fehler `INVALID_ARGUMENT` zurückgegeben.
`uri`	`string` Vollständige URL (window.location.href) der aktuellen Seite des Nutzers. Wenn Sie die clientseitige Ereignisberichterstellung mit JavaScript-Pixel und Google Tag Manager verwenden, wird dieser Wert automatisch ausgefüllt. Maximale Länge: 5.000 Zeichen.
`referrer_uri`	`string` Die Referrer-URL der aktuellen Seite. Wenn Sie die clientseitige Ereignisberichterstellung mit JavaScript-Pixel und Google Tag Manager verwenden, wird dieser Wert automatisch ausgefüllt. Aufgrund von Datenschutzbeschränkungen in einigen Browsern kann dieses Feld jedoch leer sein.

PanelInfo

Detaillierte Informationen zum Panel, das einem Nutzerereignis zugeordnet ist.

Felder
`panel_id`	`string` Erforderlich. Die Bereichs-ID.
`display_name`	`string` Der Anzeigename des Bereichs.
`documents[]`	`DocumentInfo` Optional. Die mit diesem Bereich verknüpften Dokument-IDs.
`panel_position`	`int32` Die geordnete Position des Felds, wenn es dem Nutzer zusammen mit anderen Feldern angezeigt wird. Wenn dieser Wert festgelegt ist, muss auch `total_panels` festgelegt werden.
`total_panels`	`int32` Die Gesamtzahl der Bereiche, einschließlich dieses, die dem Nutzer angezeigt wurden. Muss festgelegt werden, wenn `panel_position` festgelegt ist.

Hauptkonto

Hauptkonto-ID eines Nutzers oder einer Gruppe.

Felder
Union-Feld `principal`. Union-Feld „principal“. Das Hauptkonto kann ein Nutzer oder eine Gruppe sein. Für `principal` ist nur einer der folgenden Werte zulässig:
`user_id`	`string` Nutzer-ID. Bei einem Google Workspace-Nutzerkonto sollte „user_id“ die E‑Mail-Adresse des Google Workspace-Nutzers sein. Bei einem Nutzerkonto eines Identitätsanbieters, der nicht von Google stammt, ist „user_id“ die zugeordnete Nutzer-ID, die während der Konfiguration des Personalpools konfiguriert wurde.
`group_id`	`string` Gruppen-ID. Bei einem Google Workspace-Nutzerkonto sollte „group_id“ die E-Mail-Adresse der Google Workspace-Gruppe sein. Bei Nutzerkonten von Nicht-Google-Identitätsanbietern ist „group_id“ die zugeordnete Gruppen-ID, die während der Konfiguration des Personalpools konfiguriert wurde.
`external_entity_id`	`string` Für Identitäten von Drittanbieteranwendungen, die nicht im Identitätsanbieter des Kunden vorhanden sind.

Projekt

Metadaten und Konfigurationen für ein Google Cloud-Projekt im Dienst.

Felder
`name`	`string` Nur Ausgabe. Vollständiger Ressourcenname des Projekts, z. B. `projects/{project}`. Beachten Sie, dass bei Anfragen sowohl die Projektnummer als auch die Projekt-ID akzeptiert werden, der Server jedoch immer mit der Projektnummer antwortet.
`create_time`	`Timestamp` Nur Ausgabe. Der Zeitstempel für den Zeitpunkt, zu dem dieses Projekt erstellt wurde.
`provision_completion_time`	`Timestamp` Nur Ausgabe. Der Zeitstempel für den Zeitpunkt, zu dem dieses Projekt erfolgreich bereitgestellt wurde. Ein leerer Wert bedeutet, dass dieses Projekt noch bereitgestellt wird und noch nicht verwendet werden kann.
`service_terms_map`	`map<string, ServiceTerms>` Nur Ausgabe. Eine Karte der Nutzungsbedingungen. Der Schlüssel ist der `id` von `ServiceTerms`.
`customer_provided_config`	`CustomerProvidedConfig` Optional. Vom Kunden bereitgestellte Konfigurationen.

CustomerProvidedConfig

Vom Kunden bereitgestellte Konfigurationen.

Felder

notebooklm_config

NotebooklmConfig

Optional. Konfiguration für NotebookLM-Einstellungen.

NotebooklmConfig

Konfiguration für NotebookLM.

Felder

model_armor_config

ModelArmorConfig

Die Model Armor-Konfiguration, die zum Bereinigen von Nutzer-Prompts und LLM-Antworten verwendet werden soll.

ModelArmorConfig

Konfiguration für vom Kunden definierte Model Armor-Vorlagen, die zum Bereinigen von Nutzer-Prompts und LLM-Antworten verwendet werden.

Felder

user_prompt_template

string

Optional. Der Ressourcenname der Model Armor-Vorlage zum Bereinigen von Nutzer-Prompts. Format: projects/{project}/locations/{location}/templates/{template_id}. Wenn nicht angegeben, wird der Nutzer-Prompt nicht bereinigt.

response_template

string

Optional. Der Ressourcenname der Model Armor-Vorlage zum Bereinigen von LLM-Antworten. Format: projects/{project}/locations/{location}/templates/{template_id}. Wenn nicht angegeben, wird die LLM-Antwort nicht bereinigt.

ServiceTerms

Metadaten zu den Nutzungsbedingungen.

Felder
`id`	`string` Die eindeutige Kennung dieser Nutzungsbedingungen. Verfügbare Begriffe: `GA_DATA_USE_TERMS`: Nutzungsbedingungen für Daten. Wenn Sie dies als `id` verwenden, ist `2022-11-23` der akzeptable `version`.
`version`	`string` Der Versionsstring der Nutzungsbedingungen. Zulässige Werte finden Sie oben in den Kommentaren zu `id`.
`state`	`State` Gibt an, ob die Dienstbedingungen für das Projekt akzeptiert oder abgelehnt wurden oder ob der Status noch ausstehend ist.
`accept_time`	`Timestamp` Das letzte Mal, dass das Projekt den Nutzungsbedingungen zugestimmt hat.
`decline_time`	`Timestamp` Das letzte Mal, dass das Projekt die Nutzungsbedingungen abgelehnt oder die Zustimmung zu den Nutzungsbedingungen widerrufen hat.

Bundesland

In der Vereinbarung sind diese Nutzungsbedingungen aufgeführt.

Enums
`STATE_UNSPECIFIED`	Der Standardwert des Enums. Dieser Wert wird nicht verwendet.
`TERMS_ACCEPTED`	Das Projekt hat den Nutzungsbedingungen zugestimmt.
`TERMS_PENDING`	Das Projekt muss noch überprüft werden und die Nutzungsbedingungen müssen noch akzeptiert werden.
`TERMS_DECLINED`	Das Projekt hat die Vereinbarung zu den Nutzungsbedingungen abgelehnt oder widerrufen.

ProvisionProjectMetadata

Dieser Typ hat keine Felder.

Metadaten, die mit einem Projektbereitstellungsvorgang verknüpft sind.

ProvisionProjectRequest

Anfrage für die Methode ProjectService.ProvisionProject.

Felder
`name`	`string` Erforderlich. Vollständiger Ressourcenname eines `Project`, z. B. `projects/{project_id_or_number}`.
`accept_data_use_terms`	`bool` Erforderlich. Auf `true` festgelegt, um anzugeben, dass der Anrufer die Nutzungsbedingungen für Daten gelesen hat und der Verwendung der Daten zustimmen möchte.
`data_use_terms_version`	`string` Erforderlich. Die Version der Nutzungsbedingungen für Daten, die der Anrufer gelesen hat und der er zustimmen möchte. Die akzeptable Version ist `2022-11-23`. Das kann sich im Laufe der Zeit ändern.
`saas_params`	`SaasParams` Optional. Parameter für Agentspace.

SaasParams

Parameter für Agentspace.

Felder

accept_biz_qos

bool

Optional. Auf true festgelegt, um anzugeben, dass der Anrufer die [Terms for Agent Space quality of service] gelesen hat und seine Einwilligung erteilen möchte.

is_biz

bool

Optional. Gibt an, ob die aktuelle Anfrage für die Biz-Version (= true) oder nicht (= false) ist.

PurgeCompletionSuggestionsMetadata

Metadaten zum Fortschritt des Vorgangs „PurgeCompletionSuggestions“. Dieser Wert wird vom Feld „google.longrunning.Operation.metadata“ zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

PurgeCompletionSuggestionsRequest

Anfragenachricht für die Methode CompletionService.PurgeCompletionSuggestions.

Felder

parent

string

Erforderlich. Der Ressourcenname des übergeordneten Datenspeichers, für den Vervollständigungsvorschläge gelöscht werden sollen. Entspricht dem Muster „projects/*/locations/*/collections/*/dataStores/*“.

PurgeCompletionSuggestionsResponse

Antwortnachricht für die Methode CompletionService.PurgeCompletionSuggestions.

Felder

purge_succeeded

bool

Gibt an, ob die Vorschläge für die Vervollständigung erfolgreich gelöscht wurden.

error_samples[]

Ein Beispiel für Fehler, die bei der Verarbeitung der Anfrage aufgetreten sind.

PurgeDocumentsMetadata

Metadaten zum Fortschritt des Vorgangs „PurgeDocuments“. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder
`create_time`	`Timestamp` Erstellungszeit des Vorgangs.
`update_time`	`Timestamp` Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.
`success_count`	`int64` Anzahl der Einträge, die erfolgreich gelöscht wurden.
`failure_count`	`int64` Anzahl der Einträge, bei deren Verarbeitung Fehler aufgetreten sind.
`ignored_count`	`int64` Anzahl der Einträge, die ignoriert wurden, weil sie nicht gefunden wurden.

PurgeDocumentsRequest

Anfragenachricht für die Methode DocumentService.PurgeDocuments.

Felder
`parent`	`string` Erforderlich. Der Name der übergeordneten Ressource, z. B. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
`filter`	`string` Erforderlich. Filtern Sie übereinstimmende Dokumente, die gelöscht werden sollen. Derzeit wird nur der Wert `*` (alle Artikel) unterstützt.
`error_config`	`PurgeErrorConfig` Der gewünschte Speicherort für Fehler, die während des Bereinigens aufgetreten sind.
`force`	`bool` Führt den Löschvorgang tatsächlich aus. Wenn `force` auf „false“ gesetzt ist, wird die erwartete Anzahl an Löschungen zurückgegeben, ohne Dokumente zu löschen.
Union-Feld `source`. Die gewünschte Eingabequelle für das Löschen von Dokumenten anhand von Dokument-IDs. Für `source` ist nur einer der folgenden Werte zulässig:
`gcs_source`	`GcsSource` Cloud Storage-Speicherort für die Eingabeinhalte. Unterstützte `data_schema`: * `document_id`: Eine gültige `Document.id` pro Zeile.
`inline_source`	`InlineSource` Inline-Quelle für die Eingabeinhalte, die entfernt werden sollen.

InlineSource

Die Inline-Quelle für die Eingabekonfiguration für die Methode DocumentService.PurgeDocuments.

Felder

documents[]

string

Erforderlich. Eine Liste der vollständigen Ressourcennamen der zu löschenden Dokumente. Im Format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/* Es werden maximal 100 Elemente empfohlen.

PurgeDocumentsResponse

Antwortnachricht für die Methode DocumentService.PurgeDocuments. Wenn der Vorgang mit langer Ausführungszeit erfolgreich abgeschlossen wurde, wird diese Nachricht vom Feld „google.longrunning.Operations.response“ zurückgegeben.

Felder

purge_count

int64

Die Gesamtzahl der Dokumente, die aufgrund des Vorgangs gelöscht wurden.

purge_sample[]

string

Eine Stichprobe von Dokumentnamen, die gelöscht werden. Wird nur ausgefüllt, wenn force auf „false“ gesetzt ist. Es werden maximal 100 Namen zurückgegeben, die zufällig ausgewählt werden.

PurgeErrorConfig

Konfiguration des Ziels für Fehler im Zusammenhang mit dem Bereinigen.

Felder

Union-Feld destination Erforderlich. Ziel für Fehler. Für destination ist nur einer der folgenden Werte zulässig:

gcs_prefix

string

Cloud Storage-Präfix für Bereinigungsfehler. Dies muss ein leeres, vorhandenes Cloud Storage-Verzeichnis sein. Löschfehler werden in diesem Verzeichnis in Shard-Dateien geschrieben, eine pro Zeile, als JSON-codierte google.rpc.Status-Nachricht.

PurgeIdentityMappingsRequest

Anfragenachricht für IdentityMappingStoreService.PurgeIdentityMappings

Felder
`identity_mapping_store`	`string` Erforderlich. Der Name des Identity Mapping Store, aus dem Identity Mapping-Einträge gelöscht werden sollen. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
`filter`	`string` Passende Identitätszuweisungen filtern, die gelöscht werden sollen. Folgendes Feld kann gefiltert werden: * `update_time`: im ISO 8601-Format „Zulu“. * `external_id` Beispiele: Alle Identitätszuweisungen löschen, die in einem bestimmten Zeitraum aktualisiert wurden: `update_time > "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"` Alle Identitätszuweisungen für eine bestimmte „external_id“ löschen: `external_id = "id1"` Alle Identitätszuweisungen in einem Identitätszuweisungsspeicher löschen: `*` Bei den Filterfeldern wird von einer impliziten UND-Verknüpfung ausgegangen. Sollte nicht mit „source“ verwendet werden. Wenn beide angegeben sind, wird ein Fehler ausgegeben.
Union-Feld `source`. Die Quelle der Eingabe. Für `source` ist nur einer der folgenden Werte zulässig:
`inline_source`	`InlineSource` Die Inline-Quelle, aus der Identitätszuordnungseinträge entfernt werden sollen.
`force`	`bool` Führt den Löschvorgang tatsächlich aus. Wenn `force` auf „false“ gesetzt ist, wird die erwartete Anzahl an Löschungen zurückgegeben, ohne Identitätszuordnungen zu löschen. Dieses Feld wird nur für das Löschen mit Filter unterstützt. Für die Eingabequelle wird dieses Feld ignoriert und Daten werden unabhängig vom Wert dieses Felds gelöscht.

InlineSource

Die Inline-Quelle, aus der Identitätszuordnungseinträge entfernt werden sollen.

Felder

identity_mapping_entries[]

IdentityMappingEntry

Es können maximal 10.000 Einträge gleichzeitig gelöscht werden.

PurgeSuggestionDenyListEntriesMetadata

Metadaten zum Fortschritt des Vorgangs „PurgeSuggestionDenyListEntries“. Dieser Wert wird vom Feld „google.longrunning.Operation.metadata“ zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

PurgeSuggestionDenyListEntriesRequest

Anfragenachricht für die Methode CompletionService.PurgeSuggestionDenyListEntries.

Felder

parent

string

Erforderlich. Der Ressourcenname des übergeordneten Datenspeichers, für den Einträge auf der Sperrliste importiert werden sollen. Entspricht dem Muster „projects/*/locations/*/collections/*/dataStores/*“.

PurgeSuggestionDenyListEntriesResponse

Antwortnachricht für die Methode CompletionService.PurgeSuggestionDenyListEntries.

Felder

purge_count

int64

Anzahl der Einträge in der Sperrliste für Vorschläge, die gelöscht wurden.

error_samples[]

Ein Beispiel für Fehler, die bei der Verarbeitung der Anfrage aufgetreten sind.

PurgeUserEventsMetadata

Metadaten zum Fortschritt des Vorgangs „PurgeUserEvents“. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder
`create_time`	`Timestamp` Erstellungszeit des Vorgangs.
`update_time`	`Timestamp` Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.
`success_count`	`int64` Anzahl der Einträge, die erfolgreich gelöscht wurden.
`failure_count`	`int64` Anzahl der Einträge, bei deren Verarbeitung Fehler aufgetreten sind.

PurgeUserEventsRequest

Anfragenachricht für die Methode „PurgeUserEvents“

Felder

parent

string

Erforderlich. Der Ressourcenname des Katalogs, unter dem die Ereignisse erstellt werden. Das Format dafür ist projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.

filter

string

Erforderlich. Der Filterstring zum Angeben der zu löschenden Ereignisse. Die Länge ist auf 5.000 Zeichen begrenzt. Folgende Felder können gefiltert werden:

eventType: UserEvent.event_type-String in doppelten Anführungszeichen.
eventTime: im ISO-8601-Format „Zulu“.
userPseudoId: String in doppelten Anführungszeichen. Bei Angabe dieses Attributs werden alle mit einem Besucher verknüpften Ereignisse gelöscht.
userId: String in doppelten Anführungszeichen. Bei Angabe dieses Attributs werden alle mit einem Nutzer verknüpften Ereignisse gelöscht.

Hinweis: Mit dieser API können Daten für maximal 30 Tage gelöscht werden.

Beispiele:

Alle Termine in einem Zeitraum löschen: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
Bestimmte eventType in einem Zeitraum löschen: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
Alle Ereignisse für einen bestimmten Besucher in einem Zeitraum löschen: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
Löschen der Ereignisse der letzten 30 Tage in einem DataStore: *

Bei den Filterfeldern wird von einer impliziten UND-Verknüpfung ausgegangen.

force

bool

Das Feld force wird derzeit nicht unterstützt. Bei Anfragen zum dauerhaften Löschen von Nutzerereignissen werden alle löschbaren Ereignisse dauerhaft gelöscht. Nach Abschluss der Entwicklung: Wenn force auf „false“ gesetzt ist, gibt die Methode die erwartete Anzahl an Löschungen zurück, ohne Nutzerereignisse zu löschen. Dieses Feld wird standardmäßig auf „false“ gesetzt, wenn es nicht in der Anfrage enthalten ist.

PurgeUserEventsResponse

Antwort auf die PurgeUserEventsRequest. Wenn der Vorgang mit langer Ausführungszeit erfolgreich abgeschlossen wurde, wird diese Nachricht vom Feld „google.longrunning.Operations.response“ zurückgegeben.

Felder

purge_count

int64

Die Gesamtzahl der Ereignisse, die aufgrund des Vorgangs gelöscht wurden.

Abfrage

Definiert eine vom Nutzer eingegebene Anfrage.

Felder

query_id

string

Nur Ausgabe. Eindeutige ID für die Abfrage.

Union-Feld content. Inhalte der Anfrage. Für content ist nur einer der folgenden Werte zulässig:

text

string

Nur Text

RankRequest

Anfragenachricht für die Methode RankService.Rank.

Felder
`ranking_config`	`string` Erforderlich. Der Ressourcenname der Konfiguration des Ranking-Dienstes, z. B. `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.
`model`	`string` Die ID des zu verwendenden Modells. Es ist eines der folgenden: `semantic-ranker-512@latest`: Semantisches Ranking-Modell mit einer maximalen Eingabetokengröße von 512. Wenn nicht angegeben, wird der Standardwert auf `semantic-ranker-512@latest` gesetzt.
`top_n`	`int32` Die Anzahl der zurückzugebenden Ergebnisse. Wenn dieser Wert nicht festgelegt oder nicht größer als null ist, werden alle Ergebnisse zurückgegeben.
`query`	`string` Die zu verwendende Abfrage.
`records[]`	`RankingRecord` Erforderlich. Eine Liste der zu rankenden Datensätze.
`ignore_record_details_in_response`	`bool` Wenn „true“, enthält die Antwort nur die Datensatz-ID und die Punktzahl. Standardmäßig ist der Wert „false“. Die Antwort enthält dann Datensatzdetails.
`user_labels`	`map<string, string>` Die Nutzerlabels, die auf eine Ressource angewendet werden, müssen die folgenden Anforderungen erfüllen: Jede Ressource kann bis zu 64 Labels haben. Jedes Label muss ein Schlüssel/Wert-Paar sein. Schlüssel haben eine Mindestlänge von einem Zeichen und eine maximale Länge von 63 Zeichen und dürfen nicht leer sein. Werte dürfen leer sein und haben eine maximale Länge von 63 Zeichen. Schlüssel und Werte dürfen nur Kleinbuchstaben, Ziffern, Unterstriche und Bindestriche enthalten. Alle Zeichen müssen UTF-8-codiert sein. Internationale Zeichen sind zulässig. Der Schlüsselabschnitt eines Labels darf nur einmal vorkommen. Sie können jedoch denselben Schlüssel für mehrere Ressourcen verwenden. Schlüssel müssen mit einem Kleinbuchstaben oder einem internationalen Zeichen beginnen. Weitere Informationen finden Sie im Google Cloud-Dokument.

RankResponse

Antwortnachricht für die Methode RankService.Rank.

Felder

records[]

RankingRecord

Eine Liste von Datensätzen, sortiert nach absteigender Punktzahl.

RankingRecord

Nachricht für die Methode RankService.Rank aufzeichnen.

Felder
`id`	`string` Die eindeutige ID des Datensatzes.
`title`	`string` Der Titel des Datensatzes. Standardmäßig leer. Es muss mindestens `title` oder `content` festgelegt werden. Andernfalls wird der Fehler INVALID_ARGUMENT ausgegeben.
`content`	`string` Der Inhalt des Datensatzes. Standardmäßig leer. Es muss mindestens `title` oder `content` festgelegt werden. Andernfalls wird der Fehler INVALID_ARGUMENT ausgegeben.
`score`	`float` Die Punktzahl dieses Datensatzes basierend auf der angegebenen Anfrage und dem ausgewählten Modell. Die Punktzahl wird auf 2 Dezimalstellen gerundet. Wenn der Wert nahe 0 liegt, wird er auf 0,0001 gerundet, um zu vermeiden, dass „Nicht festgelegt“ zurückgegeben wird.

RecommendRequest

Anfragenachricht für die Methode „Recommend“.

Felder
`serving_config`	`string` Erforderlich. Vollständiger Ressourcenname eines `ServingConfig`: `projects//locations/global/collections//engines//servingConfigs/` oder `projects//locations/global/collections//dataStores//servingConfigs/` Beim Erstellen des Empfehlungssystems wird eine Standardbereitstellungskonfiguration erstellt. Die Engine-ID wird als ID der Standardkonfiguration für die Anzeigenauslieferung verwendet. Für Engine `projects//locations/global/collections//engines/my-engine` können Sie beispielsweise `projects//locations/global/collections//engines/my-engine/servingConfigs/my-engine` für Ihre `RecommendationService.Recommend`-Anfragen verwenden.
`user_event`	`UserEvent` Erforderlich. Kontext zum Nutzer, zu den Inhalten, die er sich ansieht, und zu den Aktionen, die er ausgeführt hat, um die Empfehlungsanfrage auszulösen. Diese Nutzerereignisdetails werden nicht in Nutzerereignisprotokolle aufgenommen. Daher ist für die Ereignisprotokollierung eine separate userEvent-Schreibanfrage erforderlich. Legen Sie `UserEvent.user_pseudo_id` oder `UserEvent.user_info.user_id` nicht für verschiedene Nutzer auf dieselbe feste ID fest. Wenn Sie nicht personalisierte Empfehlungen erhalten möchten (nicht empfohlen, da dies die Modellleistung beeinträchtigen kann), legen Sie stattdessen `UserEvent.user_pseudo_id` auf eine zufällige eindeutige ID fest und lassen Sie `UserEvent.user_info.user_id` nicht festgelegt.
`page_size`	`int32` Maximale Anzahl der zurückzugebenden Ergebnisse. Legen Sie diese Property auf die Anzahl der benötigten Empfehlungsergebnisse fest. Wenn der Wert null ist, wählt der Dienst einen angemessenen Standardwert aus. Der maximal zulässige Wert beträgt 100. Werte über 100 werden auf 100 festgelegt.
`filter`	`string` Filter zum Einschränken von Empfehlungsergebnissen mit einer Längenbeschränkung von 5.000 Zeichen. Derzeit werden nur Filterausdrücke für das Attribut `filter_tags` unterstützt. Beispiele: `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` Wenn `attributeFilteringSyntax` im Feld `params` auf „true“ gesetzt ist, werden attributbasierte Ausdrücke anstelle der oben beschriebenen tagbasierten Syntax erwartet. Beispiele: (language: ANY("en", "es")) AND NOT (categories: ANY("Movie")) (available: true) AND (language: ANY("en", "es")) OR (categories: ANY("Movie")) Wenn Ihr Filter alle Ergebnisse blockiert, gibt die API generische (ungefilterte) beliebte Dokumente zurück. Wenn Sie nur Ergebnisse erhalten möchten, die genau den Filtern entsprechen, setzen Sie `strictFiltering` in `RecommendRequest.params` auf `true`, um stattdessen leere Ergebnisse zu erhalten. Die API gibt niemals `Document` mit `storageStatus` als `EXPIRED` oder `DELETED` zurück, unabhängig von den Filteroptionen.
`validate_only`	`bool` Verwende für diese Empfehlungsanfrage nur den Validierungsmodus. Wenn auf `true` festgelegt, wird ein gefälschtes Modell verwendet, das beliebige Dokument-IDs zurückgibt. Der Modus „Nur validieren“ sollte nur zum Testen der API oder verwendet werden, wenn das Modell noch nicht bereit ist.
`params`	`map<string, Value>` Zusätzliche domainspezifische Parameter für die Empfehlungen. Zulässige Werte: `returnDocument`: Boolesch. Wenn auf `true` gesetzt, wird das zugehörige Document-Objekt in `RecommendResponse.RecommendationResult.document` zurückgegeben. `returnScore`: Boolesch. Wenn der Wert auf „true“ gesetzt ist, wird der Empfehlungswert für jedes zurückgegebene Dokument in `RecommendResponse.RecommendationResult.metadata` festgelegt. Die angegebene Punktzahl gibt die Wahrscheinlichkeit einer Dokumentkonvertierung an, die auf dem Kontext und dem Verlauf des Nutzers basiert. `strictFiltering`: Boolesch. Standardmäßig „true“. Wenn der Wert auf `false` gesetzt ist, gibt der Dienst allgemeine (ungefilterte) beliebte Dokumente zurück, anstatt leer zu sein, wenn Ihr Filter alle Empfehlungsergebnisse blockiert. `diversityLevel`: String. Standardmäßig leer. Wenn der Wert nicht leer ist, muss er einer der folgenden Werte sein: `no-diversity` `low-diversity` `medium-diversity` `high-diversity` `auto-diversity` So haben Sie die Kontrolle auf Anfrageebene und die Empfehlungsergebnisse werden basierend auf der Dokumentkategorie angepasst. `attributeFilteringSyntax`: Boolesch. Standardmäßig „false“. Wenn „true“, wird das Feld `filter` gemäß der neuen attributbasierten Syntax interpretiert.
`user_labels`	`map<string, string>` Die Nutzerlabels, die auf eine Ressource angewendet werden, müssen die folgenden Anforderungen erfüllen: Jede Ressource kann bis zu 64 Labels haben. Jedes Label muss ein Schlüssel/Wert-Paar sein. Schlüssel haben eine Mindestlänge von einem Zeichen und eine maximale Länge von 63 Zeichen und dürfen nicht leer sein. Werte dürfen leer sein und haben eine maximale Länge von 63 Zeichen. Schlüssel und Werte dürfen nur Kleinbuchstaben, Ziffern, Unterstriche und Bindestriche enthalten. Alle Zeichen müssen UTF-8-codiert sein. Internationale Zeichen sind zulässig. Der Schlüsselabschnitt eines Labels darf nur einmal vorkommen. Sie können jedoch denselben Schlüssel für mehrere Ressourcen verwenden. Schlüssel müssen mit einem Kleinbuchstaben oder einem internationalen Zeichen beginnen. Weitere Informationen finden Sie unter Anforderungen für Labels.

RecommendResponse

Antwortnachricht für die Methode „Recommend“.

Felder
`results[]`	`RecommendationResult` Eine Liste mit empfohlenen Dokumenten. Die Reihenfolge entspricht dem Ranking (vom relevantesten zum am wenigsten relevanten Dokument).
`attribution_token`	`string` Ein eindeutiges Attributionstoken. Diese sollten in den `UserEvent`-Logs enthalten sein, die sich aus dieser Empfehlung ergeben. So lässt sich die Leistung des Empfehlungsmodells genau zuordnen.
`missing_ids[]`	`string` IDs von Dokumenten in der Anfrage, die im Standard-Branch fehlen, der mit der angeforderten ServingConfig verknüpft ist.
`validate_only`	`bool` „True“, wenn `RecommendRequest.validate_only` festgelegt wurde.

RecommendationResult

RecommendationResult stellt ein allgemeines Empfehlungsergebnis mit zugehörigen Metadaten dar.

Felder

id

string

Ressourcen-ID des empfohlenen Dokuments.

document

MatchHighlightingCondition

Wird festgelegt, wenn returnDocument in RecommendRequest.params auf „true“ gesetzt ist.

metadata

map<string, Value>

Zusätzliche Dokumentmetadaten oder Anmerkungen.

Mögliche Werte:

score: Empfehlungs-Score als Double-Wert. Wird festgelegt, wenn returnScore in RecommendRequest.params auf „true“ gesetzt ist.

RecrawlUrisMetadata

Metadaten zum Fortschritt des Vorgangs SiteSearchEngineService.RecrawlUris. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder
`create_time`	`Timestamp` Erstellungszeit des Vorgangs.
`update_time`	`Timestamp` Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.
`invalid_uris[]`	`string` Eindeutige URIs in der Anfrage mit ungültigem Format. Die Stichprobe ist auf 1.000 beschränkt.
`invalid_uris_count`	`int32` Gesamtzahl der einzelnen URIs in der Anfrage, die ein ungültiges Format haben.
`noindex_uris[]`	`string` URIs ohne Index-Meta-Tag. Die Stichprobe ist auf 1.000 beschränkt.
`noindex_uris_count`	`int32` Die Gesamtzahl der URIs ohne Index-Meta-Tag.
`uris_not_matching_target_sites[]`	`string` Eindeutige URIs in der Anfrage, die mit keiner TargetSite im DataStore übereinstimmen, stimmen nur mit TargetSites überein, die noch nicht vollständig indexiert wurden, oder mit einer TargetSite vom Typ EXCLUDE. Die Stichprobe ist auf 1.000 beschränkt.
`uris_not_matching_target_sites_count`	`int32` Gesamtzahl der URIs, die mit keiner TargetSite übereinstimmen.
`valid_uris_count`	`int32` Gesamtzahl der eindeutigen URIs in der Anfrage, die nicht in „invalid_uris“ enthalten sind.
`success_count`	`int32` Gesamtzahl der bisher gecrawlten URIs.
`pending_count`	`int32` Gesamtzahl der URIs, die noch gecrawlt werden müssen.
`quota_exceeded_count`	`int32` Gesamtzahl der URIs, die aufgrund unzureichender Indexierungsressourcen abgelehnt wurden.

RecrawlUrisRequest

Anfragenachricht für die Methode SiteSearchEngineService.RecrawlUris.

Felder

site_search_engine

string

Erforderlich. Vollständiger Ressourcenname des SiteSearchEngine, z. B. projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

uris[]

string

Erforderlich. Liste der zu crawlenden URIs. Es werden maximal 10.000 URIs unterstützt. Andernfalls wird der Fehler INVALID_ARGUMENT ausgegeben. Jeder URI sollte mit mindestens einem TargetSite in site_search_engine übereinstimmen.

site_credential

string

Optional. Die Anmeldedaten-ID, die für das Crawling verwendet werden soll.

RecrawlUrisResponse

Antwortnachricht für die Methode SiteSearchEngineService.RecrawlUris.

Felder

failure_samples[]

FailureInfo

Details zu einer Stichprobe von bis zu 10 failed_uris.

failed_uris[]

string

URIs, die vor dem Beenden des LRO nicht gecrawlt wurden.

FailureInfo

Details dazu, warum eine bestimmte URI nicht gecrawlt werden konnte. Jede FailureInfo enthält einen FailureReason pro CorpusType.

Felder

uri

string

URI, der nicht gecrawlt werden konnte.

failure_reasons[]

FailureReason

Liste der Fehlerursachen nach Korpus-Typ (z.B. Computer, Mobilgerät).

FailureReason

Details dazu, warum das Crawling für einen bestimmten CorpusType fehlgeschlagen ist, z.B.: Das Crawlen von DESKTOP- und MOBILE-Seiten kann aus unterschiedlichen Gründen fehlschlagen.

Felder

corpus_type

CorpusType

DESKTOP, MOBILE oder CORPUS_TYPE_UNSPECIFIED.

error_message

string

Grund, warum die URI nicht gecrawlt wurde.

CorpusType

CorpusType für den fehlgeschlagenen Crawling-Vorgang.

Enums
`CORPUS_TYPE_UNSPECIFIED`	Standardwert.
`DESKTOP`	Gibt einen Crawling-Versuch für die Desktopversion einer Seite an.
`MOBILE`	Gibt einen Crawling-Versuch für die mobile Version einer Seite an.

Antworten

Definiert eine Antwortnachricht für den Nutzer.

Felder

summary

Summary

Zusammenfassung basierend auf Suchergebnissen.

SafetyRating

Die Sicherheitsbewertung, die den generierten Inhalten entspricht.

Felder
`category`	`HarmCategory` Nur Ausgabe. Schadenskategorie.
`probability`	`HarmProbability` Nur Ausgabe. Wahrscheinlichkeitsstufen für Schäden im Inhalt.
`probability_score`	`float` Nur Ausgabe. Wahrscheinlichkeitswert für Schäden.
`severity`	`HarmSeverity` Nur Ausgabe. Schweregrad des Schadens in den Inhalten.
`severity_score`	`float` Nur Ausgabe. Schweregradbewertung für Schäden.
`blocked`	`bool` Nur Ausgabe. Gibt an, ob die Inhalte aufgrund dieser Altersfreigabe herausgefiltert wurden.

HarmProbability

Wahrscheinlichkeitsstufen für Schäden im Inhalt.

Enums
`HARM_PROBABILITY_UNSPECIFIED`	Die Wahrscheinlichkeit von Schäden ist nicht angegeben.
`NEGLIGIBLE`	Geringfügiges Schadensrisiko.
`LOW`	Geringes Schadensrisiko.
`MEDIUM`	Mittleres Schadensrisiko.
`HIGH`	Hohes Maß an Schaden.

HarmSeverity

Schweregrade von Schäden.

Enums
`HARM_SEVERITY_UNSPECIFIED`	Der Schweregrad des Schadens ist nicht angegeben.
`HARM_SEVERITY_NEGLIGIBLE`	Geringfügiger Schweregrad des Schadens.
`HARM_SEVERITY_LOW`	Geringer Schweregrad des Schadens.
`HARM_SEVERITY_MEDIUM`	Mittlerer Schweregrad des Schadens.
`HARM_SEVERITY_HIGH`	Hoher Schweregrad des Schadens.

Schema

Definiert die Struktur und das Layout einer Art von Dokumentdaten.

Felder
`name`	`string` Nicht veränderbar. Der vollständige Ressourcenname des Schemas im Format `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.
Union-Feld `schema`. Schemadarstellung Du musst entweder `struct_schema` oder `json_schema` angeben. Andernfalls wird der Fehler `INVALID_ARGUMENT` ausgegeben. Für `schema` ist nur einer der folgenden Werte zulässig:
`struct_schema`	`Struct` Die strukturierte Darstellung des Schemas.
`json_schema`	`string` Die JSON-Darstellung des Schemas.

SearchAddOn

Add-on, das zusätzliche Funktionen für die Suche bietet.

Enums
`SEARCH_ADD_ON_UNSPECIFIED`	Standardwert, wenn die Enumeration nicht angegeben ist. Diese Option ist ungültig.
`SEARCH_ADD_ON_LLM`	Add-on für Large Language Models

SearchInfo

Detaillierte Suchinformationen

Felder

search_query

string

Die Suchanfrage des Nutzers.

Eine Definition finden Sie unter SearchRequest.query.

Der Wert muss ein UTF‑8-codierter String mit einer Längenbeschränkung von 5.000 Zeichen sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

Für search-Ereignisse muss mindestens search_query oder PageInfo.page_category angegeben werden. Bei anderen Ereignistypen sollte dieses Feld nicht festgelegt werden. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

order_by

string

Die Reihenfolge, in der Produkte zurückgegeben werden (falls zutreffend).

Definition und Syntax finden Sie unter SearchRequest.order_by.

Der Wert muss ein UTF‑8-codierter String mit einer Längenbeschränkung von 1.000 Zeichen sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

Dieser Wert kann nur für search-Ereignisse festgelegt werden. Bei anderen Ereignistypen sollte dieses Feld nicht festgelegt werden. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

offset

int32

Eine Ganzzahl, die den aktuellen Offset für die Paginierung angibt (die 0-basierte Startposition unter den Produkten, die von der API als relevant eingestuft werden).

Eine Definition finden Sie unter SearchRequest.offset.

Wenn dieses Feld negativ ist, wird ein INVALID_ARGUMENT zurückgegeben.

Dieser Wert kann nur für search-Ereignisse festgelegt werden. Bei anderen Ereignistypen sollte dieses Feld nicht festgelegt werden. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

SearchLinkPromotion

Das Angebots-Proto enthält den URI und andere hilfreiche Informationen zum Anzeigen des Angebots.

Felder
`title`	`string` Erforderlich. Der Titel des Angebots. Maximale Länge: 160 Zeichen.
`uri`	`string` Optional. Die URL der Seite, die der Nutzer bewerben möchte. Muss für die Websitesuche festgelegt werden. Für andere Branchen ist das optional.
`document`	`string` Optional. Die `Document`, die der Nutzer bewerben möchte. Lassen Sie das Feld für die Website-Suche leer und geben Sie nur „uri“ an. Kann zusammen mit „uri“ festgelegt werden.
`image_uri`	`string` Optional. Die URL des Miniaturwerbebilds.
`description`	`string` Optional. Die Beschreibung des Angebots. Maximale Länge: 200 Zeichen.
`enabled`	`bool` Optional. Das aktivierte Angebot wird für alle Bereitstellungskonfigurationen zurückgegeben, die mit dem übergeordneten Element der Kontrollgruppe verknüpft sind, an die dieses Angebot angehängt ist. Dieses Flag wird nur für die einfache Website-Suche verwendet.

SearchRequest

Anfragenachricht für die Methode SearchService.Search.

Felder
`serving_config`	`string` Erforderlich. Der Ressourcenname der Bereitstellungskonfiguration für die Suche, z. B. `projects//locations/global/collections/default_collection/engines//servingConfigs/default_serving_config` oder `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. Dieses Feld wird verwendet, um den Namen der Bereitstellungskonfiguration zu identifizieren, also die Gruppe von Modellen, die für die Suche verwendet werden.
`branch`	`string` Der Ressourcenname des Zweigs, z. B. `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Verwenden Sie `default_branch` als Zweig-ID oder lassen Sie dieses Feld leer, um in Dokumenten im Standardzweig zu suchen.
`query`	`string` Unbearbeitete Suchanfrage.
`image_query`	`ImageQuery` Rohe Bildanfrage.
`page_size`	`int32` Maximale Anzahl der zurückzugebenden `Document`. Der maximal zulässige Wert hängt vom Datentyp ab. Werte über dem Höchstwert werden implizit auf den Höchstwert umgewandelt. Websites mit grundlegender Indexierung: Standard `10`, maximal `25`. Websites mit erweiterter Indexierung: Standard `25`, Maximum `50`. Andere: Standardwert `50`, Maximalwert `100`. Wenn dieses Feld negativ ist, wird ein `INVALID_ARGUMENT` zurückgegeben.
`page_token`	`string` Ein Seitentoken, das von einem vorherigen `SearchService.Search`-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen für `SearchService.Search` bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Andernfalls wird der Fehler `INVALID_ARGUMENT` zurückgegeben.
`offset`	`int32` Eine nullbasierte Ganzzahl, die den aktuellen Offset (d. h. die Startposition des Ergebnisses unter den von der API als relevant eingestuften `Document`s) in den Suchergebnissen angibt. Dieses Feld wird nur berücksichtigt, wenn `page_token` nicht festgelegt wurde. Wenn dieses Feld negativ ist, wird ein `INVALID_ARGUMENT` zurückgegeben. Ein großer Offset wird möglicherweise auf einen angemessenen Grenzwert begrenzt.
`one_box_page_size`	`int32` Die maximale Anzahl der Ergebnisse, die für OneBox zurückgegeben werden sollen. Dies gilt für jeden OneBox-Typ einzeln. Der Standardwert ist 10.
`data_store_specs[]`	`DataStoreSpec` Spezifikationen, die die zu durchsuchenden `DataStore`s sowie Konfigurationen für diese Datenspeicher definieren. Dies wird nur für `Engine`s mit mehreren Datenspeichern berücksichtigt. Bei Engines mit einem einzelnen Datenspeicher sollten die Spezifikationen direkt unter `SearchRequest` verwendet werden.
`filter`	`string` Die Filtersyntax besteht aus einer Ausdruckssprache zum Erstellen eines Prädikats aus einem oder mehreren Feldern der gefilterten Dokumente. Bei Filterausdrücken wird zwischen Groß- und Kleinschreibung unterschieden. Wenn dieses Feld nicht erkannt wird, wird `INVALID_ARGUMENT` zurückgegeben. Das Filtern in Vertex AI Search erfolgt durch Zuordnen des LHS-Filterschlüssels zu einer Schlüsselattribut, das im Vertex AI Search-Backend definiert ist. Diese Zuordnung wird vom Kunden in seinem Schema definiert. Ein Media-Kunde hat in seinem Schema beispielsweise möglicherweise das Feld „name“. In diesem Fall würde der Filter so aussehen: filter --> name:'ANY("king kong")' Weitere Informationen zum Filtern, einschließlich Syntax und Filteroperatoren, finden Sie unter Filter.
`canonical_filter`	`string` Der Standardfilter, der angewendet wird, wenn ein Nutzer eine Suche durchführt, ohne auf der Suchseite Filter zu aktivieren. Der Filter, der auf jede Suchanfrage angewendet wird, wenn eine Qualitätsverbesserung wie die Erweiterung der Anfrage erforderlich ist. Wenn eine Abfrage nicht genügend Ergebnisse liefert, wird mit diesem Filter bestimmt, ob die Abfrageerweiterung aktiviert werden soll. Der ursprüngliche Filter wird weiterhin für die erweiterte Suche der Abfrage verwendet. Dieses Feld wird dringend empfohlen, um eine hohe Suchqualität zu erzielen. Weitere Informationen zur Filtersyntax finden Sie unter `SearchRequest.filter`.
`order_by`	`string` Die Reihenfolge, in der Dokumente zurückgegeben werden. Dokumente können nach einem Feld in einem `Document`-Objekt sortiert werden. Lassen Sie das Feld leer, wenn die Ergebnisse nach Relevanz sortiert werden sollen. Bei `order_by` wird zwischen Groß- und Kleinschreibung unterschieden. Weitere Informationen zum Sortieren der Website-Suchergebnisse finden Sie unter Web-Suchergebnisse sortieren. Weitere Informationen zum Sortieren der Suchergebnisse für das Gesundheitswesen finden Sie unter Suchergebnisse für das Gesundheitswesen sortieren. Wenn dieses Feld nicht erkannt wird, wird `INVALID_ARGUMENT` zurückgegeben.
`user_info`	`UserInfo` Informationen zum Endnutzer. Für Analysen und Personalisierung dringend empfohlen. `UserInfo.user_agent` wird verwendet, um `device_type` für Analysen abzuleiten.
`language_code`	`string` Der BCP-47-Sprachcode, z. B. „en-US“ oder „sr-Latn“ Weitere Informationen finden Sie unter Standardfelder. Dieses Feld hilft, die Anfrage besser zu interpretieren. Wenn kein Wert angegeben ist, wird der Abfragesprachcode automatisch erkannt. Das ist aber möglicherweise nicht korrekt.
`facet_specs[]`	`FacetSpec` Facettenspezifikationen für die Attributsuche. Wenn leer, werden keine Facetten zurückgegeben. Es sind maximal 100 Werte zulässig. Andernfalls wird der Fehler `INVALID_ARGUMENT` zurückgegeben.
`boost_spec`	`BoostSpec` Mit der Boost-Spezifikation können Sie bestimmte Dokumente hervorheben. Weitere Informationen zum Boosten finden Sie unter Boost.
`params`	`map<string, Value>` Zusätzliche Suchparameter. Für die Suche auf öffentlichen Websites sind nur die folgenden Werte zulässig: `user_country_code`: String. Standardmäßig leer. Wenn der Wert nicht leer ist, werden die Ergebnisse basierend auf dem angegebenen Standort eingeschränkt oder optimiert. z. B. `user_country_code: "au"`. Die verfügbaren Codes finden Sie unter Ländercodes. `search_type`: double. Standardmäßig leer. Ermöglicht die Suche in Nicht-Webseiten, je nach Wert. Der einzige gültige Wert, der nicht der Standardwert ist, ist 1. Damit wird die Bildersuche aktiviert. z. B. `search_type: 1`.
`query_expansion_spec`	`QueryExpansionSpec` Die Spezifikation für die Suchanfragenerweiterung, die die Bedingungen angibt, unter denen die Suchanfragenerweiterung erfolgt.
`spell_correction_spec`	`SpellCorrectionSpec` Die Spezifikation für die Rechtschreibkorrektur, die den Modus angibt, in dem die Rechtschreibkorrektur wirksam wird.
`user_pseudo_id`	`string` Eine eindeutige Kennung für das Tracking von Besuchern. Dies kann beispielsweise mit einem HTTP-Cookie implementiert werden, mit dem ein Besucher auf einem einzelnen Gerät eindeutig identifiziert werden kann. Diese eindeutige Kennung sollte sich nicht ändern, wenn sich der Besucher auf der Website an- oder abmeldet. Dieses Feld sollte KEINEN festen Wert wie `unknown_visitor` haben. Dies sollte dieselbe ID wie `UserEvent.user_pseudo_id` und `CompleteQueryRequest.user_pseudo_id` sein. Das Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 128 Zeichen sein. Andernfalls wird der Fehler `INVALID_ARGUMENT` zurückgegeben.
`content_search_spec`	`ContentSearchSpec` Eine Spezifikation zum Konfigurieren des Verhaltens der Inhaltssuche.
`ranking_expression`	`string` Optional. Mit dem Ranking-Ausdruck wird das benutzerdefinierte Ranking beim Abrufen von Dokumenten gesteuert. Dadurch wird `ServingConfig.ranking_expression` überschrieben. Die Syntax und die unterstützten Funktionen hängen vom Wert von `ranking_expression_backend` ab. Wenn `ranking_expression_backend` nicht angegeben ist, wird standardmäßig `RANK_BY_EMBEDDING` verwendet. Wenn `ranking_expression_backend` nicht angegeben oder auf `RANK_BY_EMBEDDING` festgelegt ist, sollte es sich um eine einzelne Funktion oder mehrere Funktionen handeln, die durch „+“ verbunden sind. ranking_expression = function, { " + ", function }; Unterstützte Funktionen: double * relevance_score double * dotProduct(embedding_field_path) Funktionsvariablen: `relevance_score`: Vordefinierte Keywords, die verwendet werden, um die Relevanz zwischen Anfrage und Dokument zu messen. `embedding_field_path`: Das Dokumenteinbettungsfeld, das mit dem Abfrageeinbettungsvektor verwendet wird. `dotProduct`: Einbettungsfunktion zwischen `embedding_field_path` und dem Abfrage-Einbettungsvektor. Beispiel für einen Rankingausdruck: Wenn ein Dokument das Einbettungsfeld „doc_embedding“ hat, könnte der Ranking-Ausdruck `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)` lauten. Wenn `ranking_expression_backend` auf `RANK_BY_FORMULA` gesetzt ist, werden die folgenden Ausdruckstypen (und Kombinationen davon, die mit den Operatoren „+“ oder „“ verkettet werden) unterstützt: `double` `signal` `log(signal)` `exp(signal)` `rr(signal, double > 0)` – Transformation des reziproken Rangs mit dem zweiten Argument als Nennerkonstante. `is_nan(signal)` – gibt 0 zurück, wenn das Signal NaN ist, andernfalls 1. `fill_nan(signal1, signal2 \| double)`: Wenn signal1 „NaN“ ist, wird „signal2 \| double“ zurückgegeben, andernfalls „signal1“. Hier sind einige Beispiele für Ranking-Formeln, in denen die unterstützten Ranking-Ausdruckstypen verwendet werden: `0.2 semantic_similarity_score + 0.8 * log(keyword_similarity_score)` – Die meisten Werte werden nach dem Logarithmus von `keyword_similarity_score` mit geringfügiger `semantic_smilarity_score`-Anpassung eingestuft. `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` – Rangfolge nach dem Exponenten von `semantic_similarity_score`. Der Wert wird mit 0 gefüllt, wenn er „NaN“ ist. Außerdem wird dem endgültigen Ergebnis eine konstante Anpassung von 0,3 hinzugefügt, wenn `semantic_similarity_score` „NaN“ ist. `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` – meistens nach dem reziproken Rang von `keyword_similarity_score` mit geringfügiger Anpassung des reziproken Rangs von `semantic_smilarity_score`. Die folgenden Signale werden unterstützt: `semantic_similarity_score`: Anpassung der semantischen Ähnlichkeit, die mithilfe der Einbettungen berechnet wird, die von einem proprietären Google-Modell generiert werden. Dieser Wert gibt an, wie semantisch ähnlich eine Suchanfrage und ein Dokument sind. `keyword_similarity_score`: Bei der Anpassung von Keyword-Übereinstimmungen wird die BM25-Rankingfunktion (Best Match 25) verwendet. Dieser Wert wird mithilfe eines probabilistischen Modells berechnet, um die Wahrscheinlichkeit zu schätzen, dass ein Dokument für eine bestimmte Anfrage relevant ist. `relevance_score`: Anpassung der semantischen Relevanz, bei der ein proprietäres Google-Modell verwendet wird, um die Bedeutung und Absicht hinter der Anfrage eines Nutzers im Kontext der Inhalte in den Dokumenten zu ermitteln. `pctr_rank`: Anpassung der prognostizierten Conversion-Rate als Rang. Die prognostizierte Klickrate (pCTR) wird verwendet, um die Relevanz und Attraktivität eines Suchergebnisses aus Nutzersicht zu bewerten. Eine höhere pCTR deutet darauf hin, dass das Ergebnis eher der Suchanfrage und Absicht des Nutzers entspricht. Das ist ein wichtiges Signal für das Ranking. `freshness_rank`: Aktualitätsanpassung als Rang `document_age`: Die Zeit in Stunden seit der letzten Aktualisierung des Dokuments, eine Gleitkommazahl (z.B. 0,25 entspricht 15 Minuten. `topicality_rank`: Anpassung der Aktualität als Rang. Verwendet ein proprietäres Google-Modell, um die keywordbasierte Überschneidung zwischen der Anfrage und dem Dokument zu ermitteln. `base_rank`: der Standardrang des Ergebnisses
`ranking_expression_backend`	`RankingExpressionBackend` Optional. Das Backend, das für die Auswertung des Ranking-Ausdrucks verwendet werden soll.
`safe_search`	`bool` Gibt an, ob SafeSearch aktiviert werden soll. Dies wird nur für die Websitesuche unterstützt.
`user_labels`	`map<string, string>` Die Nutzerlabels, die auf eine Ressource angewendet werden, müssen die folgenden Anforderungen erfüllen: Jede Ressource kann bis zu 64 Labels haben. Jedes Label muss ein Schlüssel/Wert-Paar sein. Schlüssel haben eine Mindestlänge von einem Zeichen und eine maximale Länge von 63 Zeichen und dürfen nicht leer sein. Werte dürfen leer sein und haben eine maximale Länge von 63 Zeichen. Schlüssel und Werte dürfen nur Kleinbuchstaben, Ziffern, Unterstriche und Bindestriche enthalten. Alle Zeichen müssen UTF-8-codiert sein. Internationale Zeichen sind zulässig. Der Schlüsselabschnitt eines Labels darf nur einmal vorkommen. Sie können jedoch denselben Schlüssel für mehrere Ressourcen verwenden. Schlüssel müssen mit einem Kleinbuchstaben oder einem internationalen Zeichen beginnen. Weitere Informationen finden Sie im Google Cloud-Dokument.
`natural_language_query_understanding_spec`	`NaturalLanguageQueryUnderstandingSpec` Optional. Konfiguration für Funktionen zur Interpretation von Anfragen in natürlicher Sprache, z. B. zum Extrahieren strukturierter Feldfilter aus der Anfrage. Weitere Informationen finden Sie in dieser Dokumentation. Wenn `naturalLanguageQueryUnderstandingSpec` nicht angegeben ist, wird keine zusätzliche Verarbeitung von Abfragen in natürlicher Sprache durchgeführt.
`search_as_you_type_spec`	`SearchAsYouTypeSpec` Konfiguration der Suche während der Eingabe Wird nur für die Branche `IndustryVertical.MEDIA` unterstützt.
`display_spec`	`DisplaySpec` Optional. Konfiguration für die Anzeige von Funktionen wie der Hervorhebung von Übereinstimmungen in Suchergebnissen.
`session`	`string` Der Name der Sitzungsressource. Optional. Mit der Sitzung können Nutzer mehrere /search API-Aufrufe ausführen oder /search API-Aufrufe und /answer API-Aufrufe koordinieren. Beispiel 1 (mehrere /search-API-Aufrufe): Rufen Sie die /search-API mit der Sitzungs-ID auf, die im ersten Aufruf generiert wurde. Hier wird die vorherige Suchanfrage bei der Bewertung der Anfrage berücksichtigt. Wenn die erste Frage beispielsweise „Wie hat sich Alphabet im Jahr 2022 entwickelt?“ lautet, und die aktuelle Frage „Wie sieht es mit 2023 aus?“ lautet, wird sie als „Wie hat sich Alphabet 2023 entwickelt?“ interpretiert. Beispiel 2 (Abstimmung zwischen /search-API-Aufrufen und /answer-API-Aufrufen): Rufen Sie die /answer-API mit der im ersten Aufruf generierten Sitzungs-ID auf. Die Antwort wird hier im Kontext der Suchergebnisse aus dem ersten Suchaufruf generiert. Die Funktion für die Suche mit mehreren Anfragen befindet sich derzeit in der privaten GA-Phase. Verwenden Sie stattdessen die Version v1alpha oder v1beta, bevor wir diese Funktion allgemein verfügbar machen. Alternativ können Sie das Google-Supportteam bitten, Sie auf die Zulassungsliste zu setzen.
`session_spec`	`SessionSpec` Sitzungsspezifikation. Kann nur verwendet werden, wenn `session` festgelegt ist.
`relevance_threshold`	`RelevanceThreshold` Der Relevanzschwellenwert der Suchergebnisse. Standardmäßig wird der von Google definierte Grenzwert verwendet, bei dem ein Gleichgewicht zwischen Präzision und Erinnerung angestrebt wird, um sowohl sehr genaue Ergebnisse als auch eine umfassende Abdeckung relevanter Informationen zu erzielen. Diese Funktion wird für die Suche im Gesundheitswesen nicht unterstützt.
`relevance_score_spec`	`RelevanceScoreSpec` Optional. Die Spezifikation für die Rückgabe des Relevanzwerts.

BoostSpec

Mit der Boost-Spezifikation können Sie bestimmte Dokumente hervorheben.

Felder

condition_boost_specs[]

ConditionBoostSpec

Spezifikationen für Bedingungs-Boosts. Wenn ein Dokument mehreren Bedingungen in den Spezifikationen entspricht, werden alle Boost-Werte aus diesen Spezifikationen angewendet und nicht linear kombiniert. Es sind maximal 20 Spezifikationen zulässig.

ConditionBoostSpec

Die Steigerung wird auf Dokumente angewendet, die einer Bedingung entsprechen.

Felder

condition

string

Ein Ausdruck, der eine Steigerungsbedingung angibt. Die Syntax und die unterstützten Felder sind dieselben wie bei einem Filterausdruck. Weitere Informationen zur Syntax und zu den Einschränkungen finden Sie unter SearchRequest.filter.

Beispiele:

So stufen Sie Dokumente mit der Dokument-ID „doc_1“ oder „doc_2“ und der Farbe „Rot“ oder „Blau“ höher ein: (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))

boost

float

Stärke des Bedingungs-Boostings, die im Bereich [-1, 1] liegen sollte. Negatives Boosting bedeutet Abwertung. Der Standardwert ist 0,0.

Wenn Sie den Wert auf 1,0 setzen, erfährt das Dokument eine starke Aufwertung. Das bedeutet aber nicht, dass das aufgewertete Dokument immer das Top-Ergebnis ist oder dass andere Dokumente ausgeschlossen werden. Ergebnisse können auch dann angezeigt werden, wenn keines mit der Bedingung übereinstimmt. Außerdem können Ergebnisse, die für die Suchanfrage deutlich relevanter sind, höher eingestuft werden als Ihre stark bevorzugten, aber irrelevanten Dokumente.

Wenn Sie den Wert auf -1,0 setzen, wird das Dokument stark herabgestuft. Ergebnisse, die sehr relevant sind, werden möglicherweise weiterhin angezeigt. Das Dokument muss sich in der Rangfolge gegen andere Dokumente durchsetzen, um eine relativ hohe Position zu erreichen, ist aber nicht vollständig blockiert.

Wenn Sie den Wert auf 0,0 festlegen, wird kein Boost angewendet. Die Bedingung für die Steigerung wird ignoriert. Es wird nur eine der Kombinationen aus (Bedingung, Steigerung) oder der boost_control_spec unten festgelegt. Wenn beide festgelegt sind, wird der globale Boost ignoriert und die detailliertere boost_control_spec angewendet.

boost_control_spec

BoostControlSpec

Komplexe Spezifikation für benutzerdefiniertes Ranking basierend auf einem vom Kunden definierten Attributwert.

BoostControlSpec

Felder
`field_name`	`string` Der Name des Felds, dessen Wert zur Bestimmung des Steigerungsbetrags verwendet wird.
`attribute_type`	`AttributeType` Der Attributtyp, der zum Ermitteln des Steigerungsbetrags verwendet werden soll. Der Attributwert kann aus dem Feldwert des angegebenen „field_name“ abgeleitet werden. Bei numerischen Werten ist das ganz einfach: attribute_value = numerical_field_value. Im Fall von „Aktualität“ gilt jedoch: attribute_value = (time.now() – datetime_field_value).
`interpolation_type`	`InterpolationType` Der Interpolationstyp, der zum Verbinden der unten aufgeführten Kontrollpunkte angewendet werden soll.
`control_points[]`	`ControlPoint` Die Kontrollpunkte, mit denen die Kurve definiert wird. Die monotone Funktion (die oben über „interpolation_type“ definiert wurde) verläuft durch die hier aufgeführten Kontrollpunkte.

AttributeType

Das Attribut(oder die Funktion), auf das bzw. die das benutzerdefinierte Ranking angewendet werden soll.

Enums
`ATTRIBUTE_TYPE_UNSPECIFIED`	Nicht angegebener AttributeType.
`NUMERICAL`	Der Wert des numerischen Felds wird verwendet, um den Steigerungsbetrag dynamisch zu aktualisieren. In diesem Fall ist der „attribute_value“ (der x-Wert) des Kontrollpunkts der tatsächliche Wert des numerischen Felds, für das „boost_amount“ angegeben ist.
`FRESHNESS`	Im Anwendungsfall „Aktualität“ ist der Attributwert die Dauer zwischen der aktuellen Uhrzeit und dem Datum im angegebenen Datums-/Uhrzeitfeld. Der Wert muss als XSD-`dayTimeDuration`-Wert formatiert sein (eine eingeschränkte Teilmenge eines ISO 8601-Dauerwerts). Das Muster dafür ist: `[nD][T[nH][nM][nS]]`. Beispiele: `5D`, `3DT12H30M`, `T24H`.

ControlPoint

Die Kontrollpunkte, mit denen die Kurve definiert wird. Die durch diese Kontrollpunkte definierte Kurve kann nur monoton steigend oder fallend sein(konstante Werte sind zulässig).

Felder

attribute_value

string

Kann einer der folgenden Werte sein: 1. Der numerische Feldwert. 2. Die Dauerangabe für die Aktualität: Der Wert muss als XSD-dayTimeDuration-Wert formatiert sein (eine eingeschränkte Teilmenge eines ISO 8601-Dauerwerts). Das Muster dafür ist: [nD][T[nH][nM][nS]].

boost_amount

float

Der Wert zwischen -1 und 1, um den die Punktzahl erhöht werden soll, wenn der „attribute_value“ dem oben angegebenen Wert entspricht.

InterpolationType

Der anzuwendende Interpolationstyp. Der Standardwert ist „linear“ (Piecewise Linear).

Enums
`INTERPOLATION_TYPE_UNSPECIFIED`	Der Interpolationstyp ist nicht angegeben. In diesem Fall wird standardmäßig „Linear“ verwendet.
`LINEAR`	Es wird eine stückweise lineare Interpolation angewendet.

ContentSearchSpec

Eine Spezifikation zum Konfigurieren des Verhaltens der Inhaltssuche.

Felder
`snippet_spec`	`SnippetSpec` Wenn `snippetSpec` nicht angegeben ist, werden keine Snippets in die Suchantwort aufgenommen.
`summary_spec`	`SummarySpec` Wenn `summarySpec` nicht angegeben ist, sind Zusammenfassungen nicht in der Suchantwort enthalten.
`extractive_content_spec`	`ExtractiveContentSpec` Wenn keine extractive_content_spec angegeben ist, enthält die Suchantwort keine extraktive Antwort.
`search_result_mode`	`SearchResultMode` Gibt den Modus für Suchergebnisse an. Wenn nichts angegeben ist, wird standardmäßig der Suchergebnismodus `DOCUMENTS` verwendet.
`chunk_spec`	`ChunkSpec` Gibt die Chunkspezifikation an, die von der Suchantwort zurückgegeben werden soll. Nur verfügbar, wenn `SearchRequest.ContentSearchSpec.search_result_mode` auf `CHUNKS` gesetzt ist.

ChunkSpec

Gibt die Chunkspezifikation an, die von der Suchantwort zurückgegeben werden soll. Nur verfügbar, wenn SearchRequest.ContentSearchSpec.search_result_mode auf CHUNKS gesetzt ist.

Felder

num_previous_chunks

int32

Die Anzahl der vorherigen Chunks, die vom aktuellen Chunk zurückgegeben werden sollen. Der maximal zulässige Wert beträgt 3. Wenn nicht angegeben, werden keine vorherigen Chunks zurückgegeben.

num_next_chunks

int32

Die Anzahl der nächsten Chunks, die vom aktuellen Chunk zurückgegeben werden sollen. Der maximal zulässige Wert beträgt 3. Wenn nicht angegeben, werden keine weiteren Chunks zurückgegeben.

ExtractiveContentSpec

Eine Spezifikation zum Konfigurieren des extraktiven Inhalts in einer Suchantwort.

Felder
`max_extractive_answer_count`	`int32` Die maximale Anzahl von extraktiven Antworten, die in jedem Suchergebnis zurückgegeben werden. Eine extraktive Antwort ist eine wörtliche Antwort, die aus dem Originaldokument extrahiert wird und eine präzise und kontextbezogene Antwort auf die Suchanfrage liefert. Wenn die Anzahl der übereinstimmenden Antworten kleiner als `max_extractive_answer_count` ist, werden alle Antworten zurückgegeben. Andernfalls wird `max_extractive_answer_count` zurückgegeben. Für jede `SearchResult` werden maximal fünf Antworten zurückgegeben.
`max_extractive_segment_count`	`int32` Die maximale Anzahl von extraktiven Segmenten, die in jedem Suchergebnis zurückgegeben werden. Wird nur angewendet, wenn `DataStore` auf `DataStore.ContentConfig.CONTENT_REQUIRED` eingestellt ist oder `DataStore.solution_types` `SOLUTION_TYPE_CHAT` ist. Ein extraktives Segment ist ein Textsegment, das aus dem Originaldokument extrahiert wird und für die Suchanfrage relevant ist. Im Allgemeinen ist es ausführlicher als eine extraktive Antwort. Das Segment kann dann als Eingabe für LLMs verwendet werden, um Zusammenfassungen und Antworten zu generieren. Wenn die Anzahl der übereinstimmenden Segmente kleiner als `max_extractive_segment_count` ist, werden alle Segmente zurückgegeben. Andernfalls wird `max_extractive_segment_count` zurückgegeben.
`return_extractive_segment_score`	`bool` Gibt an, ob der Konfidenzwert aus den extraktiven Segmenten in jedem Suchergebnis zurückgegeben werden soll. Diese Funktion ist nur für neue oder auf die Zulassungsliste gesetzte Datenspeicher verfügbar. Wenden Sie sich an Ihren Customer Engineer, um Ihren Datenspeicher auf die Zulassungsliste setzen zu lassen. Der Standardwert ist `false`.
`num_previous_segments`	`int32` Gibt an, ob auch die angrenzenden Segmente der ausgewählten Segmente einbezogen werden sollen. Gibt maximal `num_previous_segments` Segmente vor jedem ausgewählten Segment zurück.
`num_next_segments`	`int32` Gibt nach jedem ausgewählten Segment maximal `num_next_segments` Segmente zurück.

SearchResultMode

Gibt den Modus für Suchergebnisse an. Wenn nichts angegeben ist, wird standardmäßig der Suchergebnismodus DOCUMENTS verwendet.

Enums
`SEARCH_RESULT_MODE_UNSPECIFIED`	Standardwert.
`DOCUMENTS`	Gibt Dokumente im Suchergebnis zurück.
`CHUNKS`	Gibt Chunks im Suchergebnis zurück. Nur verfügbar, wenn `DocumentProcessingConfig.chunking_config` angegeben ist.

SnippetSpec

Eine Spezifikation zum Konfigurieren von Snippets in einer Suchantwort.

Felder

max_snippet_count
(deprecated)

int32

[VERWORFEN] Die Verwendung dieses Feldes wurde eingestellt. Verwenden Sie das Feld return_snippet, um die Rückgabe von Snippets zu steuern. Aus Gründen der Abwärtskompatibilität wird ein Snippet zurückgegeben, wenn „max_snippet_count“ > 0 ist.

reference_only
(deprecated)

bool

[VERALTET] Dieses Feld ist veraltet und hat keine Auswirkungen auf den Snippet.

return_snippet

bool

Bei true wird ein Snippet zurückgegeben. Wenn kein Snippet generiert werden kann, wird „Für diese Seite ist kein Snippet verfügbar“ zurückgegeben. Außerdem wird ein snippet_status mit SUCCESS oder NO_SNIPPET_AVAILABLE zurückgegeben.

SummarySpec

Eine Spezifikation zum Konfigurieren einer Zusammenfassung, die in einer Suchantwort zurückgegeben wird.

Felder
`summary_result_count`	`int32` Die Anzahl der Top-Ergebnisse, aus denen die Zusammenfassung generiert werden soll. Wenn die Anzahl der zurückgegebenen Ergebnisse kleiner als `summaryResultCount` ist, wird die Zusammenfassung aus allen Ergebnissen generiert. Es können maximal 10 Ergebnisse im Dokumentmodus oder 50 Ergebnisse im Chunks-Modus verwendet werden, um eine Zusammenfassung zu erstellen. Der Chunks-Modus wird verwendet, wenn `SearchRequest.ContentSearchSpec.search_result_mode` auf `CHUNKS` gesetzt ist.
`include_citations`	`bool` Gibt an, ob Zitationen in die Zusammenfassung aufgenommen werden sollen. Der Standardwert ist `false`. Wenn dieses Feld auf `true` gesetzt ist, enthalten Zusammenfassungen Inline-Zitiernummern. Beispiel für eine Zusammenfassung mit Quellenangaben: BigQuery ist das vollständig verwaltete und serverlose Data Warehouse für Unternehmen von Google Cloud.[1] BigQuery unterstützt alle Datentypen, funktioniert cloudübergreifend und enthält integrierte Funktionen für Machine Learning und Business Intelligence auf einer einheitlichen Plattform [2, 3]. Die Zitationsnummern beziehen sich auf die zurückgegebenen Suchergebnisse und sind 1-basiert. [1] bedeutet beispielsweise, dass der Satz dem ersten Suchergebnis zugeordnet wird. [2, 3] bedeutet, dass der Satz sowohl dem zweiten als auch dem dritten Suchergebnis zugeordnet wird.
`ignore_adversarial_query`	`bool` Gibt an, ob feindselige Anfragen herausgefiltert werden sollen. Der Standardwert ist `false`. Google verwendet die Klassifizierung von Suchanfragen, um schädliche Anfragen zu erkennen. Wenn die Suchanfrage als feindselige Anfrage eingestuft wird, wird keine Zusammenfassung zurückgegeben. Ein Nutzer könnte beispielsweise eine Frage zu negativen Kommentaren über das Unternehmen stellen oder eine Anfrage senden, die darauf abzielt, unsichere, richtlinienwidrige Ausgaben zu generieren. Wenn dieses Feld auf `true` gesetzt ist, werden keine Zusammenfassungen für feindselige Anfragen generiert. Stattdessen werden Fallback-Nachrichten zurückgegeben.
`ignore_non_summary_seeking_query`	`bool` Gibt an, ob Anfragen herausgefiltert werden sollen, die nicht auf eine Zusammenfassung abzielen. Der Standardwert ist `false`. Google verwendet die Klassifizierung von Suchanfragen, um Anfragen zu erkennen, bei denen Nutzer eine Zusammenfassung wünschen. Es wird keine Zusammenfassung zurückgegeben, wenn die Suchanfrage als Anfrage klassifiziert wird, die keine Zusammenfassung erfordert. Beispiele: `why is the sky blue` und `Who is the best soccer player in the world?` sind Anfragen, bei denen eine Zusammenfassung gesucht wird, `SFO airport` und `world cup 2026` jedoch nicht. Höchstwahrscheinlich handelt es sich um Navigationsanfragen. Wenn dieses Feld auf `true` festgelegt ist, überspringen wir das Generieren von Zusammenfassungen für Anfragen, die keine Zusammenfassung anfordern, und geben stattdessen Fallback-Nachrichten zurück.
`ignore_low_relevant_content`	`bool` Gibt an, ob Suchanfragen mit geringer Relevanz herausgefiltert werden sollen. Der Standardwert ist `false`. Wenn dieses Feld auf `false` festgelegt ist, werden alle Suchergebnisse unabhängig von ihrer Relevanz verwendet, um Antworten zu generieren. Bei Festlegung auf `true` werden nur für Anfragen mit Suchergebnissen mit hoher Relevanz Antworten generiert.
`ignore_jail_breaking_query`	`bool` Optional. Gibt an, ob Anfragen zum Jailbreaking herausgefiltert werden sollen. Der Standardwert ist `false`. Google verwendet die Klassifizierung von Suchanfragen, um Anfragen zu erkennen, die darauf abzielen, die Sicherheitsvorkehrungen zu umgehen. Es wird keine Zusammenfassung zurückgegeben, wenn die Suchanfrage als Jailbreak-Anfrage eingestuft wird. Ein Nutzer kann der Anfrage Anweisungen hinzufügen, um den Ton, Stil, die Sprache oder den Inhalt der Antwort zu ändern oder das Modell zu bitten, als eine andere Einheit zu agieren, z.B. „Antworte im Stil des CEO eines konkurrierenden Unternehmens“. Wenn dieses Feld auf `true` gesetzt ist, werden keine Zusammenfassungen für Anfragen zum Jailbreaking generiert. Stattdessen werden Fallback-Nachrichten zurückgegeben.
`model_prompt_spec`	`ModelPromptSpec` Wenn angegeben, wird die Spezifikation verwendet, um den Prompt zu ändern, der dem LLM bereitgestellt wird.
`language_code`	`string` Sprachcode für die Zusammenfassung. Verwenden Sie Sprachentags, die von BCP47 definiert werden. Hinweis: Dies ist eine experimentelle Funktion.
`model_spec`	`ModelSpec` Falls angegeben, wird die Spezifikation verwendet, um die dem LLM bereitgestellte Modellspezifikation zu ändern.
`use_semantic_chunks`	`bool` Bei „wahr“ wird die Antwort aus den relevantesten Chunks der Top-Suchergebnisse generiert. Diese Funktion verbessert die Qualität der Zusammenfassungen. Wenn diese Funktion aktiviert ist, werden nicht alle Top-Suchergebnisse referenziert und in die Referenzliste aufgenommen. Der Index der Zitationsquellen verweist also nur auf die Suchergebnisse, die in der Referenzliste aufgeführt sind.

ModelPromptSpec

Spezifikation des Prompts, der mit dem Modell verwendet werden soll.

Felder

preamble

string

Text am Anfang des Prompts, der den Assistenten anweist. Beispiele finden Sie im Nutzerhandbuch.

ModelSpec

Spezifikation des Modells.

Felder

version

string

Die Modellversion, die zum Generieren der Zusammenfassung verwendet wurde.

Unterstützte Werte:

stable: String. Standardwert, wenn kein Wert angegeben ist. Verwendet ein allgemein verfügbares, feinabgestimmtes Modell. Weitere Informationen finden Sie unter Modellversionen und Lebenszyklus für die Antwortgenerierung.
preview: String. (Öffentliche Vorschau) Verwendet ein Vorschaumodell. Weitere Informationen finden Sie unter Modellversionen und Lebenszyklus für die Antwortgenerierung.

DataStoreSpec

Eine Struktur zum Definieren von Datenspeichern, nach denen in einem Suchaufruf gefiltert werden soll, und Konfigurationen für diese Datenspeicher. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

Felder
`data_store`	`string` Erforderlich. Vollständiger Ressourcenname von `DataStore`, z. B. `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Der Pfad muss die Projektnummer enthalten. Die Projekt-ID wird für dieses Feld nicht unterstützt.
`filter`	`string` Optional. Filterspezifikation zum Filtern von Dokumenten im Datenspeicher, der durch das Feld „data_store“ angegeben wird. Weitere Informationen zum Filtern finden Sie unter Filtern.
`boost_spec`	`BoostSpec` Optional. Mit der Boost-Spezifikation können Sie bestimmte Dokumente hervorheben. Weitere Informationen zum Boosten finden Sie unter Boost.
`custom_search_operators`	`string` Optional. Benutzerdefinierte Suchoperatoren, die bei Angabe zum Filtern von Ergebnissen aus Arbeitsbereichsdatenspeichern verwendet werden. Weitere Informationen zu benutzerdefinierten Suchoperatoren finden Sie unter SearchOperators.

DisplaySpec

Gibt Funktionen für die Anzeige an, z. B. das Hervorheben von Übereinstimmungen.

Felder

match_highlighting_condition

Die Bedingung, unter der Übereinstimmungen hervorgehoben werden sollen.

MatchHighlightingCondition

Aufzählung, die beschreibt, unter welcher Bedingung die Übereinstimmung hervorgehoben werden soll.

Enums
`MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED`	Das Serververhalten ist dasselbe wie bei `MATCH_HIGHLIGHTING_DISABLED`.
`MATCH_HIGHLIGHTING_DISABLED`	Deaktiviert die Hervorhebung von Übereinstimmungen in allen Dokumenten.
`MATCH_HIGHLIGHTING_ENABLED`	Aktiviert die Hervorhebung von Übereinstimmungen in allen Dokumenten.

FacetSpec

Eine Attributspezifikation für die Attributsuche.

Felder
`facet_key`	`FacetKey` Erforderlich. Die Spezifikation des Facettenschlüssels.
`limit`	`int32` Maximale Anzahl von Attributwerten, die für dieses Attribut zurückgegeben werden. Wenn nicht angegeben, lautet die Standardeinstellung 20. Der maximal zulässige Wert beträgt 300. Werte über 300 werden implizit auf 300 umgewandelt. Bei der Aggregation in der Suche nach Gesundheitsdaten wird das Limit intern auf 10.000 überschrieben, wenn [FacetKey.key] „healthcare_aggregation_key“ ist. Das gilt unabhängig vom hier festgelegten Wert. Wenn dieses Feld negativ ist, wird ein `INVALID_ARGUMENT` zurückgegeben.
`excluded_filter_keys[]`	`string` Liste der Schlüssel, die beim Facettieren ausgeschlossen werden sollen. Standardmäßig wird `FacetKey.key` nicht aus dem Filter ausgeschlossen, sofern es nicht in diesem Feld aufgeführt ist. Wenn Sie einen Attributschlüssel in diesem Feld angeben, können seine Werte als Attributergebnisse angezeigt werden, auch wenn sie aus den Suchergebnissen herausgefiltert werden. Die Verwendung dieses Felds hat keinen Einfluss darauf, welche Suchergebnisse zurückgegeben werden. Angenommen, es gibt 100 Dokumente mit der Facette „Farbe“ – „Rot“ und 200 Dokumente mit der Facette „Farbe“ – „Blau“. Bei einer Abfrage mit dem Filter „color:ANY(‚Red‘)“ und „color“ als `FacetKey.key` werden standardmäßig nur Dokumente mit der Farbe „Rot“ in den Suchergebnissen zurückgegeben. Außerdem wird „Rot“ mit der Anzahl 100 als einzige Farb-Facette zurückgegeben. Obwohl auch blaue Dokumente verfügbar sind, wird „Blau“ nicht als verfügbarer Facettenwert angezeigt. Wenn „color“ in „excludedFilterKeys“ aufgeführt ist, werden in der Abfrage die Facettenwerte „Red“ mit dem Zähler 100 und „Blue“ mit dem Zähler 200 zurückgegeben, da der Schlüssel „color“ jetzt aus dem Filter ausgeschlossen ist. Da sich dieses Feld nicht auf die Suchergebnisse auswirkt, werden die Suchergebnisse weiterhin korrekt gefiltert, sodass nur Dokumente mit dem Wert „Rot“ zurückgegeben werden. Es sind maximal 100 Werte zulässig. Andernfalls wird der Fehler `INVALID_ARGUMENT` zurückgegeben.
`enable_dynamic_position`	`bool` Aktiviert die dynamische Position für diese Facette. Wenn „true“ festgelegt ist, wird die Position dieser Facette unter allen Facetten in der Antwort automatisch bestimmt. Wenn dynamische Attribute aktiviert sind, wird die Bestellung zusammen ausgeführt. Wenn der Wert auf „false“ gesetzt ist, ist die Position dieser Facette in der Antwort dieselbe wie in der Anfrage. Sie wird vor den Facetten mit aktivierter dynamischer Position und allen dynamischen Facetten eingestuft. Sie möchten beispielsweise immer, dass die Facette „Bewertung“ in der Antwort zurückgegeben wird, aber nicht unbedingt immer oben angezeigt wird. In diesem Fall können Sie „enable_dynamic_position“ auf „true“ setzen, damit die Position der Bewertungsfacette in der Antwort automatisch bestimmt wird. Ein weiteres Beispiel: Angenommen, Sie haben die folgenden Facetten in der Anfrage: „rating“, enable_dynamic_position = true „price“, enable_dynamic_position = false „brands“, enable_dynamic_position = false Außerdem haben Sie dynamische Facetten aktiviert, wodurch die Facette `gender` generiert wird. Die endgültige Reihenfolge der Facetten in der Antwort kann dann („price“, „brands“, „rating“, „gender“) oder („price“, „brands“, „gender“, „rating“) sein, je nachdem, wie die API die Facetten „gender“ und „rating“ sortiert. „price“ und „brands“ werden jedoch immer auf Platz 1 und 2 eingestuft, da „enable_dynamic_position“ auf „false“ gesetzt ist.

FacetKey

Gibt an, wie eine Facette berechnet wird.

Felder
`key`	`string` Erforderlich. Unterstützte Text- und numerische Attributschlüssel im Objekt `Document`, für die die Attributwerte berechnet werden. Bei Facettenschlüsseln wird zwischen Groß- und Kleinschreibung unterschieden.
`intervals[]`	`Interval` Wird nur festgelegt, wenn Werte in Intervalle unterteilt werden sollen. Muss für Facetten mit numerischen Werten festgelegt werden. Darf nicht für Facette mit Textwerten festgelegt werden. Die maximale Anzahl von Intervallen beträgt 30.
`restricted_values[]`	`string` Nur Facette für die angegebenen eingeschränkten Werte abrufen. Wird nur für Textfelder unterstützt. Angenommen, „category“ hat die drei Werte „Action > 2022“, „Action > 2021“ und „Sci-Fi > 2022“. Wenn Sie „restricted_values“ auf „Action > 2022“ festlegen, enthält die Dimension „category“ nur „Action > 2022“. Wird nur für Textfelder unterstützt. Der Maximalwert beträgt 10.
`prefixes[]`	`string` Nur Facettenwerte abrufen, die mit dem angegebenen Stringpräfix beginnen. Angenommen, „category“ hat die drei Werte „Action > 2022“, „Action > 2021“ und „Sci-Fi > 2022“. Wenn Sie „prefixes“ auf „Action“ festlegen, enthält die Dimension „category“ nur „Action > 2022“ und „Action > 2021“. Wird nur für Textfelder unterstützt. Der Maximalwert beträgt 10.
`contains[]`	`string` Nur Facettenwerte abrufen, die die angegebenen Strings enthalten. Angenommen, „category“ hat die drei Werte „Action > 2022“, „Action > 2021“ und „Sci-Fi > 2022“. Wenn Sie „contains“ auf „2022“ festlegen, enthält die Facette „category“ nur „Action > 2022“ und „Sci-Fi > 2022“. Wird nur für Textfelder unterstützt. Der Maximalwert beträgt 10.
`case_insensitive`	`bool` „True“, damit bei der Suche nach Facettierungswerten mit Präfixen oder „contains“ die Groß-/Kleinschreibung für Facettenschlüssel nicht berücksichtigt wird. Andernfalls „false“.
`order_by`	`string` Die Reihenfolge, in der Dokumente zurückgegeben werden. Zulässige Werte sind: „count desc“ bedeutet, dass nach `SearchResponse.Facet.values.count` in absteigender Reihenfolge sortiert wird. „value desc“ bedeutet, dass nach `SearchResponse.Facet.values.value` in absteigender Reihenfolge sortiert wird. Gilt nur für Textfacetten. Wenn nicht festgelegt, werden Textwerte in natürlicher Reihenfolge sortiert. Numerische Intervalle werden in der durch `FacetSpec.FacetKey.intervals` angegebenen Reihenfolge sortiert.

ImageQuery

Gibt die Eingabe für die Bildabfrage an.

Felder

Union-Feld image.

Für image ist nur einer der folgenden Werte zulässig:

image_bytes

string

Base64-codierte Bilddaten. Unterstützte Bildformate: JPEG, PNG und BMP.

NaturalLanguageQueryUnderstandingSpec

Spezifikation zur Aktivierung von Funktionen zum Verarbeiten natürlicher Sprache für Suchanfragen.

Felder
`filter_extraction_condition`	`FilterExtractionCondition` Die Bedingung, unter der die Filter extrahiert werden sollen. Das Serververhalten ist standardmäßig auf `DISABLED` eingestellt.
`geo_search_query_detection_field_names[]`	`string` Feldnamen, die für die standortbasierte Filterung verwendet werden, wenn Geolocation-Filter in Suchanfragen in natürlicher Sprache erkannt werden. Nur gültig, wenn „FilterExtractionCondition“ auf `ENABLED` festgelegt ist. Wenn dieses Feld festgelegt ist, werden die in `ServingConfig.geo_search_query_detection_field_names` festgelegten Feldnamen überschrieben.
`extracted_filter_behavior`	`ExtractedFilterBehavior` Optional. Steuert, wie extrahierte Filter auf die Suche angewendet werden. Das Standardverhalten hängt von der Anfrage ab. Bei der strukturierten Suche in einem einzelnen Datenspeicher ist der Standardwert `HARD_FILTER`. Bei der Suche in mehreren Datenspeichern ist das Standardverhalten `SOFT_BOOST`. Standortbasierte Filter werden immer als Hard-Filter angewendet und die Einstellung `SOFT_BOOST` hat keine Auswirkungen auf sie. Dieses Feld wird nur verwendet, wenn [SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition][] auf `FilterExtractionCondition.ENABLED` gesetzt ist.
`allowed_field_names[]`	`string` Optional. Zulassungsliste der Felder, die für die Extraktion von Filtern in natürlicher Sprache verwendet werden können. Wenn nichts angegeben ist, kommen standardmäßig alle indexierbaren Felder für die Extraktion von Filtern in natürlicher Sprache infrage. Es wird jedoch nicht garantiert, dass sie verwendet werden. Wenn Felder in „allowed_field_names“ angegeben sind, kommen nur die Felder für die Extraktion von Filtern in natürlicher Sprache infrage, die sowohl im Schema als indexierbar markiert als auch in der Zulassungsliste angegeben sind. Hinweis: Bei der Suche in mehreren Datenspeichern wird dies noch nicht unterstützt und ignoriert.

ExtractedFilterBehavior

Aufzählung, die beschreibt, wie extrahierte Filter auf die Suche angewendet werden.

Enums
`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED`	`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` verwendet das Standardverhalten für extrahierte Filter. Bei der Suche in einem einzelnen Datenspeicher werden sie standardmäßig als Hard-Filter angewendet. Bei der Suche in mehreren Datenspeichern werden sie standardmäßig als Soft Boosts angewendet.
`HARD_FILTER`	Wendet alle extrahierten Filter als Hard-Filter auf die Ergebnisse an. Ergebnisse, die die extrahierten Filter nicht bestehen, werden nicht in der Ergebnismenge zurückgegeben.
`SOFT_BOOST`	Wendet alle extrahierten Filter als Soft Boosts an. Ergebnisse, die die Filter bestehen, werden im Ergebnissatz auf höhere Ränge verschoben.

FilterExtractionCondition

Enumeration, die beschreibt, unter welcher Bedingung die Filterextraktion erfolgen soll.

Enums
`CONDITION_UNSPECIFIED`	Das Serververhalten ist standardmäßig auf `DISABLED` eingestellt.
`DISABLED`	Deaktiviert die Extraktion von Filtern in natürlicher Sprache.
`ENABLED`	Ermöglicht das Extrahieren von Filtern in natürlicher Sprache.

QueryExpansionSpec

Spezifikation, um festzulegen, unter welchen Bedingungen die Abfrageerweiterung erfolgen soll.

Felder

condition

Condition

Die Bedingung, unter der die Suchanfragenerweiterung erfolgen soll. Standardeinstellung ist Condition.DISABLED.

pin_unexpanded_results

bool

Gibt an, ob nicht maximierte Ergebnisse angepinnt werden sollen. Wenn dieses Feld auf „true“ gesetzt ist, werden nicht maximierte Produkte immer oben in den Suchergebnissen angezeigt, gefolgt von den maximierten Ergebnissen.

Bedingung

Aufzählung, die beschreibt, unter welcher Bedingung die Suchanfragenerweiterung erfolgen soll.

Enums
`CONDITION_UNSPECIFIED`	Nicht angegebene Bedingung für die Suchanfragenerweiterung. In diesem Fall ist das Serververhalten standardmäßig `Condition.DISABLED`.
`DISABLED`	Suchanfragenerweiterung deaktiviert. Es wird nur die genaue Suchanfrage verwendet, selbst wenn `SearchResponse.total_size` null ist.
`AUTO`	Automatische Suchanfragenerweiterung, die von der Search API erstellt wird.

RankingExpressionBackend

Das Backend, das für die Auswertung des Ranking-Ausdrucks verwendet werden soll.

Enums
`RANKING_EXPRESSION_BACKEND_UNSPECIFIED`	Standardoption für nicht angegebene/unbekannte Werte.
`BYOE`	Verworfen: Verwenden Sie stattdessen `RANK_BY_EMBEDDING`. Ranking nach benutzerdefiniertem Einbettungsmodell, der Standardweg zur Bewertung des Ranking-Ausdrucks. Die alte Enum-Option `RANK_BY_EMBEDDING` sollte stattdessen verwendet werden. Dieses Element ist veraltet.
`CLEARBOX`	Verworfen: Verwenden Sie stattdessen `RANK_BY_FORMULA`. Ranking nach benutzerdefinierter Formel. Die alte Enum-Option `RANK_BY_FORMULA` sollte stattdessen verwendet werden. Dieses Element ist veraltet.
`RANK_BY_EMBEDDING`	Ranking nach benutzerdefiniertem Einbettungsmodell, der Standardweg zur Bewertung des Ranking-Ausdrucks.
`RANK_BY_FORMULA`	Ranking nach benutzerdefinierter Formel.

RelevanceScoreSpec

Die Spezifikation für die Rückgabe des Relevanzwerts des Dokuments.

Felder

return_relevance_score

bool

Optional. Gibt an, ob der Relevanzwert für Suchergebnisse zurückgegeben werden soll. Je höher der Wert, desto relevanter ist das Dokument für die Anfrage.

RelevanceThreshold

Der Relevanzschwellenwert der Suchergebnisse. Je höher der Relevanzschwellenwert, desto relevanter sind die angezeigten Ergebnisse und desto weniger Ergebnisse werden zurückgegeben.

Enums
`RELEVANCE_THRESHOLD_UNSPECIFIED`	Standardwert. In diesem Fall entspricht das Serververhalten dem von Google definierten Schwellenwert.
`LOWEST`	Niedrigster Relevanzschwellenwert.
`LOW`	Niedriger Relevanzschwellenwert.
`MEDIUM`	Mittlerer Relevanzschwellenwert.
`HIGH`	Hoher Relevanzschwellenwert.

SearchAsYouTypeSpec

Spezifikation für die Suche während der Eingabe in Suchanfragen.

Felder

condition

Condition

Die Bedingung, unter der die Suche während der Eingabe erfolgen soll. Standardeinstellung ist Condition.DISABLED.

Bedingung

Aufzählung, die beschreibt, unter welcher Bedingung die automatische Vervollständigung der Suche erfolgen soll.

Enums
`CONDITION_UNSPECIFIED`	Das Serververhalten ist standardmäßig auf `Condition.DISABLED` eingestellt.
`DISABLED`	Deaktiviert die Suche während der Eingabe.
`ENABLED`	Aktiviert die Suche während der Eingabe.
`AUTO`	Automatisches Umschalten zwischen der Suche während der Eingabe und dem Standardmodus, ideal für Implementierungen mit einer einzigen API (z.B. Debouncing).

SessionSpec

Sitzungsspezifikation.

Die Funktion für die Suche mit mehreren Anfragen befindet sich derzeit in der privaten GA-Phase. Verwenden Sie stattdessen die Version v1alpha oder v1beta, bevor wir diese Funktion allgemein verfügbar machen. Alternativ können Sie das Google-Supportteam bitten, Sie auf die Zulassungsliste zu setzen.

Felder

query_id

string

Wenn festgelegt, wird das Suchergebnis im „Turn“ gespeichert, das durch diese Abfrage-ID angegeben wird.

Beispiel: Angenommen, die Sitzung sieht so aus: 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" } } }

Der Nutzer kann die /search-API mit einer Anfrage wie dieser aufrufen:

session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" }

Anschließend speichert die API das Suchergebnis, das mit dem letzten Turn verknüpft ist. Das gespeicherte Suchergebnis kann von einem nachfolgenden /answer-API-Aufruf verwendet werden, wenn die Sitzungs-ID und die Abfrage-ID angegeben sind. Außerdem ist es möglich, /search und /answer parallel mit derselben Sitzungs-ID und Abfrage-ID aufzurufen.

search_result_persistence_count

int32

Die Anzahl der wichtigsten Suchergebnisse, die beibehalten werden sollen. Die gespeicherten Suchergebnisse können für den nachfolgenden /answer-API-Aufruf verwendet werden.

Dieses Feld ähnelt dem Feld summary_result_count in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count.

Maximal 10 Ergebnisse im Dokumentmodus oder 50 Ergebnisse im Chunks-Modus.

SpellCorrectionSpec

Die Spezifikation für die Rechtschreibkorrektur von Anfragen.

Felder

mode

Mode

Der Modus, in dem die Rechtschreibkorrektur die ursprüngliche Suchanfrage ersetzt. Die Standardeinstellung ist Mode.AUTO.

Modus

Aufzählung, die beschreibt, in welchem Modus die Rechtschreibkorrektur erfolgen soll.

Enums
`MODE_UNSPECIFIED`	Nicht angegebener Modus für die Rechtschreibkorrektur. In diesem Fall ist das Serververhalten standardmäßig `Mode.AUTO`.
`SUGGESTION_ONLY`	Die Search API versucht, einen Rechtschreibvorschlag zu finden. Wenn ein Vorschlag gefunden wird, wird er in `SearchResponse.corrected_query` eingefügt. Der Rechtschreibvorschlag wird nicht als Suchanfrage verwendet.
`AUTO`	Automatische Rechtschreibkorrektur durch die Search API. Die Suche basiert auf der korrigierten Anfrage, sofern eine solche gefunden wird.

SearchResponse

Antwortnachricht für die Methode SearchService.Search.

Felder
`results[]`	`SearchResult` Eine Liste der übereinstimmenden Dokumente. Die Reihenfolge entspricht dem Ranking.
`facets[]`	`Facet` Ergebnisse der vom Nutzer angeforderten Facetten.
`total_size`	`int32` Die geschätzte Gesamtzahl übereinstimmender Elemente unabhängig von der Paginierung. Die Anzahl der von der Paginierung zurückgegebenen `results` kann geringer sein als die Anzahl der übereinstimmenden `total_size`.
`attribution_token`	`string` Ein eindeutiges Suchtoken. Es sollte in den `UserEvent`-Logs enthalten sein, die aus dieser Suche resultieren, was eine genaue Attribution der Leistung des Suchmodells ermöglicht. So kann eine Anfrage auch in Kundensupportszenarien leichter identifiziert werden.
`redirect_uri`	`string` Der URI einer vom Kunden definierten Weiterleitungsseite. Wenn eine Weiterleitungsaktion ausgelöst wird, wird keine Suche durchgeführt und in der Antwort werden nur `redirect_uri` und `attribution_token` festgelegt.
`next_page_token`	`string` Ein Token, das als `SearchRequest.page_token` gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.
`corrected_query`	`string` Enthält die korrigierte Abfrage, falls sie gefunden wurde. Wenn der Typ der Rechtschreibkorrektur AUTOMATIC ist, basieren die Suchergebnisse auf corrected_query. Andernfalls wird die ursprüngliche Anfrage für die Suche verwendet.
`summary`	`Summary` Eine Zusammenfassung als Teil der Suchergebnisse. Dieses Feld wird nur zurückgegeben, wenn `SearchRequest.ContentSearchSpec.summary_spec` festgelegt ist.
`query_expansion_info`	`QueryExpansionInfo` Informationen zur Abfrageerweiterung für die zurückgegebenen Ergebnisse.
`session_info`	`SessionInfo` Informationen zur Sitzung. Wird nur festgelegt, wenn `SearchRequest.session` angegeben ist. Weitere Informationen finden Sie in der Beschreibung.
`search_link_promotions[]`	`SearchLinkPromotion` Angebote für die Websitesuche.

Ein Attributergebnis.

Felder

key

string

Der Schlüssel für dieses Attribut. Beispiel: "colors" oder "price". Es entspricht SearchRequest.FacetSpec.FacetKey.key.

values[]

FacetValue

Die Attributwerte für dieses Feld.

dynamic_facet

bool

Gibt an, ob die Facette dynamisch generiert wird.

FacetValue

Ein Facettenwert, der Wertnamen und deren Anzahl enthält.

Felder
`count`	`int64` Anzahl der Elemente mit diesem Facettenwert.
Union-Feld `facet_value`. Ein Facettenwert, der Werte enthält. Für `facet_value` ist nur einer der folgenden Werte zulässig:
`value`	`string` Textwert einer Facette, z. B. „Schwarz“ für die Facette „Farben“.
`interval`	`Interval` Intervallwert für ein Facet, z. B. [10, 20) für das Facet „price“. Es entspricht `SearchRequest.FacetSpec.FacetKey.intervals`.

QueryExpansionInfo

Informationen zur Suchanfragenerweiterung, einschließlich der Angabe, ob eine Erweiterung stattgefunden hat.

Felder

expanded_query

bool

Boolescher Wert, der angibt, ob die Suchanfrage erweitert wurde.

pinned_result_count

int64

Anzahl der angepinnten Ergebnisse. Dieses Feld wird nur festgelegt, wenn eine Erweiterung erfolgt und SearchRequest.QueryExpansionSpec.pin_unexpanded_results auf „true“ gesetzt ist.

SearchResult

Stellt die Suchergebnisse dar.

Felder
`id`	`string` `Document.id` der gesuchten `Document`.
`document`	`Document` Das Dokumentdaten-Snippet in der Suchantwort. Nur Felder, die als `retrievable` markiert sind, werden ausgefüllt.
`chunk`	`Chunk` Die Chunk-Daten in der Suchantwort, wenn `SearchRequest.ContentSearchSpec.search_result_mode` auf `CHUNKS` gesetzt ist.
`model_scores`	`map<string, DoubleList>` Nur Ausgabe. Google hat verfügbare Bewertungen bereitgestellt.
`rank_signals`	`RankSignals` Optional. Eine Reihe von Ranking-Signalen, die dem Ergebnis zugeordnet sind.

RankSignals

Eine Reihe von Ranking-Signalen.

Felder
`default_rank`	`float` Optional. Der Standardrang des Ergebnisses.
`custom_signals[]`	`CustomSignal` Optional. Eine Liste benutzerdefinierter Clearbox-Signale.
`keyword_similarity_score`	`float` Optional. Anpassung der Keyword-Optionen
`relevance_score`	`float` Optional. Anpassung der semantischen Relevanz.
`semantic_similarity_score`	`float` Optional. Anpassung der semantischen Ähnlichkeit.
`pctr_rank`	`float` Optional. Prognostizierte Anpassung der Conversion-Rate als Rang.
`topicality_rank`	`float` Optional. Anpassung der Aktualität als Rang.
`document_age`	`float` Optional. Alter des Dokuments in Stunden.
`boosting_factor`	`float` Optional. Kombinierte benutzerdefinierte Steigerungen für ein Dokument.

CustomSignal

Benutzerdefiniertes Clearbox-Signal, das durch ein Name/Wert-Paar dargestellt wird.

Felder

name

string

Optional. Name des Signals.

value

float

Optional. Gleitkommawert, der das Ranking-Signal darstellt (z. B. 1,25 für BM25).

SessionInfo

Informationen zur Sitzung.

Felder

name

string

Name der Sitzung. Wenn der automatische Sitzungsmodus verwendet wird (wenn SearchRequest.session mit „-“ endet), enthält dieses Feld den neu generierten Sitzungsnamen.

query_id

string

Die Abfrage-ID, die diesem Search API-Aufruf entspricht. Eine Sitzung kann mehrere Turns mit jeweils einer eindeutigen Abfrage-ID haben.

Wenn Sie den Sitzungsnamen und diese Anfrage-ID im Answer API-Aufruf angeben, erfolgt die Antwortgenerierung im Kontext der Suchergebnisse aus diesem Suchaufruf.

Zusammenfassung

Zusammenfassung der N Top-Suchergebnisse, die in der Zusammenfassungsspezifikation angegeben sind.

Felder
`summary_text`	`string` Der Inhalt der Zusammenfassung.
`summary_skipped_reasons[]`	`SummarySkippedReason` Zusätzliche Gründe, warum Zusammenfassungen übersprungen werden. Hier wird der Grund für ignorierte Fälle angegeben. Wenn nichts übersprungen wird, ist dieses Feld nicht festgelegt.
`safety_attributes`	`SafetyAttributes` Eine Sammlung von Sicherheitsattributkategorien und den zugehörigen Konfidenzwerten.
`summary_with_metadata`	`SummaryWithMetadata` Zusammenfassung mit Metadaten.

Quellenangabe

Zitierinformationen für ein Segment.

Felder

start_index

int64

Der Index gibt den Anfang des Segments an, gemessen in Byte/Unicode.

end_index

int64

Ende des zugeordneten Segments (ausschließlich).

sources[]

CitationSource

Zitationsquellen für das zugeordnete Segment.

Zitat-MetadatenS

Zitat-Metadaten.

Felder

citations[]

Citation

Zitationen für Segmente.

CitationSource

Zitationsquelle.

Felder

reference_index

int64

Dokumentreferenzindex aus SummaryWithMetadata.references. Er ist nullbasiert und der Wert ist null, wenn „reference_index“ nicht explizit festgelegt ist.

Referenz

Dokumentreferenz.

Felder
`title`	`string` Titel des Dokuments.
`document`	`string` Erforderlich. `Document.name` des Dokuments. Vollständiger Ressourcenname des referenzierten Dokuments im Format `projects//locations//collections//dataStores//branches//documents/`.
`uri`	`string` Cloud Storage- oder HTTP-URI für das Dokument.
`chunk_contents[]`	`ChunkContent` Liste der zitierten Chunks, die aus Dokumentinhalten abgeleitet wurden.

ChunkContent

Inhalte in Chunks aufteilen

Felder

content

string

Textinhalte in Abschnitte unterteilen

page_identifier

string

Seiten-ID.

SafetyAttributes

Sicherheitsattributkategorien und die zugehörigen Konfidenzwerte.

Felder

categories[]

string

Die Anzeigenamen von mit den generierten Inhalten verknüpften Sicherheitsattributkategorien. Die Reihenfolge entspricht den Scores.

scores[]

float

Ein Konfidenzwert für die einzelnen Kategorien; ein höherer Wert bedeutet mehr Vertrauen. Die Reihenfolge entspricht den Kategorien.

SummarySkippedReason

Ein Enum für Gründe, warum Zusammenfassungen übersprungen wurden.

Enums
`SUMMARY_SKIPPED_REASON_UNSPECIFIED`	Standardwert. Der Grund für das Überspringen der Zusammenfassung ist nicht angegeben.
`ADVERSARIAL_QUERY_IGNORED`	Bei der feindseligen Anfrage wurde die Groß-/Kleinschreibung ignoriert. Wird nur verwendet, wenn `SummarySpec.ignore_adversarial_query` auf `true` festgelegt ist.
`NON_SUMMARY_SEEKING_QUERY_IGNORED`	Bei der Anfrage ohne Zusammenfassung wurde die Groß-/Kleinschreibung ignoriert. Google überspringt die Zusammenfassung, wenn die Anfrage Smalltalk ist. Wird nur verwendet, wenn `SummarySpec.ignore_non_summary_seeking_query` auf `true` festgelegt ist.
`OUT_OF_DOMAIN_QUERY_IGNORED`	Bei der Anfrage außerhalb der Domain wurde die Groß-/Kleinschreibung ignoriert. Google überspringt die Zusammenfassung, wenn es keine Suchergebnisse mit hoher Relevanz gibt. Der Datenspeicher enthält beispielsweise Fakten zu Unternehmen A, in der Nutzeranfrage werden jedoch Fragen zu Unternehmen B gestellt.
`POTENTIAL_POLICY_VIOLATION`	Der Fall des potenziellen Richtlinienverstoßes. Google überspringt die Zusammenfassung, wenn ein potenzieller Richtlinienverstoß erkannt wird. Dazu gehören Inhalte, die gewalttätig oder schädlich sein können.
`LLM_ADDON_NOT_ENABLED`	Das LLM-Add-on ist nicht aktiviert. Google überspringt die Zusammenfassung, wenn das LLM-Add-on nicht aktiviert ist.
`NO_RELEVANT_CONTENT`	Der Fall „Keine relevanten Inhalte“. Google überspringt die Zusammenfassung, wenn in den abgerufenen Suchergebnissen keine relevanten Inhalte vorhanden sind.
`JAIL_BREAKING_QUERY_IGNORED`	Bei der Jailbreak-Anfrage wurde die Groß-/Kleinschreibung ignoriert. Beispiel: „Antworte im Stil des CEO eines konkurrierenden Unternehmens.“ Wird nur verwendet, wenn [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] auf `true` gesetzt ist.
`CUSTOMER_POLICY_VIOLATION`	Der Fall des Kundenrichtlinienverstoßes. Google überspringt die Zusammenfassung, wenn ein Verstoß gegen die Kundenrichtlinie erkannt wird. Die Richtlinie wird vom Kunden definiert.
`NON_SUMMARY_SEEKING_QUERY_IGNORED_V2`	Bei der Frage, die keine Antwort sucht, wurde die Groß-/Kleinschreibung ignoriert. Google überspringt die Zusammenfassung, wenn die Anfrage keine klare Intention hat. Wird nur verwendet, wenn [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] auf `true` gesetzt ist.
`TIME_OUT`	Das Case für alle Fälle. Google überspringt die Zusammenfassung, wenn die Zeit abgelaufen ist.

SummaryWithMetadata

Zusammenfassung mit Metadaten.

Felder

summary

string

Zusammenfassungstext ohne Quellenangaben.

citation_metadata

CitationMetadata

Zitier-Metadaten für die angegebene Zusammenfassung.

references[]

Reference

Dokumentreferenzen

SearchTier

Stufen von Suchfunktionen. Für die verschiedenen Stufen gelten möglicherweise unterschiedliche Preise. Weitere Informationen finden Sie in der Dokumentation zur Preisgestaltung.

Enums
`SEARCH_TIER_UNSPECIFIED`	Standardwert, wenn die Enumeration nicht angegeben ist. Diese Option ist ungültig.
`SEARCH_TIER_STANDARD`	Standardstufe
`SEARCH_TIER_ENTERPRISE`	Enterprise-Stufe

SearchUseCase

Definiert eine weitere Unterteilung von SolutionType. Gilt speziell für SOLUTION_TYPE_SEARCH.

Enums
`SEARCH_USE_CASE_UNSPECIFIED`	Wert, der verwendet wird, wenn er nicht festgelegt ist. Tritt nicht im CSS auf.
`SEARCH_USE_CASE_SEARCH`	Anwendungsfall für die Suche Erwartet, dass der Traffic einen nicht leeren `query` hat.
`SEARCH_USE_CASE_BROWSE`	Anwendungsfall ansehen. Erwartet, dass der Traffic ein leeres `query` hat.

ServingConfig

Konfiguriert Metadaten, die zum Generieren von Ergebnissen zur Bereitstellungszeit verwendet werden, z.B. Suchergebnisse oder Empfehlungsvorhersagen. Die ServingConfig wird in der Such- und Vorhersageanfrage übergeben und generiert Ergebnisse.

Felder
`name`	`string` Nicht veränderbar. Vollständig qualifizierter Name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
`display_name`	`string` Erforderlich. Der für Menschen lesbare Anzeigename der Bereitstellungskonfiguration. Wird in der Discovery-Benutzeroberfläche verwendet. Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 128 Zeichen sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.
`solution_type`	`SolutionType` Erforderlich. Nicht veränderbar. Gibt den Lösungstyp an, dem eine Serving-Konfiguration zugeordnet werden kann.
`model_id`	`string` Die ID des Modells, das zur Bereitstellungszeit verwendet werden soll. Derzeit werden nur RecommendationModels unterstützt. Kann geändert werden, aber nur in ein kompatibles Modell (z.B. „Was Ihnen sonst noch gefallen könnte“-CTR in „Was Ihnen sonst noch gefallen könnte“-CVR). Erforderlich, wenn `SolutionType` `SOLUTION_TYPE_RECOMMENDATION` ist.
`diversity_level`	`string` Wie viel Diversität in den Ergebnissen des Empfehlungsmodells verwendet werden soll, z.B. `medium-diversity` oder `high-diversity`. Derzeit unterstützte Werte: `no-diversity` `low-diversity` `medium-diversity` `high-diversity` `auto-diversity` Wenn nicht angegeben, wird der Standardwert basierend auf dem Empfehlungsmodelltyp ausgewählt. Standardwert: `no-diversity`. Kann nur festgelegt werden, wenn `SolutionType` `SOLUTION_TYPE_RECOMMENDATION` ist.
`ranking_expression`	`string` Mit dem Ranking-Ausdruck wird das benutzerdefinierte Ranking beim Abrufen von Dokumenten gesteuert. Dazu ist das Einbetten von Dokumenten erforderlich. Die Einstellung für den Ranking-Ausdruck in ServingConfig gilt für alle Suchanfragen, die von der Bereitstellungskonfiguration bereitgestellt werden. Wenn `SearchRequest.ranking_expression` angegeben ist, wird der Ranking-Ausdruck der ServingConfig jedoch überschrieben. Der Ranking-Ausdruck ist eine einzelne Funktion oder mehrere Funktionen, die durch „+“ verbunden sind. ranking_expression = function, { " + ", function }; Unterstützte Funktionen: double * relevance_score double * dotProduct(embedding_field_path) Funktionsvariablen: `relevance_score`: Vordefinierte Keywords, die verwendet werden, um die Relevanz zwischen Anfrage und Dokument zu messen. `embedding_field_path`: Das Dokumenteinbettungsfeld, das mit dem Abfrageeinbettungsvektor verwendet wird. `dotProduct`: Einbettungsfunktion zwischen „embedding_field_path“ und dem Einbettungsvektor der Anfrage. Beispiel für einen Rankingausdruck: Wenn ein Dokument das Einbettungsfeld „doc_embedding“ hat, könnte der Ranking-Ausdruck `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)` lauten.
`create_time`	`Timestamp` Nur Ausgabe. Zeitstempel der Erstellung von ServingConfig.
`update_time`	`Timestamp` Nur Ausgabe. Zeitstempel der Aktualisierung von ServingConfig.
`filter_control_ids[]`	`string` Filtereinstellungen, die im Bereitstellungspfad verwendet werden sollen. Alle ausgelösten Filter werden angewendet. Filtersteuerungen müssen sich im selben Datenspeicher wie die Serving-Konfiguration befinden. Maximal 20 Filtersteuerungen.
`boost_control_ids[]`	`string` Boost-Variablen, die im Bereitstellungspfad verwendet werden sollen. Alle ausgelösten Boost-Einstellungen werden angewendet. Die Boost-Steuerelemente müssen sich im selben Datenspeicher wie die Serving-Konfiguration befinden. Maximal 20 Einstellungen zum Hochstufen.
`redirect_control_ids[]`	`string` IDs der Weiterleitungseinstellungen. Es wird nur die erste ausgelöste Weiterleitungsaktion angewendet, auch wenn mehrere zutreffen. Es sind maximal 100 Spezifikationen zulässig. Kann nur festgelegt werden, wenn `SolutionType` `SOLUTION_TYPE_SEARCH` ist.
`synonyms_control_ids[]`	`string` Spezifikationen für Bedingungssynonyme. Wenn mehrere Synonymbedingungen übereinstimmen, werden alle übereinstimmenden Synonymsteuerungen in der Liste ausgeführt. Es sind maximal 100 Spezifikationen zulässig. Kann nur festgelegt werden, wenn `SolutionType` `SOLUTION_TYPE_SEARCH` ist.
`oneway_synonyms_control_ids[]`	`string` Spezifikationen für unidirektionale Synonyme für Bedingungen. Wenn mehrere unidirektionale Synonymbedingungen übereinstimmen, werden alle übereinstimmenden unidirektionalen Synonymsteuerungen in der Liste ausgeführt. Es sind maximal 100 Spezifikationen zulässig. Kann nur festgelegt werden, wenn `SolutionType` `SOLUTION_TYPE_SEARCH` ist.
`dissociate_control_ids[]`	`string` Die Bedingung ist nicht mit Spezifikationen verknüpft. Wenn mehrere Bedingungen für die Zuordnung nicht zutreffen, werden alle übereinstimmenden Kontrollvariablen in der Liste ausgeführt. Die Reihenfolge spielt keine Rolle. Es sind maximal 100 Spezifikationen zulässig. Kann nur festgelegt werden, wenn `SolutionType` `SOLUTION_TYPE_SEARCH` ist.
`replacement_control_ids[]`	`string` Spezifikationen für den Bedingungsersatz. Die Anwendung erfolgt in der Reihenfolge der Liste. Ein zuvor ersetzter Begriff kann nicht noch einmal ersetzt werden. Es sind maximal 100 Spezifikationen zulässig. Kann nur festgelegt werden, wenn `SolutionType` `SOLUTION_TYPE_SEARCH` ist.
`ignore_control_ids[]`	`string` Bedingungsspezifikationen ignorieren. Wenn mehrere Bedingungen zum Ignorieren übereinstimmen, werden alle übereinstimmenden Steuerelemente zum Ignorieren in der Liste ausgeführt. Die Reihenfolge spielt keine Rolle. Es sind maximal 100 Spezifikationen zulässig.
`promote_control_ids[]`	`string` Bedingung für die Bewerbungsspezifikationen. Es sind maximal 100 Spezifikationen zulässig.
`answer_generation_spec`	`AnswerGenerationSpec` Optional. Die Spezifikation für die Antwortgenerierung.
Union-Feld `vertical_config`. Branchenspezifische Konfiguration. Für `vertical_config` ist nur einer der folgenden Werte zulässig:
`media_config`	`MediaConfig` Die MediaConfig der Bereitstellungskonfiguration.
`generic_config`	`GenericConfig` Die GenericConfig der Bereitstellungskonfiguration.

GenericConfig

Gibt die für die generische Suche erforderlichen Konfigurationen an.Derzeit werden folgende Konfigurationen unterstützt:

content_search_spec: Konfiguration für die allgemeine Inhaltssuche.

Felder

content_search_spec

ContentSearchSpec

Gibt das erwartete Verhalten der Inhaltssuche an. Gilt nur für Datenspeicher, in denen die Inhaltssuche aktiviert ist.

MediaConfig

Gibt die für die Media Discovery erforderlichen Konfigurationen an. Derzeit unterstützen wir:

demote_content_watched: Schwellenwert für die Herabstufung von angesehenen Inhalten. Kunden können angeben, ob sie die Herabstufung angesehener Inhalte oder die Herabstufung von Detailseiten verwenden möchten. Bei der Demotion von angesehenen Inhalten müssen Kunden angeben, ob die angesehenen Minuten oder der Prozentsatz den Schwellenwert überschreitet. Wenn dies der Fall ist, werden die Inhalte in den Empfehlungsergebnissen herabgestuft.
promote_fresh_content: Stichtage für die Bewerbung neuer Inhalte. Kunden können angeben, ob sie die Funktion „Aktualität von Inhalten bewerben“ nutzen möchten. Wenn die Inhalte innerhalb des Zeitraums veröffentlicht wurden, werden sie im Empfehlungsergebnis beworben. Kann nur festgelegt werden, wenn SolutionType SOLUTION_TYPE_RECOMMENDATION ist.

Felder
`demotion_event_type`	`string` Gibt den Ereignistyp an, der zum Herabstufen von Empfehlungsergebnissen verwendet wird. Derzeit unterstützte Werte: `view-item`: Artikel angesehen. `media-play`: Ein Video oder einen Song starten oder die Wiedergabe fortsetzen `media-complete`: Das Video, Lied usw. wurde beendet oder mittendrin angehalten. Wenn diese Option nicht festgelegt ist, wird die Herabstufung des Wiedergabeverlaufs nicht angewendet. Die Herabstufung aufgrund der Aktualität von Inhalten wird weiterhin angewendet.
`demote_content_watched_past_days`	`int32` Optional. Gibt die Anzahl der Tage an, die beim Herabstufen angesehener Inhalte berücksichtigt werden sollen. Wenn der Wert auf null gesetzt oder nicht festgelegt ist, wird standardmäßig der maximale Wert von 365 Tagen verwendet.
`content_freshness_cutoff_days`	`int32` Gibt die Aktualität der Inhalte an, die für das Empfehlungsergebnis verwendet werden. Inhalte werden herabgestuft, wenn sie vor mehr als der angegebenen Anzahl von Tagen veröffentlicht wurden.
Union-Feld `demote_content_watched`. Geben Sie den Grenzwert für das Herabstufen angesehener Inhalte an. Der Grenzwert kann entweder ein Prozentsatz oder ein Wert in Minuten sein. Dieser muss für den Ereignistyp `media-complete` festgelegt werden. Für `demote_content_watched` ist nur einer der folgenden Werte zulässig:
`content_watched_percentage_threshold`	`float` Gibt den Grenzwert für den Prozentsatz der angesehenen Inhalte für die Herabstufung an. Der Grenzwert muss zwischen 0 und 1, 0 (einschließlich) liegen.
`content_watched_seconds_threshold`	`float` Gibt den Grenzwert für die Wiedergabezeit (in Minuten) an, ab dem Inhalte herabgestuft werden.

Session

Externe Sitzung – Proto-Definition.

Felder
`name`	`string` Nicht veränderbar. Vollständig qualifizierter Name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
`display_name`	`string` Optional. Der Anzeigename der Sitzung. Mit diesem Feld wird die Sitzung in der Benutzeroberfläche identifiziert. Standardmäßig ist der Anzeigename der Text der ersten Anfrage in der Sitzung.
`state`	`State` Der Status der Sitzung.
`user_pseudo_id`	`string` Eine eindeutige Kennung für das Tracking von Nutzern.
`turns[]`	`Turn` Runden.
`labels[]`	`string` Optional. Die Labels für die Sitzung. Kann als Filter in ListSessionsRequest festgelegt werden.
`start_time`	`Timestamp` Nur Ausgabe. Die Uhrzeit, zu der die Sitzung begonnen hat.
`end_time`	`Timestamp` Nur Ausgabe. Die Uhrzeit, zu der die Sitzung beendet wurde.
`is_pinned`	`bool` Optional. Ob die Sitzung angepinnt ist. Angepinnte Sitzungen werden oben in der Sitzungsliste angezeigt.

Bundesland

Aufzählung des Status der Sitzung.

Enums
`STATE_UNSPECIFIED`	Zustand unbekannt.
`IN_PROGRESS`	Die Sitzung ist derzeit geöffnet.

Runde

Stellt einen Turn dar, einschließlich einer Anfrage des Nutzers und einer Antwort des Dienstes.

Felder
`query`	`Query` Optional. Die Nutzeranfrage. Darf nicht festgelegt werden, wenn bei diesem Zug lediglich eine Antwort auf einen anderen Zug neu generiert wird.
`answer`	`string` Optional. Der Ressourcenname der Antwort auf die Nutzeranfrage. Wird nur festgelegt, wenn die Antwortgenerierung (API-Aufruf /answer) in diesem Zug erfolgt ist.
`assist_answer`	`string` Nur Ausgabe. Der Ressourcenname der Assistant-Antwort auf die Nutzeranfrage. Wird nur festgelegt, wenn in diesem Zug ein Assist-Aufruf (/assist API-Aufruf) erfolgt ist. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}`. Wenn Sie alle AssistAnswers für eine Sitzung abrufen möchten, setzen Sie GetSessionRequest.include_answer_details auf „true“. Alternativ können Sie die API „AssistAnswerService.GetAssistAnswer“ verwenden, um eine einzelne AssistAnswer-Ressource abzurufen.
`detailed_answer`	`Answer` Nur Ausgabe. Wenn in der `ConversationalSearchService.GetSession` API `GetSessionRequest.include_answer_details` auf „true“ gesetzt ist, wird dieses Feld beim Abrufen der Antwortabfragesitzung ausgefüllt.
`detailed_assist_answer`	`AssistAnswer` Nur Ausgabe. Wenn in der `ConversationalSearchService.GetSession` API `GetSessionRequest.include_answer_details` auf „true“ gesetzt ist, wird dieses Feld beim Abrufen der Assistenten-Sitzung ausgefüllt.
`query_config`	`map<string, string>` Optional. Stellt Metadaten zur Abfragekonfiguration dar, z. B. das verwendete LLM-Modell und die Version sowie Modellparameter (Temperatur, Grounding-Parameter usw.). Das Präfix „google.“ ist für von Google entwickelte Funktionen reserviert.

SetUpDataConnectorMetadata

Dieser Typ hat keine Felder.

Metadaten für die Methode DataConnectorService.SetUpDataConnector.

SetUpDataConnectorRequest

Anfrage für die Methode DataConnectorService.SetUpDataConnector.

Felder
`parent`	`string` Erforderlich. Das übergeordnete Element von `Collection` im Format `projects/{project}/locations/{location}`.
`collection_id`	`string` Erforderlich. Die für `Collection` zu verwendende ID, die als letzte Komponente des Ressourcennamens von `Collection` verwendet wird. Im Rahmen der Einrichtung von `DataConnector` wird ein neues `Collection` erstellt. `DataConnector` ist eine Singleton-Ressource unter `Collection`, die alle `DataStore`s des `Collection` verwaltet. Dieses Feld muss dem RFC-1034-Standard entsprechen und darf maximal 63 Zeichen lang sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.
`collection_display_name`	`string` Erforderlich. Der Anzeigename von `Collection`. Sollte für Menschen lesbar sein und wird verwendet, um Sammlungen im Console-Dashboard anzuzeigen. UTF-8-codierter String mit einem Limit von 1.024 Zeichen.
`data_connector`	`DataConnector` Erforderlich. Die `DataConnector`, die in der neu erstellten `Collection` initialisiert werden soll.

SingleRegionKey

Metadaten für CMEKs für einzelne Regionen.

Felder

kms_key

string

Erforderlich. Der Ressourcenname des KMS-Schlüssels für eine einzelne Region, der zum Verschlüsseln von Ressourcen projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId} verwendet wird.

SiteSearchEngine

Mit SiteSearchEngine werden Konfigurationen für die Websitesuche auf Datastore-Ebene erfasst. Es handelt sich um einen Singleton-Wert pro Datenspeicher.

Felder

name

string

Der vollständig qualifizierte Ressourcenname der Website-Suchmaschine. Format: projects/*/locations/*/dataStores/*/siteSearchEngine

SiteVerificationInfo

Bestätigungsinformationen für Zielwebsites in der erweiterten Websuche.

Felder

site_verification_state

SiteVerificationState

Status der Websitebestätigung, der die Inhaberschaft und Gültigkeit angibt.

verify_time

Zeit der letzten Websitebestätigung.

SiteVerificationState

Status der Websitebestätigung.

Enums
`SITE_VERIFICATION_STATE_UNSPECIFIED`	Die Standardeinstellung ist VERIFIED.
`VERIFIED`	Die Websiteinhaberschaft wurde bestätigt.
`UNVERIFIED`	Die Bestätigung der Websiteinhaberschaft steht noch aus oder ist fehlgeschlagen.
`EXEMPTED`	Die Website ist von der Bestätigung ausgenommen, z.B. eine öffentliche Website, die für alle geöffnet ist.

Sitemap

Eine Sitemap für die SiteSearchEngine.

Felder
`name`	`string` Nur Ausgabe. Der vollständig qualifizierte Ressourcenname der Sitemap. `projects//locations//collections//dataStores//siteSearchEngine/sitemaps/*` Das Suffix `sitemap_id` wird vom System generiert.
`create_time`	`Timestamp` Nur Ausgabe. Der Erstellungszeitpunkt der Sitemap.
Union-Feld `feed`. Unterstützte Feedquellen Für `feed` ist nur einer der folgenden Werte zulässig:
`uri`	`string` Öffentlicher URI für die Sitemap, z.B. `www.example.com/sitemap.xml`.

SolutionType

Die Art der Lösung.

Enums
`SOLUTION_TYPE_UNSPECIFIED`	Standardwert.
`SOLUTION_TYPE_RECOMMENDATION`	Wird für Recommendations AI verwendet.
`SOLUTION_TYPE_SEARCH`	Wird für die Discovery-Suche verwendet.
`SOLUTION_TYPE_CHAT`	Wird für Anwendungsfälle im Zusammenhang mit dem Generative AI-Agent verwendet.
`SOLUTION_TYPE_GENERATIVE_CHAT`	Wird für Anwendungsfälle im Zusammenhang mit dem Generative Chat-Agenten verwendet. Sie wird nur für die generative Chat-Engine verwendet. Die zugehörigen Datenspeicher müssen für die `SOLUTION_TYPE_CHAT`-Lösung registriert sein.

SpannerSource

Die Spanner-Quelle für den Datenimport

Felder
`project_id`	`string` Die Projekt-ID des Projekts, das die Spanner-Quelle enthält. Die Länge ist auf 128 Zeichen begrenzt. Wenn keine Angabe erfolgt, wird die Projekt-ID von der übergeordneten Anfrage übernommen.
`instance_id`	`string` Erforderlich. Die Instanz-ID der Spanner-Quelltabelle.
`database_id`	`string` Erforderlich. Die Datenbank-ID der Spanner-Quelltabelle.
`table_id`	`string` Erforderlich. Der Tabellenname der Spanner-Datenbank, die importiert werden muss.
`enable_data_boost`	`bool` Gibt an, ob Data Boost auf den Spanner-Export angewendet werden soll. Durch Aktivieren dieser Option fallen zusätzliche Kosten an. Weitere Informationen

StreamAssistRequest

Anfrage für die Methode AssistantService.StreamAssist.

Felder
`name`	`string` Erforderlich. Der Ressourcenname der `Assistant`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` Optional. Aktuelle Nutzeranfrage. Leere Abfragen werden nur unterstützt, wenn `file_ids` angegeben werden. In diesem Fall wird die Antwort auf Grundlage dieser Kontextdateien generiert.
`session`	`string` Optional. Die für die Anfrage zu verwendende Sitzung. Falls angegeben, hat der Assistent Zugriff auf den Sitzungsverlauf und die Anfrage und die Antwort werden dort gespeichert. Wenn `-` als Session-ID angegeben oder das Feld leer gelassen wird, wird eine neue Session mit einer automatisch generierten ID erstellt. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
`user_metadata`	`AssistUserMetadata` Optional. Informationen zum Nutzer, der die Anfrage initiiert.
`agents_spec`	`AgentsSpec` Optional. Spezifikation der Agents, die zum Bearbeiten der Anfrage verwendet werden.
`tools_spec`	`ToolsSpec` Optional. Spezifikation der Tools, die zum Bearbeiten der Anfrage verwendet werden.
`generation_spec`	`GenerationSpec` Optional. Spezifikation der Generierungskonfiguration für die Anfrage.

AgentsSpec

Spezifikation der Agents, die zum Bearbeiten der Anfrage verwendet werden.

Felder

agent_specs[]

AgentSpec

Optional. Spezifikation der Agents, die zum Bearbeiten der Anfrage verwendet werden.

AgentSpec

Spezifikation eines KI-Agenten.

Felder

agent_id

string

Erforderlich. ID zur Identifizierung der Agent-Ressource, die die Anfrage bearbeitet.

Dieses Feld muss RFC-1034 entsprechen und darf maximal 63 Zeichen lang sein.

GenerationSpec

Spezifikation für die Assistant-Generierung für die Anfrage. So kann die Standardkonfiguration für die Generierung auf Engine-Ebene überschrieben werden.

Felder

model_id

string

Optional. Die Vertex AI-model_id, die für das generative Modell verwendet wird. Wenn nicht festgelegt, wird das Standard-Assistant-Modell verwendet.

ToolsSpec

Spezifikation der Tools, die zum Bearbeiten der Anfrage verwendet werden.

Felder
`vertex_ai_search_spec`	`VertexAiSearchSpec` Optional. Spezifikation des Vertex AI Search-Tools.
`web_grounding_spec`	`WebGroundingSpec` Optional. Spezifikation des Tools zur Webfundierung. Wenn das Feld vorhanden ist, wird die Fundierung mit der Websuche aktiviert. Funktioniert nur, wenn `Assistant.web_grounding_type` [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] oder [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][] ist.
`image_generation_spec`	`ImageGenerationSpec` Optional. Spezifikation des Tools zur Bildgenerierung.
`video_generation_spec`	`VideoGenerationSpec` Optional. Spezifikation des Tools zur Videogenerierung.

ImageGenerationSpec

Dieser Typ hat keine Felder.

Spezifikation des Tools zur Bildgenerierung.

VertexAiSearchSpec

Spezifikation des Vertex AI Search-Tools.

Felder

data_store_specs[]

DataStoreSpec

Optional. Spezifikationen, die DataStores definieren, nach denen in einem Suchaufruf gefiltert werden soll, sowie Konfigurationen für diese Datenspeicher. Dies wird nur für Engines mit mehreren Datenspeichern berücksichtigt.

filter

string

Optional. Die Filtersyntax besteht aus einer Ausdruckssprache zum Erstellen eines Prädikats aus einem oder mehreren Feldern der gefilterten Dokumente. Bei Filterausdrücken wird zwischen Groß- und Kleinschreibung unterschieden.

Wenn dieses Feld nicht erkannt wird, wird INVALID_ARGUMENT zurückgegeben.

Das Filtern in Vertex AI Search erfolgt durch Zuordnen des LHS-Filterschlüssels zu einer Schlüsselattribut, das im Vertex AI Search-Backend definiert ist. Diese Zuordnung wird vom Kunden in seinem Schema definiert. Ein Media-Kunde hat in seinem Schema beispielsweise möglicherweise das Feld „name“. In diesem Fall würde der Filter so aussehen: filter --> name:'ANY("king kong")'

Weitere Informationen zum Filtern, einschließlich Syntax und Filteroperatoren, finden Sie unter Filter.

VideoGenerationSpec

Dieser Typ hat keine Felder.

Spezifikation des Tools zur Videogenerierung.

WebGroundingSpec

Dieser Typ hat keine Felder.

Spezifikation des Tools zur Webfundierung.

StreamAssistResponse

Antwort für die Methode AssistantService.StreamAssist.

Felder

answer

AssistAnswer

Das Assist-Antwortressourcenobjekt enthält Teile der endgültigen Antwort des Assistenten auf die Anfrage des Nutzers.

Nicht vorhanden, wenn die aktuelle Antwort nichts zu den zuvor gesendeten AssistAnswer.replies hinzufügt.

Beobachten Sie AssistAnswer.state, um zu sehen, ob weitere Teile zu erwarten sind. Solange der Status IN_PROGRESS ist, enthält das Feld AssistAnswer.replies in jeder Antwort Antworten (Antwortfragmente), die an die in vorherigen Antworten empfangenen Antworten angehängt werden sollen. AssistAnswer.name wird nicht ausgefüllt.

Wenn der Status SUCCEEDED, FAILED oder SKIPPED ist, ist die Antwort die letzte Antwort und AssistAnswer.name hat einen Wert.

session_info

SessionInfo

Informationen zur Sitzung. Nur in der endgültigen StreamAssistResponse des Antwortstreams enthalten.

assist_token

string

Eine global eindeutige ID, die das aktuelle Paar aus Anfrage und Antwortstream identifiziert. Wird für Feedback und Support verwendet.

SessionInfo

Informationen zur Sitzung.

Felder

session

string

Name der neu generierten oder fortgesetzten Sitzung.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}.

SubscriptionTerm

Abolaufzeit LINT.IfChange

Enums
`SUBSCRIPTION_TERM_UNSPECIFIED`	Standardwert, nicht verwenden.
`SUBSCRIPTION_TERM_ONE_MONTH`	1 Monat
`SUBSCRIPTION_TERM_ONE_YEAR`	1 Jahr.
`SUBSCRIPTION_TERM_THREE_YEARS`	3 Jahre.

SubscriptionTier

Informationen zur Abostufe.

Enums
`SUBSCRIPTION_TIER_UNSPECIFIED`	Standardwert.
`SUBSCRIPTION_TIER_SEARCH`	Suchstufe. Nutzer mit dem Search-Abo können auf die VAIS-Suchfunktionen und die NotebookLM-Funktionen zugreifen.
`SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT`	Stufe „Suche und Assistent“ Nutzer mit dem Abo „Suche + Assistent“ haben Zugriff auf die VAIS-Suchfunktionen, NotebookLM-Funktionen und Assistent-Funktionen.
`SUBSCRIPTION_TIER_NOTEBOOK_LM`	NotebookLM-Stufe NotebookLM ist eine Abo-Stufe, mit der nur auf NotebookLM-Funktionen zugegriffen werden kann.
`SUBSCRIPTION_TIER_FRONTLINE_WORKER`	Frontline-Beschäftigte
`SUBSCRIPTION_TIER_AGENTSPACE_STARTER`	Agentspace Starter-Stufe.
`SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS`	Agentspace Business-Stufe.
`SUBSCRIPTION_TIER_ENTERPRISE`	Enterprise-Stufe
`SUBSCRIPTION_TIER_EDU`	EDU-Stufe.
`SUBSCRIPTION_TIER_EDU_PRO`	EDU Pro-Stufe
`SUBSCRIPTION_TIER_EDU_EMERGING`	EDU-Schwellenmarktstufe.
`SUBSCRIPTION_TIER_EDU_PRO_EMERGING`	EDU Pro-Schwellenmarktstufe.

SuggestionDenyListEntry

Eintrag in der Ablehnungsliste für Vorschläge, der die Wortgruppe angibt, die in Vorschlägen blockiert werden soll, und den angewendeten Vorgang für die Wortgruppe.

Felder

block_phrase

string

Erforderlich. Aus Vorschlägen auszuschließender Begriff. Darf maximal 125 Zeichen lang sein.

match_operator

MatchOperator

Erforderlich. Der Abgleichsoperator, der für diesen Ausdruck angewendet werden soll. Ob die genaue Wortgruppe oder alle Vorschläge, die diese Wortgruppe enthalten, blockiert werden sollen.

MatchOperator

Operator für den Abgleich mit den generierten Vorschlägen.

Enums
`MATCH_OPERATOR_UNSPECIFIED`	Standardwert. Sollte nicht verwendet werden
`EXACT_MATCH`	Wenn der Vorschlag genau mit dem block_phrase übereinstimmt, blockieren Sie ihn.
`CONTAINS`	Wenn der Vorschlag die block_phrase enthält, blockieren Sie ihn.

TargetSite

Eine Zielwebsite für die SiteSearchEngine.

Felder
`name`	`string` Nur Ausgabe. Der vollständig qualifizierte Ressourcenname der Zielwebsite. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` Die `target_site_id` wird vom System generiert.
`provided_uri_pattern`	`string` Erforderlich. Nur Eingabe. Das vom Nutzer bereitgestellte URI-Muster, aus dem der `generated_uri_pattern` generiert wird.
`type`	`Type` Der Typ der Zielwebsite, z.B. ob die Website ein- oder ausgeschlossen werden soll.
`exact_match`	`bool` Nicht veränderbar. Wenn „false“ festgelegt ist, wird ein „uri_pattern“ generiert, der alle Seiten umfasst, deren Adresse „provided_uri_pattern“ enthält. Wenn „true“ festgelegt ist, wird ein „uri_pattern“ generiert, der dem angegebenen „provided_uri_pattern“ genau entspricht oder nur der spezifischen Seite, wenn der angegebene „provided_uri_pattern“ spezifisch ist. „provided_uri_pattern“ wird immer normalisiert, um das URI-Muster zu generieren, das von der Suchmaschine verwendet werden soll.
`generated_uri_pattern`	`string` Nur Ausgabe. Diese wird vom System basierend auf dem bereitgestellten URI-Muster generiert.
`root_domain_uri`	`string` Nur Ausgabe. Stammdomain des provided_uri_pattern.
`site_verification_info`	`SiteVerificationInfo` Nur Ausgabe. Status der Bestätigung der Websiteinhaberschaft und ‑gültigkeit.
`indexing_status`	`IndexingStatus` Nur Ausgabe. Indexierungsstatus
`update_time`	`Timestamp` Nur Ausgabe. Der Zeitpunkt der letzten Aktualisierung der Zielwebsite.
`failure_reason`	`FailureReason` Nur Ausgabe. Grund für den Fehler.

FailureReason

Gründe für Fehler bei der Indexierung der Website-Suche.

Felder

Union-Feld failure. Grund für den Fehler. Für failure ist nur einer der folgenden Werte zulässig:

quota_failure

QuotaFailure

Fehler aufgrund unzureichenden Kontingents.

QuotaFailure

Fehler aufgrund unzureichenden Kontingents.

Felder

total_required_quota

int64

Diese Zahl ist eine Schätzung des gesamten Kontingents, das für die erfolgreiche Indexierung dieses Projekts erforderlich ist.

IndexingStatus

Aufzählung des Indexierungsstatus der Zielwebsite.

Enums
`INDEXING_STATUS_UNSPECIFIED`	Die Standardeinstellung ist SUCCEEDED.
`PENDING`	Die Zielwebsite befindet sich in der Aktualisierungswarteschlange und wird von der Indexierungspipeline verarbeitet.
`FAILED`	Die Zielwebsite wird nicht indexiert.
`SUCCEEDED`	Die Zielwebsite wurde indexiert.
`DELETING`	Die zuvor indexierte Zielwebsite wurde zum Löschen markiert. Dies ist ein Übergangszustand, der entweder zu Folgendem führt: 1. Die Zielwebsite wird gelöscht, wenn die Deindexierung erfolgreich ist. 2. Der Status wird auf „ERFOLGREICH“ zurückgesetzt, wenn die Deindexierung fehlschlägt.
`CANCELLABLE`	Die Änderung der Zielwebsite steht aus, kann aber abgebrochen werden.
`CANCELLED`	Die Änderung der Zielwebsite wird abgebrochen.

Typ

Mögliche Zielstandorttypen.

Enums
`TYPE_UNSPECIFIED`	Dieser Wert wird nicht verwendet. In diesem Fall ist das Serververhalten standardmäßig `Type.INCLUDE`.
`INCLUDE`	Nehmen Sie die Zielwebsite mit auf.
`EXCLUDE`	Schließen Sie die Zielwebsite aus.

Mandant

Mandanteninformationen für eine Connector-Quelle. Dazu gehören einige der Informationen, die in der Anmeldedaten-Mitteilung gespeichert sind, aber nur die, die erforderlich sind, um dem Nutzer eine Liste der zugänglichen Mandanten bereitzustellen.

Felder

id

string

Die Instanz-ID des Mandanten. Beispiele: Jira („8594f221-9797-5f78-1fa4-485e198d7cd0“), Slack („T123456“).

uri

string

Die URI des Mandanten, falls zutreffend. Der URI einer Jira-Instanz ist beispielsweise https://my-jira-instance.atlassian.net. Ein Slack-Tenant hat keinen URI.

display_name

string

Optionaler Anzeigename für den Mandanten, z.B. „Mein Slack-Team“.

TextInput

Definiert die Texteingabe.

Felder

input

string

Texteingabe

context

ConversationContext

Kontext der Unterhaltung für die Eingabe.

TrainCustomModelMetadata

Metadaten zum Fortschritt des Vorgangs „TrainCustomModel“. Dieser Wert wird vom Feld „google.longrunning.Operation.metadata“ zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

TrainCustomModelRequest

Anfragenachricht für die Methode SearchTuningService.TrainCustomModel.

Felder
`data_store`	`string` Erforderlich. Der Ressourcenname des Datenspeichers, z. B. `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. Mit diesem Feld wird der Datenspeicher angegeben, in dem die Modelle trainiert werden sollen.
`model_type`	`string` Das zu trainierende Modell. Unterstützte Werte: search-tuning: Das Suchsystem wird anhand der bereitgestellten Daten optimiert.
`error_config`	`ImportErrorConfig` Der gewünschte Ort für Fehler, die während der Datenerfassung und des Trainings auftreten.
`model_id`	`string` Wenn nicht angegeben, wird eine UUID generiert.
Union-Feld `training_input`. Modelltrainingseingabe. Für `training_input` ist nur einer der folgenden Werte zulässig:
`gcs_training_input`	`GcsTrainingInput` Cloud Storage-Trainingseingabe.

GcsTrainingInput

Cloud Storage-Eingabe für Trainingsdaten.

Felder
`corpus_data_path`	`string` Die Cloud Storage-Korpusdaten, die mit Trainingsdaten verknüpft werden könnten. Das Datenpfadformat ist `gs://<bucket_to_data>/<jsonl_file_name>`. Eine durch Zeilenumbruch getrennte JSONL-/NDJSON-Datei. Für das Modell zur Suchoptimierung sollte jede Zeile die Felder „_id“, „title“ und „text“ enthalten. Beispiel: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
`query_data_path`	`string` Die GCS-Abfragedaten, die mit Trainingsdaten verknüpft werden könnten. Das Datenpfadformat ist `gs://<bucket_to_data>/<jsonl_file_name>`. Eine durch Zeilenumbruch getrennte JSONL-/NDJSON-Datei. Für das Modell zur Suchoptimierung sollte jede Zeile die _id und den Text enthalten. Beispiel: {"_id": "query1", "text": "example query"}
`train_data_path`	`string` Cloud Storage-Pfad für Trainingsdaten, dessen Format `gs://<bucket_to_data>/<tsv_file_name>` sein sollte. Die Datei muss das TSV-Format haben. Jede Zeile sollte die doc_id, die query_id und die Punktzahl (Zahl) enthalten. Für das Modell zur Optimierung der Suche sollte die TSV-Datei die Spaltenüberschriften „query-id“, „corpus-id“ und „score“ enthalten. Der Wert muss eine Zahl in `[0, inf+)` sein. Je größer die Zahl, desto relevanter ist das Paar. Beispiel: `query-id\tcorpus-id\tscore` `query1\tdoc1\t1`
`test_data_path`	`string` Cloud Storage-Testdaten. Dasselbe Format wie „train_data_path“. Wenn nicht angegeben, wird für „train_data_path“ eine zufällige Aufteilung in Trainings- und Testdaten im Verhältnis 80/20 durchgeführt.

TrainCustomModelResponse

Antwort von TrainCustomModelRequest. Diese Nachricht wird vom Feld „google.longrunning.Operations.response“ zurückgegeben.

Felder
`error_samples[]`	`Status` Ein Beispiel für Fehler, die bei der Verarbeitung der Daten aufgetreten sind.
`error_config`	`ImportErrorConfig` Gibt das Ziel für die vollständigen Fehler in der Anfrage an, sofern festgelegt.
`model_status`	`string` Der Status des trainierten Modells. Folgende Werte sind möglich: bad-data: Die Qualität der Trainingsdaten ist schlecht. no-improvement: Die Optimierung hat die Leistung nicht verbessert. Wird nicht bereitgestellt. in-progress (wird ausgeführt): Die Erstellung des Modelltrainingsjobs läuft. Training: Das Modell wird gerade trainiert. Bewertung: Das Modell bewertet trainierte Messwerte. Indexierung: Die Messwerte für das trainierte Modell werden indexiert. Bereit: Das Modell kann bereitgestellt werden.
`metrics`	`map<string, double>` Die Messwerte des trainierten Modells.
`model_name`	`string` Vollständig qualifizierter Name des CustomTuningModel.

TransactionInfo

Eine Transaktion umfasst die gesamte Kauftransaktion.

Felder
`currency`	`string` Erforderlich. Währungscode. Verwenden Sie den dreistelligen ISO‑4217-Code.
`transaction_id`	`string` Die Transaktions-ID mit einer Längenbeschränkung von 128 Zeichen.
`value`	`float` Erforderlich. Der Gesamtwert der Transaktion, der nicht null ist. Der Wert kann Versandkosten, Steuern und andere Anpassungen des Gesamtwerts enthalten, die berücksichtigt werden sollen.
`tax`	`float` Alle Steuern, die mit der Transaktion verbunden sind.
`cost`	`float` Alle Kosten, die mit den Produkten verbunden sind. Dazu können Fertigungskosten, Versandkosten, die nicht vom Endnutzer getragen werden, oder andere Kosten gehören, sodass gilt: Gewinn = `value` – `tax` – `cost`
`discount_value`	`float` Der Gesamtwert der Rabatte, die auf diese Transaktion angewendet wurden. Diese Zahl sollte aus `TransactionInfo.value` ausgeschlossen werden. Wenn ein Nutzer beispielsweise den Betrag `TransactionInfo.value` bezahlt hat, ist der nominale Wert (vor Rabatt) der Transaktion die Summe aus `TransactionInfo.value` und `TransactionInfo.discount_value`. Das bedeutet, dass der Gewinn unabhängig vom Rabattwert auf dieselbe Weise berechnet wird und `TransactionInfo.discount_value` größer als `TransactionInfo.value` sein kann: Gewinn = `value` – `tax` – `cost`

UpdateAclConfigRequest

Anfragenachricht für die Methode „UpdateAclConfig“.

Felder
`acl_config`	`AclConfig`

UpdateAssistantRequest

Anfragenachricht für die Methode AssistantService.UpdateAssistant.

Felder

assistant

Assistant

Erforderlich. Die zu aktualisierende Assistant.

Das Feld name des Assistant wird verwendet, um das zu aktualisierende Assistant zu identifizieren. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Wenn der Aufrufer nicht berechtigt ist, die Assistant zu aktualisieren, unabhängig davon, ob sie vorhanden ist oder nicht, wird der Fehler PERMISSION_DENIED zurückgegeben.

Wenn die zu aktualisierende Assistant nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

update_mask

Die Liste der zu aktualisierenden Felder.

UpdateCmekConfigMetadata

Metadaten zum Fortschritt des Vorgangs CmekConfigService.UpdateCmekConfig. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

UpdateCmekConfigRequest

Anfragenachricht für die Methode „UpdateCmekConfig“. rpc.

Felder

config

CmekConfig

Erforderlich. Die CmekConfig-Ressource.

set_default

bool

Legen Sie die folgende CmekConfig als Standard für untergeordnete Ressourcen fest, wenn keine angegeben ist.

UpdateControlRequest

Anfrage für die Methode „UpdateControl“.

Felder

control

Control

Erforderlich. Das zu aktualisierende Steuerelement.

update_mask

Optional. Gibt an, welche Felder im bereitgestellten Control aktualisiert werden sollen. Folgendes wird NICHT unterstützt:

Control.name
Control.solution_type

Wenn sie nicht festgelegt oder leer ist, werden alle unterstützten Felder aktualisiert.

UpdateConversationRequest

Anfrage für die Methode „UpdateConversation“.

Felder

conversation

Erforderlich. Die zu aktualisierende Unterhaltung.

update_mask

Gibt an, welche Felder im bereitgestellten Conversation aktualisiert werden sollen. Folgendes wird NICHT unterstützt:

Conversation.name

Wenn sie nicht festgelegt oder leer ist, werden alle unterstützten Felder aktualisiert.

UpdateDataConnectorRequest

Anfragenachricht für die Methode DataConnectorService.UpdateDataConnector.

Felder

data_connector

DataConnector

Erforderlich. Die zu aktualisierende DataConnector.

Wenn der Aufrufer nicht berechtigt ist, die DataConnector zu aktualisieren, unabhängig davon, ob sie vorhanden ist oder nicht, wird der Fehler PERMISSION_DENIED zurückgegeben.

Wenn DataConnector nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

update_mask

Gibt an, welche Felder im bereitgestellten DataConnector aktualisiert werden sollen.

Unterstützte Feldpfade:

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

Hinweis: Die Unterstützung für diese Felder kann je nach Connectortyp variieren. Beispielsweise wird destination_configs nicht von allen Connectors unterstützt.

Wenn ein nicht unterstützter oder unbekannter Feldpfad angegeben wird, wird in der Anfrage der Fehler INVALID_ARGUMENT zurückgegeben.

UpdateDataStoreRequest

Anfragenachricht für die Methode DataStoreService.UpdateDataStore.

Felder

data_store

DataStore

Erforderlich. Die zu aktualisierende DataStore.

Wenn der Aufrufer nicht berechtigt ist, die DataStore zu aktualisieren, unabhängig davon, ob sie vorhanden ist oder nicht, wird der Fehler PERMISSION_DENIED zurückgegeben.

Wenn die zu aktualisierende DataStore nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

update_mask

Gibt an, welche Felder im bereitgestellten DataStore aktualisiert werden sollen.

Wenn ein nicht unterstütztes oder unbekanntes Feld bereitgestellt wird, wird der Fehler INVALID_ARGUMENT zurückgegeben.

UpdateDocumentRequest

Anfragenachricht für die Methode DocumentService.UpdateDocument.

Felder

document

Erforderlich. Das zu aktualisierende/erstellende Dokument.

Wenn der Aufrufer nicht berechtigt ist, die Document zu aktualisieren, unabhängig davon, ob sie vorhanden ist oder nicht, wird der Fehler PERMISSION_DENIED zurückgegeben.

Wenn die zu aktualisierende Document nicht vorhanden ist und allow_missing nicht festgelegt ist, wird ein NOT_FOUND-Fehler zurückgegeben.

allow_missing

bool

Wenn der Wert auf true gesetzt ist und Document nicht gefunden wird, wird ein neues Document erstellt.

update_mask

Gibt an, welche Felder im bereitgestellten importierten „Dokument“ aktualisiert werden sollen. Wenn nicht festgelegt, werden standardmäßig alle Felder aktualisiert.

UpdateEngineRequest

Anfragenachricht für die Methode EngineService.UpdateEngine.

Felder

engine

Engine

Erforderlich. Die zu aktualisierende Engine.

Wenn der Aufrufer nicht berechtigt ist, die Engine zu aktualisieren, unabhängig davon, ob sie vorhanden ist oder nicht, wird der Fehler PERMISSION_DENIED zurückgegeben.

Wenn die zu aktualisierende Engine nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

update_mask

Gibt an, welche Felder im bereitgestellten Engine aktualisiert werden sollen.

Wenn ein nicht unterstütztes oder unbekanntes Feld bereitgestellt wird, wird der Fehler INVALID_ARGUMENT zurückgegeben.

UpdateLicenseConfigRequest

Anfragenachricht für die Methode LicenseConfigService.UpdateLicenseConfig.

Felder

license_config

LicenseConfig

Erforderlich. Die zu aktualisierende LicenseConfig.

update_mask

Optional. Gibt an, welche Felder im bereitgestellten LicenseConfig aktualisiert werden sollen.

Wenn ein nicht unterstütztes oder unbekanntes Feld bereitgestellt wird, wird der Fehler INVALID_ARGUMENT zurückgegeben.

UpdateSchemaMetadata

Metadaten für UpdateSchema-LRO.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

UpdateSchemaRequest

Anfragenachricht für die Methode SchemaService.UpdateSchema.

Felder

schema

Schema

Erforderlich. Die zu aktualisierende Schema.

allow_missing

bool

Wenn der Wert auf „true“ gesetzt ist und Schema nicht gefunden wird, wird ein neues Schema erstellt. In diesem Fall wird update_mask ignoriert.

UpdateServingConfigRequest

Anfrage für die Methode „UpdateServingConfig“.

Felder

serving_config

ServingConfig

Erforderlich. Die zu aktualisierende ServingConfig.

update_mask

Gibt an, welche Felder im bereitgestellten ServingConfig aktualisiert werden sollen. Folgendes wird NICHT unterstützt:

ServingConfig.name

Wenn sie nicht festgelegt ist, werden alle unterstützten Felder aktualisiert.

UpdateSessionRequest

Anfrage für die Methode „UpdateSession“.

Felder

session

Erforderlich. Die zu aktualisierende Sitzung.

update_mask

Gibt an, welche Felder im bereitgestellten Session aktualisiert werden sollen. Folgendes wird NICHT unterstützt:

Session.name

Wenn sie nicht festgelegt oder leer ist, werden alle unterstützten Felder aktualisiert.

UpdateTargetSiteMetadata

Metadaten zum Fortschritt des Vorgangs SiteSearchEngineService.UpdateTargetSite. Dieser Wert wird vom Feld google.longrunning.Operation.metadata zurückgegeben.

Felder

create_time

Erstellungszeit des Vorgangs.

update_time

Uhrzeit der letzten Aktualisierung des Vorgangs. Wenn der Vorgang abgeschlossen ist, ist dies auch die Endzeit.

UpdateTargetSiteRequest

Anfragenachricht für die Methode SiteSearchEngineService.UpdateTargetSite.

Felder

target_site