Corpora

Zasób REST: korpusy

Zasób: Korpus

Element Corpus to zbiór elementów Document. W projekcie można utworzyć maksymalnie 5 korpusów.

Zapis JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}
Pola
name string

Stała. Identyfikator. Nazwa zasobu Corpus. Identyfikator (nazwa bez prefiksu „korpus/”) może zawierać do 40 znaków w postaci małych liter alfanumerycznych lub myślników (-). Identyfikator nie może zaczynać się ani kończyć łącznikiem. Jeśli podczas tworzenia nazwa będzie pusta, zostanie ona pobrana z displayName i dodany 12-znakowy losowy sufiks. Przykład: corpora/my-awesome-corpora-123a456b789c

displayName string

Opcjonalnie: Zrozumiała dla człowieka wyświetlana nazwa elementu Corpus. Wyświetlana nazwa może mieć maksymalnie 512 znaków łącznie ze spacjami. Przykład: „Dokumenty w module odbioru semantycznego”

createTime string (Timestamp format)

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

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

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

Metoda: corpora.create

Tworzy pusty element Corpus.

Punkt końcowy

post https://generativelanguage.googleapis.com/v1beta/corpora
.

Treść żądania

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

Treść odpowiedzi

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

Metoda: corpora.list

Zawiera listę wszystkich elementów Corpora należących do użytkownika.

Punkt końcowy

pobierz https://generativelanguage.googleapis.com/v1beta/corpora
.

Parametry zapytania

pageSize integer

Opcjonalnie: Maksymalna liczba elementów Corpora do zwrócenia (na stronę). Usługa może zwrócić mniej Corpora.

Jeśli nie określono inaczej, zwróconych zostanie maksymalnie 10 elementów Corpora. Maksymalny rozmiar pliku to 20 Corpora na stronę.

pageToken string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania funkcji corpora.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 corpora.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 corpora.list zawierająca podzieloną na strony listę Corpora. Wyniki są posortowane rosnąco według wartości corpus.create_time.

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

Pola
corpora[] object (Corpus)

Zwrócone korpusy.

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 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

Metoda: corpora.query

Przeprowadza wyszukiwanie semantyczne w elemencie Corpus.

Punkt końcowy

post https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query
.

Parametry ścieżki

name string

Wymagane. Nazwa elementu Corpus, którego ma dotyczyć zapytanie. Przykład: corpora/my-corpus-123 przybiera postać corpora/{corpora}.

Treść żądania

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

Pola
query string

Wymagane. Ciąg zapytania używany do wyszukiwania semantycznego.

metadataFilters[] object (MetadataFilter)

Opcjonalnie: Filtruj według metadanych Chunk i Document. Każdy obiekt MetadataFilter powinien odpowiadać unikalnemu kluczowi. Wiele obiektów MetadataFilter jest połączonych warunkiem logicznym „AND”.

Przykładowe zapytanie na poziomie dokumentu: (rok >= 2020 LUB rok < 2010) AND (gatunek = dramat LUB gatunek = akcja)

Lista obiektów MetadataFilter: metadataFilters = [ {key = "document.custom_metadata.year" warunki = [{int_value = 2020, Operations = GREATER_EQUAL}, {int_value = 2010, actions = LESS}]}, {key = "document.custom_metadata.year" warunki = [{int_value = 2020, action = GREATER_EQUAL}, {int_value = 2010, actions = MNIEJ}]}, {klucz = "document.custom_metadata.genre" warunki = [{stringValue = "dramat", Operation = RÓWNOW.}, {stringValue = "działanie", operacja = EQUAL}]}]

Przykład zapytania na poziomie fragmentu dla liczbowego zakresu wartości: (rok > 2015 ORAZ rok <= 2020)

Lista obiektów MetadataFilter: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot; warunki = [{int_value = 2020, action = LESS_EQUAL}]}]

Uwaga: operatory „ORAZ” dla tego samego klucza są obsługiwane tylko w przypadku wartości liczbowych. Wartości w postaci ciągów znaków obsługują tylko operator „LUB” w przypadku tego samego klucza.

resultsCount integer

Opcjonalnie: Maksymalna liczba wartości Chunk do zwrócenia. 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. Maksymalna określona liczba wyników to 100.

Treść odpowiedzi

Odpowiedź od: corpora.query zawierająca listę odpowiednich fragmentów.

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

Pola
relevantChunks[] object (RelevantChunk)

Odpowiednie fragmenty.

Zapis JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Metoda: corpora.get

Pobiera informacje na temat: Corpus.

Punkt końcowy

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

Parametry ścieżki

name string

Wymagane. Nazwa elementu Corpus. Przykład: corpora/my-corpus-123 przybiera postać corpora/{corpora}.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

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

Metoda: corpora.patch

Aktualizuje Corpus.

Punkt końcowy

poprawka https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

Parametry ścieżki

corpus.name string

Stała. Identyfikator. Nazwa zasobu Corpus. Identyfikator (nazwa bez prefiksu „korpus/”) może zawierać do 40 znaków w postaci małych liter alfanumerycznych lub myślników (-). Identyfikator nie może zaczynać się ani kończyć łącznikiem. Jeśli podczas tworzenia nazwa będzie pusta, zostanie ona pobrana z displayName i dodany 12-znakowy losowy sufiks. Przykład: corpora/my-awesome-corpora-123a456b789c przybiera postać corpora/{corpora}.

Parametry zapytania

updateMask string (FieldMask format)

Wymagane. Lista pól do zaktualizowania. Obecnie można aktualizować tylko displayName.

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

Treść odpowiedzi

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

Metoda: corpora.delete

Usuwa element Corpus.

Punkt końcowy

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

Parametry ścieżki

name string

Wymagane. Nazwa zasobu komponentu Corpus. Przykład: corpora/my-corpus-123 przybiera postać corpora/{corpora}.

Parametry zapytania

force boolean

Opcjonalnie: Jeśli ma wartość Prawda, wszystkie elementy Document i obiekty powiązane z tym elementem Corpus również zostaną usunięte.

Jeśli zasada ma wartość fałsz (domyślna), a pole Corpus zawiera wartości Document, zwracany jest błąd FAILED_PRECONDITION.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

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

Zasób REST: corpora.permissions

Zasób: Permission

Uprawnienie zapewnia użytkownikowi, grupie lub reszcie świata dostęp do zasobu interfejsu PaLM API (np. dostrojonego modelu czy korpusu).

Rola to zbiór dozwolonych operacji, który umożliwia użytkownikom wykonywanie określonych działań na zasobach interfejsu PaLM API. Aby je udostępnić użytkownikom, grupom lub kontom usługi, musisz przypisać do nich role. Przypisując rolę, przyznajesz jej uprawnienia.

Istnieją 3 role koncentryczne. Każda rola jest nadzbiorem dozwolonych operacji poprzedniej roli:

  • czytnik może używać zasobu (np. dostrojonego modelu, korpusu) w celu wnioskowania
  • autor ma uprawnienia czytelnika i dodatkowo może edytować i udostępniać
  • właściciel ma uprawnienia zapisującego i dodatkowo może usuwać
Zapis JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}
Pola
name string

Tylko dane wyjściowe. Identyfikator. Nazwa uprawnienia. Podczas tworzenia zostanie wygenerowana unikalna nazwa. Przykłady: tylko dostrojoneModele/{tunedModel}/permissions/{permission} korpus/{korpus}/permissions/{permission} – dane wyjściowe.

granteeType enum (GranteeType)

Opcjonalnie: Stały. Rodzaj beneficjenta.

emailAddress string

Opcjonalnie: Stała. Adres e-mail użytkownika grupy, do którego odnosi się to uprawnienie. Pole nie jest ustawione, gdy typ użytkownika uprawnień to WSZYSCY.

role enum (Role)

Wymagane. Rola przypisana przez to uprawnienie.

GranteeType

Definiuje typy osób, którym przyznano to uprawnienie.

Wartości w polu enum
GRANTEE_TYPE_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
USER Reprezentuje użytkownika. Gdy to ustawienie jest skonfigurowane, musisz podać adres e-mail użytkownika.
GROUP Reprezentuje grupę. Jeśli to ustawienie jest skonfigurowane, musisz podać adres e-mail grupy.
EVERYONE Reprezentuje dostęp dla wszystkich. Nie musisz podawać żadnych dodatkowych informacji.

Rola

Określa rolę przypisaną przez to uprawnienie.

Wartości w polu enum
ROLE_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
OWNER Właściciel może używać, aktualizować, udostępniać i usuwać zasób.
WRITER Zapisujący może używać, aktualizować i udostępniać zasób.
READER Odczytujący może użyć zasobu.

MetadataFilter

Podany przez użytkownika filtr ograniczający pobieranie na podstawie wartości metadanych na poziomie Chunk lub Document. Przykład (gatunek = dramat LUB gatunek = akcja): klucz = "document.custom_metadata.genre" warunki = [{stringValue = "dramat", Operation = RÓWNOW.}, {stringValue = "działanie", operacja = EQUAL}]

Zapis JSON 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}
Pola
key string

Wymagane. Klucz metadanych, według których filtrować.

conditions[] object (Condition)

Wymagane. Elementy typu Condition przypisane do danego klucza, które aktywują ten filtr. Wiele elementów Condition jest połączonych operatorem logicznym LUB.

Warunek

Warunek filtra odnoszący się do pojedynczego klucza.

Zapis JSON 
{
  "operation": enum (Operator),

  // Union field value can be only one of the following:
  "stringValue": string,
  "numericValue": number
  // End of list of possible types for union field value.
}
Pola
operation enum (Operator)

Wymagane. Operator zastosowany do danej pary klucz-wartość w celu aktywowania warunku.

Pole sumy value. Typ wartości musi być zgodny z typem wartości zdefiniowanym w polu dla odpowiedniego klucza. Jeśli typy wartości nie są spójne, wynikiem będzie pusty zbiór. Jeśli CustomMetadata ma typ wartości StringList, warunek filtrowania powinien użyć parametru string_value w połączeniu z operacją UWZGLĘDNIJ/WYKLUCZ. W przeciwnym razie wynik również będzie pusty. value może mieć tylko jedną z tych wartości:
stringValue string

Wartość ciągu znaków, według której mają być filtrowane metadane.

numericValue number

Wartość liczbowa, według której mają być filtrowane metadane.

Operator

Definiuje prawidłowe operatory, które można zastosować w parze klucz-wartość.

Wartości w polu enum
OPERATOR_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
LESS Obsługiwane przez wartości liczbowe.
LESS_EQUAL Obsługiwane przez wartości liczbowe.
EQUAL Obsługiwane przez operatory liczbowe & ciągu znaków.
GREATER_EQUAL Obsługiwane przez wartości liczbowe.
GREATER Obsługiwane przez wartości liczbowe.
NOT_EQUAL Obsługiwane przez operatory liczbowe & ciągu znaków.
INCLUDES Obsługiwane przez ciąg znaków tylko wtedy, gdy typ wartości CustomMetadata danego klucza zawiera stringListValue.
EXCLUDES Obsługiwane przez ciąg znaków tylko wtedy, gdy typ wartości CustomMetadata danego klucza zawiera stringListValue.

RelevantChunk

Informacje dotyczące fragmentu istotnego dla zapytania.

Zapis JSON 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  }
}
Pola
chunkRelevanceScore number

Chunk trafność w stosunku do zapytania.

chunk object (Chunk)

Element Chunk powiązany z zapytaniem