Chunks

Metoda: corpora.documents.chunks.create

Tworzy Chunk.

Punkt końcowy

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks

Parametry ścieżki

parent string

Wymagane. Nazwa jednostki Document, w której zostanie utworzony element Chunk. Przykład: corpora/my-corpus-123/documents/the-doc-abc. Ma on postać corpora/{corpora}/documents/{document}.

Treść żądania

Treść żądania zawiera wystąpienie elementu Chunk.

Pola
name string

Niezmienna. Identyfikator. Nazwa zasobu Chunk. Identyfikator (nazwa bez prefiksu „korpus/*/dokumenty/*/fragmenty/”) może zawierać maksymalnie 40 znaków (małe litery i myślniki (-)). Identyfikator nie może zaczynać się ani kończyć łącznikiem. Jeśli nazwa jest pusta podczas tworzenia, zostanie wygenerowany losowy 12-znakowy identyfikator. Przykład: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

Wymagane. Treść Chunk, np. ciąg tekstowy. Maksymalna liczba tokenów na fragment to 2043.

customMetadata[] object (CustomMetadata)

Opcjonalnie: Niestandardowe metadane podane przez użytkownika przechowywane jako pary klucz-wartość. Maksymalna liczba elementów CustomMetadata na fragment to 20.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała nowo utworzoną instancję Chunk.

Metoda: corpora.documents.chunks.list

Zawiera listę wszystkich elementów Chunk w elemencie Document.

Punkt końcowy

get https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks

Parametry ścieżki

parent string

Wymagane. Nazwa Document zawierającej Chunk. Przykład: corpora/my-corpus-123/documents/the-doc-abc. Ma on postać corpora/{corpora}/documents/{document}.

Parametry zapytania

pageSize integer

Opcjonalnie: Maksymalna liczba zwracanych elementów Chunk (na stronę). Usługa może zwrócić mniej elementów typu Chunk.

Jeśli nie zostanie podana żadna wartość, zwróci się maksymalnie 10 Chunk. Maksymalny limit rozmiaru to 100 Chunk na stronę.

pageToken string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania funkcji chunks.list.

Podaj nextPageToken zwrócony w odpowiedzi jako argument następnego żądania, które pozwala pobrać następną stronę.

Podczas podziału na strony wszystkie inne parametry przekazane do funkcji chunks.list muszą być zgodne z wywołaniem, które dostarczyło token strony.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź od użytkownika chunks.list zawierająca podzielona na strony listę elementów Chunk. Elementy typu Chunk są posortowane rosnąco według wartości chunk.create_time.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Pola
chunks[] object (Chunk)

Zwracane Chunk.

nextPageToken string

Token, który może zostać wysłany jako pageToken w celu pobrania następnej strony. Jeśli pominiesz to pole, nie będzie więcej stron.

Zapis JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "nextPageToken": string
}

Metoda: corpora.documents.chunks.get

Pobiera informacje o konkretnym Chunk.

Punkt końcowy

pobierz https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*}

Parametry ścieżki

name string

Wymagane. Nazwa Chunk do pobrania. Przykład: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk przybiera postać corpora/{corpora}/documents/{document}/chunks/{chunk}.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Chunk.

Metoda: corpora.documents.chunks.patch

Aktualizuje Chunk.

Punkt końcowy

poprawka https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*}

Parametry ścieżki

chunk.name string

Niezmienna. Identyfikator. Nazwa zasobu Chunk. Identyfikator (nazwa bez prefiksu „korpus/*/dokumenty/*/fragmenty/”) może zawierać maksymalnie 40 znaków (małe litery i myślniki (-)). Identyfikator nie może zaczynać się ani kończyć łącznikiem. Jeśli podczas tworzenia nazwa jest pusta, zostanie wygenerowany losowy 12-znakowy identyfikator. Przykład: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c przybiera postać corpora/{corpora}/documents/{document}/chunks/{chunk}.

Parametry zapytania

updateMask string (FieldMask format)

Wymagane. Lista pól do zaktualizowania. Obecnie dotyczy to tylko aktualizacji customMetadata i data.

Jest to rozdzielana przecinkami lista w pełni kwalifikowanych nazw pól. Przykład: "user.displayName,photo".

Treść żądania

Treść żądania zawiera wystąpienie elementu Chunk.

Pola
data object (ChunkData)

Wymagane. Treść pola Chunk, na przykład ciąg tekstowy. Maksymalna liczba tokenów na fragment to 2043.

customMetadata[] object (CustomMetadata)

Opcjonalnie: Niestandardowe metadane podane przez użytkownika przechowywane jako pary klucz-wartość. Maksymalna liczba elementów CustomMetadata na fragment to 20.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Chunk.

Metoda: corpora.documents.chunks.delete

Usuwa element Chunk.

Punkt końcowy

delete https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*}

Parametry ścieżki

name string

Wymagane. Nazwa zasobu Chunk, który chcesz usunąć. Przykład: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk przybiera postać corpora/{corpora}/documents/{document}/chunks/{chunk}.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie pusta.

Metoda: corpora.documents.chunks.batchCreate

Tworzenie zbiorczego Chunk.

Punkt końcowy

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchCreate

Parametry ścieżki

parent string

Opcjonalnie: Nazwa Document, w którym zostanie utworzona ta partia Chunk. Pole nadrzędne w każdym elemencie CreateChunkRequest musi pasować do tej wartości. Przykład: corpora/my-corpus-123/documents/the-doc-abc przybiera postać corpora/{corpora}/documents/{document}.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Pola
requests[] object (CreateChunkRequest)

Wymagane. Komunikaty z żądaniem określają Chunk do utworzenia. Maksymalnie 100 Chunk można utworzyć zbiorczo.

Treść odpowiedzi

Odpowiedź od użytkownika chunks.batchCreate zawierająca listę utworzonych elementów Chunk.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Pola
chunks[] object (Chunk)

Utworzono Chunk.

Zapis JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

CreateChunkRequest

Prośba o utworzenie dokumentu Chunk.

Pola
parent string

Wymagane. Nazwa jednostki Document, w której zostanie utworzony element Chunk. Przykład: corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

Wymagane. Chunk do utworzenia.

Zapis JSON 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}

Metoda: corpora.documents.chunks.batchUpdate

Zbiorcza aktualizacja Chunk.

Punkt końcowy

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchUpdate

Parametry ścieżki

parent string

Opcjonalnie: Nazwa elementu Document zawierającego elementy Chunk do zaktualizowania. Pole nadrzędne w każdym elemencie UpdateChunkRequest musi pasować do tej wartości. Przykład: corpora/my-corpus-123/documents/the-doc-abc przybiera postać corpora/{corpora}/documents/{document}.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Pola
requests[] object (UpdateChunkRequest)

Wymagane. wiadomości z prośbą o zaktualizowanie Chunk; Maksymalna liczba Chunk, które można zaktualizować zbiorczo, to 100.

Treść odpowiedzi

Odpowiedź z chunks.batchUpdate zawierająca listę zaktualizowanych Chunk.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Pola
chunks[] object (Chunk)

Zaktualizowano Chunk.

Zapis JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

UpdateChunkRequest

Prośba o zaktualizowanie Chunk.

Pola
chunk object (Chunk)

Wymagane. Chunk do zaktualizowania.

updateMask string (FieldMask format)

Wymagane. Lista pól do zaktualizowania. Obecnie ta funkcja obsługuje tylko aktualizacje customMetadata i data.

Jest to lista pełnych nazw pól rozdzielona przecinkami. Przykład: "user.displayName,photo".

Zapis JSON 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}

Metoda: corpora.documents.chunks.batchDelete

Usuwanie wielu Chunk wsadowo.

Punkt końcowy

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchDelete

Parametry ścieżki

parent string

Opcjonalnie: Nazwa elementu Document zawierającego elementy Chunk do usunięcia. Pole nadrzędne w każdym elemencie DeleteChunkRequest musi odpowiadać tej wartości. Przykład: corpora/my-corpus-123/documents/the-doc-abc. Ma on postać corpora/{corpora}/documents/{document}.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Pola
requests[] object (DeleteChunkRequest)

Wymagane. wiadomości z prośbą o usunięcie Chunk,

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi jest pusta.

DeleteChunkRequest

Prośba o usunięcie Chunk.

Pola
name string

Wymagane. Nazwa zasobu Chunk, który chcesz usunąć. Przykład: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk

Zapis JSON 
{
  "name": string
}

Zasób REST: corpora.documents.chunks

Zasób: Chunk

Chunk to podczęść elementu Document, która jest traktowana jako niezależna jednostka na potrzeby reprezentacji wektorowej i przechowywania danych. W elemencie Corpus maksymalna liczba elementów typu Chunk to 1 milion.

Pola
name string

Niezmienna. Identyfikator. Nazwa zasobu Chunk. Identyfikator (nazwa bez prefiksu „korpus/*/dokumenty/*/fragmenty/”) może zawierać maksymalnie 40 znaków (małe litery i myślniki (-)). Identyfikator nie może zaczynać się ani kończyć łącznikiem. Jeśli nazwa jest pusta podczas tworzenia, zostanie wygenerowany losowy 12-znakowy unikalny identyfikator. Przykład: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

Wymagane. Treść Chunk, np. ciąg tekstowy. Maksymalna liczba tokenów na fragment to 2043.

customMetadata[] object (CustomMetadata)

Opcjonalnie: niestandardowe metadane przesłane przez użytkownika, zapisane jako pary klucz-wartość; Maksymalna liczba elementów CustomMetadata na fragment to 20.

createTime string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa utworzenia elementu Chunk.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy element Chunk został ostatnio zaktualizowany.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

state enum (State)

Tylko dane wyjściowe. Obecny stan Chunk.

Zapis JSON 
{
  "name": string,
  "data": {
    object (ChunkData)
  },
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (State)
}

ChunkData

Wyodrębnione dane reprezentujące treści Chunk.

Pola

Pole unii data.

data może mieć tylko jedną z tych wartości:

stringValue string

Treść Chunk w postaci ciągu znaków. Maksymalna liczba tokenów na fragment to 2043.

Zapis JSON 
{

  // Union field data can be only one of the following:
  "stringValue": string
  // End of list of possible types for union field data.
}

Stan

Stany w cyklu życia Chunk.

Wartości w polu enum
STATE_UNSPECIFIED Wartość domyślna. Ta wartość jest używana w przypadku pominięcia stanu.
STATE_PENDING_PROCESSING Plik Chunk jest przetwarzany (umieszczanie i przechowywanie wektorowe).
STATE_ACTIVE Plik Chunk został przetworzony i jest dostępny do wyszukiwania.
STATE_FAILED Nie udało się przetworzyć pliku Chunk.