Chunks

Zasób REST: corpora.documents.chunks

Zasób: fragment

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.

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

Stała. 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ść 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.

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 ostatniej aktualizacji 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".

state enum (State)

Tylko dane wyjściowe. Bieżący stan: Chunk.

ChunkData

Wyodrębnione dane reprezentujące zawartość: Chunk.

Zapis JSON 
{

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

Pole sumy 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.

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 Usługa Chunk została przetworzona i można wysyłać zapytania.
STATE_FAILED Nie udało się przetworzyć pliku Chunk.

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 przybiera postać corpora/{corpora}/documents/{document}.

Treść żądania

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

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

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

Parametry ścieżki

parent string

Wymagane. Nazwa elementu Document zawierającego elementy Chunk. Przykład: corpora/my-corpus-123/documents/the-doc-abc przybiera 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 określono inaczej, zwróconych zostanie maksymalnie 10 elementów Chunk. Maksymalny limit rozmiaru strony to 100 elementów Chunk.

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 dzielenia na strony wszystkie pozostałe parametry podane w narzędziu 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)

Zwrócone elementy 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 na temat: Chunk.

Punkt końcowy

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

Parametry ścieżki

name string

Wymagane. Nazwa elementu 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

Stała. 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 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.

Treść odpowiedzi

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

Metoda: corpora.documents.chunks.delete

Usuwa element Chunk.

Punkt końcowy

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

Parametry ścieżki

name string

Wymagane. Nazwa zasobu Chunk do usunięcia. 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

Utwórz zbiorczo elementy typu Chunk.

Punkt końcowy

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

Parametry ścieżki

parent string

Opcjonalnie: Nazwa grupy Document, w której zostanie utworzona ta grupa elementów 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. Grupę można utworzyć maksymalnie 100 elementów Chunk.

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: Chunk.

Zapis JSON 
{
  "parent": string,
  "chunk": {
    object (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.

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. Komunikaty żądania określające Chunk do zaktualizowania. Zbiorczo można zaktualizować maksymalnie 100 elementów typu Chunk.

Treść odpowiedzi

Odpowiedź od użytkownika chunks.batchUpdate zawierająca listę zaktualizowanych elementów 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.

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

Wymagane. Chunk do zaktualizowania.

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".

Metoda: corpora.documents.chunks.batchDelete

Usuń zbiorczo elementy typu Chunk.

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 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 (DeleteChunkRequest)

Wymagane. Komunikaty z prośbą o wskazanie elementów Chunk do usunięcia.

Treść odpowiedzi

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

DeleteChunkRequest

Prośba o usunięcie elementu Chunk.

Zapis JSON 
{
  "name": string
}
Pola
name string

Wymagane. Nazwa zasobu Chunk do usunięcia. Przykład: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk