API zur Erfassung externer Inhalte

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 16 Minuten Lesedauer

    • Die Erfassung Externer Inhalte Die API stellt Endpunkte bereit, die die Erfassung von Inhalten aus Quellen außerhalb von ermöglichen ServiceNow®Instanz in ServiceNow® KI-SucheIndex der Anwendung.

    API zur Erfassung externer Inhalte: LÖSCHEN SIE /ais/external_content/deleteByQuery/{Schema_table_Name}

    Löscht alle externen Dokumente, die der angegebenen Abfrage entsprechen, aus KI-SucheIndex.

    URL-Format

    Versionierte URL: /api/now/{api_Version}/ais/external_content/deleteByQuery/{Schema_table_Name}?query={query}

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfad-Parameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Schema_table_Name

    Der Name der Schematabelle für externe Inhalte, die das Schema für die zu löschenden indizierten Dokumente definiert. Beispiel: u_ext_content .

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    query

    Eine gültige URL-Escape-Abfrage für die von angegebene Schematabelle schema_table_name. Beispiel: Title=Einführung Dient zum Abfragen von Dokumenten, deren Titel lautet Einführung .

    Datentyp: Zeichenfolge
    Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

    Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 4. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Tabelle : 5. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler

    Objekt, das den Fehler während der Verarbeitung der Anforderung beschreibt.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail

    Details des bei der Verarbeitung der Anforderung aufgetretenen Fehlers.

    Datentyp: Zeichenfolge
    Fehler.Nachricht

    Nachricht für den Fehler, der während der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Zeichenfolge
    Ergebnis

    Ergebnis einer erfolgreich verarbeiteten Anforderung.

    Datentyp: Zeichenfolge
    Status

    Status einer nicht erfolgreichen Anforderung.

    Gültige Werte:
    • failure

    Datentyp: Zeichenfolge

    Curl-Anforderung

    Löschen Sie Dokumente mit Titelfeldwerten Einführung Und Bericht für 31. Oktober 2020 Aus der Schematabelle u_ext_content.

    curl "https://instance.service-now.com/api/now/v2/ais/external_content/deleteByQuery/u_ext_content?query=title%3DIntroduction%20OR%20title%3DReport%20for%2031%20October%202020" \
--request DELETE \
--user "username":"password" \
--header "Accept: application/json"
    {
  "result": "Delete By Query Successfully Executed"
}

    API zur Erfassung externer Inhalte – LÖSCHEN SIE /ais/external_content/deleteDocument/{Schema_table_Name}/{document_ID}

    Löscht das externe Dokument mit einem angegebenen eindeutigen Bezeichner aus KI-SucheIndex.

    URL-Format

    Versionierte URL: /api/now/{api_Version}/ais/external_content/deleteDocument/{Schema_table_Name}/{document_ID}

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfad-Parameter
    Parameter Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    document_id

    Der eindeutige Bezeichner für das zu löschende externe Dokument. Beispiel: ADMINISTRATOR-2027858531-16 .

    Datentyp: Zeichenfolge
    Schema_table_Name

    Der Name der Schematabelle für externe Inhalte, die das Schema für das zu löschende indizierte Dokument definiert. Beispiel: u_ext_content .

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 9. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

    Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 10. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Tabelle : 11. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Element Beschreibung
    Fehler

    Objekt, das den Fehler während der Verarbeitung der Anforderung beschreibt.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail

    Details des bei der Verarbeitung der Anforderung aufgetretenen Fehlers.

    Datentyp: Zeichenfolge
    Fehler.Nachricht

    Nachricht für den Fehler, der während der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Zeichenfolge
    Ergebnis

    Ergebnis einer erfolgreich verarbeiteten Anforderung.

    Datentyp: Zeichenfolge
    Status

    Status einer nicht erfolgreichen Anforderung.

    Gültige Werte:
    • failure

    Datentyp: Zeichenfolge

    Curl-Anforderung

    Löschen Sie das Dokument mit dem Bezeichner ADMINISTRATOR-2587918521-27 Aus der Schematabelle u_ext_content.

    curl 'https://instance.service-now.com/api/now/v2/ais/external_content/deleteDocument/u_ext_content/ADMIN-2587918521-27' \
--request DELETE \
--user 'username':'password' \
--header 'Accept: application/json'
    {
  "result":"Document removed"
}

    API zur Erfassung externer Inhalte – POSTEN SIE /ais/external_content/ingestDocument/{Schema_table_Name}

    Sendet eine Liste externer Dokumente an KI-SucheErfassungs-Batcher für die Indizierung. Nach Abschluss der Indizierung kann der Inhalt aus den erfassten Dokumenten durchsucht werden.

    Sie können diesen Endpunkt verwenden, um externe Dokumente mit Textinhalten und Metadaten zu füttern.

    Wenn Sie einem externen Dokument durchsuchbare Binärinhalte und Metadaten zuordnen müssen, führen Sie die folgenden Schritte aus:
    1. Speichern Sie den binären Inhalt in KI-SucheMit VERÖFFENTLICHEN SIE /ais/external_content/storeContent Endpunkt. Zeichnen Sie den Wert von auf resultAntworttext-Parameter.
    2. Senden Sie das externe Dokument an KI-SucheDieser Endpunkt wird verwendet. Legen Sie die Dokumente fest content_pointerAnforderungstext-Parameter zur Übereinstimmung mit dem aufgezeichneten resultParameterwert des Antworttexts.
    Während der Erfassung KI-SucheAnalysiert den binären Inhalt und fügt seinen durchsuchbaren Inhalt dem indizierten Datensatz hinzu, der das externe Dokument darstellt. Durch die Analyse wird das gespeicherte Inhaltsobjekt entfernt.

    URL-Format

    Versionierte URL: /api/now/{api_Version}/ais/external_content/ingestDocument/{Schema_table_Name}

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfad-Parameter
    Parameter Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Schema_table_Name

    Der Name der Schematabelle für externe Inhalte, die das Schema für externe Dokumente in der Anforderung definiert. Beispiel: u_ext_content .

    Datentyp: Zeichenfolge
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Anforderungstext-Parameter (XML oder JSON)
    Element Beschreibung
    [Array]

    Erforderlich. Unbenanntes Array von Objekten, in dem jedes Objekt ein externes Dokument darstellt, das zur Indizierung erfasst werden soll.

    Datentyp: Array

    [
  {
    "content_pointer": "String",
    "document_id": "String",
    "principals": {Object},
    "properties": {Object}
  }
]
    [Array].content_pointer
    Bezeichner für eine Instanz von binärem Inhalt, der mit gespeichert wird VERÖFFENTLICHEN SIE /ais/external_content/storeContent Endpunkt. Während der Erfassung KI-SucheAnalysiert den binären Inhalt und fügt seinen durchsuchbaren Inhalt dem indizierten Datensatz hinzu, der das externe Dokument darstellt. Durch die Analyse wird das gespeicherte Inhaltsobjekt entfernt.
    Hinweis:
    Dieser Bezeichner muss mit übereinstimmen resultAntworttextelement, das von zurückgegeben wird StoreContent Endpunkt.

    Datentyp: Zeichenfolge
    [Array].document_ID

    Erforderlich. Eindeutiger Bezeichner für das externe Dokument in der von angegebenen externen Inhaltsschematabelle schema_table_namePfadparameter.

    Hinweis:
    Wenn Sie ein Dokument erfassen, werden alle vorhandenen Dokumente in derselben Schematabelle für externe Inhalte überschrieben, die dasselbe enthält document_id. Wenn mindestens zwei Dokumente in derselben Erfassungsanforderung dasselbe haben document_id, Die Anforderung schlägt fehl.

    Datentyp: Zeichenfolge
    [Array].Prinzipale
    Objekt mit Schlüssel-Wert-Paaren, die die Zugriffsberechtigungen des externen Dokuments für extern definierte Sicherheitsprinzipale (Anwender und Gruppen) beschreiben.
    Hinweis:

    Wenn Sie diesen Parameter für ein Dokument auslassen, ist die Anforderung erfolgreich, aber KI-SucheLehnt das Dokument mit der Feedback-Nachricht zur Erfassung ab Der Prinzipal des Dokuments fehlt .

    Wenn dieses Parameterobjekt keine Schlüssel-Wert-Paare enthält, die Zugriff auf ein Dokument gewähren, ist die Anforderung erfolgreich, aber KI-SucheLehnt das Dokument mit der Feedback-Nachricht zur Erfassung ab Der Prinzipal des Dokuments ist ungültig .

    Datentyp: Objekt

    "principals": {
  "everyone": Boolean,
  "groups.deny": [Array],
  "groups.read": [Array],
  "none": Boolean,
  "users.deny": [Array],
  "users.read": [Array]
}

    Unterstützte Versionen: Verfügbar ab v2 der API.
    [Array].Prinzipale.jeder
    Kennzeichnung, die angibt, ob der Zugriff auf das externe Dokument für alle Anwender zulässig ist. Wenn dieser Parameter auf festgelegt ist true, Alle Now PlatformAnwender können den indizierten Datensatz anzeigen, der aus dem Dokument erstellt wurde.
    Hinweis:
    Wenn Sie sowohl diesen Parameter als auch festlegen [array].principals.noneBis trueFür ein Dokument ist die Anforderung erfolgreich, aber KI-SucheLehnt das Dokument mit der Feedback-Nachricht zur Erfassung ab Der Prinzipal des Dokuments ist ungültig . Sie können nur einen dieser beiden Parameter auf festlegen trueIn einer Anforderung.
    Gültige Werte:
    • true: Allen Anwendern Zugriff auf das Dokument gewähren. KI-SucheIgnoriert alle [array].principals.groups.*Und [array].principals.users.*Parametereinstellungen für das Dokument.
    • false: Nicht allen Anwendern den Zugriff auf das externe Dokument erlauben. Anwender können nur auf das Dokument zugreifen, wenn [array].principals.noneIst auf „falsch“ festgelegt und wenn dies durch die Interaktion ihrer Anwenderzuordnungen und der zulässig ist [array].principals.groups.*Und [array].principals.users.*Parameter.

    Datentyp: Boolescher Wert

    Standard: true

    Unterstützte Versionen: Verfügbar ab v2 der API.
    [Array].principals.groups.deny

    Array von Zeichenfolgen, wobei jede Zeichenfolge der Name einer extern definierten Gruppe ist, der der Zugriff auf das externe Dokument verweigert wird. Now PlatformAnwender, die einer dieser externen Gruppen zugeordnet sind, können den indizierten Suchergebnisdatensatz, der aus dem Dokument erstellt wurde, nicht anzeigen.

    Wenn einer der beiden Fälle ist [array].principals.everyoneOder [array].principals.noneIst auf festgelegt true, Dieser Parameter hat keine Auswirkung.

    Dieser Parameter hat Vorrang vor [array].principals.groups.read. Wenn derselbe Anwender externen Gruppen mit Lesezugriffsberechtigungen und Deny-Zugriffsberechtigungen für ein Dokument zugeordnet ist, KI-SucheVerweigert diesem Anwender den Zugriff auf den indizierten Datensatz.

    Standardmäßig [array].principals.users.readHat Vorrang vor diesem Parameter. Informationen zum Umkehren dieser Rangfolge für eine indizierte Quelle finden Sie unter Ändern Sie den Vorrang der Anwender-Lese- und Gruppenverweigerungsberechtigungen für eine indizierte Quelle für externe Inhalte. .

    Datentyp: Array

    Werte können in einem beliebigen Format vorliegen, abhängig von den Namen der angegebenen extern definierten Gruppen. Beispiele:

    "groups.deny": [
  "hr-admin",
  "legal"
]

    Unterstützte Versionen: Verfügbar ab v2 der API.
    [array].principals.groups.read

    Array von Zeichenfolgen, wobei jede Zeichenfolge der Name einer extern definierten Gruppe ist, die auf das externe Dokument zugreifen darf. Now PlatformAnwender, die einer dieser externen Gruppen zugeordnet sind, können den indizierten Suchergebnisdatensatz anzeigen, der aus dem Dokument erstellt wurde.

    Wenn einer der beiden Fälle ist [array].principals.everyoneOder [array].principals.noneIst auf festgelegt true, Dieser Parameter hat keine Auswirkung.

    [array].principals.groups.deny Hat Vorrang vor diesem Parameter. Wenn derselbe Anwender externen Gruppen mit Lesezugriffsberechtigungen und Deny-Zugriffsberechtigungen für ein Dokument zugeordnet ist, KI-SucheVerweigert diesem Anwender den Zugriff auf den indizierten Datensatz.

    Datentyp: Array

    Werte können in einem beliebigen Format vorliegen, abhängig von den Namen der angegebenen extern definierten Gruppen. Beispiele:

    "groups.read": [
  "devops",
  "it",
  "report-admins"
]

    Unterstützte Versionen: Verfügbar ab v2 der API.
    [Array].principals.none
    Boolesche Option, die angibt, ob der Zugriff auf das externe Dokument für alle Anwender verweigert wird. Wenn dieser Parameter auf festgelegt ist true, Nur Now PlatformAnwender mit ais_high_security_admin Die Rolle mit erweiterten Berechtigungen kann den indizierten Datensatz anzeigen, der aus dem Dokument erstellt wurde.
    Hinweis:
    Wenn Sie sowohl diesen Parameter als auch festlegen [array].principals.everyoneBis trueFür ein Dokument KI-SucheLehnt das Dokument während der Erfassung mit Fehlermeldung ab Der Prinzipal des Dokuments ist ungültig . Sie können nur einen dieser beiden Parameter auf festlegen trueIn einer Anforderung.
    Gültige Werte:
    • true: Verweigern Sie allen Anwendern mit Ausnahme von den Zugriff auf das Dokument ais_high_security_admin Rolle mit erhöhten Berechtigungen. KI-SucheIgnoriert alle [array].principals.groups.*Und [array].principals.users.*Parametereinstellungen für das Dokument.
    • false: Verweigern Sie nicht allen Anwendern den Zugriff auf das Dokument. Anwender können auf das Dokument zugreifen, wenn [array].principals.everyoneIst auf festgelegt true, Oder, wenn dies durch die Interaktion ihrer Anwenderzuordnungen und der zulässig ist [array].principals.groups.readUnd [array].principals.users.readParameter.

    Datentyp: Boolescher Wert

    Standard: false

    Unterstützte Versionen: Verfügbar ab v2 der API.
    [Array].principals.users.deny

    Array von Zeichenfolgen, wobei jede Zeichenfolge der Name eines extern definierten Anwenders ist, dem der Zugriff auf das externe Dokument verweigert wird. Now PlatformAnwender, die einem dieser externen Anwender zugeordnet sind, können den indizierten Suchergebnisdatensatz, der aus dem Dokument erstellt wurde, nicht anzeigen.

    Wenn einer der beiden Fälle ist [array].principals.everyoneOder [array].principals.noneIst auf festgelegt true, Dieser Parameter hat keine Auswirkung.

    Dieser Parameter hat Vorrang vor [array].principals.users.read. Wenn derselbe Anwender externen Anwendern mit Lese- und Deniy-Zugriffsberechtigungen für ein Dokument zugeordnet ist, KI-SucheVerweigert diesem Anwender den Zugriff auf den indizierten Datensatz.

    Datentyp: Array

    Werte können in einem beliebigen Format vorliegen, abhängig von den Namen der angegebenen extern definierten Anwender. Beispiele:

    "users.deny": [
  "ad\bow-ruggeri",
  "abel-tuter@sharepoint"
]

    Unterstützte Versionen: Verfügbar ab v2 der API.
    [array].principals.users.read

    Array von Zeichenfolgen, wobei jede Zeichenfolge der Name eines extern definierten Anwenders ist, der auf das externe Dokument zugreifen darf. Now PlatformAnwender, die einem dieser externen Anwender zugeordnet sind, können den indizierten Suchergebnisdatensatz anzeigen, der aus dem Dokument erstellt wurde.

    Wenn einer der beiden Fälle ist [array].principals.everyoneOder [array].principals.noneIst auf festgelegt true, Dieser Parameter hat keine Auswirkung.

    [array].principals.users.deny Hat Vorrang vor diesem Parameter. Wenn derselbe Anwender externen Anwendern mit Lese- und Deniy-Zugriffsberechtigungen für ein Dokument zugeordnet ist, KI-SucheVerweigert diesem Anwender den Zugriff auf den indizierten Datensatz.

    Standardmäßig hat dieser Parameter Vorrang [array].principals.groups.deny. Informationen zum Umkehren dieser Rangfolge für eine indizierte Quelle finden Sie unter Ändern Sie den Vorrang der Anwender-Lese- und Gruppenverweigerungsberechtigungen für eine indizierte Quelle für externe Inhalte. .

    Datentyp: Array

    Werte können in einem beliebigen Format vorliegen, abhängig von den Namen der angegebenen extern definierten Anwender. Beispiele:

    "users.read": [
  "ad\abel-tuter",
  "beth-anglin@sharepoint"
]

    Unterstützte Versionen: Verfügbar ab v2 der API.
    [Array].properties

    Objekt mit Name-Wert-Paaren, wobei jedes Paar einen Feldnamen und Wert darstellt, der für das Dokument erfasst werden soll. Alle Feldnamen und -Werte müssen als Zeichenfolgen angegeben werden.

    Nach der Erfassung sind diese Dokumentfeldwerte über die indizierte Quelle zugänglich, die für die von angegebene externe Inhaltsschematabelle definiert ist schema_table_namePfadparameter. Anwender können nach diesen Feldwerten in Suchquellen suchen, die von dieser indizierten Quelle abgeleitet sind.

    Datentyp: Objekt

    Feldnamen dürfen nur Kleinbuchstaben und Unterstriche enthalten. Werte können beliebige Zeichen enthalten. Die Länge des Werts wird durch begrenzt max_lengthAttribut, das für das Feld in der Schematabelle für externe Inhalte definiert ist. Beispiele für Feldname-Wert-Paare:

    "properties": {
  "creation_date": "2020-11-03 12:27:43",
  "file_size": "10285",
  "title": "Introduction",
  "url": "file:///myhost/reports/Introduction.pdf"
}

    Header

    Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 16. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/json.
    Tabelle : 17. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    202 Teilweise Erfolgreich. Die Anforderung wurde verarbeitet. Einige Dokumente enthalten Warnungen oder Fehlermeldungen für Erfassungsfeedback.
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler

    Objekt, das den Fehler während der Verarbeitung der Anforderung beschreibt.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail

    Details des bei der Verarbeitung der Anforderung aufgetretenen Fehlers.

    Datentyp: Zeichenfolge
    Fehler.Nachricht

    Nachricht für den Fehler, der während der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Zeichenfolge
    Ergebnis

    JSON-formatierte Zeichenfolge, die das Ergebnisobjekt für die Erfassungsanforderung darstellt.

    Datentyp: Zeichenfolge

    "result": "{\"duration_in_ms\": Number, \"feedback\": [Array] }"
    Ergebnis.duration_in_ms

    Zeit, die für die Erfassung der externen Dokumente aufgewendet wurde.

    Datentyp: Zahl

    Einheit: Millisekunden
    Ergebnis.Feedback

    Array von Objekten, in denen jedes Objekt Feedback für ein Dokument darstellt, das aus dem Anforderungstext erfasst wurde.

    Datentyp: Array

    "feedback": [
  {
    "document_id": "String",
    "messages": [Array]
  }
]
    Ergebnis.Feedback.Dokument_ID

    Eindeutiger Bezeichner für das externe Dokument, wie im Anforderungstext angegeben.

    Datentyp: Zeichenfolge
    Ergebnis.Feedback.Nachrichten

    Array von unbenannten Objekten, in denen jedes Objekt eine Erfassungsfeedback-Nachricht darstellt, die während der Indizierung des externen Dokuments protokolliert wird.

    Datentyp: Array

    "messages": [
  {
    "code": "String",
    "component": "String",
    "level": "String",
    "message": "String"
  }
]
    Ergebnis.Feedback.Nachrichten.Code

    Code für eine Ausnahme, die von der Indexierungs-Workflow-Komponente ausgelöst wurde, die die Feedback-Nachricht zur Erfassung protokolliert hat.

    Datentyp: Zeichenfolge
    result.feedback.messages.component

    Bezeichner für die Indexierungs-Workflow-Komponente, die die Erfassungsfeedback-Nachricht protokolliert hat.

    Datentyp: Zeichenfolge
    Ergebnis.Feedback.Nachrichten.Ebene

    Protokollierungsebene für die Feedback-Nachricht der Erfassung.

    Gültige Werte:
    • ERROR
    • INFO
    • MINOR_ERROR
    • WARN

    Datentyp: Zeichenfolge
    Ergebnis.Feedback.Nachrichten.Nachricht

    Text, der für die Feedback-Nachricht der Erfassung protokolliert wurde.

    Datentyp: Zeichenfolge
    Status

    Status einer nicht erfolgreichen Anforderung.

    Gültige Werte:
    • failure

    Datentyp: Zeichenfolge

    Rangfolge für Prinzipalberechtigungen

    Die Rangfolge für [array].principalsBerechtigungen hängen vom Wert von ab user_read_takes_precedence_over_group_denyAttribut für die indizierte Quelle, die zum Erfassen eines externen Dokuments verwendet wird.
    Attributwert Rangfolge für Prinzipalberechtigungen
    wahr
    Von höchster Priorität zu niedrigster Priorität:
    1. [array].principals.everyone, [array].principals.none
    2. [array].principals.users.deny
    3. [array].principals.users.read
    4. [array].principals.groups.deny
    5. [array].principals.groups.read
    Hinweis:
    Dies ist der Standardattributwert für indizierte Quellen für externe Inhalte.
    falsch
    Von höchster Priorität zu niedrigster Priorität:
    1. [array].principals.everyone, [array].principals.none
    2. [array].principals.users.deny, [array].principals.groups.deny
    3. [array].principals.users.read, [array].principals.groups.read
    Hinweis:
    Anweisungen zum Festlegen dieses Attributwerts finden Sie unter Ändern Sie den Vorrang der Anwender-Lese- und Gruppenverweigerungsberechtigungen für eine indizierte Quelle für externe Inhalte .

    Curl-Anforderung

    Fügen Sie zwei externe Dokumente (mit Inhaltsverzeichnissen zu binären Inhaltsobjekten zu, die zuvor mit gespeichert wurden VERÖFFENTLICHEN SIE /ais/external_content/storeContent Endpunkt) für die Indizierung in die Schematabelle u_ext_content.

    curl 'https://instance.servicenow.com/api/now/v2/ais/external_content/ingestDocument/u_ext_content' \
  --request POST \
  --user 'username':'password' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "document_id": "ADMIN-2027858531-16",
    "content_pointer": "749b52a1-baa8-4556-a4f3-00404c95e6a8",
    "properties": {
      "title": "Introduction",
      "url": "file:///myhost/reports/Introduction.pdf",
      "file_name": "Introduction.pdf",
      "file_size": "10285",
      "creation_date": "2020-11-01 12:27:43"
    },
    "principals": {
      "everyone": false,
      "groups.read": [
        "report-users",
        "report-admins"
      ],
      "users.deny": [
        "ad\abel-tuter"
      ]
    }
  },
  {
    "document_id": "ADMIN-2587918521-27",
    "content_pointer": "bd605435-268b-464f-a7c3-0c5ea894a5c2",
    "properties": {
      "title": "Report for 31 August 2020",
      "url": "file:///myhost/reports/Report-2020-08-31.pdf",
      "file_size": "27597",
      "creation_date": "2020-09-01 12:48:13"
    },
    "principals": {
      "everyone": false,
      "groups.read": [
        "report-users",
        "report-admins"
      ],
      "users.read": [
        "ad\beth-anglin"
      ]
    }
  }
]'
    {
  "result":"{\"duration_in_ms\":3822,\"feedback\":[{\"messages\":[{\"level\":\"INFO\",\"message\":\"CREATED\",\"component\":\"init\"},{\"level\":\"INFO\",\"message\":\"OK\",\"component\":\"index-886de18e750030108b23bcd69cdc2dd3-indexer.index-886de18e750030108b23bcd69cdc2dd3-content-dispatcher\"},{\"level\":\"INFO\",\"message\":\"COMPLETED\",\"component\":\"sink.sink\"}],\"document_id\":\"ADMIN-2027858531-16\"},{\"messages\":[{\"level\":\"INFO\",\"message\":\"CREATED\",\"component\":\"init\"},{\"level\":\"WARN\",\"message\":\"field \\u0027text\\u0027 tokens exceed index.maxTokens\",\"code\":\"INDEX_ENGINE-32\",\"component\":\"ingestGlideDocument.standardAnalyzer\"},{\"level\":\"INFO\",\"message\":\"OK\",\"component\":\"index-886de18e750030108b23bcd69cdc2dd3-indexer.index-886de18e750030108b23bcd69cdc2dd3-content-dispatcher\"},{\"level\":\"INFO\",\"message\":\"COMPLETED\",\"component\":\"sink.sink\"}],\"document_id\":\"ADMIN-2587918521-27\"}]}"
}

    API zur Erfassung externer Inhalte: VERÖFFENTLICHEN SIE ais/external_content/storeContent

    Speichert binären Inhalt als Inhaltsobjekt in KI-Suche.

    Sie können gespeicherten Binärinhalt einem externen Dokument zuordnen, indem Sie die folgenden Schritte ausführen:
    1. Speichern Sie den binären Inhalt mit diesem Endpunkt. Zeichnen Sie den Wert von auf resultAntworttext-Parameter.
    2. Senden Sie das externe Dokument an KI-SucheMit VERÖFFENTLICHEN SIE /ais/external_content/ingestDocument/{Schema_table_Name} Endpunkt. Legen Sie die Dokumente fest content_pointerAnforderungstext-Parameter zur Übereinstimmung mit dem aufgezeichneten resultParameterwert des Antworttexts.
    Während der Erfassung KI-SucheAnalysiert den binären Inhalt und fügt seinen durchsuchbaren Inhalt dem indizierten Datensatz hinzu, der das externe Dokument darstellt. Durch die Analyse wird das gespeicherte Inhaltsobjekt entfernt.

    URL-Format

    Versionierte URL: /api/now/{api_Version}/ais/external_content/storeContent

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfad-Parameter
    Parameter Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 21. Anforderungstext-Parameter
    Element Beschreibung
    [Binärdaten] Erforderlich. Binärinhalt, der als Inhaltsobjekt in gespeichert werden soll KI-Suche.

    Header

    Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 22. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Inhaltstyp

    Datenformat des Anforderungstexts.

    Gültige Werte:
    • application/msword
    • application/octet-stream
    • application/pdf
    • application/vnd.ms-excel
    • application/vnd.ms-powerpoint
    • application/vnd.ms-powerpoint.presentation.macroenabled.12
    • application/vnd.openxmlformats-officedocument.presentationml.presentation
    • application/vnd.openxmlformats-officedocument.presentationml.template
    • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
    • application/vnd.openxmlformats-officedocument.wordprocessingml.document
    • application/vnd.openxmlformats-officedocument.wordprocessingml.template
    • text/html
    • text/plain
    Tabelle : 23. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Element Beschreibung
    Fehler

    Objekt, das den Fehler während der Verarbeitung der Anforderung beschreibt.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail

    Details des bei der Verarbeitung der Anforderung aufgetretenen Fehlers.

    Datentyp: Zeichenfolge
    Fehler.Nachricht

    Nachricht für den Fehler, der während der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Zeichenfolge
    Ergebnis

    Bezeichner für das binäre Inhaltsobjekt, das von einer erfolgreichen Anforderung gespeichert wurde.

    Datentyp: Zeichenfolge

    "result" : "91841766-2a5f-4c64-a20a-27ca485eca21"
    Hinweis:
    Um den gespeicherten Inhalt an ein erfasstes externes Dokument anzuhängen, geben Sie diesen Bezeichner als an content_pointerAnforderungstext-Element für eine Anforderung an IngestDocument Endpunkt.
    Status

    Status einer nicht erfolgreichen Anforderung.

    Gültige Werte:
    • failure

    Datentyp: Zeichenfolge

    Curl-Anforderung

    Binärinhalt für eine PDF-Datei als Inhaltsobjekt speichern.

    curl 'https://instance.servicenow.com/api/now/v2/ais/external_content/storeContent' \
--request POST \
--user 'username':'password' \
--header 'Content-Type: application/pdf' \
--data-binary '@Report-2020-08-31.pdf'

    Der Antworttext enthält den eindeutigen Bezeichner für das neue Inhaltsobjekt.

    {
  "result" : "fb439a4f-62ad-4dab-9654-5088d99a6ff9"
}