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 Document, w której zostanie utworzona ta 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 „corpora/*/documents/*/chunks/”) może zawierać maksymalnie 40 znaków, które są małymi literami, cyframi lub łącznikami (-). 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 przesłane przez użytkownika, zapisane jako pary klucz-wartość; Maksymalna liczba CustomMetadata na fragment to 20.

Treść odpowiedzi

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

Metoda: corpora.documents.chunks.list

Wyświetla wszystkie Chunk w 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 Chunk do zwrócenia (na stronę). Usługa może zwrócić mniej 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.

Aby pobrać kolejną stronę, podaj jako argument kolejnego żądania nextPageToken zwrócony w odpowiedzi.

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ź z chunks.list zawierająca pogrupowaną listę Chunk. Chunk są posortowane rosnąco według kolumny chunk.create_time.

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

Pola
chunks[] object (Chunk)

Zwrócone Chunk.

nextPageToken string

token, który może być wysyłany jako pageToken w celu pobrania następnej strony. Jeśli pominiesz to pole, nie będzie kolejnych stron.

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

Metoda: corpora.documents.chunks.get

Pobiera informacje o konkretnym Chunk.

Punkt końcowy

get 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. Ma on 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

Zaktualizowano Chunk.

Punkt końcowy

patch 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 „corpora/*/documents/*/chunks/”) może zawierać maksymalnie 40 znaków, które są małymi literami, cyframi lub łącznikami (-). 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. Ma on postać corpora/{corpora}/documents/{document}/chunks/{chunk}.

Parametry zapytania

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

Treść żądania

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

Pola
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 CustomMetadata na fragment to 20.

Treść odpowiedzi

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

Metoda: corpora.documents.chunks.delete

usuwa 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. Ma on postać corpora/{corpora}/documents/{document}/chunks/{chunk}.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi to pusty obiekt JSON.

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

Wymagane. wiadomości z prośbą o utworzenie Chunk; Maksymalnie 100 Chunk można utworzyć zbiorczo.

Treść odpowiedzi

Odpowiedź z chunks.batchCreate zawierająca listę utworzonych 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 Document, w której zostanie utworzona ta Chunk. Przykład: corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

Wymagane. Element 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 Document zawierającej Chunk, które mają zostać zaktualizowane. Pole nadrzędne w każdym elemencie UpdateChunkRequest 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 (UpdateChunkRequest)

Wymagane. wiadomości z żądaniem określające Chunk do zaktualizowania; 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 jednocześnie.

Punkt końcowy

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

Parametry ścieżki

parent string

Opcjonalnie: Nazwa Document zawierającej Chunk, które chcesz usunąć. 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 to pusty obiekt JSON.

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 podelement Document, który jest traktowany jako niezależna jednostka do celów reprezentacji i przechowywania wektorów. Corpus może zawierać maksymalnie 1 milion Chunk.

Pola
name string

Niezmienna. Identyfikator. Nazwa zasobu Chunk. Identyfikator (nazwa bez prefiksu „corpora/*/documents/*/chunks/”) może zawierać maksymalnie 40 znaków, które są małymi literami, cyframi lub łącznikami (-). 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 przesłane przez użytkownika, zapisane jako pary klucz-wartość; Maksymalna liczba CustomMetadata na fragment to 20.

createTime string (Timestamp format)

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

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

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

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

state enum (State)

Tylko dane wyjściowe. Bieżący 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
data Union type
data może być tylko jednym z tych elementów:
stringValue string

Treść pola Chunk jako ciąg znaków. Maksymalna liczba tokenów na fragment to 2043.

Zapis JSON 
{

  // data
  "stringValue": string
  // Union type
}

Stan

Stany w cyklu życia Chunk.

Wartości w polu enum
STATE_UNSPECIFIED Wartość domyślna. Ta wartość jest używana, jeśli stan jest pominięty.
STATE_PENDING_PROCESSING Trwa przetwarzanie pliku Chunk (osadzanie i przechowywanie wektorów).
STATE_ACTIVE Plik Chunk został przetworzony i jest dostępny do wyszukiwania.
STATE_FAILED Chunk nie udało się przetworzyć.